This page refers to the old SeisComP 3 version, and may no longer be accurate. See seiscomp.de for the latest version.

Trac Macros

<ol><li><a href="#TracMacros">Trac Macros</a><ol><li><a href="#UsingMacros">Using Macros</a><ol><li><a href="#Example">Example</a></li></ol></li><li> <a href="#AvailableMacros">Available Macros</a></li><li> <a href="#Macrosfromaroundtheworld">Macros from around the world</a></li><li> <a href="#DevelopingCustomMacros">Developing Custom Macros</a></li><li> <a href="#Implementation">Implementation</a><ol><li><a href="#Macrowithoutarguments">Macro without arguments</a></li><li> <a href="#Macrowitharguments">Macro with arguments</a></li><li> <a href="#expand_macrodetails"><tt>expand_macro</tt> details</a></li></ol></li></ol></li></ol>

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.

Another kind of macros are WikiProcessors. They typically deal with alternate markup formats and representation of larger blocks of information (like source code highlighting).

Using Macros

Macro calls are enclosed in two square brackets. Like Python functions, macros can also have arguments, a comma separated list within parentheses.

Trac 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.

Example

A list of 3 most recently changed wiki pages starting with 'Trac':

 [[RecentChanges(Trac,3)]]

Display:

07/22/11
TracGuide (diff)
06/23/09
TracAccessibility
TracAdmin

Available Macros

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 mod_python.

[[InterTrac]]: Provide a list of known <a class="wiki" href="/seiscomp3/InterTrac.html">InterTrac</a> prefixes.
[[TitleIndex]]: Inserts an alphabetic list of all wiki pages into the output. Accepts a prefix string as parameter: if provided, only pages with names that start with the prefix are included in the resulting list. If this parameter is omitted, all pages are listed. Alternate <tt>format</tt> and <tt>depth</tt> can be specified: <ul><li><tt>format=group</tt>: The list of page will be structured in groups according to common prefix. This format also supports a <tt>min=n</tt> argument, where <tt>n</tt> is the minimal number of pages for a group. </li><li><tt>depth=n</tt>: limit the depth of the pages to list. If set to 0, only toplevel pages will be shown, if set to 1, only immediate children pages will be shown, etc. If not set, or set to -1, all pages in the hierarchy will be shown. </li></ul>
[[RecentChanges]]: Lists all pages that have recently been modified, grouping them by the day they were last modified. This macro accepts two parameters. The first is a prefix string: if provided, only pages with names that start with the prefix are included in the resulting list. If this parameter is omitted, all pages are listed. The second parameter is a number for limiting the number of pages returned. For example, specifying a limit of 5 will result in only the five most recently changed pages to be included in the list.
[[PageOutline]]: Displays a structural outline of the current wiki page, each item in the outline being a link to the corresponding heading. This macro accepts three optional parameters: <ul><li>The first is a number or range that allows configuring the minimum and maximum level of headings that should be included in the outline. For example, specifying "1" here will result in only the top-level headings being included in the outline. Specifying "2-3" will make the outline include all headings of level 2 and 3, as a nested list. The default is to include all heading levels. </li><li>The second parameter can be used to specify a custom title (the default is no title). </li><li>The third parameter selects the style of the outline. This can be either <tt>inline</tt> or <tt>pullout</tt> (the latter being the default). The <tt>inline</tt> style renders the outline as normal part of the content, while <tt>pullout</tt> causes the outline to be rendered in a box that is by default floated to the right side of the other content. </li></ul>
[[Image]]: Embed an image in wiki-formatted text. The first argument is the file specification. The file specification may reference attachments in three ways: <ul><li><tt>module:id:file</tt>, where module can be either wiki or ticket, to refer to the attachment named file of the specified wiki page or ticket. </li><li><tt>id:file</tt>: same as above, but id is either a ticket shorthand or a Wiki page name. </li><li><tt>file</tt> to refer to a local attachment named 'file'. This only works from within that wiki page or a ticket. </li></ul> Also, the file specification may refer to repository files, using the <tt>source:file</tt> syntax (<tt>source:file@rev</tt> works also). Files can also be accessed with a direct URLs; <tt>/file</tt> for a project-relative, <tt>//file</tt> for a server-relative, or <tt>http://server/file</tt> for absolute location of the file. The remaining arguments are optional and allow configuring the attributes and style of the rendered <tt><img></tt> element: <ul><li>digits and unit are interpreted as the size (ex. 120, 25%) for the image </li><li><tt>right</tt>, <tt>left</tt>, <tt>top</tt> or <tt>bottom</tt> are interpreted as the alignment for the image </li><li><tt>link=some TracLinks...</tt> replaces the link to the image source by the one specified using a <a class="wiki" href="/seiscomp3/TracLinks.html">TracLinks</a>. If no value is specified, the link is simply removed. </li><li><tt>nolink</tt> means without link to image source (deprecated, use <tt>link=</tt>) </li><li><tt>key=value</tt> style are interpreted as HTML attributes or CSS style indications for the image. Valid keys are: <ul><li>align, border, width, height, alt, title, longdesc, class, id and usemap </li><li><tt>border</tt> can only be a number </li></ul></li></ul> Examples: <pre class="wiki"> [[Image(photo.jpg)]] # simplest [[Image(photo.jpg, 120px)]] # with image width size [[Image(photo.jpg, right)]] # aligned by keyword [[Image(photo.jpg, nolink)]] # without link to source [[Image(photo.jpg, align=right)]] # aligned by attribute </pre> You can use image from other page, other ticket or other module. <pre class="wiki"> [[Image(OtherPage:foo.bmp)]] # if current module is wiki [[Image(base/sub:bar.bmp)]] # from hierarchical wiki page [[Image(#3:baz.bmp)]] # if in a ticket, point to #3 [[Image(ticket:36:boo.jpg)]] [[Image(source:/images/bee.jpg)]] # straight from the repository! [[Image(htdocs:foo/bar.png)]] # image file in project htdocs dir. </pre> Adapted from the Image.py macro created by Shun-ichi Goto <<a class="mail-link" href="mailto:gotoh@taiyo.co.jp"> gotoh@taiyo.co.jp</a>>
[[MacroList]]: Displays a list of all installed Wiki macros, including documentation if available. Optionally, the name of a specific macro can be provided as an argument. In that case, only the documentation for that macro will be rendered. Note that this macro will not be able to display the documentation of macros if the <tt>PythonOptimize</tt> option is enabled for mod_python!
[[TracIni]]: Produce documentation for Trac configuration file. Typically, this will be used in the <a class="wiki" href="/seiscomp3/TracIni.html">TracIni</a> page. Optional arguments are a configuration section filter, and a configuration option name filter: only the configuration options whose section and name start with the filters are output.
[[TracGuideToc]]: This macro shows a quick and dirty way to make a table-of-contents for a set of wiki pages.
[[TicketQuery]]: Macro that lists tickets that match certain criteria. This macro accepts a comma-separated list of keyed parameters, in the form "key=value". If the key is the name of a field, the value must use the syntax of a filter specifier as defined in <a class="wiki" href="/seiscomp3/TracQuery.html#QueryLanguage">TracQuery#QueryLanguage</a>. Note that this is not the same as the simplified URL syntax used for <tt>query:</tt> links starting with a <tt>?</tt> character. In addition to filters, several other named parameters can be used to control how the results are presented. All of them are optional. The <tt>format</tt> parameter determines how the list of tickets is presented: <ul><li>list -- the default presentation is to list the ticket ID next to the summary, with each ticket on a separate line. </li><li>compact -- the tickets are presented as a comma-separated list of ticket IDs. </li><li>count -- only the count of matching tickets is displayed </li><li>table -- a view similar to the custom query view (but without the controls) </li></ul> The <tt>max</tt> parameter can be used to limit the number of tickets shown (defaults to 0, i.e. no maximum). The <tt>order</tt> parameter sets the field used for ordering tickets (defaults to id). The <tt>desc</tt> parameter indicates whether the order of the tickets should be reversed (defaults to false). The <tt>group</tt> parameter sets the field used for grouping tickets (defaults to not being set). The <tt>groupdesc</tt> parameter indicates whether the natural display order of the groups should be reversed (defaults to false). The <tt>verbose</tt> parameter can be set to a true value in order to get the description for the listed tickets. For table format only. deprecated in favor of the <tt>rows</tt> parameter The <tt>rows</tt> parameter can be used to specify which field(s) should be viewed as a row, e.g. <tt>rows=description|summary</tt> For compatibility with Trac 0.10, if there's a second positional parameter given to the macro, it will be used to specify the <tt>format</tt>. Also, using "&" as a field separator still works (except for <tt>order</tt>) but is deprecated.
[[InterWiki]]: Provide a description list for the known <a class="wiki" href="/seiscomp3/InterWiki.html">InterWiki</a> prefixes.
[[TracAdminHelp]]: Displays help for trac-admin commands. Examples: <pre class="wiki">[[TracAdminHelp]] # all commands [[TracAdminHelp(wiki)]] # all wiki commands [[TracAdminHelp(wiki export)]] # the "wiki export" command [[TracAdminHelp(upgrade)]] # the upgrade command </pre>
[[NewsFlash]]: Makes a colored box from the contents of the macro.
[[NewsFlashStart]]: Start a newflash box.
[[NewsFlashEnd]]: End a newflash box.
[[BlogList]]: A macro to display list of posts and extracts outside (or inside) the Blog module - most commonly Wiki pages. All arguments are optional: <pre class="wiki">[[BlogList]] </pre> Available named arguments: <ul><li><tt>recent=</tt> - max. number of posts </li><li><tt>category=</tt> - a category </li><li><tt>author=</tt> - an author </li><li><tt>period=</tt> - time period of the format YYYY/MM </li><li><tt>heading=</tt> - a heading for the list </li><li><tt>format=</tt> - type of display (see below for details) </li><li><tt>max_size=</tt> - max. number of characters to render for each post </li></ul> Example showing some available named arguments: <pre class="wiki">[[BlogList(recent=5, max_size=250, period=2007/12, author=osimons, format=float, heading=Some Trac Posts)]] </pre> The arguments for criteria are 'AND'-based, so the above example will render at most 5 posts by 'osimons' in December 2007. There is no heading unless specified. Without restriction on recent number of posts, it will use the number currently active in the Blog module as default for 'float' and 'full' rendering, but for rendering of 'inline' list it will render all found as default unless restricted. Additionally for 'float' and 'full' it will truncate content if it is larger than a max_size (if set). The <tt>format=</tt> keyword argument supports rendering these formats: <table class="wiki"> <tr><td><tt>format=inline</tt></td><td>Renders an unordered list in the normal text flow (default). </td></tr><tr><td><tt>format=float</tt></td><td>A floating box out on the side of the page with slightly more detail. </td></tr><tr><td><tt>format=full</tt></td><td>Full rendering like on period, category and author listings inside blog. </td></tr></table> The arguments can appear in any order. Posts are rendered sorted by newest first for all modes.
[[Include]]: Inserts the contents of another wiki page. It expands arguments in the page in the form {{N}}. Example: <div class="newsflash"><h1 id="NewSeisComP3forum">New SeisComP3 forum</h1> <a href="https://forum.seiscomp3.org">SC3 Forum</a> has been launched to replace the mailing list. Please register to read software support categories. <h1 id="NewSeisComP3Jakartarelease">New SeisComP3 Jakarta release</h1> The new release Jakarta 2016.333 is here. Please check the <a href="https://github.com/SeisComP3/seiscomp3/blob/build/jakarta/2016.333/CHANGELOG.md">changelog</a> for further information. <a class="wiki" href="/seiscomp3/download.html">Download</a> <h1 id="SeisComP3onGithub">SeisComP3 on Github</h1> SeisComP3 source code is now available on <a href="https://www.github.com/SeisComP3/seiscomp3">Github</a>. <h1 id="Tryarclink_fetch">Try arclink_fetch!</h1> The <a class="wiki" href="/seiscomp3/doc/applications/arclink_fetch.html">arclink_fetch</a> client is a convenient way to request data from an <a class="wiki" href="/seiscomp3/doc/applications/arclink.html">ArcLink</a> server such as the one included in SeisComP. <a class="wiki" href="/seiscomp3/doc/applications/arclink_fetch.html">More information</a>. <h1 id="Ticketsystemavailable">Ticket system available</h1> Users are encouraged to create tickets for bugs and feature requests. This is a good chance to contribute to the development and the stability of SeisComP. Request a login to <a href="/seiscomp3">http://www.seiscomp3.org</a> by sending e-mail to <a class="mail-link" href="mailto:geofon@gfz-potsdam.de">�geofon@gfz-potsdam.de</a>. </div><h1 id="WelcometotheprojectsiteofSeisComP3">Welcome to the project site of SeisComP3</h1> This page is the entry point if you want to learn about the SeisComP software, browse the documentation and inform yourself about the SeisComP license conditions. SeisComP is a seismological software for data acquisition, processing, distribution and interactive analysis that has been developed by the <a href="http://geofon.gfz-potsdam.de">GEOFON Program</a> at <a href="http://www.gfz-potsdam.de">Helmholtz Centre Potsdam, GFZ German Research Centre for Geosciences</a> and <a href="http://www.gempa.de">gempa GmbH</a>. <h2 id="TableofContents">Table of Contents</h2> <ul><li><a class="wiki" href="/seiscomp3/about.html">About</a> </li><li><a class="wiki" href="/seiscomp3/license.html">License</a> </li><li><a class="wiki" href="/seiscomp3/doc.html">Documentation</a> </li><li><a class="wiki" href="/seiscomp3/doc/changelog.html">Changelog</a> </li><li><a class="wiki" href="/seiscomp3/community.html">Community</a> <ul><li><a class="wiki" href="/seiscomp3/contribs.html">Contributions</a> </li><li><a class="wiki" href="/seiscomp3/FAQ.html">Frequently Asked Questions</a> </li><li><a class="wiki" href="/seiscomp3/recipes.html">Recipes</a> </li><li><a class="wiki" href="/seiscomp3/dev.html">Development</a> </li><li><del><a class="wiki" href="/seiscomp3/wish-list.html">Wish list of new features</a></del>: Please use <del>the <a href="/seiscomp3/report">ticket system</a></del> <a href="https://github.com/SeisComP3/seiscomp3/issues">Github</a> instead. </li></ul></li><li><a class="wiki" href="/seiscomp3/support.html">Support</a> </li><li><a class="wiki" href="/seiscomp3/download.html">Download</a> </li><li><a class="wiki" href="/seiscomp3/contact.html">Contact</a> </li></ul> WARNING: avoid recursive inclusion.
[[LatexDummy]]: Macro with no effect
[[LatexBeginDoc]]: HTML version for <a class="missing wiki">TexLatexBeginDocMacro?</a>
[[LatexEndDoc]]: HTML version for <a class="missing wiki">TexLatexEndDocMacro?</a>
[[LatexDocCls]]: HTML version for <a class="missing wiki">TexLatexDocClsMacro?</a>
[[LatexGetRes]]: HTML version for <a class="missing wiki">TexLatexGetResMacro?</a>
[[LatexCmd]]: HTML version for <a class="missing wiki">TexLatexCmdMacro?</a>
[[LatexUsePkg]]: HTML version for <a class="missing wiki">TexLatexUsePkgMacro?</a>
[[LatexTable]]: HTML version for <a class="missing wiki">TexLatexTableMacro?</a>
[[LatexLongTable]]: HTML version for <a class="missing wiki">TexLatexLongTableMacro?</a>
[[LatexBasicHeaders]]: HTML version for <a class="missing wiki">TexLatexBasicHeadersMacro?</a>
[[LatexSpecialChar]]: HTML version for <a class="missing wiki">TexLatexSpecialCharMacro?</a>
[[TexTracIni]]: Not supported yet or not useful in Latex enviroment.
[[TexTracAdminHelp]]: Not supported yet or not useful in Latex enviroment.
[[TexTitleIndex]]: Not supported yet or not useful in Latex enviroment.
[[TexTicketQuery]]: Not supported yet or not useful in Latex enviroment.
[[TexRecentChanges]]: Not supported yet or not useful in Latex enviroment.
[[TexPageOutline]]: Not supported yet or not useful in Latex enviroment.
[[TexMacroList]]: Not supported yet or not useful in Latex enviroment.
[[TexInterTrac]]: Not supported yet or not useful in Latex enviroment.
[[TexHelloWorld]]: Not supported yet or not useful in Latex enviroment.
[[TexTracGuideToc]]: Not supported yet or not useful in Latex enviroment.
[[TexLatexRender]]: Not supported yet or not useful in Latex enviroment.
[[Latex]]: Latex <a class="missing wiki">WikiProcessor?</a>: Now you can specify small pieces of latex code into any wiki context, like <a class="wiki" href="/seiscomp3/WikiHtml.html">WikiHtml</a>. Ex.: <pre class="wiki"> {{{ #!Latex %label=fig_math %width=800 %height=600 %dpi=300 %use=package[opts]:package_url $\frac{\alpha^{\beta^2}}{\delta + \alpha}$ }}} </pre> This code will produce a PNG file and a PDF file, both will be added to Attachments section. The parameters are specified as latex comments. %label Picture label, default value is 'unnamed', if two differents blocks has the same label, just the last block will be rendered. %width PNG and display width. %height PNG and display height. %dpi Dots per Inch (resolution), default value is 300.
[[LatexRender]]: Like Latex <a class="missing wiki">WikiProcessor?</a> <a class="missing wiki">LatexRender?</a> macro is used to specify small pieces of latex code into any wiki context, but <a class="missing wiki">LatexRender?</a> support latex code specified in other files (svn, attachments) and support external dependecies. Ex.: <pre class="wiki">[[LatexRender(source:/docs/tex/math.tex,inc=mymacros.sty,inc=others.sty,width=800,height=600,dpi=300)]] </pre> This example will produce the same two figures as <a class="missing wiki">LatexMacro?</a> using the tex file /docs/tex/math.tex in SVN with two external dependencies (\usepackage) in Attachments section. The first parameter must be a URL to source code. The parameter "inc" is used to specify the external dependency URL and the others parameters are the same as <a class="missing wiki">LatexMacro?</a> width height dpi You can use the parameter "code" to specify a latex source code. Ex.: <pre class="wiki">[[LatexRender(code="$\frac{\alpha}{\beta}$",inc=mymacros.sty,inc=others.sty,width=800,height=600,dpi=300)]] </pre>
[[TexImage]]: This is the Tex version of Image macro.
[[TexLatexBasicHeaders]]: Include some necessary packages and macros to render latex documents.
[[TexLatexBeginDoc]]: This inform to Trac2Latex parser where the document begins.
[[TexLatexCmd]]: This macro inform to Trac2Latex parser a latex command to be inserted. Ex.: <pre class="wiki">[[LatexCmd("\maketitle")]] </pre>
[[TexLatexDocCls]]: This macro inform to Trac2Latex parser the document class and parameters. Ex.: <pre class="wiki">[[LatexDocClsMacro(atricle,a4paper)]] </pre>
[[TexLatexEndDoc]]: This inform to Trac2Latex parser where the document ends.
[[TexLatexGetRes]]: This macro inform to Trac2Latex parser a external dependency URL. This dependency (picture, package, document class, etc...) will be downloaded to a temporary directory. Ex.: <pre class="wiki">[[LatexGetRes(source:/docs/math.tex)]] </pre>
[[TexLatex]]: Tex version to Latex <a class="missing wiki">WikiProcessor?</a>, does nothing, just return the latex code.
[[TexLatexSpecialChar]]: Return Tex version for some special characters, like %, $, alpha, beta, etc...
[[TexLatexTable]]: Include all necessary packages and macros to render latex tables.
[[TexLatexLongTable]]: Include all necessary packages and macros to render latex tables.
[[TexLatexUsePkg]]: This macro inform to Trac2Latex parser a package to be used (\usepackage). Ex.: <pre class="wiki">[[LatexUsePkg(tabular)]] </pre>
[[TexTimestamp]]: Tex version to Timestamp macro. Return \today.
[[TexInclude]]: This is the Tex version of Image macro.

Macros from around the world

The Trac Hacks site provides a wide collection of macros and other Trac 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.

Developing Custom Macros

Macros, like Trac itself, are written in the Python programming language.

For more information about developing macros, see the development resources on the main project site.

Implementation

Here are 2 simple examples showing how to create a Macro with Trac 0.11.

Also, have a look at Timestamp.py for an example that shows the difference between old style and new style macros and at the macros/README which provides a little more insight about the transition.

Macro without arguments

It should be saved as TimeStamp.py as Trac will use the module name as the Macro name

from datetime import datetime
# Note: since Trac 0.11, datetime objects are used internally

from genshi.builder import tag

from trac.util.datefmt import format_datetime, utc
from trac.wiki.macros import WikiMacroBase

class TimeStampMacro(WikiMacroBase):
    """Inserts the current time (in seconds) into the wiki page."""

    revision = "$Rev$"
    url = "$URL$"

    def expand_macro(self, formatter, name, args):
        t = datetime.now(utc)
        return tag.b(format_datetime(t, '%c'))

Macro with arguments

It should be saved as HelloWorld.py (in the plugins/ directory) as Trac will use the module name as the Macro name

from trac.wiki.macros import WikiMacroBase

class HelloWorldMacro(WikiMacroBase):
    """Simple HelloWorld macro.

    Note that the name of the class is meaningful:
     - it must end with "Macro"
     - what comes before "Macro" ends up being the macro name

    The documentation of the class (i.e. what you're reading)
    will become the documentation of the macro, as shown by
    the !MacroList macro (usually used in the WikiMacros page).
    """

    revision = "$Rev$"
    url = "$URL$"

    def expand_macro(self, formatter, name, args):
        """Return some output that will be displayed in the Wiki content.

        `name` is the actual name of the macro (no surprise, here it'll be
        `'HelloWorld'`),
        `args` is the text enclosed in parenthesis at the call of the macro.
          Note that if there are ''no'' parenthesis (like in, e.g.
          [[HelloWorld]]), then `args` is `None`.
        """
        return 'Hello World, args = ' + unicode(args)
    
    # Note that there's no need to HTML escape the returned data,
    # as the template engine (Genshi) will do it for us.

`expand_macro` details

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.

If your macro creates wiki markup instead of HTML, you can convert it to HTML like this:

  text = "whatever wiki markup you want, even containing other macros"
  # Convert Wiki markup to HTML, new style
  out = StringIO()
  Formatter(self.env, formatter.context).format(text, out)
  return Markup(out.getvalue())