| 1 | | = Wiki Processors = |
| 2 | | |
| 3 | | Processors 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 | | |
| 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'': |
| | 1 | = Wiki Processors |
| | 2 | |
| | 3 | Processors are WikiMacros that provide alternative markup formats for the [TracWiki Wiki engine]. Processors can be thought of as ''macro functions to process user-edited text''. |
| | 4 | |
| | 5 | Wiki 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] such as <div> or <span> blocks 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 | |
| | 12 | To use a processor on a block of text, first delimit the lines using a Wiki ''code block'': |
| 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 == |
| | 32 | Besides 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 | |
| | 34 | As some processors are meant to process Wiki markup, it's quite possible to ''nest'' processor blocks. |
| | 35 | You 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 |
| 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]''' =|| |
| 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'') || |
| 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]] || 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 | |
| | 168 | Since 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 | |
| | 170 | Using the MIME type as processor, it is possible to syntax-highlight the same languages that are supported when browsing source code. |
| | 171 | |
| 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 | | |
| | 233 | Line 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 |
| | 236 | def 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 |
| | 254 | def 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 | |
| | 271 | For more processor macros developed and/or contributed by users, visit the [https://trac-hacks.org Trac Hacks] community site. |
| | 272 | |
| | 273 | Processors are implemented using the same interfaces as Wiki macros, only the usage syntax differs. To develop a processor, see WikiMacros#DevelopingCustomMacros. |
