WikiProcessors - mattbichay/test GitHub Wiki

Table of Contents

Wiki Processors

Processors are WikiMacros designed to provide alternative markup formats for the [TracWiki]. Processors can be thought of as macro functions to process user-edited text.

The Wiki engine uses processors to allow using [wiki:WikiRestructuredText], [wiki:WikiHtml] and textile in any Wiki text throughout Trac.

Using Processors

To use a processor on a block of text, use a Wiki code block, selecting a processor by name using shebang notation (#!), familiar to most UNIX users from scripts.

Example 1 (inserting raw HTML in a wiki text):

Results in:

Example 2 (inserting Restructured Text in wiki text):

Results in:

Example 3 (inserting a block of C source code in wiki text):

Results in:

Available Processors

The following processors are included in the Trac distribution: 

 * '''html''' -- Insert custom HTML in a wiki page. See WikiHtml.
 * '''rst''' -- Trac support for Restructured Text. See WikiRestructuredText.
 * '''textile''' -- Supported if  [http://dealmeida.net/projects/textile/ Textile] is installed. See [http://hobix.com/textile/ a Textile reference].

Textile link above is rotten. this one works, allows to test example.

Code Highlighting Support

Trac includes processors to provide inline [wiki:TracSyntaxColoring] for the following languages: 

 * '''c''' -- C
 * '''cpp''' -- C++
 * '''python''' -- Python
 * '''perl''' -- Perl
 * '''ruby''' -- Ruby
 * '''php''' -- PHP
 * '''asp''' --- ASP
 * '''sql''' -- SQL
 * '''xml''' -- XML

Note: Trac relies on external software packages for syntax coloring. See TracSyntaxColoring for more info.

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:

The result will be syntax highlighted HTML code. The same is valid for all other mime types supported.

For more processor macros developed and/or contributed by users, visit: 

 * [http://projects.edgewall.com/trac/wiki/ProcessorBazaar ProcessorBazaar]
 * [http://projects.edgewall.com/trac/wiki/MacroBazaar MacroBazaar]

Advanced Topics: Developing Processor Macros

Developing processors is no different from WikiMacros. In fact they work the same way, only the usage syntax differs. See WikiMacros for more information.

Example: (Restructured Text Processor):

See also: WikiMacros, WikiHtml, WikiRestructuredText, TracSyntaxColoring, WikiFormatting, TracGuide
⚠️ **GitHub.com Fallback** ⚠️