Changes between Version 1 and Version 2 of WikiProcessors


Ignore:
Timestamp:
Jul 30, 2012 5:33:18 PM (12 years ago)
Author:
trac
Comment:

--

Legend:

Unmodified
Added
Removed
Modified

  • WikiProcessors

    v1 v2  
    33Processors 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''.  
    44 
    5 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. 
     5Wiki processors can be used in any Wiki text throughout Trac, 
     6for various different purposes, like: 
     7 - [#CodeHighlightingSupport syntax highlighting] or for rendering text verbatim, 
     8 - rendering [#HTMLrelated Wiki markup inside a context],  
     9   like inside <div> blocks or <span> or within <td> or <th> table cells, 
     10 - using an alternative markup syntax, like [wiki:WikiHtml raw HTML] and 
     11   [wiki:WikiRestructuredText Restructured Text], 
     12   or [http://www.textism.com/tools/textile/ textile] 
    613 
    714 
    815== Using Processors == 
    916 
    10 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. 
    11  
    12 '''Example 1''' (''inserting raw HTML in a wiki text''): 
    13  
     17To use a processor on a block of text, first delimit the lines using 
     18a Wiki ''code block'': 
     19{{{ 
     20{{{ 
     21The lines 
     22that should be processed... 
     23}}} 
     24}}} 
     25 
     26Immediately after the `{{{` or on the line just below,  
     27add `#!` followed by the ''processor name''. 
     28 
     29{{{ 
     30{{{ 
     31#!processorname 
     32The lines 
     33that should be processed... 
     34}}} 
     35}}} 
     36 
     37This is the "shebang" notation, familiar to most UNIX users. 
     38 
     39Besides their content, some Wiki processors can also accept ''parameters'', 
     40which are then given as `key=value` pairs after the processor name,  
     41on the same line. If `value` has to contain space, as it's often the case for 
     42the style parameter, a quoted string can be used (`key="value with space"`). 
     43 
     44As some processors are meant to process Wiki markup, it's quite possible to 
     45''nest'' processor blocks. 
     46You may want to indent the content of nested blocks for increased clarity, 
     47this extra indentation will be ignored when processing the content. 
     48 
     49 
     50== Examples == 
     51 
     52||= Wiki Markup =||= Display =|| 
     53{{{#!td colspan=2 align=center style="border: none" 
     54 
     55                __Example 1__: Inserting raw HTML 
     56}}} 
     57|----------------------------------------------------------------- 
     58{{{#!td style="border: none" 
     59{{{ 
    1460{{{ 
    1561#!html 
    16 <pre class="wiki">{{{ 
     62<h1 style="color: grey">This is raw HTML</h1> 
     63}}} 
     64}}} 
     65}}} 
     66{{{#!td valign=top style="border: none; padding-left: 2em" 
     67{{{ 
    1768#!html 
    18 &lt;h1 style="color: orange"&gt;This is raw HTML&lt;/h1&gt; 
    19 }}}</pre> 
    20 }}} 
    21  
    22 '''Results in:''' 
    23 {{{ 
    24 #!html 
    25 <h1 style="color: orange">This is raw HTML</h1> 
    26 }}} 
    27  
    28 Note that since 0.11, such blocks of HTML 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 div or span processors for achieving similar effect (see WikiHtml). 
    29  
    30 ---- 
    31  
    32 '''Example 2''' (''inserting Restructured Text in wiki text''): 
    33  
    34 {{{ 
    35 #!html 
    36 <pre class="wiki">{{{ 
    37 #!rst 
    38 A header 
    39 -------- 
    40 This is some **text** with a footnote [*]_. 
    41  
    42 .. [*] This is the footnote. 
    43 }}}</pre> 
    44 }}} 
    45  
    46 '''Results in:''' 
    47 {{{ 
    48 #!rst 
    49 A header 
    50 -------- 
    51 This is some **text** with a footnote [*]_. 
    52  
    53 .. [*] This is the footnote. 
    54 }}} 
    55 ---- 
    56 '''Example 3''' (''inserting a block of C source code in wiki text''): 
    57  
    58 {{{ 
    59 #!html 
    60 <pre class="wiki">{{{ 
    61 #!c 
    62 int main(int argc, char *argv[]) 
    63 { 
    64   printf("Hello World\n"); 
    65   return 0; 
    66 } 
    67 }}}</pre> 
    68 }}} 
    69  
    70 '''Results in:''' 
    71 {{{ 
    72 #!c 
    73 int main(int argc, char *argv[]) 
    74 { 
    75   printf("Hello World\n"); 
    76   return 0; 
    77 } 
    78 }}} 
    79  
    80 ---- 
    81  
     69<h1 style="color: grey">This is raw HTML</h1> 
     70}}} 
     71}}} 
     72|----------------------------------------------------------------- 
     73{{{#!td colspan=2 align=center style="border: none" 
     74 
     75     __Example 2__: Highlighted Python code in a <div> block with custom style 
     76}}} 
     77|----------------------------------------------------------------- 
     78{{{#!td style="border: none" 
     79  {{{ 
     80  {{{#!div style="background: #ffd; border: 3px ridge" 
     81 
     82  This is an example of embedded "code" block: 
     83 
     84    {{{ 
     85    #!python 
     86    def hello(): 
     87        return "world" 
     88    }}} 
     89 
     90  }}} 
     91  }}} 
     92}}} 
     93{{{#!td valign=top style="border: none; padding: 1em" 
     94  {{{#!div style="background: #ffd; border: 3px ridge" 
     95 
     96  This is an example of embedded "code" block: 
     97 
     98    {{{ 
     99    #!python 
     100    def hello(): 
     101        return "world" 
     102    }}} 
     103 
     104  }}} 
     105}}} 
     106|----------------------------------------------------------------- 
     107{{{#!td colspan=2 align=center style="border: none" 
     108 
     109     __Example 3__: Searching tickets from a wiki page, by keywords. 
     110}}} 
     111|----------------------------------------------------------------- 
     112{{{#!td style="border: none" 
     113  {{{ 
     114  {{{ 
     115  #!html 
     116  <form action="/query" method="get"><div> 
     117  <input type="text" name="keywords" value="~" size="30"/> 
     118  <input type="submit" value="Search by Keywords"/> 
     119  <!-- To control what fields show up use hidden fields 
     120  <input type="hidden" name="col" value="id"/> 
     121  <input type="hidden" name="col" value="summary"/> 
     122  <input type="hidden" name="col" value="status"/> 
     123  <input type="hidden" name="col" value="milestone"/> 
     124  <input type="hidden" name="col" value="version"/> 
     125  <input type="hidden" name="col" value="owner"/> 
     126  <input type="hidden" name="col" value="priority"/> 
     127  <input type="hidden" name="col" value="component"/> 
     128  --> 
     129  </div></form> 
     130  }}} 
     131  }}} 
     132}}} 
     133{{{#!td valign=top style="border: none; padding: 1em" 
     134  {{{ 
     135  #!html 
     136  <form action="/query" method="get"><div> 
     137  <input type="text" name="keywords" value="~" size="30"/> 
     138  <input type="submit" value="Search by Keywords"/> 
     139  <!-- To control what fields show up use hidden fields 
     140  <input type="hidden" name="col" value="id"/> 
     141  <input type="hidden" name="col" value="summary"/> 
     142  <input type="hidden" name="col" value="status"/> 
     143  <input type="hidden" name="col" value="milestone"/> 
     144  <input type="hidden" name="col" value="version"/> 
     145  <input type="hidden" name="col" value="owner"/> 
     146  <input type="hidden" name="col" value="priority"/> 
     147  <input type="hidden" name="col" value="component"/> 
     148  --> 
     149  </div></form> 
     150  }}} 
     151}}} 
    82152== Available Processors == 
     153 
    83154The following processors are included in the Trac distribution: 
    84  * '''html''' -- Insert custom HTML in a wiki page. See WikiHtml. 
    85  * '''div''' -- Wrap an arbitrary Wiki content in a <div> element (''since 0.11''). See WikiHtml. 
    86  * '''span''' -- Wrap an arbitrary Wiki content in a <span> element (''since 0.11''). See also WikiHtml. 
    87  * '''rst''' -- Trac support for Restructured Text. See WikiRestructuredText. 
    88  * '''textile''' -- Supported if [http://cheeseshop.python.org/pypi/textile Textile] is installed. See [http://www.textism.com/tools/textile/ a Textile reference]. 
    89  * '''comment''' -- Do not process the text in this section (i.e. contents exist only in the plain text - not in the rendered page). 
    90  * '''diff''' -- Pretty print patches and diffs. 
    91  
    92 === Code Highlighting Support === 
    93 Trac includes processors to provide inline [wiki:TracSyntaxColoring syntax highlighting] for the following languages: 
    94  * '''c''' -- C 
    95  * '''cpp''' -- C++ 
    96  * '''csharp''' --- C# (''use #!text/x-csharp'') 
    97  * '''python''' -- Python 
    98  * '''perl''' -- Perl 
    99  * '''ruby''' -- Ruby 
    100  * '''php''' -- PHP 
    101  * '''asp''' -- ASP 
    102  * '''java''' -- Java 
    103  * '''js''' -- Javascript 
    104  * '''sql''' -- SQL 
    105  * '''xml''' -- XML 
    106  * '''sh''' -- Bourne/Bash shell 
    107  
    108 '''Note:''' ''Trac relies on external software packages for syntax coloring. See TracSyntaxColoring for more info.'' 
    109  
    110 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: 
    111 {{{ 
     155 
     156|| '''`#!default`''' || Present the text verbatim in a preformatted text block. This is the same as specifying ''no'' processor name (and no `#!`) || 
     157|| '''`#!comment`''' || Do not process the text in this section (i.e. contents exist only in the plain text - not in the rendered page). || 
     158|||| || 
     159||||= '''HTML related''' =|| 
     160|| '''`#!html`''' || Insert custom HTML in a wiki page. || 
     161|| '''`#!htmlcomment`''' || Insert an HTML comment in a wiki page (''since 0.12''). || 
     162|| || 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.  || 
     163|| '''`#!div`''' || Wrap an arbitrary Wiki content inside a <div> element (''since 0.11''). || 
     164|| '''`#!span`''' || Wrap an arbitrary Wiki content inside a <span> element (''since 0.11''). || 
     165|| '''`#!td`''' || Wrap an arbitrary Wiki content inside a <td> element (''since 0.12'') || 
     166|| '''`#!th`''' || Wrap an arbitrary Wiki content inside a <th> element (''since 0.12'') || 
     167|| '''`#!tr`''' || Can optionally be used for wrapping `#!td` and `#!th` blocks, either for specifying row attributes of better visual grouping (''since 0.12'') || 
     168|| || See WikiHtml for example usage and more details about these processors. || 
     169|||| || 
     170||||= '''Other Markups''' =|| 
     171|| '''`#!rst`''' || Trac support for Restructured Text. See WikiRestructuredText. || 
     172|| '''`#!textile`''' || Supported if [http://cheeseshop.python.org/pypi/textile Textile] is installed. See [http://www.textism.com/tools/textile/ a Textile reference]. || 
     173|||| || 
     174||||= '''Code Highlighting Support''' =|| 
     175|| '''`#!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. || 
     176|||| || 
     177||||= '''MIME Type Processors''' =|| 
     178|||| Using the MIME type as processor, it is possible to syntax-highlight the same languages that are supported when browsing source code. || 
     179{{{#!tr 
     180{{{#!td 
     181Some examples: 
     182 {{{ 
    112183{{{ 
    113184#!text/html 
    114185<h1>text</h1> 
    115186}}} 
    116 }}} 
    117  
     187 }}} 
     188}}} 
     189{{{#!td 
    118190The result will be syntax highlighted HTML code: 
    119 {{{ 
     191 {{{ 
    120192#!text/html 
    121193<h1>text</h1> 
    122 }}} 
    123  
    124 The same is valid for all other mime types supported. 
    125  
     194 }}} 
     195 
     196The same is valid for all other [TracSyntaxColoring#SyntaxColoringSupport mime types supported]. 
     197}}} 
     198}}} 
     199{{{#!td 
     200 {{{ 
     201{{{ 
     202#!diff 
     203--- Version 55 
     204+++ Version 56 
     205@@ -115,8 +115,9 @@ 
     206     name='TracHelloWorld', version='1.0', 
     207     packages=find_packages(exclude=['*.tests*']), 
     208-    entry_points = """ 
     209-        [trac.plugins] 
     210-        helloworld = myplugs.helloworld 
     211-    """, 
     212+    entry_points = { 
     213+        'trac.plugins': [ 
     214+            'helloworld = myplugs.helloworld', 
     215+        ], 
     216+    }, 
     217 ) 
     218}}} 
     219 }}} 
     220}}} 
     221{{{#!td 
     222'''`#!diff`''' has a particularly nice renderer: 
     223 {{{ 
     224#!diff 
     225--- Version 55 
     226+++ Version 56 
     227@@ -115,8 +115,9 @@ 
     228     name='TracHelloWorld', version='1.0', 
     229     packages=find_packages(exclude=['*.tests*']), 
     230-    entry_points = """ 
     231-        [trac.plugins] 
     232-        helloworld = myplugs.helloworld 
     233-    """, 
     234+    entry_points = { 
     235+        'trac.plugins': [ 
     236+            'helloworld = myplugs.helloworld', 
     237+        ], 
     238+    }, 
     239 ) 
     240 }}} 
     241}}} 
    126242 
    127243For more processor macros developed and/or contributed by users, visit:  
    … …  
    130246 * [th:WikiStart Trac Hacks] community site 
    131247 
    132  
    133 == Advanced Topics: Developing Processor Macros == 
    134 Developing processors is no different from Wiki macros. In fact they work the same way, only the usage syntax differs. See WikiMacros for more information. 
     248Developing processors is no different from Wiki macros.  
     249In fact they work the same way, only the usage syntax differs.  
     250See WikiMacros#DevelopingCustomMacros for more information. 
    135251 
    136252