Code

Changes between Version 4 and Version 5 of WikiMacros


Ignore:
Timestamp:
01/28/11 12:52:13 (3 years ago)
Author:
trac
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • WikiMacros

    v4 v5  
    1 =  Wiki Macros = 
     1= Trac Macros = 
     2 
     3[[PageOutline]] 
     4 
    25Trac 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. 
    36 
    4 Another kind of macros are WikiProcessors. They typically deal with alternate markup formats and representation of larger blocks of information (like source code highlighting). See also: WikiProcessors. 
    5  
    6 There is a separate page with [wiki:WikiMacroList a list of macros available] in this wiki. 
     7Another kind of macros are WikiProcessors. They typically deal with alternate markup formats and representation of larger blocks of information (like source code highlighting). 
    78 
    89== Using Macros == 
    9 Macro calls are enclosed in two ''square brackets''. Like python functions, macros can also have arguments, a comma separated list within parenthesis.  
    1010 
    11 === Examples === 
     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 
     21 
     22=== Example === 
     23 
     24A list of 3 most recently changed wiki pages starting with 'Trac': 
     25 
     26||= Wiki Markup =||= Display =|| 
     27{{{#!td 
     28  {{{ 
     29  [[RecentChanges(Trac,3)]] 
     30  }}} 
     31}}} 
     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}}} 
     53 
     54== Available Macros == 
     55 
     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].'' 
     57 
     58[[MacroList]] 
     59 
     60== Macros from around the world == 
     61 
     62The [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'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. 
     63 
     64== Developing Custom Macros == 
     65Macros, like Trac itself, are written in the [http://python.org/ Python programming language] and are developed as part of TracPlugins. 
     66 
     67For more information about developing macros, see the [trac:TracDev development resources] on the main project site. 
     68 
     69 
     70Here are 2 simple examples showing how to create a Macro with Trac 0.11.  
     71 
     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. 
     73 
     74=== Macro without arguments === 
     75To test the following code, you should saved it in a `timestamp_sample.py` file located in the TracEnvironment's `plugins/` directory. 
     76{{{ 
     77#!python 
     78from datetime import datetime 
     79# Note: since Trac 0.11, datetime objects are used internally 
     80 
     81from genshi.builder import tag 
     82 
     83from trac.util.datefmt import format_datetime, utc 
     84from trac.wiki.macros import WikiMacroBase 
     85 
     86class TimeStampMacro(WikiMacroBase): 
     87    """Inserts the current time (in seconds) into the wiki page.""" 
     88 
     89    revision = "$Rev$" 
     90    url = "$URL$" 
     91 
     92    def expand_macro(self, formatter, name, text): 
     93        t = datetime.now(utc) 
     94        return tag.b(format_datetime(t, '%c')) 
     95}}} 
     96 
     97=== Macro with arguments === 
     98To test the following code, you should saved it in a `helloworld_sample.py` file located in the TracEnvironment's `plugins/` directory. 
     99{{{ 
     100#!python 
     101from genshi.core import Markup 
     102 
     103from trac.wiki.macros import WikiMacroBase 
     104 
     105class HelloWorldMacro(WikiMacroBase): 
     106    """Simple HelloWorld macro. 
     107 
     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 
     111 
     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    """ 
     116 
     117    revision = "$Rev$" 
     118    url = "$URL$" 
     119 
     120    def expand_macro(self, formatter, name, text, args): 
     121        """Return some output that will be displayed in the Wiki content. 
     122 
     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))) 
     133 
     134}}} 
     135 
     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''). 
     137 
     138For example, when writing: 
     139{{{ 
     140{{{#!HelloWorld style="polite" 
     141<Hello World!> 
     142}}} 
     143 
     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: 
    12160 
    13161{{{ 
    14  [[Timestamp]] 
     162#!python 
     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()) 
    15168}}} 
    16 Display: 
    17  [[Timestamp]] 
    18  
    19 {{{ 
    20  [[HelloWorld(Testing)]] 
    21 }}} 
    22 Display: 
    23  [[HelloWorld(Testing)]] 
    24  
    25  
    26 == Available Macros == 
    27 Macros are still a new feature, and the list of available (and distributed) macros is  
    28 admittedly not very impressive. In future Trac releases, we hope to build a library of useful macros, and will of course happily include contributed macros (see below).  
    29  
    30  * '''!HelloWorld''' -- An example macro, useful for learning how to write macros. 
    31  * '''Timestamp''' -- Insert the current date and time. 
    32  
    33  
    34 ---- 
    35  
    36  
    37 == Macros from around the world == 
    38 The [http://projects.edgewall.com/trac/ Trac Project] has a section dedicated to user-contributed macros, [http://projects.edgewall.com/trac/wiki/MacroBazaar MacroBazaar]. If you're looking for new macros, or have written new ones to share with the world, don't hesitate adding it to the [http://projects.edgewall.com/trac/wiki/MacroBazaar MacroBazaar] wiki page. 
    39  
    40   http://projects.edgewall.com/trac/wiki/MacroBazaar 
    41  
    42  
    43 ---- 
    44  
    45  
    46 == Developing New Macros == 
    47 Macros, like Trac itself, are written in the [http://www.python.org/ Python programming language]. They are very simple modules, identified by the filename and should contain a single ''entry point'' function. Trac will display the returned data inserted into the HTML where the macro was called. 
    48  
    49 It's easiest to learn from an example: 
    50 {{{ 
    51 # MyMacro.py -- The world's simplest macro 
    52  
    53 def execute(hdf, args, env): 
    54     return "Hello World called with args: %s" % args 
    55 }}} 
    56  
    57 === Advanced Topics: Template-enabled Macros === 
    58 For advanced uses, macros can also render structured output in HDF, to be rendered to HTML using clearsilver templates - like most Trac output. In short, this allows more generic and well-designed advanced macros. 
    59  
    60 Macros gain direct access to the main HDF tree, and are free to manipulate it.  
    61  
    62 Example: 
    63 {{{ 
    64 def execute(hdf, args, env): 
    65     # Currently hdf is set only when the macro is called 
    66     # From a wiki page 
    67     if hdf: 
    68         hdf.setValue('wiki.macro.greeting', 'Hello World') 
    69          
    70     # args will be null if the macro is called without parentesis. 
    71     args = args or 'No arguments' 
    72     return 'Hello World, args = ' + args 
    73 }}} 
    74  
    75 You can also use the environment (env) object to access configuration data. 
    76  
    77 Example. 
    78 {{{ 
    79 def execute(hdf, txt, env): 
    80     return env.get_config('trac', 'repository_dir') 
    81 }}} 
    82 ---- 
    83 See also:  WikiProcessors, WikiFormatting, TracGuide