Changes between Initial Version and Version 1 of WikiMacros

2011-05-24 14:55:59 (9 years ago)



  • WikiMacros

    v1 v1  
     1= Trac Macros = 
     5Trac 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. 
     7Another kind of macros are WikiProcessors. They typically deal with alternate markup formats and representation of larger blocks of information (like source code highlighting). 
     9== Using Macros == 
     11Macro calls are enclosed in two ''square brackets''. Like Python functions, macros can also have arguments, a comma separated list within parentheses. 
     13=== Getting Detailed Help === 
     14The list of available macros and the full help can be obtained using the !MacroList macro, as seen [#AvailableMacros below]. 
     16A brief list can be obtained via ![[MacroList(*)]] or ![[?]]. 
     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?]]. 
     22=== Example === 
     24A list of 3 most recently changed wiki pages starting with 'Trac': 
     26||= Wiki Markup =||= Display =|| 
     28  {{{ 
     29  [[RecentChanges(Trac,3)]] 
     30  }}} 
     32{{{#!td style="padding-left: 2em;" 
     37  {{{ 
     38  [[RecentChanges?(Trac,3)]] 
     39  }}} 
     41{{{#!td style="padding-left: 2em;" 
     46  {{{ 
     47  [[?]] 
     48  }}} 
     50{{{#!td style="padding-left: 2em; font-size: 80%" 
     54== Available Macros == 
     56''Note that the following list will only contain the macro documentation if you've not enabled `-OO` optimizations, or not set the `PythonOptimize` option for [wiki:TracModPython mod_python].'' 
     60== Macros from around the world == 
     62The [ Trac Hacks] site provides a wide collection of macros and other Trac [TracPlugins plugins] contributed by the Trac community. If you're looking for new macros, or have written one that you'd like to share with the world, please don't hesitate to visit that site. 
     64== Developing Custom Macros == 
     65Macros, like Trac itself, are written in the [ Python programming language] and are developed as part of TracPlugins. 
     67For more information about developing macros, see the [trac:TracDev development resources] on the main project site. 
     70Here are 2 simple examples showing how to create a Macro with Trac 0.11.  
     72Also, have a look at [trac:source:tags/trac-0.11/sample-plugins/] 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. 
     74=== Macro without arguments === 
     75To test the following code, you should saved it in a `` file located in the TracEnvironment's `plugins/` directory. 
     78from datetime import datetime 
     79# Note: since Trac 0.11, datetime objects are used internally 
     81from genshi.builder import tag 
     83from trac.util.datefmt import format_datetime, utc 
     84from import WikiMacroBase 
     86class TimeStampMacro(WikiMacroBase): 
     87    """Inserts the current time (in seconds) into the wiki page.""" 
     89    revision = "$Rev$" 
     90    url = "$URL$" 
     92    def expand_macro(self, formatter, name, text): 
     93        t = 
     94        return tag.b(format_datetime(t, '%c')) 
     97=== Macro with arguments === 
     98To test the following code, you should saved it in a `` file located in the TracEnvironment's `plugins/` directory. 
     101from genshi.core import Markup 
     103from import WikiMacroBase 
     105class HelloWorldMacro(WikiMacroBase): 
     106    """Simple HelloWorld macro. 
     108    Note that the name of the class is meaningful: 
     109     - it must end with "Macro" 
     110     - what comes before "Macro" ends up being the macro name 
     112    The documentation of the class (i.e. what you're reading) 
     113    will become the documentation of the macro, as shown by 
     114    the !MacroList macro (usually used in the WikiMacros page). 
     115    """ 
     117    revision = "$Rev$" 
     118    url = "$URL$" 
     120    def expand_macro(self, formatter, name, text, args): 
     121        """Return some output that will be displayed in the Wiki content. 
     123        `name` is the actual name of the macro (no surprise, here it'll be 
     124        `'HelloWorld'`), 
     125        `text` is the text enclosed in parenthesis at the call of the macro. 
     126          Note that if there are ''no'' parenthesis (like in, e.g. 
     127          [[HelloWorld]]), then `text` is `None`. 
     128        `args` are the arguments passed when HelloWorld is called using a 
     129        `#!HelloWorld` code block. 
     130        """ 
     131        return 'Hello World, text = %s, args = %s' % \ 
     132            (Markup.escape(text), Markup.escape(repr(args))) 
     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''). 
     138For example, when writing: 
     140{{{#!HelloWorld style="polite" 
     141<Hello World!> 
     145<Hello World!> 
     148[[HelloWorld(<Hello World!>)]] 
     150One should get: 
     152Hello World, text = <Hello World!> , args = {'style': u'polite'} 
     153Hello World, text = <Hello World!> , args = {} 
     154Hello World, text = <Hello World!> , args = None 
     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`).   
     159You can also recursively use a wiki Formatter (`from import Formatter`) to process the `text` as wiki markup, for example by doing: 
     163from genshi.core import Markup 
     164from import WikiMacroBase 
     165from import Formatter 
     166import StringIO 
     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())