Edgewall Software

Changes between Version 49 and Version 50 of WikiMacros


Ignore:
Timestamp:
Jan 7, 2016, 2:34:03 PM (8 years ago)
Author:
figaro
Comment:

Cosmetic changes

Legend:

Unmodified
Added
Removed
Modified

  • WikiMacros

    v49 v50  
    11= Trac Macros
    22
    3 [[PageOutline]]
     3[[PageOutline(2-5,Contents,pullout)]]
    44[[TranslatedPages]]
    55
    6 Trac macros are plugins to extend the Trac engine with custom 'functions' written in Python. A macro inserts dynamic HTML data in any context supporting WikiFormatting. Its syntax is `[[macro-name(optional-arguments)]]`.
     6'''Trac macros''' extend the Trac engine with custom functionality. Macros are a special type of plugin and are written in Python. A macro inserts dynamic HTML data in any context supporting WikiFormatting.
    77
    8 The WikiProcessors are another kind of macros. They typically deal with alternate markup formats and transformation of larger "blocks" of information, like source code highlighting. They are used for processing the multiline `{{{#!wiki-processor-name ... }}}` blocks.
     8The macro syntax is `[[macro-name(optional-arguments)]]`.
     9
     10'''WikiProcessors''' are another kind of macros. They are typically used for source code highlighting, such as `!#python` or `!#apache` and when the source code spans multiple lines, such as:
     11
     12{{{
     13{{{#!wiki-processor-name
     14...
     15}}}
     16}}}
    917
    1018== Using Macros
    1119
    12 Macro calls are enclosed in two ''square brackets'' `[[..]]`. Like Python functions, macros can also have arguments, a comma separated list within parentheses `[[..(,)]]`.
     20Macro calls are enclosed in double-square brackets `[[..]]`. Like Python functions, macros can have arguments, which is then a comma separated list within parentheses `[[..(,)]]`.
    1321
    1422=== Getting Detailed Help
    … …  
    5058{{{#!td style="padding-left: 2em"
    5159{{{#!html
    52 <div style="font-size: 80%" class="trac-macrolist">
     60<div class="trac-macrolist">
    5361<h3><code>[[Image]]</code></h3>Embed an image in wiki-formatted text.
    5462
    55 The first argument is the file …
     63The first argument is the file, as in <code>[[Image(filename.png)]]</code>
    5664<h3><code>[[InterTrac]]</code></h3>Provide a list of known <a class="wiki" href="/wiki/InterTrac">InterTrac</a> prefixes.
    5765<h3><code>[[InterWiki]]</code></h3>Provide a description list for the known <a class="wiki" href="/wiki/InterWiki">InterWiki</a> prefixes.
    5866<h3><code>[[KnownMimeTypes]]</code></h3>List all known mime-types which can be used as <a class="wiki" href="/wiki/WikiProcessors">WikiProcessors</a>.
    59 Can be …</div>
     67</div>
    6068}}}
    6169etc.
    … …  
    7078== Macros from around the world
    7179
    72 The [http://trac-hacks.org/ Trac Hacks] site provides a wide collection of macros and other Trac [TracPlugins plugins] contributed by the Trac community. If you are looking for new macros, or have written one that you would like to share with the world, don't hesitate to visit that site.
     80The [http://trac-hacks.org/ Trac Hacks] site provides a wide collection of macros and other Trac [TracPlugins plugins] contributed by the Trac community. If you are looking for new macros, or have written one that you would like to share, please visit that site.
    7381
    7482== Developing Custom Macros
    … …  
    7886For more information about developing macros, see the [trac:TracDev development resources] on the main project site.
    7987
    80 Here are 2 simple examples showing how to create a Macro. Also, have a look at [trac:source:tags/trac-1.0.2/sample-plugins/Timestamp.py Timestamp.py] for an example that shows the difference between old style and new style macros and at the [trac:source:tags/trac-0.11/wiki-macros/README macros/README] which provides a little more insight about the transition.
     88Here are 2 simple examples showing how to create a Macro. Also, have a look at [trac:source:tags/trac-1.0.2/sample-plugins/Timestamp.py Timestamp.py] for an example that shows the difference between old style and new style macros and at the [trac:source:tags/trac-0.11/wiki-macros/README macros/README] which provides more insight about the transition.
    8189
    8290=== Macro without arguments
    8391
    84 To test the following code, you should saved it in a `timestamp_sample.py` file located in the TracEnvironment's `plugins/` directory.
    85 {{{
    86 #!python
     92To test the following code, save it in a `timestamp_sample.py` file located in the TracEnvironment's `plugins/` directory.
     93
     94{{{#!python
    8795from datetime import datetime
    8896# Note: since Trac 0.11, datetime objects are used internally
    … …  
    106114=== Macro with arguments
    107115
    108 To test the following code, you should save it in a `helloworld_sample.py` file located in the TracEnvironment's `plugins/` directory.
    109 {{{
    110 #!python
     116To test the following code, save it in a `helloworld_sample.py` file located in the TracEnvironment's `plugins/` directory.
     117
     118{{{#!python
    111119from genshi.core import Markup
    112120
    … …  
    144152}}}
    145153
    146 Note that `expand_macro` optionally takes a 4^th^ parameter ''`args`''. When the macro is called as a [WikiProcessors WikiProcessor], it's also possible to pass `key=value` [WikiProcessors#UsingProcessors processor parameters]. If given, those are stored in a dictionary and passed in this extra `args` parameter. On the contrary, when called as a macro, `args` is `None`. (''since 0.12'').
     154Note that `expand_macro` optionally takes a 4^th^ parameter ''`args`''. When the macro is called as a [WikiProcessors WikiProcessor], it is also possible to pass `key=value` [WikiProcessors#UsingProcessors processor parameters]. If given, those are stored in a dictionary and passed in this extra `args` parameter. In the other case, when called as a macro, `args` is `None`. (''since 0.12'').
    147155
    148156For example, when writing:
    … …  
    158166[[HelloWorld(<Hello World!>)]]
    159167}}}
     168
    160169One should get:
    161170{{{
    162 Hello World, text = <Hello World!> , args = {'style': u'polite', 'silent': False, 'verbose': True}
    163 Hello World, text = <Hello World!> , args = {}
    164 Hello World, text = <Hello World!> , args = None
     171Hello World, text = <Hello World!>, args = {'style': u'polite', 'silent': False, 'verbose': True}
     172Hello World, text = <Hello World!>, args = {}
     173Hello World, text = <Hello World!>, args = None
    165174}}}
    166175
    167 Note that the return value of `expand_macro` is '''not''' HTML escaped. Depending on the expected result, you should escape it by yourself (using `return Markup.escape(result)`) or, if this is indeed HTML, wrap it in a Markup object (`return Markup(result)`) with `Markup` coming from Genshi, (`from genshi.core import Markup`). 
     176Note that the return value of `expand_macro` is '''not''' HTML escaped. Depending on the expected result, you should escape it yourself (using `return Markup.escape(result)`) or, if this is indeed HTML, wrap it in a Markup object (`return Markup(result)`) with `Markup` coming from Genshi (`from genshi.core import Markup`).
    168177
    169178You can also recursively use a wiki Formatter (`from trac.wiki import Formatter`) to process the `text` as wiki markup:
    170179
    171 {{{
    172 #!python
     180{{{#!python
    173181from genshi.core import Markup
    174182from trac.wiki.macros import WikiMacroBase