Changes between Initial Version and Version 1 of WikiMacros


Ignore:
Timestamp:
07/02/18 15:39:20 (3 years ago)
Author:
trac
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • WikiMacros

    v1 v1  
     1= Trac Macros
     2
     3[[PageOutline(2-5,Contents,pullout)]]
     4
     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.
     6
     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:
     10
     11{{{
     12{{{#!wiki-processor-name
     13...
     14}}}
     15}}}
     16
     17== Using Macros
     18
     19Macro calls are enclosed in double-square brackets `[[..]]`. Like Python functions, macros can have arguments, which is then a comma separated list within parentheses `[[..(,)]]`.
     20
     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.
     69}}}
     70
     71== Available Macros
     72
     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 trac.util.datefmt import format_datetime, utc
     98from trac.util.html import tag
     99from trac.wiki.macros import WikiMacroBase
     100
     101class TimeStampMacro(WikiMacroBase):
     102    """Inserts the current time (in seconds) into the wiki page."""
     103
     104    revision = "$Rev$"
     105    url = "$URL$"
     106
     107    def expand_macro(self, formatter, name, text):
     108        t = datetime.now(utc)
     109        return tag.strong(format_datetime(t, '%c'))
     110}}}
     111
     112=== Macro with arguments
     113
     114To test the following code, save it in a `helloworld_sample.py` file located in the TracEnvironment's `plugins/` directory.
     115
     116{{{#!python
     117from trac.util.html import Markup
     118from trac.wiki.macros import WikiMacroBase
     119
     120class HelloWorldMacro(WikiMacroBase):
     121    """Simple HelloWorld macro.
     122
     123    Note that the name of the class is meaningful:
     124     - it must end with "Macro"
     125     - what comes before "Macro" ends up being the macro name
     126
     127    The documentation of the class (i.e. what you're reading)
     128    will become the documentation of the macro, as shown by
     129    the !MacroList macro (usually used in the WikiMacros page).
     130    """
     131
     132    revision = "$Rev$"
     133    url = "$URL$"
     134
     135    def expand_macro(self, formatter, name, text, args):
     136        """Return some output that will be displayed in the Wiki content.
     137
     138        `name` is the actual name of the macro (no surprise, here it'll be
     139        `'HelloWorld'`),
     140        `text` is the text enclosed in parenthesis at the call of the macro.
     141          Note that if there are ''no'' parenthesis (like in, e.g.
     142          [[HelloWorld]]), then `text` is `None`.
     143        `args` are the arguments passed when HelloWorld is called using a
     144        `#!HelloWorld` code block.
     145        """
     146        return 'Hello World, text = %s, args = %s' % \
     147            (Markup.escape(text), Markup.escape(repr(args)))
     148
     149}}}
     150
     151Note 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'').
     152
     153For example, when writing:
     154{{{
     155{{{#!HelloWorld style="polite" -silent verbose
     156<Hello World!>
     157}}}
     158
     159{{{#!HelloWorld
     160<Hello World!>
     161}}}
     162
     163[[HelloWorld(<Hello World!>)]]
     164}}}
     165
     166One should get:
     167{{{
     168Hello World, text = <Hello World!>, args = {'style': u'polite', 'silent': False, 'verbose': True}
     169Hello World, text = <Hello World!>, args = {}
     170Hello World, text = <Hello World!>, args = None
     171}}}
     172
     173Note 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)` (`from trac.util.html import Markup`).
     174
     175You can also recursively use a wiki Formatter (`from trac.wiki import Formatter`) to process the `text` as wiki markup:
     176
     177{{{#!python
     178from trac.util.html import Markup
     179from trac.wiki.macros import WikiMacroBase
     180from trac.wiki import Formatter
     181import StringIO
     182
     183class HelloWorldMacro(WikiMacroBase):
     184    def expand_macro(self, formatter, name, text, args):
     185        text = "whatever '''wiki''' markup you want, even containing other macros"
     186        # Convert Wiki markup to HTML, new style
     187        out = StringIO.StringIO()
     188        Formatter(self.env, formatter.context).format(text, out)
     189        return Markup(out.getvalue())
     190}}}