Changes between Version 2 and Version 3 of WikiMacros


Ignore:
Timestamp:
04/04/12 14:28:08 (8 years ago)
Author:
trac
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • WikiMacros

    v2 v3  
    88
    99== Using Macros ==
    10 Macro calls are enclosed in two ''square brackets''. Like Python functions, macros can also have arguments, a comma separated list within parentheses.
    1110
    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.
     11Macro calls are enclosed in two ''square brackets''. Like Python functions, macros can also have arguments, a comma separated list within parentheses.
     12
     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
     26||= Wiki Markup =||= Display =||
    1827{{{
    19  [[RecentChanges(Trac,3)]]
     28#!td
     29  {{{
     30  [[RecentChanges(Trac,3)]]
     31 
    2032}}}
    21 
    22 Display:
    23  [[RecentChanges(Trac,3)]]
     33}}}
     34{{{
     35#!td style="padding-left: 2em;"
     36[[RecentChanges(Trac,3)]]
     37}}}
     38|-----------------------------------
     39{{{
     40#!td
     41  {{{
     42  [[RecentChanges?(Trac,3)]]
     43 
     44}}}
     45}}}
     46{{{
     47#!td style="padding-left: 2em;"
     48[[RecentChanges?(Trac,3)]]
     49}}}
     50|-----------------------------------
     51{{{
     52#!td
     53  {{{
     54  [[?]]
     55 
     56}}}
     57}}}
     58{{{
     59#!td style="padding-left: 2em; font-size: 80%"
     60[[?]]
     61}}}
    2462
    2563== Available Macros ==
     
    3472
    3573== Developing Custom Macros ==
    36 Macros, like Trac itself, are written in the [http://python.org/ Python programming language].
     74Macros, like Trac itself, are written in the [http://python.org/ Python programming language] and are developed as part of TracPlugins.
    3775
    3876For more information about developing macros, see the [trac:TracDev development resources] on the main project site.
    3977
    40 
    41 == Implementation ==
    4278
    4379Here are 2 simple examples showing how to create a Macro with Trac 0.11.
     
    4682
    4783=== Macro without arguments ===
    48 It should be saved as `TimeStamp.py` as Trac will use the module name as the Macro name
     84To test the following code, you should saved it in a `timestamp_sample.py` file located in the TracEnvironment's `plugins/` directory.
    4985{{{
    5086#!python
     
    6399    url = "$URL$"
    64100
    65     def expand_macro(self, formatter, name, args):
     101    def expand_macro(self, formatter, name, text):
    66102        t = datetime.now(utc)
    67103        return tag.b(format_datetime(t, '%c'))
     
    69105
    70106=== Macro with arguments ===
    71 It should be saved as `HelloWorld.py` (in the plugins/ directory) as Trac will use the module name as the Macro name
     107To test the following code, you should saved it in a `helloworld_sample.py` file located in the TracEnvironment's `plugins/` directory.
    72108{{{
    73109#!python
     110from genshi.core import Markup
     111
    74112from trac.wiki.macros import WikiMacroBase
    75113
     
    89127    url = "$URL$"
    90128
    91     def expand_macro(self, formatter, name, args):
     129    def expand_macro(self, formatter, name, text, args):
    92130        """Return some output that will be displayed in the Wiki content.
    93131
    94132        `name` is the actual name of the macro (no surprise, here it'll be
    95133        `'HelloWorld'`),
    96         `args` is the text enclosed in parenthesis at the call of the macro.
     134        `text` is the text enclosed in parenthesis at the call of the macro.
    97135          Note that if there are ''no'' parenthesis (like in, e.g.
    98           [[HelloWorld]]), then `args` is `None`.
     136          [[HelloWorld]]), then `text` is `None`.
     137        `args` are the arguments passed when HelloWorld is called using a
     138        `#!HelloWorld` code block.
    99139        """
    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.
     140        return 'Hello World, text = %s, args = %s' % \
     141            (Markup.escape(text), Markup.escape(repr(args)))
     142
    104143}}}
    105144
     145Note 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'').
    106146
    107 === {{{
    108 expand_macro
    109 }}} details ===
     147For example, when writing:
    110148{{{
    111 expand_macro
    112 }}} should return either a simple Python string which will be interpreted as HTML, or preferably a Markup object (use {{{
    113 from trac.util.html import Markup
    114 }}}).  {{{
    115 Markup(string)
    116 }}} 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 {{{
    117 from trac.wiki import Formatter
    118 }}}.
     149{{{
     150#!HelloWorld style="polite"
     151<Hello World!>
     152}}}
    119153
    120 If your macro creates wiki markup instead of HTML, you can convert it to HTML like this:
     154{{{
     155#!HelloWorld
     156<Hello World!>
     157}}}
     158
     159[[HelloWorld(<Hello World!>)]]
     160}}}
     161One should get:
     162{{{
     163Hello World, text = <Hello World!> , args = {'style': u'polite'}
     164Hello World, text = <Hello World!> , args = {}
     165Hello World, text = <Hello World!> , args = None
     166}}}
     167
     168Note 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`). 
     169
     170You can also recursively use a wiki Formatter (`from trac.wiki import Formatter`) to process the `text` as wiki markup, for example by doing:
    121171
    122172{{{
    123173#!python
    124   text = "whatever wiki markup you want, even containing other macros"
    125   # Convert Wiki markup to HTML, new style
    126   out = StringIO()
    127   Formatter(self.env, formatter.context).format(text, out)
    128   return Markup(out.getvalue())
     174    text = "whatever wiki markup you want, even containing other macros"
     175    # Convert Wiki markup to HTML, new style
     176    out = StringIO()
     177    Formatter(self.env, formatter.context).format(text, out)
     178    return Markup(out.getvalue())
    129179}}}
    130180