Changes between Version 3 and Version 4 of Wiki Processors


Ignore:
Timestamp:
Apr 12, 2015, 9:30:13 PM (9 years ago)
Author:
trac
Comment:

--

Legend:

Unmodified
Added
Removed
Modified

  • Wiki Processors

    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 =||
    … …  
    150137  }}}
    151138}}}
    152 == Available Processors ==
     139
     140== Available Processors
    153141
    154142The following processors are included in the Trac distribution:
    155143
    156144|| '''`#!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). ||
     145|| '''`#!comment`''' || Do not process the text in this section, i.e. contents exist only in the plain text - not in the rendered page. ||
    158146|| '''`#!rtl`''' || Introduce a Right-To-Left block with appropriate CSS direction and styling ''(since 0.12.2)'' ||
    159147|||| ||
    … …  
    177165|| '''`#!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. ||
    178166|||| ||
     167
     168Since 1.1.2 the default, coding highlighting and MIME-type processors support the argument `lineno` for adding line numbering to the code block. When a value is specified, as in `lineno=3`, the numbering will start at the specified value. When used in combination with the `lineno` argument, the `marks` argument is also supported for highlighting lines. A single line number, set of line numbers and range of line numbers are allowed. For example, `marks=3`, `marks=3-6`, `marks=3,5,7` and `marks=3-5,7` are all allowed. The specified values are relative to the numbered lines, so if `lineno=2` is specified to start the line numbering at 2, `marks=2` will result in the first line being highlighted.
    179169
    180170Using the MIME type as processor, it is possible to syntax-highlight the same languages that are supported when browsing source code.
    … …  
    245235}}}
    246236
    247 For 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 
    252 Developing processors is no different from Wiki macros.
    253 In fact they work the same way, only the usage syntax differs.
    254 See WikiMacros#DevelopingCustomMacros for more information.
    255 
     237Line numbers can be added to code blocks and lines can be highlighted //(since 1.1.2)//.
     238{{{
     239{{{#!python lineno=3 marks=3,9-10,16
     240def expand_markup(stream, ctxt=None):
     241    """A Genshi stream filter for expanding `genshi.Markup` events.
     242
     243    Note: Expansion may not be possible if the fragment is badly
     244    formed, or partial.
     245    """
     246    for event in stream:
     247        if isinstance(event[1], Markup):
     248            try:
     249                for subevent in HTML(event[1]):
     250                    yield subevent
     251            except ParseError:
     252                yield event
     253        else:
     254            yield event
     255}}}
     256}}}
     257{{{#!python lineno=3 marks=3,9-10,16
     258def expand_markup(stream, ctxt=None):
     259    """A Genshi stream filter for expanding `genshi.Markup` events.
     260
     261    Note: Expansion may not be possible if the fragment is badly
     262    formed, or partial.
     263    """
     264    for event in stream:
     265        if isinstance(event[1], Markup):
     266            try:
     267                for subevent in HTML(event[1]):
     268                    yield subevent
     269            except ParseError:
     270                yield event
     271        else:
     272            yield event
     273}}}
     274
     275For more processor macros developed and/or contributed by users, visit the [th:WikiStart Trac Hacks] community site.
     276
     277Developing 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.
    256278
    257279----