Changes between Version 1 and Version 2 of WikiMacros

Show
Ignore:
Timestamp:
01/12/10 15:18:04 (5 years ago)
Author:
trac (IP: 127.0.0.1)
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • WikiMacros

    v1 v2  
    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 
     
    58 
    69== Using Macros == 
    7 Macro calls are enclosed in two ''square brackets''. Like python functions, macros can also have arguments, a comma separated list within parentheses.  
     10Macro calls are enclosed in two ''square brackets''. Like Python functions, macros can also have arguments, a comma separated list within parentheses. 
    811 
    9 === Examples === 
     12Trac 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 
     14=== Example === 
     15 
     16A list of 3 most recently changed wiki pages starting with 'Trac': 
    1017 
    1118{{{ 
    12  [[Timestamp]] 
     19 [[RecentChanges(Trac,3)]] 
    1320}}} 
     21 
    1422Display: 
    15  [[Timestamp]] 
    16  
    17 {{{ 
    18  [[HelloWorld(Testing)]] 
    19 }}} 
    20 Display: 
    21  [[HelloWorld(Testing)]] 
     23 [[RecentChanges(Trac,3)]] 
    2224 
    2325== Available Macros == 
     
    2830 
    2931== Macros from around the world == 
    30 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. 
    3132 
    32 ---- 
     33The [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. 
    3334 
    3435== Developing Custom Macros == 
    35 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. 
     36Macros, like Trac itself, are written in the [http://python.org/ Python programming language]. 
    3637 
    37 It's easiest to learn from an example: 
     38For more information about developing macros, see the [trac:TracDev development resources] on the main project site. 
     39 
     40 
     41== Implementation == 
     42 
     43Here are 2 simple examples showing how to create a Macro with Trac 0.11.  
     44 
     45Also, 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. 
     46 
     47=== Macro without arguments === 
     48It should be saved as `TimeStamp.py` (in the TracEnvironment's `plugins/` directory) as Trac will use the module name as the Macro name. 
    3849{{{ 
    3950#!python 
    40 # MyMacro.py -- The world's simplest macro 
     51from datetime import datetime 
     52# Note: since Trac 0.11, datetime objects are used internally 
    4153 
    42 def execute(hdf, args, env): 
    43     return "Hello World called with args: %s" % args 
     54from genshi.builder import tag 
     55 
     56from trac.util.datefmt import format_datetime, utc 
     57from trac.wiki.macros import WikiMacroBase 
     58 
     59class TimeStampMacro(WikiMacroBase): 
     60    """Inserts the current time (in seconds) into the wiki page.""" 
     61 
     62    revision = "$Rev$" 
     63    url = "$URL$" 
     64 
     65    def expand_macro(self, formatter, name, args): 
     66        t = datetime.now(utc) 
     67        return tag.b(format_datetime(t, '%c')) 
    4468}}} 
    4569 
    46 You can also use the environment (`env`) object, for example to access configuration data and the database, for example: 
     70=== Macro with arguments === 
     71It should be saved as `HelloWorld.py` (in the TracEnvironment's `plugins/` directory) as Trac will use the module name as the Macro name. 
    4772{{{ 
    4873#!python 
    49 def execute(hdf, txt, env): 
    50     return env.get_config('trac', 'repository_dir') 
     74from trac.wiki.macros import WikiMacroBase 
     75 
     76class HelloWorldMacro(WikiMacroBase): 
     77    """Simple HelloWorld macro. 
     78 
     79    Note that the name of the class is meaningful: 
     80     - it must end with "Macro" 
     81     - what comes before "Macro" ends up being the macro name 
     82 
     83    The documentation of the class (i.e. what you're reading) 
     84    will become the documentation of the macro, as shown by 
     85    the !MacroList macro (usually used in the WikiMacros page). 
     86    """ 
     87 
     88    revision = "$Rev$" 
     89    url = "$URL$" 
     90 
     91    def expand_macro(self, formatter, name, args): 
     92        """Return some output that will be displayed in the Wiki content. 
     93 
     94        `name` is the actual name of the macro (no surprise, here it'll be 
     95        `'HelloWorld'`), 
     96        `args` is the text enclosed in parenthesis at the call of the macro. 
     97          Note that if there are ''no'' parenthesis (like in, e.g. 
     98          [[HelloWorld]]), then `args` is `None`. 
     99        """ 
     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. 
    51104}}} 
    52105 
    53 Note that since version 0.9, wiki macros can also be written as TracPlugins. This gives them some capabilities than “classic” macros do not have, such as directly access the HTTP request. 
    54106 
    55 For more information about developing macros, see the [http://projects.edgewall.com/trac/wiki/TracDev development resources] on the main project site. 
     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}}}. 
    56109 
    57 ---- 
    58 See also:  WikiProcessors, WikiFormatting, TracGuide 
     110If your macro creates wiki markup instead of HTML, you can convert it to HTML like this: 
     111 
     112{{{ 
     113#!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()) 
     119}}}