Changes between Version 1 and Version 2 of WikiProcessors

Timestamp:

May 12, 2012 12:00:03 PM (13 years ago)

Author:

trac

Comment:

--

WikiProcessors

@@ -3 +3 @@
 Processors are WikiMacros designed to provide alternative markup formats for the [TracWiki Wiki engine]. Processors can be thought of as ''macro functions to process user-edited text''. 
 
-The Wiki engine uses processors to allow using [wiki:WikiRestructuredText Restructured Text], [wiki:WikiHtml raw HTML] and [http://www.textism.com/tools/textile/ textile] in any Wiki text throughout Trac.
+Wiki processors can be used in any Wiki text throughout Trac,
+for various different purposes, like:
+ - [#CodeHighlightingSupport syntax highlighting] or for rendering text verbatim,
+ - rendering [#HTMLrelated Wiki markup inside a context], 
+   like inside <div> blocks or <span> or within <td> or <th> table cells,
+ - using an alternative markup syntax, like [wiki:WikiHtml raw HTML] and
+   [wiki:WikiRestructuredText Restructured Text],
+   or [http://www.textism.com/tools/textile/ textile]
 
 
 == Using Processors ==
 
-To use a processor on a block of text, use a Wiki code block, selecting a processor by name using ''shebang notation'' (#!), familiar to most UNIX users from scripts.
-
-'''Example 1''' (''inserting raw HTML in a wiki text''):
-
+To use a processor on a block of text, first delimit the lines using
+a Wiki ''code block'':
+{{{
+{{{
+The lines
+that should be processed...
+}}}
+}}}
+
+Immediately after the `{{{` or on the line just below, 
+add `#!` followed by the ''processor name''.
+
+{{{
+{{{
+#!processorname
+The lines
+that should be processed...
+}}}
+}}}
+
+This is the "shebang" notation, familiar to most UNIX users.
+
+Besides their content, some Wiki processors can also accept ''parameters'',
+which are then given as `key=value` pairs after the processor name, 
+on the same line. If `value` has to contain space, as it's often the case for
+the style parameter, a quoted string can be used (`key="value with space"`).
+
+As some processors are meant to process Wiki markup, it's quite possible to
+''nest'' processor blocks.
+You may want to indent the content of nested blocks for increased clarity,
+this extra indentation will be ignored when processing the content.
+
+
+== Examples ==
+
+||= Wiki Markup =||= Display =||
+{{{#!td colspan=2 align=center style="border: none"
+
+                __Example 1__: Inserting raw HTML
+}}}
+|-----------------------------------------------------------------
+{{{#!td style="border: none"
+{{{
 {{{
 #!html
-<pre class="wiki">{{{
+<h1 style="color: grey">This is raw HTML</h1>
+}}}
+}}}
+}}}
+{{{#!td valign=top style="border: none; padding-left: 2em"
+{{{
 #!html
-&lt;h1 style="color: orange"&gt;This is raw HTML&lt;/h1&gt;
-}}}</pre>
-}}}
-
-'''Results in:'''
-{{{
-#!html
-<h1 style="color: orange">This is raw HTML</h1>
-}}}
-
-----
-
-'''Example 2''' (''inserting Restructured Text in wiki text''):
-
-{{{
-#!html
-<pre class="wiki">{{{
-#!rst
-A header
---------
-This is some **text** with a footnote [*]_.
-
-.. [*] This is the footnote.
-}}}</pre>
-}}}
-
-'''Results in:'''
-{{{
-#!rst
-A header
---------
-This is some **text** with a footnote [*]_.
-
-.. [*] This is the footnote.
-}}}
-----
-'''Example 3''' (''inserting a block of C source code in wiki text''):
-
-{{{
-#!html
-<pre class="wiki">{{{
-#!c
-int main(int argc, char *argv[])
-{
-  printf("Hello World\n");
-  return 0;
-}
-}}}</pre>
-}}}
-
-'''Results in:'''
-{{{
-#!c
-int main(int argc, char *argv[])
-{
-  printf("Hello World\n");
-  return 0;
-}
-}}}
-
-----
-
+<h1 style="color: grey">This is raw HTML</h1>
+}}}
+}}}
+|-----------------------------------------------------------------
+{{{#!td colspan=2 align=center style="border: none"
+
+     __Example 2__: Highlighted Python code in a <div> block with custom style
+}}}
+|-----------------------------------------------------------------
+{{{#!td style="border: none"
+  {{{
+  {{{#!div style="background: #ffd; border: 3px ridge"
+
+  This is an example of embedded "code" block:
+
+    {{{
+    #!python
+    def hello():
+        return "world"
+    }}}
+
+  }}}
+  }}}
+}}}
+{{{#!td valign=top style="border: none; padding: 1em"
+  {{{#!div style="background: #ffd; border: 3px ridge"
+
+  This is an example of embedded "code" block:
+
+    {{{
+    #!python
+    def hello():
+        return "world"
+    }}}
+
+  }}}
+}}}
+|-----------------------------------------------------------------
+{{{#!td colspan=2 align=center style="border: none"
+
+     __Example 3__: Searching tickets from a wiki page, by keywords.
+}}}
+|-----------------------------------------------------------------
+{{{#!td style="border: none"
+  {{{
+  {{{
+  #!html
+  <form action="/query" method="get"><div>
+  <input type="text" name="keywords" value="~" size="30"/>
+  <input type="submit" value="Search by Keywords"/>
+  <!-- To control what fields show up use hidden fields
+  <input type="hidden" name="col" value="id"/>
+  <input type="hidden" name="col" value="summary"/>
+  <input type="hidden" name="col" value="status"/>
+  <input type="hidden" name="col" value="milestone"/>
+  <input type="hidden" name="col" value="version"/>
+  <input type="hidden" name="col" value="owner"/>
+  <input type="hidden" name="col" value="priority"/>
+  <input type="hidden" name="col" value="component"/>
+  -->
+  </div></form>
+  }}}
+  }}}
+}}}
+{{{#!td valign=top style="border: none; padding: 1em"
+  {{{
+  #!html
+  <form action="/query" method="get"><div>
+  <input type="text" name="keywords" value="~" size="30"/>
+  <input type="submit" value="Search by Keywords"/>
+  <!-- To control what fields show up use hidden fields
+  <input type="hidden" name="col" value="id"/>
+  <input type="hidden" name="col" value="summary"/>
+  <input type="hidden" name="col" value="status"/>
+  <input type="hidden" name="col" value="milestone"/>
+  <input type="hidden" name="col" value="version"/>
+  <input type="hidden" name="col" value="owner"/>
+  <input type="hidden" name="col" value="priority"/>
+  <input type="hidden" name="col" value="component"/>
+  -->
+  </div></form>
+  }}}
+}}}
 == Available Processors ==
+
 The following processors are included in the Trac distribution:
- * '''html''' -- Insert custom HTML in a wiki page. See WikiHtml.
- * '''rst''' -- Trac support for Restructured Text. See WikiRestructuredText.
- * '''textile''' -- Supported if  [http://dealmeida.net/projects/textile/ Textile] is installed. See [http://hobix.com/textile/ a Textile reference].
-
-Textile link above is rotten. [http://www.textism.com/tools/textile/ this one] works, allows to test example.
-
-=== Code Highlighting Support ===
-Trac includes processors to provide inline [wiki:TracSyntaxColoring syntax highlighting] for the following languages:
- * '''c''' -- C
- * '''cpp''' -- C++
- * '''python''' -- Python
- * '''perl''' -- Perl
- * '''ruby''' -- Ruby
- * '''php''' -- PHP
- * '''asp''' --- ASP
- * '''sql''' -- SQL
- * '''xml''' -- XML
-'''Note:''' ''Trac relies on external software packages for syntax coloring. See TracSyntaxColoring for more info.''
-
-By using the MIME type as processor, it is possible to syntax-highlight the same languages that are supported when browsing source code. For example, you can write:
-{{{
+
+|| '''`#!default`''' || Present the text verbatim in a preformatted text block. This is the same as specifying ''no'' processor name (and no `#!`) ||
+|| '''`#!comment`''' || Do not process the text in this section (i.e. contents exist only in the plain text - not in the rendered page). ||
+|||| ||
+||||= '''HTML related''' =||
+|| '''`#!html`''' || Insert custom HTML in a wiki page. ||
+|| '''`#!htmlcomment`''' || Insert an HTML comment in a wiki page (''since 0.12''). ||
+|| || Note that `#!html` blocks have to be ''self-contained'', i.e. you can't start an HTML element in one block and close it later in a second block. Use the following processors for achieving a similar effect.  ||
+|| '''`#!div`''' || Wrap an arbitrary Wiki content inside a <div> element (''since 0.11''). ||
+|| '''`#!span`''' || Wrap an arbitrary Wiki content inside a <span> element (''since 0.11''). ||
+|| '''`#!td`''' || Wrap an arbitrary Wiki content inside a <td> element (''since 0.12'') ||
+|| '''`#!th`''' || Wrap an arbitrary Wiki content inside a <th> element (''since 0.12'') ||
+|| '''`#!tr`''' || Can optionally be used for wrapping `#!td` and `#!th` blocks, either for specifying row attributes of better visual grouping (''since 0.12'') ||
+|| || See WikiHtml for example usage and more details about these processors. ||
+|||| ||
+||||= '''Other Markups''' =||
+|| '''`#!rst`''' || Trac support for Restructured Text. See WikiRestructuredText. ||
+|| '''`#!textile`''' || Supported if [http://cheeseshop.python.org/pypi/textile Textile] is installed. See [http://www.textism.com/tools/textile/ a Textile reference]. ||
+|||| ||
+||||= '''Code Highlighting Support''' =||
+|| '''`#!c`''' [[BR]] '''`#!cpp`''' (C++) [[BR]] '''`#!python`''' [[BR]] '''`#!perl`''' [[BR]] '''`#!ruby`''' [[BR]] '''`#!php`''' [[BR]] '''`#!asp`''' [[BR]] '''`#!java`''' [[BR]] '''`#!js`''' (Javascript) [[BR]] '''`#!sql`''' [[BR]] '''`#!xml`''' (XML or HTML) [[BR]] '''`#!sh`''' (!Bourne/Bash shell) [[BR]] '''etc.''' [[BR]] || Trac includes processors to provide inline syntax highlighting for source code in various languages. [[BR]] [[BR]] Trac relies on external software packages for syntax coloring, like [http://pygments.org Pygments]. [[BR]] [[BR]] See TracSyntaxColoring for information about which languages are supported and how to enable support for more languages. ||
+|||| ||
+||||= '''MIME Type Processors''' =||
+|||| Using the MIME type as processor, it is possible to syntax-highlight the same languages that are supported when browsing source code. ||
+{{{#!tr
+{{{#!td
+Some examples:
+ {{{
 {{{
 #!text/html
 <h1>text</h1>
 }}}
-}}}
-
-The result will be syntax highlighted HTML code. The same is valid for all other mime types supported.
-
+ }}}
+}}}
+{{{#!td
+The result will be syntax highlighted HTML code:
+ {{{
+#!text/html
+<h1>text</h1>
+ }}}
+
+The same is valid for all other [TracSyntaxColoring#SyntaxColoringSupport mime types supported].
+}}}
+}}}
+{{{#!td
+ {{{
+{{{
+#!diff
+--- Version 55
++++ Version 56
+@@ -115,8 +115,9 @@
+     name='TracHelloWorld', version='1.0',
+     packages=find_packages(exclude=['*.tests*']),
+-    entry_points = """
+-        [trac.plugins]
+-        helloworld = myplugs.helloworld
+-    """,
++    entry_points = {
++        'trac.plugins': [
++            'helloworld = myplugs.helloworld',
++        ],
++    },
+ )
+}}}
+ }}}
+}}}
+{{{#!td
+'''`#!diff`''' has a particularly nice renderer:
+ {{{
+#!diff
+--- Version 55
++++ Version 56
+@@ -115,8 +115,9 @@
+     name='TracHelloWorld', version='1.0',
+     packages=find_packages(exclude=['*.tests*']),
+-    entry_points = """
+-        [trac.plugins]
+-        helloworld = myplugs.helloworld
+-    """,
++    entry_points = {
++        'trac.plugins': [
++            'helloworld = myplugs.helloworld',
++        ],
++    },
+ )
+ }}}
+}}}
 
 For more processor macros developed and/or contributed by users, visit: 
- * [http://projects.edgewall.com/trac/wiki/ProcessorBazaar ProcessorBazaar]
- * [http://projects.edgewall.com/trac/wiki/MacroBazaar MacroBazaar]
-
-
-== Advanced Topics: Developing Processor Macros ==
-Developing processors is no different from WikiMacros. In fact they work the same way, only the usage syntax differs. See WikiMacros for more information.
-
-'''Example:''' (''Restructured Text Processor''):
-{{{
-#!python
-from docutils.core import publish_string
-
-def execute(hdf, text, env):
-    html = publish_string(text, writer_name = 'html')
-    return html[html.find('<body>')+6:html.find('</body>')].strip()
-}}}
+ * [trac:ProcessorBazaar]
+ * [trac:MacroBazaar]
+ * [th:WikiStart Trac Hacks] community site
+
+Developing processors is no different from Wiki macros. 
+In fact they work the same way, only the usage syntax differs. 
+See WikiMacros#DevelopingCustomMacros for more information.
+
 
 ----