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)]] |
|
[[RecentChanges?(Trac,3)]] |
|
[[?]] |
Fügt eine Änderungssatz-Nachricht in die Ausgabe ein.
Dieses Makro … |
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.
[[CommitTicketReference]]
Fügt eine Änderungssatz-Nachricht in die Ausgabe ein.
Dieses Makro muss mit der Wiki-Prozessor-Syntax wie folgt aufgerufen werden:
{{{
#!CommitTicketReference repository="reponame" revision="rev"
}}}
wobei die Argumente die folgenden sind:
repository: das Repositorium, dass den Änderungssatz enthältrevision: die Revision des gewünschten Änderungssatzes
[[ElementEnd]]
ElementEndMacro markiert das Ende einer ausklappbaren DIV
Example:
[[ElementEnd]]
[[ElementStart]]
ElementStartMacro makiert den Anfang einer ausklappbaren DIV
Example:
[[ElementStart(Title)]]
[[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.fileto refer to a local attachment named 'file'. This only works from within that wiki page or a ticket.
The file specification may also refer to:
- repository files, using the
source:filesyntax (source:file@revworks also). - files, using direct URLs:
/filefor a project-relative,//filefor a server-relative, orhttp://server/filefor absolute location. An InterWiki prefix may be used. - embedded data using the
rfc2397
dataURL scheme, provided the URL is enclosed in quotes.
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. 120px, 25%) for the image
right,left,center,top,bottomandmiddleare interpreted as the alignment for the image (alternatively, the first three can be specified usingalign=...and the last three usingvalign=...)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.inlinespecifies that the content generated be an inline XHTML element. By default, inline content is not generated, therefore images won't be rendered in section headings and other one-line content.nolinkmeans without link to image source (deprecated, uselink=)key=valuestyle are interpreted as HTML attributes or CSS style indications for the image. Valid keys are:- align, valign, border, width, height, alt, title, longdesc, class, margin, margin-(left,right,top,bottom), id and usemap
border,margin, andmargin-* can only be a single number (units are pixels).marginis superseded bycenterwhich uses auto margins
Examples:
[[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
You can use an image from a wiki page, ticket or other module.
[[Image(OtherPage:foo.bmp)]] # from a wiki page [[Image(base/sub:bar.bmp)]] # from hierarchical wiki page [[Image(#3:baz.bmp)]] # from another ticket [[Image(ticket:36:boo.jpg)]] # from another ticket (long form) [[Image(source:/img/bee.jpg)]] # from the repository [[Image(htdocs:foo/bar.png)]] # from project htdocs dir [[Image(shared:foo/bar.png)]] # from shared htdocs dir (since 1.0.2)
Adapted from the Image.py macro created by Shun-ichi Goto <gotoh@…>
[[InterTrac]]
Geben Sie eine Liste der bekannten InterTrac-Präfixe an.
[[InterWiki]]
Erstellt eine Beschreibungsliste der bekannten InterWiki-Präfixe.
[[KnownMimeTypes]]
Zeige alle bekannten mime-Typen die als WikiProcessors genutzt werden können.
Kann ein optionales Argument nutzen, dass als mime-Typ-Filter interpretiert wird.
[[MacroList]]
Zeige eine Liste aller installierten Wiki-Makros mit Dokumentation falls verfügbar.
Als optionales Argument kann der Name eines spezifischen Makros angegeben werden. Dann wird nur die Dokumentation dieses Makros dargestellt.
Dieses Makro kann die Dokumentation von Makros nicht darstellen,
wenn die PythonOptimize Option für mod_python eingeschaltet ist!
[[PageOutline]]
Zeigt die Strukturübersicht der aktuellen Wikiseite, wobei jeder Eintrag ein Link zur entsprechenden Überschrift ist.
Dieses Makro akzeptiert vier optionale Parameter:
- Der erste ist eine Zahl oder ein Intervall, der die niedrigste und die höchste Überschriftenebene für die Übersicht angibt. Der Wert "1" würde
zum Beispiel nur die Überschriften der oberste Ebene berücksichtigen. Die Angabe "2-3" würde alle Überschriften der Ebene 2 und 3 als geschachtelte Liste einfügen. Die Voreinstellung ist, alle Ebenen zu berücksichtigen.
- Der zweite Parameter kann einen angepassten Titel angeben
(Voreinstellung: kein Titel).
- Der dritte Parameter wählt den Stil der Übersicht. Dieser kann entweder
inline oder pullout sein (letzterer ist die Voreinstellung). Der
inlineStil stellt die Übersicht als Teil des normalen Inhalts dar, währendpulloutin einen Kasten zeichnet der per Voreinstellung rechts neben
dem anderen Inhalt dargestellt wird.
- Der vierte Parameter legt fest, ob die Übersicht nummeriert ist oder nicht.
Es kann entweder
numberedorunnumberedsein (ersteres ist die
Voreinstellung). Dieser Parameter hat nur Auswirkungen im inline Stil.
[[ProjectStats]]
Wiki macro listing some generic Trac statistics.
This macro accepts a comma-separated list of keyed parameters, in the form "key=value". Valid keys:
- wiki -- statistics for TracWiki, values:
- count -- show wiki page count
- prefix -- use with wiki key: only names that start with that prefix are included
'count' is also recognized without prepended key name.
[[RecentChanges]]
Zeige eine Liste aller Seiten, die kürzlich geändert wurden, sortiert nach dem letzten Änderungszeitpunkt.
Dieses Makro akzeptiert zwei Argumente und ein benanntes Argument. Das benannte Argument kann überall in der Argumentliste stehen.
Der erste Parameter ist ein Präfixstring: falls vorhanden, werden nur Seiten deren Namen mit dem Präfix beginnen in die Ergebnisliste aufgenommen. Wird der Parameter weggelassen, werden alle Seiten aufgeführt.
Der zweite Parameter ist die maximale Anzahl von Seiten in der Ergebnisliste.
Der group Parameter bestimmt, wie die Liste aufbereitet wird:
group=date- Die Seiten werden in Listen nach Datum gruppiert
(Voreinstellung).
group=none- Die Seiten werden in einer einzigen Liste dargestellt.
Tipp: Falls nur die Maximalzahl von Einträgen aber kein Präfixfilter
angegeben werden soll, kann man den ersten Parameter leer lassen,
z.B. [[RecentChanges(,10,group=none)]].
[[RepositoryIndex]]
Display the list of available repositories.
Can be given the following named arguments:
- format
-
Select the rendering format:
- compact produces a comma-separated list of repository prefix names (default)
- list produces a description list of repository prefix names
- table produces a table view, similar to the one visible in the Browse View page
- glob
- Do a glob-style filtering on the repository names (defaults to '*')
- order
- Order repositories by the given column (one of "name", "date" or "author")
- desc
- When set to 1, order by descending order
[[SubscriberList]]
Zeige eine Liste aller installierten Benachrichtigungs-Abonnenten mit Dokumentation falls verfügbar.
Als optionales Argument kann der Name eines spezifischen Abonnenten angegeben werden. Dann wird nur die Dokumentation diesen Abonnenten dargestellt.
Dieses Makro kann die Dokumentation von Makros nicht darstellen,
wenn die PythonOptimize Option für mod_python eingeschaltet ist!
[[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
literal 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
- rawcount -- only the count of matching tickets is displayed, not even with a link to the corresponding query (since 1.1.1)
- table -- a view similar to the custom query view (but without the controls)
- progress -- a view similar to the milestone progress bars
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
The col parameter can be used to specify which fields should
be viewed as columns. For table format only.
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.
[[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.
The prefix string supports the standard relative-path notation when
using the macro in a wiki page. A prefix string starting with ./
will be relative to the current page, and parent pages can be
specified using ../.
Several 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 amin=nargument, wherenis 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 amin=nargument, where highernflatten the display hierarchydepth=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.include=page1:page*2: include only pages that match an item in the colon-separated list of pages. If the list is empty, or if noincludeargument is given, include all pages.exclude=page1:page*2: exclude pages that match an item in the colon- separated list of pages.
The include and exclude lists accept shell-style patterns.
[[TracAdminHelp]]
Hilfe für trac-admin Kommandos anzeigen.
Beispiele:
[[TracAdminHelp]] # alle Kommandos [[TracAdminHelp(wiki)]] # alle Wiki Kommandos [[TracAdminHelp(wiki export)]] # das "wiki export" Kommando [[TracAdminHelp(upgrade)]] # das upgrade Kommando
[[TracGuideToc]]
Zeige ein Inhaltsverzeichnis für die Trac-Anleitung.
Dieses Makro ist ein einfacher und unsauberer Weg ein Inhaltsverzeichnis für die Hilfe/Anleitung zu erstellen. Das Inhaltsverzeichnis wird die Trac* und WikiFormatting Seiten enthalten und kann nicht angepasst werden. Weitere Informationen, um ein anpassbares Inhaltsverzeichnis zu erstellen, finden Sie unter TocMacro.
[[TracIni]]
Produce documentation for the Trac configuration file.
Typically, this will be used in the TracIni page. The macro accepts two ordered arguments and two named arguments.
The ordered 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.
The named arguments can be specified:
- section
- a glob-style filtering on the section names
- option
- a glob-style filtering on the option names
[[UserQuery]]
Wiki macro listing users that match certain criteria.
This macro accepts a comma-separated list of keyed parameters, in the form "key=value". Valid keys:
- perm -- show only that users, a permission action given by value has been granted to
- locked -- retrieve users, who's account has/has not been locked depending on boolean value
- format -- output style: 'count', 'list' or comma-separated values (default)
- nomatch -- replacement wiki markup that is displayed, if there's no match and output style isn't 'count' either
'count' is also recognized without prepended key name. Other non-keyed parameters are:
- locked -- alias for 'locked=True'
- visit -- show a list of accounts with last-login information, only available in table format
- name -- forces replacement of maching username with their corresponding full names, if available; adds a full names column if combined with 'visit'
- email -- append email address to usernames, if available
Requires USER_VIEW permission for output in any format other then 'count'.
A misc placeholder with this statement is presented to unprivileged users.
[[Workflow]]
Render a workflow graph.
This macro accepts a TracWorkflow configuration and renders the states and transitions as a directed graph. If no parameters are given, the current ticket workflow is rendered.
In WikiProcessor mode the width and height
arguments can be specified (Defaults: width = 800 and height = 600).
The repository-scoped path of a workflow file can be specified as either
a macro or WikiProcessor file argument. The file revision can be
specified by appending @<rev> to the path. The file argument value
must be enclosed in single or double quotes. (Since 1.3.2).
Examples:
[[Workflow()]]
[[Workflow(go = here -> there; return = there -> here)]]
[[Workflow(file=/contrib/workflow/enterprise-workflow.ini@1)]]
{{{#!Workflow file="/contrib/workflow/enterprise-workflow.ini"
}}}
{{{#!Workflow width=700 height=700
leave = * -> *
leave.operations = leave_status
leave.default = 1
create = <none> -> new
create.default = 1
create_and_assign = <none> -> assigned
create_and_assign.label = assign
create_and_assign.permissions = TICKET_MODIFY
create_and_assign.operations = may_set_owner
accept = new,assigned,accepted,reopened -> accepted
accept.permissions = TICKET_MODIFY
accept.operations = set_owner_to_self
resolve = new,assigned,accepted,reopened -> closed
resolve.permissions = TICKET_MODIFY
resolve.operations = set_resolution
reassign = new,assigned,accepted,reopened -> assigned
reassign.permissions = TICKET_MODIFY
reassign.operations = set_owner
reopen = closed -> reopened
reopen.permissions = TICKET_CREATE
reopen.operations = del_resolution
}}}
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 and are developed as part of TracPlugins.
For more information about developing macros, see the development resources on the main project site.
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
To test the following code, you should saved it in a timestamp_sample.py file located in the TracEnvironment's plugins/ directory.
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, text):
t = datetime.now(utc)
return tag.b(format_datetime(t, '%c'))
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.
from genshi.core import Markup
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, 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=value processor 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).
For example, when writing:
{{{#!HelloWorld style="polite"
<Hello World!>
}}}
{{{#!HelloWorld
<Hello World!>
}}}
[[HelloWorld(<Hello World!>)]]
One should get:
Hello World, text = <Hello World!> , args = {'style': u'polite'}
Hello World, text = <Hello World!> , args = {}
Hello World, text = <Hello World!> , args = None
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:
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())
