Changes between Version 1 and Version 2 of WikiProcessors


Ignore:
Timestamp:
08/02/11 11:44:45 (7 years ago)
Author:
trac
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • WikiProcessors

    v1 v2  
    11= Wiki Processors = 
    2 Processors are WikiMacros designed to provide alternative markup formats for the Trac Wiki engine. Processors can be thought of as ''macro functions to process user-edited text''.  
    3  
    4 The wiki engine uses processors to allow using [wiki:WikiRestructuredText Restructured Text] and [wiki:WikiHtml raw HTML] in any wiki text throughout Trac. 
     2 
     3Processors 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''.  
     4 
     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] 
     13 
    514 
    615== Using Processors == 
    7 To use a processor on a block of text, use a wiki blockquote, selecting a processor by name using ''shebang notation'' (#!), familiar to most UNIX users from scripts. 
    8  
    9 '''Example 1''' (''inserting raw HTML in a wiki text''): 
    10  
     16 
     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" 
    1166{{{ 
    1267#!html 
    13 <pre class="wiki">{{{ 
    14 #!html 
    15 &lt;h1 style="color: orange"&gt;This is raw HTML&lt;/h1&gt; 
    16 }}}</pre> 
    17 }}} 
    18  
    19 '''Results in:''' 
    20 {{{ 
    21 #!html 
    22 <h1 style="color: orange">This is raw HTML</h1> 
    23 }}} 
    24  
    25 ---- 
    26  
    27 '''Example 2''' (''inserting Restructured Text in wiki text''): 
    28  
    29 {{{ 
    30 #!html 
    31 <pre class="wiki">{{{ 
    32 #!rst 
    33 A header 
    34 -------- 
    35 This is some **text** with a footnote [*]_. 
    36  
    37 .. [*] This is the footnote. 
    38 }}}</pre> 
    39 }}} 
    40  
    41 '''Results in:''' 
    42 {{{ 
    43 #!rst 
    44 A header 
    45 -------- 
    46 This is some **text** with a footnote [*]_. 
    47  
    48 .. [*] This is the footnote. 
    49 }}} 
    50 ---- 
    51 '''Example 3''' (''inserting a block of C source code in wiki text''): 
    52  
    53 {{{ 
    54 #!html 
    55 <pre class="wiki">{{{ 
    56 #!c 
    57 int main(int argc, char *argv[]) 
    58 { 
    59   printf("Hello World\n"); 
    60   return 0; 
    61 } 
    62 }}}</pre> 
    63 }}} 
    64  
    65 '''Results in:''' 
    66 {{{ 
    67 #!c 
    68 int main(int argc, char *argv[]) 
    69 { 
    70   printf("Hello World\n"); 
    71   return 0; 
    72 } 
    73 }}} 
    74  
    75 ---- 
    76  
     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"> 
     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  </form> 
     129  }}} 
     130  }}} 
     131}}} 
     132{{{#!td valign=top style="border: none; padding: 1em" 
     133  {{{ 
     134  #!html 
     135  <form action="/query" method="get"> 
     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  </form> 
     149  }}} 
     150}}} 
    77151== Available Processors == 
     152 
    78153The following processors are included in the Trac distribution: 
    79  * '''html''' -- Insert custom HTML in a wiki page. See WikiHtml. 
    80  * '''rst''' -- Trac support for Restructured Text. See WikiRestructuredText. 
    81  * '''textile''' -- Supported if  [http://dealmeida.net/projects/textile/ Textile] is installed. 
     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 
    82189 
    83190=== Code Highlighting Support === 
    84 Trac includes processors to provide inline [wiki:TracSyntaxColoring syntax highlighting] for the following languages: 
    85  * '''c''' -- C 
    86  * '''cpp''' -- C++ 
    87  * '''python''' -- Python 
    88  * '''perl''' -- Perl 
    89  * '''ruby''' -- Ruby 
    90  * '''php''' -- PHP 
    91  * '''asp''' --- ASP 
    92  * '''sql''' -- SQL 
    93  * '''xml''' -- XML 
    94 '''Note:''' ''Trac relies on external software packages for syntax coloring. See TracSyntaxColoring for more info.'' 
    95  
    96 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: 
    97205{{{ 
    98206{{{ 
     
    102210}}} 
    103211 
    104 The result will be syntax highlighted HTML code. The same is valid for all other mime types supported. 
     212The result will be syntax highlighted HTML code: 
     213{{{ 
     214#!text/html 
     215<h1>text</h1> 
     216}}} 
     217 
     218The same is valid for all other [TracSyntaxColoring#SyntaxColoringSupport mime types supported]. 
    105219 
    106220 
    107221For more processor macros developed and/or contributed by users, visit:  
    108  * [http://projects.edgewall.com/trac/wiki/ProcessorBazaar ProcessorBazaar] 
    109  * [http://projects.edgewall.com/trac/wiki/MacroBazaar MacroBazaar] 
    110  
    111  
    112 == Advanced Topics: Developing Processor Macros == 
    113 Developing processors is no different than WikiMacros. In fact they work the same way, only the usage syntax differs. See WikiMacros for more information. 
    114  
    115 '''Example:''' (''Restructured Text Processor''): 
    116 {{{ 
    117 from docutils.core import publish_string 
    118  
    119 def execute(hdf, text, env): 
    120     html = publish_string(text, writer_name = 'html') 
    121     return html[html.find('<body>')+6:html.find('</body>')].strip() 
    122 }}} 
     222 * [trac:ProcessorBazaar] 
     223 * [trac:MacroBazaar] 
     224 * [th:WikiStart Trac Hacks] community site 
     225 
     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. 
     229 
    123230 
    124231----