Changes between Version 3 and Version 4 of WikiProcessors


Ignore:
Timestamp:
Apr 24, 2017, 10:36:27 AM (8 months ago)
Author:
trac
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • WikiProcessors

    v3 v4  
    1 = Wiki Processors =
     1= Wiki Processors
    22
    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 Wiki processors can be used in any Wiki text throughout Trac,
    6 for 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 
    14 
    15 == Using Processors ==
    16 
    17 To use a processor on a block of text, first delimit the lines using
    18 a Wiki ''code block'':
     5Wiki processors can be used in any Wiki text throughout Trac, such as:
     6 - [#CodeHighlightingSupport syntax highlighting] or for rendering text verbatim
     7 - rendering [#HTMLrelated Wiki markup inside a context], like inside <div> blocks or <span> or within <td> or <th> table cells
     8 - using an alternative markup syntax, like [wiki:WikiHtml raw HTML] and [wiki:WikiRestructuredText Restructured Text] or [http://www.textism.com/tools/textile/ textile]
     9
     10== Using Processors
     11
     12To use a processor on a block of text, first delimit the lines using a Wiki ''code block'':
    1913{{{
    2014{{{
     
    2418}}}
    2519
    26 Immediately after the `{{{` or on the line just below,
    27 add `#!` followed by the ''processor name''.
     20Immediately after the `{{{` or on the line just below, add `#!` followed by the ''processor name'':
    2821
    2922{{{
     
    3730This is the "shebang" notation, familiar to most UNIX users.
    3831
    39 Besides their content, some Wiki processors can also accept ''parameters'',
    40 which are then given as `key=value` pairs after the processor name,
    41 on the same line. If `value` has to contain space, as it's often the case for
    42 the style parameter, a quoted string can be used (`key="value with space"`).
    43 
    44 As some processors are meant to process Wiki markup, it's quite possible to
    45 ''nest'' processor blocks.
    46 You may want to indent the content of nested blocks for increased clarity,
    47 this extra indentation will be ignored when processing the content.
    48 
    49 
    50 == Examples ==
     32Besides their content, some Wiki processors can also accept ''parameters'', which are then given as `key=value` pairs after the processor name and 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"`).
     33
     34As some processors are meant to process Wiki markup, it's quite possible to ''nest'' processor blocks.
     35You may want to indent the content of nested blocks for increased clarity, this extra indentation will be ignored when processing the content.
     36
     37== Examples
    5138
    5239||= Wiki Markup =||= Display =||
     
    5946{{{
    6047{{{
     48#!html
    6149<h1 style="color: grey">This is raw HTML</h1>
    6250}}}
     
    113101  {{{
    114102  #!html
    115   <form action="/query" method="get">
    116   <input type="text" name="keywords" value="~" size="30">
    117   <input type="submit" value="Search by Keywords">
     103  <form action="/query" method="get"><div>
     104  <input type="text" name="keywords" value="~" size="30"/>
     105  <input type="submit" value="Search by Keywords"/>
    118106  <!-- 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">
     107  <input type="hidden" name="col" value="id"/>
     108  <input type="hidden" name="col" value="summary"/>
     109  <input type="hidden" name="col" value="status"/>
     110  <input type="hidden" name="col" value="milestone"/>
     111  <input type="hidden" name="col" value="version"/>
     112  <input type="hidden" name="col" value="owner"/>
     113  <input type="hidden" name="col" value="priority"/>
     114  <input type="hidden" name="col" value="component"/>
    127115  -->
    128   </form>
     116  </div></form>
    129117  }}}
    130118  }}}
     
    133121  {{{
    134122  #!html
    135   <form action="/query" method="get">
    136   <input type="text" name="keywords" value="~" size="30">
    137   <input type="submit" value="Search by Keywords">
     123  <form action="/query" method="get"><div>
     124  <input type="text" name="keywords" value="~" size="30"/>
     125  <input type="submit" value="Search by Keywords"/>
    138126  <!-- 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">
     127  <input type="hidden" name="col" value="id"/>
     128  <input type="hidden" name="col" value="summary"/>
     129  <input type="hidden" name="col" value="status"/>
     130  <input type="hidden" name="col" value="milestone"/>
     131  <input type="hidden" name="col" value="version"/>
     132  <input type="hidden" name="col" value="owner"/>
     133  <input type="hidden" name="col" value="priority"/>
     134  <input type="hidden" name="col" value="component"/>
    147135  -->
    148   </form>
    149   }}}
    150 }}}
    151 == Available Processors ==
     136  </div></form>
     137  }}}
     138}}}
     139
     140== Available Processors
    152141
    153142The following processors are included in the Trac distribution:
    154143
    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 
    166 Note that `#!html` blocks have to be ''self-contained'',
    167 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.
    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 
    180 See 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 
    189 
    190 === Code Highlighting Support ===
    191 
    192 Trac 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 
    198 Trac relies on external software packages for syntax coloring,
    199 like [http://pygments.org Pygments].
    200 
    201 See TracSyntaxColoring for information about which languages
    202 are supported and how to enable support for more languages.
    203 
    204 Note 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:
    205 {{{
     144|| '''`#!default`''' || Present the text verbatim in a preformatted text block. This is the same as specifying ''no'' processor name (and no `#!`) ||
     145|| '''`#!comment`''' || Do not process the text in this section, i.e. contents exist only in the plain text - not in the rendered page. ||
     146|| '''`#!rtl`''' || Introduce a Right-To-Left block with appropriate CSS direction and styling ''(since 0.12.2)'' ||
     147|||| ||
     148||||= '''[=#HTMLrelated HTML related]''' =||
     149|| '''`#!html`''' || Insert custom HTML in a wiki page. ||
     150|| '''`#!htmlcomment`''' || Insert an HTML comment in a wiki page (''since 0.12''). ||
     151|| || 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.  ||
     152|| '''`#!div`''' || Wrap an arbitrary Wiki content inside a <div> element (''since 0.11''). ||
     153|| '''`#!span`''' || Wrap an arbitrary Wiki content inside a <span> element (''since 0.11''). ||
     154|| '''`#!td`''' || Wrap an arbitrary Wiki content inside a <td> element (''since 0.12'') ||
     155|| '''`#!th`''' || Wrap an arbitrary Wiki content inside a <th> element (''since 0.12'') ||
     156|| '''`#!tr`''' || Can optionally be used for wrapping `#!td` and `#!th` blocks, either for specifying row attributes or better visual grouping (''since 0.12'') ||
     157|| '''`#!table`''' || Can optionally be used for wrapping `#!tr`, `#!td` and `#!th` blocks, for specifying table attributes. One current limitation however is that tables cannot be nested. (''since 0.12'') ||
     158|| || See WikiHtml for example usage and more details about these processors. ||
     159|||| ||
     160||||= '''Other Markups''' =||
     161|| '''`#!rst`''' || Trac support for Restructured Text. See WikiRestructuredText. ||
     162|| '''`#!textile`''' || Supported if [http://cheeseshop.python.org/pypi/textile Textile] is installed. See [http://www.textism.com/tools/textile/ a Textile reference]. ||
     163|||| ||
     164||||= '''[=#CodeHighlightingSupport Code Highlighting Support]''' =||
     165|| '''`#!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. ||
     166|||| ||
     167
     168Using the MIME type as processor, it is possible to syntax-highlight the same languages that are supported when browsing source code.
     169
     170||||= '''MIME Type Processors''' =||
     171{{{#!tr
     172{{{#!td
     173Some examples:
     174 {{{
    206175{{{
    207176#!text/html
    208177<h1>text</h1>
    209178}}}
    210 }}}
    211 
     179 }}}
     180}}}
     181{{{#!td
    212182The result will be syntax highlighted HTML code:
    213 {{{
     183 {{{
    214184#!text/html
    215185<h1>text</h1>
    216 }}}
     186 }}}
    217187
    218188The same is valid for all other [TracSyntaxColoring#SyntaxColoringSupport mime types supported].
    219 
    220 
    221 For more processor macros developed and/or contributed by users, visit:
    222  * [trac:ProcessorBazaar]
    223  * [trac:MacroBazaar]
    224  * [th:WikiStart Trac Hacks] community site
    225 
    226 Developing processors is no different from Wiki macros.
    227 In fact they work the same way, only the usage syntax differs.
    228 See WikiMacros#DevelopingCustomMacros for more information.
    229 
     189}}}
     190}}}
     191{{{#!td
     192 {{{
     193{{{
     194#!diff
     195--- Version 55
     196+++ Version 56
     197@@ -115,8 +115,9 @@
     198     name='TracHelloWorld', version='1.0',
     199     packages=find_packages(exclude=['*.tests*']),
     200-    entry_points = """
     201-        [trac.plugins]
     202-        helloworld = myplugs.helloworld
     203-    """,
     204+    entry_points = {
     205+        'trac.plugins': [
     206+            'helloworld = myplugs.helloworld',
     207+        ],
     208+    },
     209 )
     210}}}
     211 }}}
     212}}}
     213{{{#!td
     214'''`#!diff`''' has a particularly nice renderer:
     215 {{{
     216#!diff
     217--- Version 55
     218+++ Version 56
     219@@ -115,8 +115,9 @@
     220     name='TracHelloWorld', version='1.0',
     221     packages=find_packages(exclude=['*.tests*']),
     222-    entry_points = """
     223-        [trac.plugins]
     224-        helloworld = myplugs.helloworld
     225-    """,
     226+    entry_points = {
     227+        'trac.plugins': [
     228+            'helloworld = myplugs.helloworld',
     229+        ],
     230+    },
     231 )
     232 }}}
     233}}}
     234
     235For more processor macros developed and/or contributed by users, visit the [http://trac-hacks.org/wiki/WikiStart Trac Hacks] community site.
     236
     237Developing 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.
    230238
    231239----