Changes between Version 2 and Version 3 of WikiMacros


Ignore:
Timestamp:
11/11/10 14:43:40 (4 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 
    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 
    38 For more information about developing macros, see the [wiki:TracDev development resources] on the main project site. 
     67For more information about developing macros, see the [trac:TracDev development resources] on the main project site. 
    3968 
    4069 
    41 == Implementation == 
     70Here are 2 simple examples showing how to create a Macro with Trac 0.11.  
    4271 
    43 Here are 2 simple examples on how to create a Macro with [wiki:0.11 Trac 0.11] have a look at source:trunk/sample-plugins/Timestamp.py for an example that shows the difference between old style and new style macros and also source:trunk/wiki-macros/README which provides a little more insight about the transition. 
     72Also, have a look at [trac:source:tags/trac-0.11/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. 
    4473 
    4574=== Macro without arguments === 
    46 It should be saved as `TimeStamp.py` 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. 
    4776{{{ 
    4877#!python 
     
    5584from trac.wiki.macros import WikiMacroBase 
    5685 
    57 class TimestampMacro(WikiMacroBase): 
     86class TimeStampMacro(WikiMacroBase): 
    5887    """Inserts the current time (in seconds) into the wiki page.""" 
    5988 
     
    6190    url = "$URL$" 
    6291 
    63     def expand_macro(self, formatter, name, args): 
     92    def expand_macro(self, formatter, name, text): 
    6493        t = datetime.now(utc) 
    6594        return tag.b(format_datetime(t, '%c')) 
     
    6796 
    6897=== Macro with arguments === 
    69 It should be saved as `HelloWorld.py` (in the 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. 
    7099{{{ 
    71100#!python 
     101from genshi.core import Markup 
     102 
    72103from trac.wiki.macros import WikiMacroBase 
    73104 
     
    87118    url = "$URL$" 
    88119 
    89     def expand_macro(self, formatter, name, args): 
     120    def expand_macro(self, formatter, name, text, args): 
    90121        """Return some output that will be displayed in the Wiki content. 
    91122 
    92123        `name` is the actual name of the macro (no surprise, here it'll be 
    93124        `'HelloWorld'`), 
    94         `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. 
    95126          Note that if there are ''no'' parenthesis (like in, e.g. 
    96           [[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. 
    97130        """ 
    98         return 'Hello World, args = ' + unicode(args) 
    99      
    100     # Note that there's no need to HTML escape the returned data, 
    101     # 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 
    102134}}} 
    103135 
     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''). 
    104137 
    105 === {{{expand_macro}}} details === 
    106 {{{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}}} 
    107143 
    108 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: 
    109160 
    110161{{{ 
    111162#!python 
    112   text = "whatever wiki markup you want, even containing other macros" 
    113   # Convert Wiki markup to HTML, new style 
    114   out = StringIO() 
    115   Formatter(self.env, formatter.context).format(text, out) 
    116   return Markup(out.getvalue()) 
     163from genshi.core import Markup 
     164from trac.wiki.macros import WikiMacroBase 
     165from trac.wiki import Formatter 
     166import StringIO 
     167 
     168class HelloWorldMacro(WikiMacroBase): 
     169        def expand_macro(self, formatter, name, text, args): 
     170                text = "whatever '''wiki''' markup you want, even containing other macros" 
     171                # Convert Wiki markup to HTML, new style 
     172                out = StringIO.StringIO() 
     173                Formatter(self.env, formatter.context).format(text, out) 
     174                return Markup(out.getvalue()) 
    117175}}}