Changes between Version 4 and Version 5 of WikiMacros


Ignore:
Timestamp:
18/06/2010 11:33:48 (14 years ago)
Author:
trac
Comment:

--

Legend:

Unmodified
Added
Removed
Modified

  • WikiMacros

    v4 v5  
    88
    99== Using Macros ==
     10
    1011Macro calls are enclosed in two ''square brackets''. Like Python functions, macros can also have arguments, a comma separated list within parentheses.
    1112
    12 Trac macros can also be written as TracPlugins. This gives them some capabilities that macros do not have, such as being able to directly access the HTTP request.
     13=== Getting Detailed Help ===
     14The list of available macros and the full help can be obtained using the !MacroList macro, as seen [#AvailableMacros below].
     15
     16A brief list can be obtained via ![[MacroList(*)]] or ![[?]].
     17
     18Detailed help on a specific macro can be obtained by passing it as an argument to !MacroList, e.g. ![[MacroList(MacroList)]], or, more conveniently, by appending a question mark (?) to the macro's name, like in ![[MacroList?]].
     19
     20
    1321
    1422=== Example ===
    … …  
    1624A list of 3 most recently changed wiki pages starting with 'Trac':
    1725
    18 {{{
    19  [[RecentChanges(Trac,3)]]
     26||= Wiki Markup =||= Display =||
     27{{{#!td
     28  {{{
     29  [[RecentChanges(Trac,3)]]
     30  }}}
    2031}}}
    21 
    22 Display:
    23  [[RecentChanges(Trac,3)]]
     32{{{#!td style="padding-left: 2em;"
     33[[RecentChanges(Trac,3)]]
     34}}}
     35|-----------------------------------
     36{{{#!td
     37  {{{
     38  [[RecentChanges?(Trac,3)]]
     39  }}}
     40}}}
     41{{{#!td style="padding-left: 2em;"
     42[[RecentChanges?(Trac,3)]]
     43}}}
     44|-----------------------------------
     45{{{#!td
     46  {{{
     47  [[?]]
     48  }}}
     49}}}
     50{{{#!td style="padding-left: 2em; font-size: 80%"
     51[[?]]
     52}}}
    2453
    2554== Available Macros ==
    … …  
    3463
    3564== Developing Custom Macros ==
    36 Macros, like Trac itself, are written in the [http://python.org/ Python programming language].
     65Macros, like Trac itself, are written in the [http://python.org/ Python programming language] and are developed as part of TracPlugins.
    3766
    3867For more information about developing macros, see the [trac:TracDev development resources] on the main project site.
    3968
    40 
    41 == Implementation ==
    4269
    4370Here are 2 simple examples showing how to create a Macro with Trac 0.11.
    … …  
    4673
    4774=== Macro without arguments ===
    48 It should be saved as `TimeStamp.py` (in the TracEnvironment's `plugins/` directory) as Trac will use the module name as the Macro name.
     75To test the following code, you should saved it in a `timestamp_sample.py` file located in the TracEnvironment's `plugins/` directory.
    4976{{{
    5077#!python
    … …  
    6390    url = "$URL$"
    6491
    65     def expand_macro(self, formatter, name, args):
     92    def expand_macro(self, formatter, name, text):
    6693        t = datetime.now(utc)
    6794        return tag.b(format_datetime(t, '%c'))
    … …  
    6996
    7097=== Macro with arguments ===
    71 It should be saved as `HelloWorld.py` (in the TracEnvironment's `plugins/` directory) as Trac will use the module name as the Macro name.
     98To test the following code, you should saved it in a `helloworld_sample.py` file located in the TracEnvironment's `plugins/` directory.
    7299{{{
    73100#!python
     101from genshi.core import Markup
     102
    74103from trac.wiki.macros import WikiMacroBase
    75104
    … …  
    89118    url = "$URL$"
    90119
    91     def expand_macro(self, formatter, name, args):
     120    def expand_macro(self, formatter, name, text, args):
    92121        """Return some output that will be displayed in the Wiki content.
    93122
    94123        `name` is the actual name of the macro (no surprise, here it'll be
    95124        `'HelloWorld'`),
    96         `args` is the text enclosed in parenthesis at the call of the macro.
     125        `text` is the text enclosed in parenthesis at the call of the macro.
    97126          Note that if there are ''no'' parenthesis (like in, e.g.
    98           [[HelloWorld]]), then `args` is `None`.
     127          [[HelloWorld]]), then `text` is `None`.
     128        `args` are the arguments passed when HelloWorld is called using a
     129        `#!HelloWorld` code block.
    99130        """
    100         return 'Hello World, args = ' + unicode(args)
    101    
    102     # Note that there's no need to HTML escape the returned data,
    103     # as the template engine (Genshi) will do it for us.
     131        return 'Hello World, text = %s, args = %s' % \
     132            (Markup.escape(text), Markup.escape(repr(args)))
     133
    104134}}}
    105135
     136Note 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'').
    106137
    107 === {{{expand_macro}}} details ===
    108 {{{expand_macro}}} should return either a simple Python string which will be interpreted as HTML, or preferably a Markup object (use {{{from trac.util.html import Markup}}}).  {{{Markup(string)}}} just annotates the string so the renderer will render the HTML string as-is with no escaping. You will also need to import Formatter using {{{from trac.wiki import Formatter}}}.
     138For example, when writing:
     139{{{
     140{{{#!HelloWorld style="polite"
     141<Hello World!>
     142}}}
    109143
    110 If your macro creates wiki markup instead of HTML, you can convert it to HTML like this:
     144{{{#!HelloWorld
     145<Hello World!>
     146}}}
     147
     148[[HelloWorld(<Hello World!>)]]
     149}}}
     150One should get:
     151{{{
     152Hello World, text = <Hello World!> , args = {'style': u'polite'}
     153Hello World, text = <Hello World!> , args = {}
     154Hello World, text = <Hello World!> , args = None
     155}}}
     156
     157Note 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`). 
     158
     159You can also recursively use a wiki Formatter (`from trac.wiki import Formatter`) to process the `text` as wiki markup, for example by doing:
    111160
    112161{{{
    113162#!python
    114   text = "whatever wiki markup you want, even containing other macros"
    115   # Convert Wiki markup to HTML, new style
    116   out = StringIO()
    117   Formatter(self.env, formatter.context).format(text, out)
    118   return Markup(out.getvalue())
     163    text = "whatever wiki markup you want, even containing other macros"
     164    # Convert Wiki markup to HTML, new style
     165    out = StringIO()
     166    Formatter(self.env, formatter.context).format(text, out)
     167    return Markup(out.getvalue())
    119168}}}