Changes between Version 1 and Version 2 of WikiProcessors
- Timestamp:
- 10/20/08 09:40:50 (16 years ago)
Legend:
- Unmodified
- Added
- Removed
- Modified
-
WikiProcessors
v1 v2 1 1 = 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''.3 2 4 The wiki engine uses processors to allow using [wiki:WikiRestructuredText Restructured Text] and [wiki:WikiHtml raw HTML] in any wiki text throughout Trac. 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 The 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 5 7 6 8 == Using Processors == 7 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. 9 10 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. 8 11 9 12 '''Example 1''' (''inserting raw HTML in a wiki text''): … … 22 25 <h1 style="color: orange">This is raw HTML</h1> 23 26 }}} 27 28 Note 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). 24 29 25 30 ---- … … 75 80 ---- 76 81 77 78 79 82 == Available Processors == 80 83 The following processors are included in the Trac distribution: 81 84 * '''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. 82 87 * '''rst''' -- Trac support for Restructured Text. See WikiRestructuredText. 83 * '''textile''' -- Initial support as of aug 2, 2004. See [http://projects.edgewall.com/trac/ticket/593 ticket 593] and [http://dealmeida.net/projects/textile/ Textile]. 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). 84 90 85 === Source CodeSupport ===86 Trac includes processors to provide inline [wiki:TracSyntaxColoring syntax highlighting] for the selanguages:91 === Code Highlighting Support === 92 Trac includes processors to provide inline [wiki:TracSyntaxColoring syntax highlighting] for the following languages: 87 93 * '''c''' -- C 88 94 * '''cpp''' -- C++ … … 91 97 * '''ruby''' -- Ruby 92 98 * '''php''' -- PHP 93 * '''asp''' --- ASP 99 * '''asp''' -- ASP 100 * '''java''' -- Java 101 * '''js''' -- Javascript 94 102 * '''sql''' -- SQL 95 103 * '''xml''' -- XML 104 * '''sh''' -- Bourne/Bash shell 105 96 106 '''Note:''' ''Trac relies on external software packages for syntax coloring. See TracSyntaxColoring for more info.'' 97 107 98 By using the mime-type as processor, it is posible to syntax-highlight the same languages that are supported when browsing source code. (The list of mime-types can be found in [source:trunk/trac/Mimeview.py Mimeview.py]). 99 100 For example, you can write: 101 108 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: 102 109 {{{ 103 110 {{{ … … 107 114 }}} 108 115 109 The result will be syntax highlighted html code. The same is valid for all other mime types supported. 116 The result will be syntax highlighted HTML code: 117 {{{ 118 #!text/html 119 <h1>text</h1> 120 }}} 121 122 The same is valid for all other mime types supported. 110 123 111 124 125 For more processor macros developed and/or contributed by users, visit: 126 * [trac:ProcessorBazaar] 127 * [trac:MacroBazaar] 128 * [th:WikiStart Trac Hacks] community site 112 129 113 For more processor macros developed and/or contributed by users, visit the macro bazaar: 114 http://projects.edgewall.com/trac/wiki/MacroBazaar 130 131 == Advanced Topics: Developing Processor Macros == 132 Developing processors is no different from Wiki macros. In fact they work the same way, only the usage syntax differs. See WikiMacros for more information. 133 115 134 116 135 ---- 117 == Advanced Topics: Developing Processor Macros == 118 Developing processors is no different than WikiMacros. In fact they work the same way, only the usage syntax differs. See WikiMacros for more information. 119 120 '''Example:''' (''Restructured Text Processor''): 121 {{{ 122 from docutils.core import publish_string 123 124 def execute(hdf, text, env): 125 html = publish_string(text, writer_name = 'html') 126 return html[html.find('<body>')+6:html.find('</body>')].strip() 127 }}} 128 129 ---- 130 See also : WikiMacros, WikiHtml, WikiRestructuredText, TracSyntaxColoring, WikiFormatting, TracGuide 136 See also: WikiMacros, WikiHtml, WikiRestructuredText, TracSyntaxColoring, WikiFormatting, TracGuide