stablejet is hosted by Hepforge, IPPP Durham
close Warning: Can't synchronize with repository "(default)" (/hepforge/svn/stablejet does not appear to be a Subversion repository.). Look in the Trac log for more information.

Changes between Version 1 and Version 2 of WikiProcessors


Ignore:
Timestamp:
Jul 17, 2018, 2:12:37 PM (6 years ago)
Author:
trac
Comment:

--

Legend:

Unmodified
Added
Removed
Modified

  • WikiProcessors

    v1 v2  
    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 [WikiHtml raw HTML] and [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
    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 |||| ||
    159 ||||= '''HTML related''' =||
     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]''' =||
    160149|| '''`#!html`''' || Insert custom HTML in a wiki page. ||
    161 || '''`#!htmlcomment`''' || Insert an HTML comment in a wiki page (''since 0.12''). ||
     150|| '''`#!htmlcomment`''' || Insert an HTML comment in a wiki page. (''since 0.12'') ||
    162151|| || 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.  ||
    163 || '''`#!div`''' || Wrap an arbitrary Wiki content inside a <div> element (''since 0.11''). ||
    164 || '''`#!span`''' || Wrap an arbitrary Wiki content inside a <span> element (''since 0.11''). ||
    165 || '''`#!td`''' || Wrap an arbitrary Wiki content inside a <td> element (''since 0.12'') ||
    166 || '''`#!th`''' || Wrap an arbitrary Wiki content inside a <th> element (''since 0.12'') ||
    167 || '''`#!tr`''' || Can optionally be used for wrapping `#!td` and `#!th` blocks, either for specifying row attributes of better visual grouping (''since 0.12'') ||
     152|| '''`#!div`''' || Wrap wiki content inside a <div> element. ||
     153|| '''`#!span`''' || Wrap wiki content inside a <span> element. ||
     154|| '''`#!td`''' || Wrap wiki content inside a <td> element. (''since 0.12'') ||
     155|| '''`#!th`''' || Wrap 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'') ||
    168158|| || See WikiHtml for example usage and more details about these processors. ||
    169159|||| ||
    … …  
    172162|| '''`#!textile`''' || Supported if [http://cheeseshop.python.org/pypi/textile Textile] is installed. See [http://www.textism.com/tools/textile/ a Textile reference]. ||
    173163|||| ||
    174 ||||= '''Code Highlighting Support''' =||
    175 || '''`#!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. ||
    176 |||| ||
     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 [http://pygments.org Pygments] for syntax coloring. [[BR]] [[BR]] See TracSyntaxColoring for information about which languages are supported and how to enable support for more languages. ||
     166|||| ||
     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.
     169
     170Using the MIME type as processor, it is possible to syntax-highlight the same languages that are supported when browsing source code.
     171
    177172||||= '''MIME Type Processors''' =||
    178 |||| Using the MIME type as processor, it is possible to syntax-highlight the same languages that are supported when browsing source code. ||
    179173{{{#!tr
    180174{{{#!td
    181175Some examples:
    182176 {{{
    183 {{{
    184 #!text/html
     177{{{#!text/html
    185178<h1>text</h1>
    186179}}}
    … …  
    189182{{{#!td
    190183The result will be syntax highlighted HTML code:
     184 {{{#!text/html
     185<h1>text</h1>
     186 }}}
     187
     188The same is valid for all other [TracSyntaxColoring#SyntaxColoringSupport mime types supported].
     189}}}
     190}}}
     191{{{#!td
    191192 {{{
    192 #!text/html
    193 <h1>text</h1>
    194  }}}
    195 
    196 The same is valid for all other [TracSyntaxColoring#SyntaxColoringSupport mime types supported].
    197 }}}
    198 }}}
    199 {{{#!td
    200  {{{
    201 {{{
    202 #!diff
     193{{{#!diff
    203194--- Version 55
    204195+++ Version 56
    … …  
    221212{{{#!td
    222213'''`#!diff`''' has a particularly nice renderer:
    223  {{{
    224 #!diff
     214 {{{#!diff
    225215--- Version 55
    226216+++ Version 56
    … …  
    241231}}}
    242232
    243 For more processor macros developed and/or contributed by users, visit:
    244  * [trac:ProcessorBazaar]
    245  * [trac:MacroBazaar]
    246  * [http://trac-hacks.org Trac Hacks] community site
    247 
    248 Developing processors is no different from Wiki macros.
    249 In fact they work the same way, only the usage syntax differs.
    250 See WikiMacros#DevelopingCustomMacros for more information.
    251 
     233Line numbers can be added to code blocks and lines can be highlighted //(since 1.1.2)//.
     234{{{
     235{{{#!python lineno=3 marks=3,9-10,16
     236def expand_markup(stream, ctxt=None):
     237    """A Genshi stream filter for expanding `genshi.Markup` events.
     238
     239    Note: Expansion may not be possible if the fragment is badly
     240    formed, or partial.
     241    """
     242    for event in stream:
     243        if isinstance(event[1], Markup):
     244            try:
     245                for subevent in HTML(event[1]):
     246                    yield subevent
     247            except ParseError:
     248                yield event
     249        else:
     250            yield event
     251}}}
     252}}}
     253{{{#!python lineno=3 marks=3,9-10,16
     254def expand_markup(stream, ctxt=None):
     255    """A Genshi stream filter for expanding `genshi.Markup` events.
     256
     257    Note: Expansion may not be possible if the fragment is badly
     258    formed, or partial.
     259    """
     260    for event in stream:
     261        if isinstance(event[1], Markup):
     262            try:
     263                for subevent in HTML(event[1]):
     264                    yield subevent
     265            except ParseError:
     266                yield event
     267        else:
     268            yield event
     269}}}
     270
     271For more processor macros developed and/or contributed by users, visit the [https://trac-hacks.org Trac Hacks] community site.
     272
     273Developing 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.
    252274
    253275----