| Version 2 (modified by , 20 years ago) ( diff ) |
|---|
This page documents the 1.4 (latest stable) release. Documentation for other releases can be found here.
Wiki Processors
Processors are WikiMacros designed to provide alternative markup formats for the Trac Wiki engine. Processors can be thought of as macro functions to process user-edited text.
The wiki engine uses processors to allow using Restructured Text and raw HTML in any wiki text throughout Trac.
Using Processors
To use a processor on a block of text, use a wiki blockquote, selecting a processor by name using 'hashbang notation' (#!), familiar to most UNIX users from scripts.
Example 1 (inserting raw HTML in a wiki text):
{{{
#!html
<h1 style="color: orange">This is raw HTML</h1>
}}}
Results in:
This is raw HTML
Example 2 (inserting Restructured Text in wiki text):
{{{
#!rst
A header
--------
This is some **text** with a footnote [*]_.
.. [*] This is the footnote.
}}}
Results in:
Advanced Topics: Developing Processor Macros
Developing processors is no different than WikiMacros. In fact they work the same way, only the usage syntax differs. See WikiMacros for more information.
Example: (Restructured Text Processor):
from docutils.core import publish_string
def execute(hdf, text):
html = publish_string(text, writer_name = 'html')
return html[html.find('<body>')+6:html.find('</body>')].strip()
See also: WikiMacros, WikiFormatting, TracGuide
