Changes between Version 1 and Version 2 of WikiProcessors


Ignore:
Timestamp:
2008-08-08T23:13:15Z (17 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).
    8290
    8391=== Code Highlighting Support ===
    … …  
    8997 * '''ruby''' -- Ruby
    9098 * '''php''' -- PHP
    91  * '''asp''' --- ASP
     99 * '''asp''' -- ASP
     100 * '''java''' -- Java
     101 * '''js''' -- Javascript
    92102 * '''sql''' -- SQL
    93103 * '''xml''' -- XML
     104 * '''sh''' -- Bourne/Bash shell
     105
    94106'''Note:''' ''Trac relies on external software packages for syntax coloring. See TracSyntaxColoring for more info.''
    95107
    … …  
    102114}}}
    103115
    104 The result will be syntax highlighted HTML code. The same is valid for all other mime types supported.
     116The result will be syntax highlighted HTML code:
     117{{{
     118#!text/html
     119<h1>text</h1>
     120}}}
     121
     122The same is valid for all other mime types supported.
    105123
    106124
    107125For 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]
     126 * [trac:ProcessorBazaar]
     127 * [trac:MacroBazaar]
     128 * [th:WikiStart Trac Hacks] community site
    110129
    111130
    112131== 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.
     132Developing processors is no different from Wiki macros. In fact they work the same way, only the usage syntax differs. See WikiMacros for more information.
    114133
    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 }}}
    123134
    124135----