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

Examples

 [[Timestamp]]

Display:

Mon Sep 25 04:22:24 2017

 [[HelloWorld(Testing)]]

Display:

Hello World, args = Testing

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 InterTrac prefixes.

[[objc]]

Syntax highlighting for Objective-C using Pygments

[[javascript+erb]]

Syntax highlighting for JavaScript?+Ruby using Pygments

[[text]]

Syntax highlighting for Text only using Pygments

[[rest]]

Syntax highlighting for reStructuredText using Pygments

[[html+ruby]]

Syntax highlighting for RHTML using Pygments

[[html+kid]]

Syntax highlighting for HTML+Genshi using Pygments

[[xml+genshi]]

Syntax highlighting for Genshi using Pygments

[[genshi]]

Syntax highlighting for Genshi using Pygments

[[csharp]]

Syntax highlighting for C# using Pygments

[[trac-wiki]]

Syntax highlighting for MoinMoin/Trac? Wiki markup using Pygments

[[xml]]

Syntax highlighting for XML using Pygments

[[javascript+django]]

Syntax highlighting for JavaScript?+Django/Jinja using Pygments

[[jinja]]

Syntax highlighting for Django/Jinja using Pygments

[[restructuredtext]]

Syntax highlighting for reStructuredText using Pygments

[[css+mako]]

Syntax highlighting for CSS+Mako using Pygments

[[vbnet]]

Syntax highlighting for VB.net using Pygments

[[python]]

Syntax highlighting for Python using Pygments

[[myghty]]

Syntax highlighting for Myghty using Pygments

[[bbcode]]

Syntax highlighting for BBCode using Pygments

[[bat]]

Syntax highlighting for Batchfile using Pygments

[[js+genshitext]]

Syntax highlighting for JavaScript?+Genshi Text using Pygments

[[d]]

Syntax highlighting for D using Pygments

[[pascal]]

Syntax highlighting for Delphi using Pygments

[[c++]]

Syntax highlighting for C++ using Pygments

[[man]]

Syntax highlighting for Groff using Pygments

[[html+erb]]

Syntax highlighting for RHTML using Pygments

[[befunge]]

Syntax highlighting for Befunge using Pygments

[[cfg]]

Syntax highlighting for INI using Pygments

[[html+php]]

Syntax highlighting for HTML+PHP using Pygments

[[html+myghty]]

Syntax highlighting for HTML+Myghty using Pygments

[[tex]]

Syntax highlighting for TeX using Pygments

[[html+jinja]]

Syntax highlighting for HTML+Django/Jinja using Pygments

[[javascript+genshi]]

Syntax highlighting for JavaScript?+Genshi Text using Pygments

[[javascript+ruby]]

Syntax highlighting for JavaScript?+Ruby using Pygments

[[html+django]]

Syntax highlighting for HTML+Django/Jinja using Pygments

[[groff]]

Syntax highlighting for Groff using Pygments

[[xml+django]]

Syntax highlighting for XML+Django/Jinja using Pygments

[[delphi]]

Syntax highlighting for Delphi using Pygments

[[js+smarty]]

Syntax highlighting for JavaScript?+Smarty using Pygments

[[javascript+php]]

Syntax highlighting for JavaScript?+PHP using Pygments

[[lua]]

Syntax highlighting for Lua using Pygments

[[javascript+mako]]

Syntax highlighting for JavaScript?+Mako using Pygments

[[js+jinja]]

Syntax highlighting for JavaScript?+Django/Jinja using Pygments

[[redcode]]

Syntax highlighting for Redcode using Pygments

[[rb]]

Syntax highlighting for Ruby using Pygments

[[irb]]

Syntax highlighting for Ruby irb session using Pygments

[[irc]]

Syntax highlighting for IRC logs using Pygments

[[bf]]

Syntax highlighting for Brainfuck using Pygments

[[javascript]]

Syntax highlighting for JavaScript? using Pygments

[[js+erb]]

Syntax highlighting for JavaScript?+Ruby using Pygments

[[html+smarty]]

Syntax highlighting for HTML+Smarty using Pygments

[[js]]

Syntax highlighting for JavaScript? using Pygments

[[apache]]

Syntax highlighting for ApacheConf? using Pygments

[[javascript+myghty]]

Syntax highlighting for JavaScript?+Myghty using Pygments

[[bash]]

Syntax highlighting for Bash using Pygments

[[c]]

Syntax highlighting for C using Pygments

[[vb.net]]

Syntax highlighting for VB.net using Pygments

[[js+ruby]]

Syntax highlighting for JavaScript?+Ruby using Pygments

[[ocaml]]

Syntax highlighting for OCaml using Pygments

[[css+genshi]]

Syntax highlighting for CSS+Genshi Text using Pygments

[[genshitext]]

Syntax highlighting for Genshi Text using Pygments

[[nroff]]

Syntax highlighting for Groff using Pygments

[[xml+myghty]]

Syntax highlighting for XML+Myghty using Pygments

[[aconf]]

Syntax highlighting for ApacheConf? using Pygments

[[js+genshi]]

Syntax highlighting for JavaScript?+Genshi Text using Pygments

[[smarty]]

Syntax highlighting for Smarty using Pygments

[[vim]]

Syntax highlighting for VimL using Pygments

[[haskell]]

Syntax highlighting for Haskell using Pygments

[[diff]]

Syntax highlighting for Diff using Pygments

[[js+django]]

Syntax highlighting for JavaScript?+Django/Jinja using Pygments

[[rbcon]]

Syntax highlighting for Ruby irb session using Pygments

[[pycon]]

Syntax highlighting for Python console session using Pygments

[[xml+jinja]]

Syntax highlighting for XML+Django/Jinja using Pygments

[[java]]

Syntax highlighting for Java using Pygments

[[js+mako]]

Syntax highlighting for JavaScript?+Mako using Pygments

[[py]]

Syntax highlighting for Python using Pygments

[[makefile]]

Syntax highlighting for Makefile using Pygments

[[perl]]

Syntax highlighting for Perl using Pygments

[[xml+ruby]]

Syntax highlighting for XML+Ruby using Pygments

[[scheme]]

Syntax highlighting for Scheme using Pygments

[[rhtml]]

Syntax highlighting for RHTML using Pygments

[[apacheconf]]

Syntax highlighting for ApacheConf? using Pygments

[[pl]]

Syntax highlighting for Perl using Pygments

[[css+genshitext]]

Syntax highlighting for CSS+Genshi Text using Pygments

[[xml+mako]]

Syntax highlighting for XML+Mako using Pygments

[[c#]]

Syntax highlighting for C# using Pygments

[[js+php]]

Syntax highlighting for JavaScript?+PHP using Pygments

[[pytb]]

Syntax highlighting for Python Traceback using Pygments

[[css+ruby]]

Syntax highlighting for CSS+Ruby using Pygments

[[rst]]

Syntax highlighting for reStructuredText using Pygments

[[moin]]

Syntax highlighting for MoinMoin/Trac? Wiki markup using Pygments

[[ruby]]

Syntax highlighting for Ruby using Pygments

[[objectivec]]

Syntax highlighting for Objective-C using Pygments

[[xml+smarty]]

Syntax highlighting for XML+Smarty using Pygments

[[javascript+smarty]]

Syntax highlighting for JavaScript?+Smarty using Pygments

[[mf]]

Syntax highlighting for Makefile using Pygments

[[css+jinja]]

Syntax highlighting for CSS+Django/Jinja using Pygments

[[obj-c]]

Syntax highlighting for Objective-C using Pygments

[[xml+erb]]

Syntax highlighting for XML+Ruby using Pygments

[[erb]]

Syntax highlighting for ERB using Pygments

[[css+smarty]]

Syntax highlighting for CSS+Smarty using Pygments

[[css+erb]]

Syntax highlighting for CSS+Ruby using Pygments

[[raw]]

Syntax highlighting for Raw token data using Pygments

[[objective-c]]

Syntax highlighting for Objective-C using Pygments

[[brainfuck]]

Syntax highlighting for Brainfuck using Pygments

[[ini]]

Syntax highlighting for INI using Pygments

[[mupad]]

Syntax highlighting for MuPAD using Pygments

[[js+myghty]]

Syntax highlighting for JavaScript?+Myghty using Pygments

[[css+myghty]]

Syntax highlighting for CSS+Myghty using Pygments

[[mako]]

Syntax highlighting for Mako using Pygments

[[pas]]

Syntax highlighting for Delphi using Pygments

[[javascript+jinja]]

Syntax highlighting for JavaScript?+Django/Jinja using Pygments

[[xml+kid]]

Syntax highlighting for Genshi using Pygments

[[make]]

Syntax highlighting for Makefile using Pygments

[[minid]]

Syntax highlighting for MiniD using Pygments

[[css+django]]

Syntax highlighting for CSS+Django/Jinja using Pygments

[[javascript+genshitext]]

Syntax highlighting for JavaScript?+Genshi Text using Pygments

[[sourceslist]]

Syntax highlighting for Debian Sourcelist using Pygments

[[html]]

Syntax highlighting for HTML using Pygments

[[php4]]

Syntax highlighting for PHP using Pygments

[[php5]]

Syntax highlighting for PHP using Pygments

[[css+php]]

Syntax highlighting for CSS+PHP using Pygments

[[css]]

Syntax highlighting for CSS using Pygments

[[php3]]

Syntax highlighting for PHP using Pygments

[[html+mako]]

Syntax highlighting for HTML+Mako using Pygments

[[boo]]

Syntax highlighting for Boo using Pygments

[[cpp]]

Syntax highlighting for C++ using Pygments

[[jsp]]

Syntax highlighting for Java Server Page using Pygments

[[sql]]

Syntax highlighting for SQL using Pygments

[[php]]

Syntax highlighting for PHP using Pygments

[[kid]]

Syntax highlighting for Genshi using Pygments

[[latex]]

Syntax highlighting for TeX using Pygments

[[dylan]]

Syntax highlighting for DylanLexer? using Pygments

[[xml+php]]

Syntax highlighting for XML+PHP using Pygments

[[django]]

Syntax highlighting for Django/Jinja using Pygments

[[objectpascal]]

Syntax highlighting for Delphi using Pygments

[[sh]]

Syntax highlighting for Bash using Pygments

[[sources.list]]

Syntax highlighting for Debian Sourcelist using Pygments

[[html+genshi]]

Syntax highlighting for HTML+Genshi using Pygments

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

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

  • 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 or files 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).

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, top or bottom are interpreted as the alignment for the image
  • nolink means without link to image source.
  • key=value style are interpreted as HTML attributes or CSS style

indications for the image. Valid keys are:

  • align, border, width, height, alt, title, longdesc, class, id and usemap
  • border can only be a number

Examples:

    [[Image(photo.jpg)]]                           # simplest
    [[Image(photo.jpg, 120px)]]                    # with 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 image from other page, other ticket or other module.

    [[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@taiyo.co.jp>

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

[[TracIni]]

Produce documentation for 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.

[[HelloWorld]]

Example macro.

[[Timestamp]]

Inserts the current time (in seconds) into the wiki page.

[[TracGuideToc]]

This macro shows a quick and dirty way to make a table-of-contents for a set of wiki pages.

[[TracAdminHelp]]

Displays help for trac-admin commands.

Examples:

[[TracAdminHelp]]               # all commands
[[TracAdminHelp(wiki)]]         # all wiki commands
[[TracAdminHelp(wiki export)]]  # the "wiki export" command
[[TracAdminHelp(upgrade)]]      # the upgrade command
[[TicketQuery]]

Macro that lists tickets that match certain criteria.

This macro accepts two parameters, the second of which is optional.

The first parameter is the query itself, and uses the same syntax as for query: wiki links (but not the variant syntax starting with "?").

The second parameter determines how the list of tickets is presented: the default presentation is to list the ticket ID next to the summary, with each ticket on a separate line. If the second parameter is given, it must be one of:

  • compact -- the tickets are presented as a comma-separated list of ticket IDs.
  • count -- only the count of matching tickets is displayed

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. They are very simple modules, identified by the filename and should contain a single execute() function. Trac will display the returned data inserted into the HTML representation of the Wiki page where the macro is called.

It's easiest to learn from an example:

# MyMacro.py -- The world's simplest macro

def execute(hdf, args, env):
    return "Hello World called with args: %s" % args

You can also use the environment (env) object, for example to access configuration data and the database, for example:

def execute(hdf, txt, env):
    return env.config.get('trac', 'repository_dir')

Note that since version 0.9, wiki macros can also be written as TracPlugins. This gives them some capabilities that “classic” macros do not have, such as being able to directly access the HTTP request.

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


See also: WikiProcessors, WikiFormatting, TracGuide