Changes between Version 1 and Version 2 of WikiProcessors


Ignore:
Timestamp:
Jan 10, 2010 6:55:06 PM (6 years ago)
Author:
trac
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • WikiProcessors

    v1 v2  
    11= Wiki Processors =
    2 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''.
    32
    4 The wiki engine uses processors to allow using [wiki:WikiRestructuredText Restructured Text] and [wiki:WikiHtml raw HTML] in any wiki text throughout Trac.
     3Processors 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
     5The Wiki engine uses processors to allow using [wiki:WikiRestructuredText Restructured Text], [wiki:WikiHtml raw HTML] and [http://www.textism.com/tools/textile/ textile] in any Wiki text throughout Trac.
     6
    57
    68== Using Processors ==
    7 To use a processor on a block of text, use a wiki blockquote, selecting a processor by name using ''shebang notation'' (#!), familiar to most UNIX users from scripts.
     9
     10To 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.
    811
    912'''Example 1''' (''inserting raw HTML in a wiki text''):
     
    2225<h1 style="color: orange">This is raw HTML</h1>
    2326}}}
     27
     28Note that since 0.11, such blocks of HTML 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 div or span processors for achieving similar effect (see WikiHtml).
    2429
    2530----
     
    7883The following processors are included in the Trac distribution:
    7984 * '''html''' -- Insert custom HTML in a wiki page. See WikiHtml.
     85 * '''div''' -- Wrap an arbitrary Wiki content in a <div> element (''since 0.11''). See WikiHtml.
     86 * '''span''' -- Wrap an arbitrary Wiki content in a <span> element (''since 0.11''). See also WikiHtml.
    8087 * '''rst''' -- Trac support for Restructured Text. See WikiRestructuredText.
    81  * '''textile''' -- Supported if  [http://dealmeida.net/projects/textile/ Textile] is installed.
     88 * '''textile''' -- Supported if [http://cheeseshop.python.org/pypi/textile Textile] is installed. See [http://www.textism.com/tools/textile/ a Textile reference].
     89 * '''comment''' -- Do not process the text in this section (i.e. contents exist only in the plain text - not in the rendered page).
     90 * '''diff''' -- Pretty print patches and diffs.
    8291
    8392=== Code Highlighting Support ===
     
    8594 * '''c''' -- C
    8695 * '''cpp''' -- C++
     96 * '''csharp''' --- C# (''use #!text/x-csharp'')
    8797 * '''python''' -- Python
    8898 * '''perl''' -- Perl
    8999 * '''ruby''' -- Ruby
    90100 * '''php''' -- PHP
    91  * '''asp''' --- ASP
     101 * '''asp''' -- ASP
     102 * '''java''' -- Java
     103 * '''js''' -- Javascript
    92104 * '''sql''' -- SQL
    93105 * '''xml''' -- XML
     106 * '''sh''' -- Bourne/Bash shell
     107
    94108'''Note:''' ''Trac relies on external software packages for syntax coloring. See TracSyntaxColoring for more info.''
    95109
     
    102116}}}
    103117
    104 The result will be syntax highlighted HTML code. The same is valid for all other mime types supported.
     118The result will be syntax highlighted HTML code:
     119{{{
     120#!text/html
     121<h1>text</h1>
     122}}}
     123
     124The same is valid for all other mime types supported.
    105125
    106126
    107127For more processor macros developed and/or contributed by users, visit:
    108  * [http://projects.edgewall.com/trac/wiki/ProcessorBazaar ProcessorBazaar]
    109  * [http://projects.edgewall.com/trac/wiki/MacroBazaar MacroBazaar]
     128 * [trac:ProcessorBazaar]
     129 * [trac:MacroBazaar]
     130 * [th:WikiStart Trac Hacks] community site
    110131
    111132
    112133== Advanced Topics: Developing Processor Macros ==
    113 Developing processors is no different than WikiMacros. In fact they work the same way, only the usage syntax differs. See WikiMacros for more information.
     134Developing processors is no different from Wiki macros. In fact they work the same way, only the usage syntax differs. See WikiMacros for more information.
    114135
    115 '''Example:''' (''Restructured Text Processor''):
    116 {{{
    117 from docutils.core import publish_string
    118 
    119 def execute(hdf, text, env):
    120     html = publish_string(text, writer_name = 'html')
    121     return html[html.find('<body>')+6:html.find('</body>')].strip()
    122 }}}
    123136
    124137----