Changes between Initial Version and Version 1 of WikiProcessors


Ignore:
Timestamp:
Nov 5, 2014, 5:03:51 PM (5 years ago)
Author:
trac
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • WikiProcessors

    v1 v1  
     1= Wiki Processors =
     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
     14
     15== Using Processors ==
     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#!html
     62<h1 style="color: grey">This is raw HTML</h1>
     63}}}
     64}}}
     65}}}
     66{{{#!td valign=top style="border: none; padding-left: 2em"
     67{{{
     68#!html
     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}}}
     152== Available Processors ==
     153
     154The following processors are included in the Trac distribution:
     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|| '''`#!rtl`''' || Introduce a Right-To-Left block with appropriate CSS direction and styling ''(since 0.12.2)'' ||
     159|||| ||
     160||||= '''[=#HTMLrelated HTML related]''' =||
     161|| '''`#!html`''' || Insert custom HTML in a wiki page. ||
     162|| '''`#!htmlcomment`''' || Insert an HTML comment in a wiki page (''since 0.12''). ||
     163|| || 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.  ||
     164|| '''`#!div`''' || Wrap an arbitrary Wiki content inside a <div> element (''since 0.11''). ||
     165|| '''`#!span`''' || Wrap an arbitrary Wiki content inside a <span> element (''since 0.11''). ||
     166|| '''`#!td`''' || Wrap an arbitrary Wiki content inside a <td> element (''since 0.12'') ||
     167|| '''`#!th`''' || Wrap an arbitrary Wiki content inside a <th> element (''since 0.12'') ||
     168|| '''`#!tr`''' || Can optionally be used for wrapping `#!td` and `#!th` blocks, either for specifying row attributes or better visual grouping (''since 0.12'') ||
     169|| '''`#!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'') ||
     170|| || See WikiHtml for example usage and more details about these processors. ||
     171|||| ||
     172||||= '''Other Markups''' =||
     173|| '''`#!rst`''' || Trac support for Restructured Text. See WikiRestructuredText. ||
     174|| '''`#!textile`''' || Supported if [http://cheeseshop.python.org/pypi/textile Textile] is installed. See [http://www.textism.com/tools/textile/ a Textile reference]. ||
     175|||| ||
     176||||= '''[=#CodeHighlightingSupport Code Highlighting Support]''' =||
     177|| '''`#!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. ||
     178|||| ||
     179
     180Using the MIME type as processor, it is possible to syntax-highlight the same languages that are supported when browsing source code.
     181
     182||||= '''MIME Type Processors''' =||
     183{{{#!tr
     184{{{#!td
     185Some examples:
     186 {{{
     187{{{
     188#!text/html
     189<h1>text</h1>
     190}}}
     191 }}}
     192}}}
     193{{{#!td
     194The result will be syntax highlighted HTML code:
     195 {{{
     196#!text/html
     197<h1>text</h1>
     198 }}}
     199
     200The same is valid for all other [TracSyntaxColoring#SyntaxColoringSupport mime types supported].
     201}}}
     202}}}
     203{{{#!td
     204 {{{
     205{{{
     206#!diff
     207--- Version 55
     208+++ Version 56
     209@@ -115,8 +115,9 @@
     210     name='TracHelloWorld', version='1.0',
     211     packages=find_packages(exclude=['*.tests*']),
     212-    entry_points = """
     213-        [trac.plugins]
     214-        helloworld = myplugs.helloworld
     215-    """,
     216+    entry_points = {
     217+        'trac.plugins': [
     218+            'helloworld = myplugs.helloworld',
     219+        ],
     220+    },
     221 )
     222}}}
     223 }}}
     224}}}
     225{{{#!td
     226'''`#!diff`''' has a particularly nice renderer:
     227 {{{
     228#!diff
     229--- Version 55
     230+++ Version 56
     231@@ -115,8 +115,9 @@
     232     name='TracHelloWorld', version='1.0',
     233     packages=find_packages(exclude=['*.tests*']),
     234-    entry_points = """
     235-        [trac.plugins]
     236-        helloworld = myplugs.helloworld
     237-    """,
     238+    entry_points = {
     239+        'trac.plugins': [
     240+            'helloworld = myplugs.helloworld',
     241+        ],
     242+    },
     243 )
     244 }}}
     245}}}
     246
     247For more processor macros developed and/or contributed by users, visit:
     248 * [trac:ProcessorBazaar]
     249 * [trac:MacroBazaar]
     250 * [http://trac-hacks.org Trac Hacks] community site
     251
     252Developing processors is no different from Wiki macros.
     253In fact they work the same way, only the usage syntax differs.
     254See WikiMacros#DevelopingCustomMacros for more information.
     255
     256
     257----
     258See also: WikiMacros, WikiHtml, WikiRestructuredText, TracSyntaxColoring, WikiFormatting, TracGuide