Trac Macros

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.

Getting Detailed Help

The list of available macros and the full help can be obtained using the MacroList macro, as seen below.

A brief list can be obtained via [[MacroList(*)]] or [[?]].

Detailed 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?]].

Example

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

Wiki Markup

Display

[[RecentChanges(Trac,3)]]

02/08/2011

[[RecentChanges]]

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

[[?]]

[[Image]]

Embed an image in wiki-formatted text.
The first argument is the file …

[[InterTrac]]

[[RepositoryIndex]]

compact will produce a comma-separated list of
repository prefix names

list will produce a description list of
repository prefix names

table will produce a table view, similar to the
one visible in the Browse View page

Can be given a glob argument, which will do a glob-style
filtering on the repository names (defaults to '*')

(since 0.12)

[[rstdoc]]

When enabled, generates documentation from the repository.

Macro syntax: [[rstdoc(target)]]

[[rstfile]]

When enabled, display reStructured text inline from

a file in the repository.

Macro syntax: [[rstfile(target)]]

[[TitleIndex]]

Insert 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.
If the prefix is specified, a second argument of value 'hideprefix'
can be given as well, in order to remove that prefix from the output.

Alternate format and depth named parameters can be specified:

format=compact: The pages are displayed as comma-separated links.

format=group: The list of pages will be structured in groups
according to common prefix. This format also supports a min=n
argument, where n is the minimal number of pages for a group.

format=hierarchy: The list of pages will be structured according
to the page name path hierarchy. This format also supports a min=n
argument, where higher n flatten the display hierarchy

depth=n: 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.

[[RecentChanges]]

List 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]]

Display 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:

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.

The second parameter can be used to specify a custom title (the default
is no title).

The third parameter selects the style of the outline. This can be
either inline or pullout (the latter being the default). The inline
style renders the outline as normal part of the content, while pullout
causes the outline to be rendered in a box that is by default floated to
the right side of the other content.

[[Image]]

Embed an image in wiki-formatted text.

The first argument is the file specification. The file specification may
reference attachments in three ways:

module:id:file, where module can be either wiki or ticket,
to refer to the attachment named file of the specified wiki page or
ticket.

id:file: same as above, but id is either a ticket shorthand or a Wiki
page name.

file to refer to a local attachment named 'file'. This only works from
within that wiki page or a ticket.

Also, the file specification may refer to repository files, using the
source:file syntax (source:file@rev works also).

Files can also be accessed with a direct URLs; /file for a
project-relative, //file for a server-relative, or http://server/file
for absolute location of the file.

The remaining arguments are optional and allow configuring the attributes
and style of the rendered <img> element:

digits and unit are interpreted as the size (ex. 120, 25%)
for the image

right, left, center, top, bottom and middle are interpreted
as the alignment for the image (alternatively, the first three can be
specified using align=... and the last three using valign=...)

link=some TracLinks... replaces the link to the image source by the
one specified using a TracLinks. If no value is specified, the link is
simply removed.

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

Adapted from the Image.py macro created by Shun-ichi Goto
<gotoh@…>

[[MacroList]]

Display 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 PythonOptimize option is enabled for mod_python!

[[TracIni]]

Produce documentation for the Trac configuration file.

Typically, this will be used in the TracIni 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.

[[KnownMimeTypes]]

Can be given an optional argument which is interpreted as mime-type filter.

[[TracGuideToc]]

Display a table of content for the Trac guide.

This macro shows a quick and dirty way to make a table-of-contents
for the Help/Guide?. The table of contents will contain the Trac* and
WikiFormatting pages, and can't be customized. Search for TocMacro? for a
a more customizable table of contents.

[[TicketQuery]]

Wiki macro listing 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 TracQuery#QueryLanguage.
Note that this is not the same as the simplified URL syntax
used for query: links starting with a ? character. Commas (,)
can be included in field values by escaping them with a backslash (\).

Groups of field constraints to be OR-ed together can be separated by a
litteral or argument.

In addition to filters, several other named parameters can be used
to control how the results are presented. All of them are optional.

The format parameter determines how the list of tickets is
presented:

list -- the default presentation is to list the ticket ID next
to the summary, with each ticket on a separate line.

compact -- the tickets are presented as a comma-separated
list of ticket IDs.

count -- only the count of matching tickets is displayed

table -- a view similar to the custom query view (but without
the controls)

The max parameter can be used to limit the number of tickets shown
(defaults to 0, i.e. no maximum).

The order parameter sets the field used for ordering tickets
(defaults to id).

The desc parameter indicates whether the order of the tickets
should be reversed (defaults to false).

The group parameter sets the field used for grouping tickets
(defaults to not being set).

The groupdesc parameter indicates whether the natural display
order of the groups should be reversed (defaults to false).

The verbose 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 rows parameter

The rows parameter can be used to specify which field(s) should
be viewed as a row, e.g. rows=description|summary

For compatibility with Trac 0.10, if there's a last positional parameter
given to the macro, it will be used to specify the format.
Also, using "&" as a field separator still works (except for order)
but is deprecated.

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 format= keyword argument supports rendering these formats:

format=inline

Renders an unordered list in the normal text flow (default).

format=float

A floating box out on the side of the page with slightly more detail.

format=full

Full rendering like on period, category and author listings inside blog.

The arguments can appear in any order.

Posts are rendered sorted by newest first for all modes.

[[CommitTicketReference]]

Insert a changeset message into the output.

This macro must be called using wiki processor syntax as follows:

{{{
#!CommitTicketReference repository="reponame" revision="rev"
}}}

where the arguments are the following:

repository: the repository containing the changeset

revision: the revision of the desired changeset

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.

Macro with arguments

To test the following code, you should saved it in a helloworld_sample.py file located in the TracEnvironment's plugins/ directory.

fromgenshi.coreimport Markup
fromtrac.wiki.macrosimport WikiMacroBase
classHelloWorldMacro(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$"defexpand_macro(self, formatter, name, text, 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'`),
`text` 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 `text` is `None`.
`args` are the arguments passed when HelloWorld is called using a
`#!HelloWorld` code block.
"""return'Hello World, text = %s, args = %s'% \
(Markup.escape(text), Markup.escape(repr(args)))

Note that expand_macro optionally takes a 4th parameter args. When the macro is called as a WikiProcessor, it's also possible to pass key=valueprocessor 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).

Note 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).

You can also recursively use a wiki Formatter (from trac.wiki import Formatter) to process the text as wiki markup, for example by doing: