Changes between Version 1 and Version 2 of WikiMacros


Ignore:
Timestamp:
Feb 25, 2025, 12:53:26 PM (3 months ago)
Author:
trac
Comment:

--

Legend:

Unmodified
Added
Removed
Modified

  • WikiMacros

    v1 v2  
    1 =  Wiki Macros =
    2 Trac 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.
     1= Trac Macros
    32
    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.
     3[[PageOutline(2-5,Contents,pullout)]]
    54
    6 == Using Macros ==
    7 Macro calls are enclosed in two ''square brackets''. Like python functions, macros can also have arguments, a comma separated list within parenthesis.
     5'''Trac macros''' extend the Trac engine with custom functionality. Macros are a special type of plugin and are written in Python. A macro inserts dynamic HTML data in any context supporting WikiFormatting.
    86
    9 === Examples ===
     7The macro syntax is `[[macro-name(optional-arguments)]]`.
     8
     9'''WikiProcessors''' are another kind of macros. They are typically used for source code highlighting, such as `!#python` or `!#apache` and when the source code spans multiple lines, such as:
    1010
    1111{{{
    12  [[Timestamp]]
     12{{{#!wiki-processor-name
     13...
    1314}}}
    14 Display:
    15  [[Timestamp]]
    16 
    17 {{{
    18  [[HelloWorld(Testing)]]
    19 }}}
    20 Display:
    21  [[HelloWorld(Testing)]]
    22 
    23 
    24 == Available Macros ==
    25 Macros are still a new feature, and the list of available (and distributed) macros is
    26 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).
    27 
    28  * '''!HelloWorld''' -- An example macro, useful for learning how to write macros.
    29  * '''Timestamp''' -- Insert the current date and time.
    30 
    31 
    32 ----
    33 
    34 
    35 == Macros from around the world ==
    36 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.
    37 
    38   http://projects.edgewall.com/trac/wiki/MacroBazaar
    39 
    40 
    41 ----
    42 
    43 
    44 == Developing New Macros ==
    45 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.
    46 
    47 It's easiest to learn from an example:
    48 {{{
    49 # MyMacro.py -- The world's simplest macro
    50 
    51 def execute(hdf, args, env):
    52     return "Hello World called with args: %s" % args
    5315}}}
    5416
    55 === Advanced Topics: Template-enabled Macros ===
    56 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.
     17== Using Macros
    5718
    58 Macros gain direct access to the main HDF tree, and are free to manipulate it.
     19Macro calls are enclosed in double-square brackets `[[..]]`. Like Python functions, macros can have arguments, which is then a comma separated list within parentheses `[[..(,)]]`.
    5920
    60 Example:
    61 {{{
    62 def execute(hdf, args, env):
    63     # Currently hdf is set only when the macro is called
    64     # From a wiki page
    65     if hdf:
    66         hdf.setValue('wiki.macro.greeting', 'Hello World')
    67        
    68     # args will be null if the macro is called without parentesis.
    69     args = args or 'No arguments'
    70     return 'Hello World, args = ' + args
     21=== Getting Detailed Help
     22
     23The list of available macros and the full help can be obtained using the !MacroList macro, as seen [#AvailableMacros below].
     24
     25A brief list can be obtained via `[[MacroList(*)]]` or `[[?]]`.
     26
     27Detailed 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?]]`.
     28
     29=== Example
     30
     31A list of the 3 most recently changed wiki pages starting with 'Trac':
     32
     33||= Wiki Markup =||= Display =||
     34{{{#!td
     35  {{{
     36  [[RecentChanges(Trac,3)]]
     37  }}}
     38}}}
     39{{{#!td style="padding-left: 2em;"
     40[[RecentChanges(Trac,3)]]
     41}}}
     42|-----------------------------------
     43{{{#!td
     44  {{{
     45  [[RecentChanges?(Trac,3)]]
     46  }}}
     47}}}
     48{{{#!td style="padding-left: 2em;"
     49[[RecentChanges?(Trac,3)]]
     50}}}
     51|-----------------------------------
     52{{{#!td
     53  {{{
     54  [[?]]
     55  }}}
     56}}}
     57{{{#!td style="padding-left: 2em"
     58{{{#!html
     59<div class="trac-macrolist">
     60<h3><code>[[Image]]</code></h3>Embed an image in wiki-formatted text.
     61
     62The first argument is the file, as in <code>[[Image(filename.png)]]</code>
     63<h3><code>[[InterTrac]]</code></h3>Provide a list of known <a class="wiki" href="/wiki/InterTrac">InterTrac</a> prefixes.
     64<h3><code>[[InterWiki]]</code></h3>Provide a description list for the known <a class="wiki" href="/wiki/InterWiki">InterWiki</a> prefixes.
     65<h3><code>[[KnownMimeTypes]]</code></h3>List all known mime-types which can be used as <a class="wiki" href="/wiki/WikiProcessors">WikiProcessors</a>.
     66</div>
     67}}}
     68etc.
    7169}}}
    7270
    73 You can also use the environment (env) object to access configuration data.
     71== Available Macros
    7472
    75 Example.
     73''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].''
     74
     75[[MacroList]]
     76
     77== Macros from around the world
     78
     79The [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 are looking for new macros, or have written one that you would like to share, please visit that site.
     80
     81== Developing Custom Macros
     82
     83Macros, like Trac itself, are written in the [http://python.org/ Python programming language] and are developed as part of TracPlugins.
     84
     85For more information about developing macros, see the [trac:TracDev development resources] on the main project site.
     86
     87Here are 2 simple examples showing how to create a Macro. Also, have a look at [trac:source:tags/trac-1.0.2/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 more insight about the transition.
     88
     89=== Macro without arguments
     90
     91To test the following code, save it in a `timestamp_sample.py` file located in the TracEnvironment's `plugins/` directory.
     92
     93{{{#!python
     94from datetime import datetime
     95# Note: since Trac 0.11, datetime objects are used internally
     96
     97from genshi.builder import tag
     98
     99from trac.util.datefmt import format_datetime, utc
     100from trac.wiki.macros import WikiMacroBase
     101
     102class TimeStampMacro(WikiMacroBase):
     103    """Inserts the current time (in seconds) into the wiki page."""
     104
     105    revision = "$Rev$"
     106    url = "$URL$"
     107
     108    def expand_macro(self, formatter, name, text):
     109        t = datetime.now(utc)
     110        return tag.strong(format_datetime(t, '%c'))
     111}}}
     112
     113=== Macro with arguments
     114
     115To test the following code, save it in a `helloworld_sample.py` file located in the TracEnvironment's `plugins/` directory.
     116
     117{{{#!python
     118from genshi.core import Markup
     119
     120from trac.wiki.macros import WikiMacroBase
     121
     122class HelloWorldMacro(WikiMacroBase):
     123    """Simple HelloWorld macro.
     124
     125    Note that the name of the class is meaningful:
     126     - it must end with "Macro"
     127     - what comes before "Macro" ends up being the macro name
     128
     129    The documentation of the class (i.e. what you're reading)
     130    will become the documentation of the macro, as shown by
     131    the !MacroList macro (usually used in the WikiMacros page).
     132    """
     133
     134    revision = "$Rev$"
     135    url = "$URL$"
     136
     137    def expand_macro(self, formatter, name, text, args):
     138        """Return some output that will be displayed in the Wiki content.
     139
     140        `name` is the actual name of the macro (no surprise, here it'll be
     141        `'HelloWorld'`),
     142        `text` is the text enclosed in parenthesis at the call of the macro.
     143          Note that if there are ''no'' parenthesis (like in, e.g.
     144          [[HelloWorld]]), then `text` is `None`.
     145        `args` are the arguments passed when HelloWorld is called using a
     146        `#!HelloWorld` code block.
     147        """
     148        return 'Hello World, text = %s, args = %s' % \
     149            (Markup.escape(text), Markup.escape(repr(args)))
     150
     151}}}
     152
     153Note that `expand_macro` optionally takes a 4^th^ parameter ''`args`''. When the macro is called as a [WikiProcessors WikiProcessor], it is 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. In the other case, when called as a macro, `args` is `None`. (''since 0.12'').
     154
     155For example, when writing:
    76156{{{
    77 def execute(hdf, txt, env):
    78     return env.get_config('trac', 'repository_dir')
     157{{{#!HelloWorld style="polite" -silent verbose
     158<Hello World!>
    79159}}}
    80 ----
    81 See also:  WikiProcessors, WikiFormatting, TracGuide
     160
     161{{{#!HelloWorld
     162<Hello World!>
     163}}}
     164
     165[[HelloWorld(<Hello World!>)]]
     166}}}
     167
     168One should get:
     169{{{
     170Hello World, text = <Hello World!>, args = {'style': u'polite', 'silent': False, 'verbose': True}
     171Hello World, text = <Hello World!>, args = {}
     172Hello World, text = <Hello World!>, args = None
     173}}}
     174
     175Note that the return value of `expand_macro` is '''not''' HTML escaped. Depending on the expected result, you should escape it 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`).
     176
     177You can also recursively use a wiki Formatter (`from trac.wiki import Formatter`) to process the `text` as wiki markup:
     178
     179{{{#!python
     180from genshi.core import Markup
     181from trac.wiki.macros import WikiMacroBase
     182from trac.wiki import Formatter
     183import StringIO
     184
     185class HelloWorldMacro(WikiMacroBase):
     186    def expand_macro(self, formatter, name, text, args):
     187        text = "whatever '''wiki''' markup you want, even containing other macros"
     188        # Convert Wiki markup to HTML, new style
     189        out = StringIO.StringIO()
     190        Formatter(self.env, formatter.context).format(text, out)
     191        return Markup(out.getvalue())
     192}}}