Changes between Version 1 and Version 2 of WikiProcessors


Ignore:
Timestamp:
01/18/14 15:27:42 (10 years ago)
Author:
trac
Comment:

--

Legend:

Unmodified
Added
Removed
Modified

  • WikiProcessors

    v1 v2  
    5959{{{ 
    6060{{{ 
     61#!html 
    6162<h1 style="color: grey">This is raw HTML</h1> 
    6263}}} 
    … …  
    113114  {{{ 
    114115  #!html 
    115   <form action="/query" method="get"> 
    116   <input type="text" name="keywords" value="~" size="30"> 
    117   <input type="submit" value="Search by Keywords"> 
     116  <form action="/query" method="get"><div> 
     117  <input type="text" name="keywords" value="~" size="30"/> 
     118  <input type="submit" value="Search by Keywords"/> 
    118119  <!-- To control what fields show up use hidden fields 
    119   <input type="hidden" name="col" value="id"> 
    120   <input type="hidden" name="col" value="summary"> 
    121   <input type="hidden" name="col" value="status"> 
    122   <input type="hidden" name="col" value="milestone"> 
    123   <input type="hidden" name="col" value="version"> 
    124   <input type="hidden" name="col" value="owner"> 
    125   <input type="hidden" name="col" value="priority"> 
    126   <input type="hidden" name="col" value="component"> 
     120  <input type="hidden" name="col" value="id"/> 
     121  <input type="hidden" name="col" value="summary"/> 
     122  <input type="hidden" name="col" value="status"/> 
     123  <input type="hidden" name="col" value="milestone"/> 
     124  <input type="hidden" name="col" value="version"/> 
     125  <input type="hidden" name="col" value="owner"/> 
     126  <input type="hidden" name="col" value="priority"/> 
     127  <input type="hidden" name="col" value="component"/> 
    127128  --> 
    128   </form> 
     129  </div></form> 
    129130  }}} 
    130131  }}} 
    … …  
    133134  {{{ 
    134135  #!html 
    135   <form action="/query" method="get"> 
    136   <input type="text" name="keywords" value="~" size="30"> 
    137   <input type="submit" value="Search by Keywords"> 
     136  <form action="/query" method="get"><div> 
     137  <input type="text" name="keywords" value="~" size="30"/> 
     138  <input type="submit" value="Search by Keywords"/> 
    138139  <!-- To control what fields show up use hidden fields 
    139   <input type="hidden" name="col" value="id"> 
    140   <input type="hidden" name="col" value="summary"> 
    141   <input type="hidden" name="col" value="status"> 
    142   <input type="hidden" name="col" value="milestone"> 
    143   <input type="hidden" name="col" value="version"> 
    144   <input type="hidden" name="col" value="owner"> 
    145   <input type="hidden" name="col" value="priority"> 
    146   <input type="hidden" name="col" value="component"> 
     140  <input type="hidden" name="col" value="id"/> 
     141  <input type="hidden" name="col" value="summary"/> 
     142  <input type="hidden" name="col" value="status"/> 
     143  <input type="hidden" name="col" value="milestone"/> 
     144  <input type="hidden" name="col" value="version"/> 
     145  <input type="hidden" name="col" value="owner"/> 
     146  <input type="hidden" name="col" value="priority"/> 
     147  <input type="hidden" name="col" value="component"/> 
    147148  --> 
    148   </form> 
     149  </div></form> 
    149150  }}} 
    150151}}} 
    … …  
    153154The following processors are included in the Trac distribution: 
    154155 
    155  `#!default` :: Present the text verbatim in a preformatted text block.  
    156                 This is the same as specifying ''no'' processor name 
    157                 (and no `#!`) 
    158  `#!comment` :: Do not process the text in this section (i.e. contents exist 
    159                 only in the plain text - not in the rendered page). 
    160  
    161 === HTML related === 
    162  
    163  `#!html`        :: Insert custom HTML in a wiki page. 
    164  `#!htmlcomment` :: Insert an HTML comment in a wiki page (''since 0.12''). 
    165  
    166 Note that `#!html` blocks have to be ''self-contained'', 
    167 i.e. you can't start an HTML element in one block and close it later in a second block. Use the following processors for achieving a similar effect.  
    168  
    169   `#!div` :: Wrap an arbitrary Wiki content inside a <div> element 
    170              (''since 0.11''). 
    171  `#!span` :: Wrap an arbitrary Wiki content inside a <span> element  
    172              (''since 0.11'').  
    173  
    174  `#!td` :: Wrap an arbitrary Wiki content inside a <td> element (''since 0.12'') 
    175  `#!th` :: Wrap an arbitrary Wiki content inside a <th> element (''since 0.12'')  
    176  `#!tr` :: Can optionally be used for wrapping `#!td` and `#!th` blocks, 
    177        either for specifying row attributes of better visual grouping 
    178        (''since 0.12'') 
    179  
    180 See WikiHtml for example usage and more details about these processors. 
    181  
    182 === Other Markups === 
    183  
    184      `#!rst` :: Trac support for Restructured Text. See WikiRestructuredText. 
    185  `#!textile` :: Supported if [http://cheeseshop.python.org/pypi/textile Textile]  
    186                 is installed.  
    187                 See [http://www.textism.com/tools/textile/ a Textile reference]. 
    188  
    189  
    190 === Code Highlighting Support === 
    191  
    192 Trac includes processors to provide inline syntax highlighting: 
    193  `#!c` (C), `#!cpp` (C++), `#!python` (Python), `#!perl` (Perl),  
    194  `#!ruby` (Ruby), `#!php` (PHP), `#!asp` (ASP), `#!java` (Java),  
    195  `#!js` (Javascript), `#!sql (SQL)`, `#!xml` (XML or HTML), 
    196  `#!sh` (!Bourne/Bash shell), etc. 
    197  
    198 Trac relies on external software packages for syntax coloring, 
    199 like [http://pygments.org Pygments].  
    200  
    201 See TracSyntaxColoring for information about which languages 
    202 are supported and how to enable support for more languages. 
    203  
    204 Note also that 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: 
    205 {{{ 
     156|| '''`#!default`''' || Present the text verbatim in a preformatted text block. This is the same as specifying ''no'' processor name (and no `#!`) || 
     157|| '''`#!comment`''' || Do not process the text in this section (i.e. contents exist only in the plain text - not in the rendered page). || 
     158|||| || 
     159||||= '''HTML related''' =|| 
     160|| '''`#!html`''' || Insert custom HTML in a wiki page. || 
     161|| '''`#!htmlcomment`''' || Insert an HTML comment in a wiki page (''since 0.12''). || 
     162|| || Note that `#!html` blocks 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 the following processors for achieving a similar effect.  || 
     163|| '''`#!div`''' || Wrap an arbitrary Wiki content inside a <div> element (''since 0.11''). || 
     164|| '''`#!span`''' || Wrap an arbitrary Wiki content inside a <span> element (''since 0.11''). || 
     165|| '''`#!td`''' || Wrap an arbitrary Wiki content inside a <td> element (''since 0.12'') || 
     166|| '''`#!th`''' || Wrap an arbitrary Wiki content inside a <th> element (''since 0.12'') || 
     167|| '''`#!tr`''' || Can optionally be used for wrapping `#!td` and `#!th` blocks, either for specifying row attributes of better visual grouping (''since 0.12'') || 
     168|| || See WikiHtml for example usage and more details about these processors. || 
     169|||| || 
     170||||= '''Other Markups''' =|| 
     171|| '''`#!rst`''' || Trac support for Restructured Text. See WikiRestructuredText. || 
     172|| '''`#!textile`''' || Supported if [http://cheeseshop.python.org/pypi/textile Textile] is installed. See [http://www.textism.com/tools/textile/ a Textile reference]. || 
     173|||| || 
     174||||= '''Code Highlighting Support''' =|| 
     175|| '''`#!c`''' [[BR]] '''`#!cpp`''' (C++) [[BR]] '''`#!python`''' [[BR]] '''`#!perl`''' [[BR]] '''`#!ruby`''' [[BR]] '''`#!php`''' [[BR]] '''`#!asp`''' [[BR]] '''`#!java`''' [[BR]] '''`#!js`''' (Javascript) [[BR]] '''`#!sql`''' [[BR]] '''`#!xml`''' (XML or HTML) [[BR]] '''`#!sh`''' (!Bourne/Bash shell) [[BR]] '''etc.''' [[BR]] || Trac includes processors to provide inline syntax highlighting for source code in various languages. [[BR]] [[BR]] Trac relies on external software packages for syntax coloring, like [http://pygments.org Pygments]. [[BR]] [[BR]] See TracSyntaxColoring for information about which languages are supported and how to enable support for more languages. || 
     176|||| || 
     177 
     178Using the MIME type as processor, it is possible to syntax-highlight the same languages that are supported when browsing source code. 
     179 
     180||||= '''MIME Type Processors''' =|| 
     181{{{#!tr 
     182{{{#!td 
     183Some examples: 
     184 {{{ 
    206185{{{ 
    207186#!text/html 
    208187<h1>text</h1> 
    209188}}} 
    210 }}} 
    211  
     189 }}} 
     190}}} 
     191{{{#!td 
    212192The result will be syntax highlighted HTML code: 
    213 {{{ 
     193 {{{ 
    214194#!text/html 
    215195<h1>text</h1> 
    216 }}} 
     196 }}} 
    217197 
    218198The same is valid for all other [TracSyntaxColoring#SyntaxColoringSupport mime types supported]. 
    219  
     199}}} 
     200}}} 
     201{{{#!td 
     202 {{{ 
     203{{{ 
     204#!diff 
     205--- Version 55 
     206+++ Version 56 
     207@@ -115,8 +115,9 @@ 
     208     name='TracHelloWorld', version='1.0', 
     209     packages=find_packages(exclude=['*.tests*']), 
     210-    entry_points = """ 
     211-        [trac.plugins] 
     212-        helloworld = myplugs.helloworld 
     213-    """, 
     214+    entry_points = { 
     215+        'trac.plugins': [ 
     216+            'helloworld = myplugs.helloworld', 
     217+        ], 
     218+    }, 
     219 ) 
     220}}} 
     221 }}} 
     222}}} 
     223{{{#!td 
     224'''`#!diff`''' has a particularly nice renderer: 
     225 {{{ 
     226#!diff 
     227--- Version 55 
     228+++ Version 56 
     229@@ -115,8 +115,9 @@ 
     230     name='TracHelloWorld', version='1.0', 
     231     packages=find_packages(exclude=['*.tests*']), 
     232-    entry_points = """ 
     233-        [trac.plugins] 
     234-        helloworld = myplugs.helloworld 
     235-    """, 
     236+    entry_points = { 
     237+        'trac.plugins': [ 
     238+            'helloworld = myplugs.helloworld', 
     239+        ], 
     240+    }, 
     241 ) 
     242 }}} 
     243}}} 
    220244 
    221245For more processor macros developed and/or contributed by users, visit:  
    222246 * [trac:ProcessorBazaar] 
    223247 * [trac:MacroBazaar] 
    224  * [th:WikiStart Trac Hacks] community site 
     248 * [http://trac-hacks.org Trac Hacks] community site 
    225249 
    226250Developing processors is no different from Wiki macros.