| 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'': |
| 19 | {{{ |
| 20 | {{{ |
| 21 | The lines |
| 22 | that should be processed... |
| 23 | }}} |
| 24 | }}} |
| 25 | |
| 26 | Immediately after the `{{{` or on the line just below, |
| 27 | add `#!` followed by the ''processor name''. |
| 28 | |
| 29 | {{{ |
| 30 | {{{ |
| 31 | #!processorname |
| 32 | The lines |
| 33 | that should be processed... |
| 34 | }}} |
| 35 | }}} |
| 36 | |
| 37 | This is the "shebang" notation, familiar to most UNIX users. |
| 38 | |
| 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 == |
| 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 | <h1 style="color: grey">This is raw HTML</h1> |
| 62 | }}} |
| 63 | }}} |
| 64 | }}} |
| 65 | {{{#!td valign=top style="border: none; padding-left: 2em" |
| 66 | {{{ |
| 67 | #!html |
| 68 | <h1 style="color: grey">This is raw HTML</h1> |
| 69 | }}} |
| 70 | }}} |
| 71 | |----------------------------------------------------------------- |
| 72 | {{{#!td colspan=2 align=center style="border: none" |
| 73 | |
| 74 | __Example 2__: Highlighted Python code in a <div> block with custom style |
| 75 | }}} |
| 76 | |----------------------------------------------------------------- |
| 77 | {{{#!td style="border: none" |
| 78 | {{{ |
| 79 | {{{#!div style="background: #ffd; border: 3px ridge" |
| 80 | |
| 81 | This is an example of embedded "code" block: |
| 82 | |
| 83 | {{{ |
| 84 | #!python |
| 85 | def hello(): |
| 86 | return "world" |
| 87 | }}} |
| 88 | |
| 89 | }}} |
| 90 | }}} |
| 91 | }}} |
| 92 | {{{#!td valign=top style="border: none; padding: 1em" |
| 93 | {{{#!div style="background: #ffd; border: 3px ridge" |
| 94 | |
| 95 | This is an example of embedded "code" block: |
| 96 | |
| 97 | {{{ |
| 98 | #!python |
| 99 | def hello(): |
| 100 | return "world" |
| 101 | }}} |
| 102 | |
| 103 | }}} |
| 104 | }}} |
| 105 | |----------------------------------------------------------------- |
| 106 | {{{#!td colspan=2 align=center style="border: none" |
| 107 | |
| 108 | __Example 3__: Searching tickets from a wiki page, by keywords. |
| 109 | }}} |
| 110 | |----------------------------------------------------------------- |
| 111 | {{{#!td style="border: none" |
| 112 | {{{ |
| 113 | {{{ |
| 114 | #!html |
| 115 | <form action="/query" method="get"><div> |
| 116 | <input type="text" name="keywords" value="~" size="30"/> |
| 117 | <input type="submit" value="Search by Keywords"/> |
| 118 | <!-- 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"/> |
| 127 | --> |
| 128 | </div></form> |
| 129 | }}} |
| 130 | }}} |
| 131 | }}} |
| 132 | {{{#!td valign=top style="border: none; padding: 1em" |
| 133 | {{{ |
| 134 | #!html |
| 135 | <form action="/query" method="get"><div> |
| 136 | <input type="text" name="keywords" value="~" size="30"/> |
| 137 | <input type="submit" value="Search by Keywords"/> |
| 138 | <!-- 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"/> |
| 147 | --> |
| 148 | </div></form> |
| 149 | }}} |
| 150 | }}} |
| 151 | == Available Processors == |
| 152 | |
| 153 | The following processors are included in the Trac distribution: |
| 154 | |
| 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 | {{{ |
| 206 | {{{ |
| 207 | #!text/html |
| 208 | <h1>text</h1> |
| 209 | }}} |
| 210 | }}} |
| 211 | |
| 212 | The result will be syntax highlighted HTML code: |
| 213 | {{{ |
| 214 | #!text/html |
| 215 | <h1>text</h1> |
| 216 | }}} |
| 217 | |
| 218 | The 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 | |
| 230 | |
| 231 | ---- |
| 232 | See also: WikiMacros, WikiHtml, WikiRestructuredText, TracSyntaxColoring, WikiFormatting, TracGuide |