Changes between Version 1 and Version 2 of WikiProcessors


Ignore:
Timestamp:
Feb 24, 2010 5:37:18 PM (9 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.
     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}}}
    1125
    12 '''Example 1''' (''inserting raw HTML in a wiki text''):
     26Immediately after the `{{{` or on the line just below,
     27add `#!` followed by the ''processor name''.
    1328
     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"
    1459{{{
    1560#!html
    1661<pre class="wiki">{{{
    1762#!html
    18 &lt;h1 style="color: orange"&gt;This is raw HTML&lt;/h1&gt;
     63&lt;h1 style="color: grey"&gt;This is raw HTML&lt;/h1&gt;
    1964}}}</pre>
    2065}}}
    21 
    22 '''Results in:'''
     66}}}
     67{{{#!td valign=top style="border: none; padding-left: 2em"
    2368{{{
    2469#!html
    25 <h1 style="color: orange">This is raw HTML</h1>
     70<h1 style="color: grey">This is raw HTML</h1>
     71}}}
     72}}}
     73|-----------------------------------------------------------------
     74{{{#!td colspan=2 align=center style="border: none"
     75
     76     __Example 2__: Highlighted Python code in a <div> block with custom style
     77}}}
     78|-----------------------------------------------------------------
     79{{{#!td style="border: none"
     80  {{{
     81  {{{#!div style="background: #ffd; border: 3px ridge"
     82
     83  This is an example of embedded "code" block:
     84
     85    {{{
     86    #!python
     87    def hello():
     88        return "world"
     89    }}}
     90
     91  }}}
     92  }}}
     93}}}
     94{{{#!td valign=top style="border: none; padding: 1em"
     95  {{{#!div style="background: #ffd; border: 3px ridge"
     96
     97  This is an example of embedded "code" block:
     98
     99    {{{
     100    #!python
     101    def hello():
     102        return "world"
     103    }}}
     104
     105  }}}
    26106}}}
    27107
    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 ----
    81108
    82109== Available Processors ==
     110
    83111The 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).
     112
     113 `#!default` :: Present the text verbatim in a preformatted text block.
     114                This is the same as specifying ''no'' processor name
     115                (and no `#!`)
     116 `#!comment` :: Do not process the text in this section (i.e. contents exist
     117                only in the plain text - not in the rendered page).
     118
     119=== HTML related ===
     120
     121 `#!html`        :: Insert custom HTML in a wiki page.
     122 `#!htmlcomment` :: Insert an HTML comment in a wiki page (''since 0.12'').
     123
     124Note that `#!html` blocks have to be ''self-contained'',
     125i.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.
     126
     127  `#!div` :: Wrap an arbitrary Wiki content inside a <div> element
     128             (''since 0.11'').
     129 `#!span` :: Wrap an arbitrary Wiki content inside a <span> element
     130             (''since 0.11'').
     131
     132 `#!td` :: Wrap an arbitrary Wiki content inside a <td> element (''since 0.12'')
     133 `#!th` :: Wrap an arbitrary Wiki content inside a <th> element (''since 0.12'')
     134 `#!tr` :: Can optionally be used for wrapping `#!td` and `#!th` blocks,
     135       either for specifying row attributes of better visual grouping
     136       (''since 0.12'')
     137
     138See WikiHtml for more details about these processors.
     139
     140=== Other Markups ===
     141
     142     `#!rst` :: Trac support for Restructured Text. See WikiRestructuredText.
     143 `#!textile` :: Supported if [http://cheeseshop.python.org/pypi/textile Textile]
     144                is installed.
     145                See [http://www.textism.com/tools/textile/ a Textile reference].
     146
    90147
    91148=== Code Highlighting Support ===
    92 Trac includes processors to provide inline [wiki:TracSyntaxColoring syntax highlighting] for the following languages:
    93  * '''c''' -- C
    94  * '''cpp''' -- C++
    95  * '''python''' -- Python
    96  * '''perl''' -- Perl
    97  * '''ruby''' -- Ruby
    98  * '''php''' -- PHP
    99  * '''asp''' -- ASP
    100  * '''java''' -- Java
    101  * '''js''' -- Javascript
    102  * '''sql''' -- SQL
    103  * '''xml''' -- XML
    104  * '''sh''' -- Bourne/Bash shell
    105149
    106 '''Note:''' ''Trac relies on external software packages for syntax coloring. See TracSyntaxColoring for more info.''
     150Trac includes processors to provide inline syntax highlighting:
     151 `#!c` (C), `#!cpp` (C++), `#!python` (Python), `#!perl` (Perl),
     152 `#!ruby` (Ruby), `#!php` (PHP), `#!asp` (ASP), `#!java` (Java),
     153 `#!js` (Javascript), `#!sql (SQL)`, `#!xml` (XML or HTML),
     154 `#!sh` (Bourne/Bash shell), etc.
    107155
    108 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:
     156Trac relies on external software packages for syntax coloring,
     157like [http://pygments.org Pygments].
     158
     159See TracSyntaxColoring for informations about which languages
     160are supported and how to enable support for more languages.
     161
     162Note 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:
    109163{{{
    110164{{{
     
    122176The same is valid for all other mime types supported.
    123177
    124 
     178=== Additional Processors ===
    125179For more processor macros developed and/or contributed by users, visit:
    126180 * [trac:ProcessorBazaar]
     
    128182 * [th:WikiStart Trac Hacks] community site
    129183
    130 
    131 == Advanced Topics: Developing Processor Macros ==
    132 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.
     184Developing processors is no different from Wiki macros.
     185In fact they work the same way, only the usage syntax differs.
     186See WikiMacros#DevelopingCustomMacros for more information.
    133187
    134188