Changes between Version 6 and Version 7 of WikiProcessors


Ignore:
Timestamp:
01/24/11 13:49:18 (15 years ago)
Author:
trac
Comment:

--

Legend:

Unmodified
Added
Removed
Modified

  • WikiProcessors

    v6 v7  
    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  
    14 {{{ 
     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{{{ 
     60{{{ 
     61<h1 style="color: grey">This is raw HTML</h1> 
     62}}} 
     63}}} 
     64}}} 
     65{{{#!td valign=top style="border: none; padding-left: 2em" 
    1566{{{ 
    1667#!html 
    17 <h1 style="color: orange">This is raw HTML</h1> 
    18 }}} 
    19 }}} 
    20  
    21 '''Results in:''' 
    22 {{{ 
    23 #!html 
    24 <h1 style="color: orange">This is raw HTML</h1> 
    25 }}} 
    26  
    27 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). 
    28  
    29 ---- 
    30  
    31 '''Example 2''' (''inserting Restructured Text in wiki text''): 
    32  
    33 {{{ 
    34 {{{ 
    35 #!rst 
    36 A header 
    37 -------- 
    38 This is some **text** with a footnote [*]_. 
    39  
    40 .. [*] This is the footnote. 
    41 }}} 
    42 }}} 
    43  
    44 '''Results in:''' 
    45 {{{ 
    46 #!rst 
    47 A header 
    48 -------- 
    49 This is some **text** with a footnote [*]_. 
    50  
    51 .. [*] This is the footnote. 
    52 }}} 
    53 ---- 
    54 '''Example 3''' (''inserting a block of C source code in wiki text''): 
    55  
    56 {{{ 
    57 {{{ 
    58 #!c 
    59 int main(int argc, char *argv[]) 
    60 { 
    61   printf("Hello World\n"); 
    62   return 0; 
    63 } 
    64 }}} 
    65 }}} 
    66  
    67 '''Results in:''' 
    68 {{{ 
    69 #!c 
    70 int main(int argc, char *argv[]) 
    71 { 
    72   printf("Hello World\n"); 
    73   return 0; 
    74 } 
    75 }}} 
    76  
    77 ---- 
    78 '''Example 4''' (''Searching from a wiki page by custom field. Allows user to reuse most common searches on a wiki page''): 
    79  
    80 {{{ 
    81 {{{ 
    82 #!html 
    83 <form action="/query" method="get"> 
    84 <input type="text" name="keywords" value="~" size="30"> <input type="submit" value="Search by Keywords#"> 
    85 <!-- To control what fields show up use hidden fields 
    86 <input type="hidden" name="col" value="id"> 
    87 <input type="hidden" name="col" value="summary"> 
    88 <input type="hidden" name="col" value="status"> 
    89 <input type="hidden" name="col" value="milestone"> 
    90 <input type="hidden" name="col" value="version"> 
    91 <input type="hidden" name="col" value="owner"> 
    92 <input type="hidden" name="col" value="priority"> 
    93 <input type="hidden" name="col" value="component"> 
    94 --> 
    95 </form> 
    96 }}} 
    97 }}} 
    98  
    99  
    100 ''' Result:''' 
    101 {{{ 
    102 #!html 
    103 <form action="/query" method="get"> 
    104 <input type="text" name="keywords" value="~" size="30"> <input type="submit" value="Search by Keywords#"> 
    105 <!-- To control what fields show up use hidden fields 
    106 <input type="hidden" name="col" value="id"> 
    107 <input type="hidden" name="col" value="summary"> 
    108 <input type="hidden" name="col" value="status"> 
    109 <input type="hidden" name="col" value="milestone"> 
    110 <input type="hidden" name="col" value="version"> 
    111 <input type="hidden" name="col" value="owner"> 
    112 <input type="hidden" name="col" value="priority"> 
    113 <input type="hidden" name="col" value="component"> 
    114 --> 
    115 </form> 
    116 }}} 
    117  
    118  
    119 ---- 
    120  
     68<h1 style="color: grey">This is raw HTML</h1> 
     69}}} 
     70}}} 
     71|----------------------------------------------------------------- 
     72{{{#!td colspan=2 align=center style="border: none" 
     73 
     74     __Example 2__: Highlighted Python code in a <div> block with custom style 
     75}}} 
     76|----------------------------------------------------------------- 
     77{{{#!td style="border: none" 
     78  {{{ 
     79  {{{#!div style="background: #ffd; border: 3px ridge" 
     80 
     81  This is an example of embedded "code" block: 
     82 
     83    {{{ 
     84    #!python 
     85    def hello(): 
     86        return "world" 
     87    }}} 
     88 
     89  }}} 
     90  }}} 
     91}}} 
     92{{{#!td valign=top style="border: none; padding: 1em" 
     93  {{{#!div style="background: #ffd; border: 3px ridge" 
     94 
     95  This is an example of embedded "code" block: 
     96 
     97    {{{ 
     98    #!python 
     99    def hello(): 
     100        return "world" 
     101    }}} 
     102 
     103  }}} 
     104}}} 
     105|----------------------------------------------------------------- 
     106{{{#!td colspan=2 align=center style="border: none" 
     107 
     108     __Example 3__: Searching tickets from a wiki page, by keywords. 
     109}}} 
     110|----------------------------------------------------------------- 
     111{{{#!td style="border: none" 
     112  {{{ 
     113  {{{ 
     114  #!html 
     115  <form action="/query" method="get"><div> 
     116  <input type="text" name="keywords" value="~" size="30"/> 
     117  <input type="submit" value="Search by Keywords"/> 
     118  <!-- To control what fields show up use hidden fields 
     119  <input type="hidden" name="col" value="id"/> 
     120  <input type="hidden" name="col" value="summary"/> 
     121  <input type="hidden" name="col" value="status"/> 
     122  <input type="hidden" name="col" value="milestone"/> 
     123  <input type="hidden" name="col" value="version"/> 
     124  <input type="hidden" name="col" value="owner"/> 
     125  <input type="hidden" name="col" value="priority"/> 
     126  <input type="hidden" name="col" value="component"/> 
     127  --> 
     128  </div></form> 
     129  }}} 
     130  }}} 
     131}}} 
     132{{{#!td valign=top style="border: none; padding: 1em" 
     133  {{{ 
     134  #!html 
     135  <form action="/query" method="get"><div> 
     136  <input type="text" name="keywords" value="~" size="30"/> 
     137  <input type="submit" value="Search by Keywords"/> 
     138  <!-- To control what fields show up use hidden fields 
     139  <input type="hidden" name="col" value="id"/> 
     140  <input type="hidden" name="col" value="summary"/> 
     141  <input type="hidden" name="col" value="status"/> 
     142  <input type="hidden" name="col" value="milestone"/> 
     143  <input type="hidden" name="col" value="version"/> 
     144  <input type="hidden" name="col" value="owner"/> 
     145  <input type="hidden" name="col" value="priority"/> 
     146  <input type="hidden" name="col" value="component"/> 
     147  --> 
     148  </div></form> 
     149  }}} 
     150}}} 
    121151== Available Processors == 
     152 
    122153The following processors are included in the Trac distribution: 
    123  * '''html''' -- Insert custom HTML in a wiki page. See WikiHtml. 
    124  * '''div''' -- Wrap an arbitrary Wiki content in a <div> element (''since 0.11''). See WikiHtml. 
    125  * '''span''' -- Wrap an arbitrary Wiki content in a <span> element (''since 0.11''). See also WikiHtml. 
    126  * '''rst''' -- Trac support for Restructured Text. See WikiRestructuredText. 
    127  * '''textile''' -- Supported if [http://cheeseshop.python.org/pypi/textile Textile] is installed. See [http://www.textism.com/tools/textile/ a Textile reference]. 
    128  * '''comment''' -- Do not process the text in this section (i.e. contents exist only in the plain text that can be viewed when editing the wiki page content - not in the rendered page). 
    129  * '''diff''' -- Pretty print patches and diffs. 
     154 
     155 `#!default` :: Present the text verbatim in a preformatted text block.  
     156                This is the same as specifying ''no'' processor name 
     157                (and no `#!`) 
     158 `#!comment` :: Do not process the text in this section (i.e. contents exist 
     159                only in the plain text - not in the rendered page). 
     160 
     161=== HTML related === 
     162 
     163 `#!html`        :: Insert custom HTML in a wiki page. 
     164 `#!htmlcomment` :: Insert an HTML comment in a wiki page (''since 0.12''). 
     165 
     166Note that `#!html` blocks have to be ''self-contained'', 
     167i.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.  
     168 
     169  `#!div` :: Wrap an arbitrary Wiki content inside a <div> element 
     170             (''since 0.11''). 
     171 `#!span` :: Wrap an arbitrary Wiki content inside a <span> element  
     172             (''since 0.11'').  
     173 
     174 `#!td` :: Wrap an arbitrary Wiki content inside a <td> element (''since 0.12'') 
     175 `#!th` :: Wrap an arbitrary Wiki content inside a <th> element (''since 0.12'')  
     176 `#!tr` :: Can optionally be used for wrapping `#!td` and `#!th` blocks, 
     177       either for specifying row attributes of better visual grouping 
     178       (''since 0.12'') 
     179 
     180See WikiHtml for example usage and more details about these processors. 
     181 
     182=== Other Markups === 
     183 
     184     `#!rst` :: Trac support for Restructured Text. See WikiRestructuredText. 
     185 `#!textile` :: Supported if [http://cheeseshop.python.org/pypi/textile Textile]  
     186                is installed.  
     187                See [http://www.textism.com/tools/textile/ a Textile reference]. 
     188 
    130189 
    131190=== Code Highlighting Support === 
    132 Trac includes processors to provide inline [wiki:TracSyntaxColoring syntax highlighting] for the following languages: 
    133  * '''c''' -- C 
    134  * '''cpp''' -- C++ 
    135  * '''csharp''' --- C# 
    136  * '''python''' -- Python 
    137  * '''perl''' -- Perl 
    138  * '''ruby''' -- Ruby 
    139  * '''php''' -- PHP 
    140  * '''asp''' -- ASP 
    141  * '''java''' -- Java 
    142  * '''js''' -- Javascript 
    143  * '''sql''' -- SQL 
    144  * '''xml''' -- XML 
    145  * '''sh''' -- Bourne/Bash shell 
    146  
    147 '''Note:''' ''Trac relies on external software packages for syntax coloring. See TracSyntaxColoring for more info.'' 
    148  
    149 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: 
     191 
     192Trac includes processors to provide inline syntax highlighting: 
     193 `#!c` (C), `#!cpp` (C++), `#!python` (Python), `#!perl` (Perl),  
     194 `#!ruby` (Ruby), `#!php` (PHP), `#!asp` (ASP), `#!java` (Java),  
     195 `#!js` (Javascript), `#!sql (SQL)`, `#!xml` (XML or HTML), 
     196 `#!sh` (!Bourne/Bash shell), etc. 
     197 
     198Trac relies on external software packages for syntax coloring, 
     199like [http://pygments.org Pygments].  
     200 
     201See TracSyntaxColoring for information about which languages 
     202are supported and how to enable support for more languages. 
     203 
     204Note also that 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: 
    150205{{{ 
    151206{{{ 
    … …  
    169224 * [th:WikiStart Trac Hacks] community site 
    170225 
    171  
    172 == Advanced Topics: Developing Processor Macros == 
    173 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. 
     226Developing processors is no different from Wiki macros.  
     227In fact they work the same way, only the usage syntax differs.  
     228See WikiMacros#DevelopingCustomMacros for more information. 
    174229 
    175230