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).
Macro calls are enclosed in two square brackets. Like Python functions, macros can also have arguments, a comma separated list within parentheses.
Wed Mar 3 21:43:24 2021
Hello World, args = Testing
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?.
Provide a list of known InterTrac? prefixes.
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.
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.
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.
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
[[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 <email@example.com>
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!
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.
This macro shows a quick and dirty way to make a table-of-contents for a set of wiki pages.
Inserts the current time (in seconds) into the wiki page.
Generate a table of contents for the current page or a set of pages. If no arguments are given, a table of contents is generated for the current page, with the top-level title stripped:
To generate a table of contents for a set of pages, simply pass them as comma separated arguments to the TOC macro, e.g. as in
[[TOC(TracGuide, TracInstall, TracUpgrade, TracIni, TracAdmin, TracBackup, TracLogging, TracPermissions, TracWiki, WikiFormatting, TracBrowser, TracRoadmap, TracChangeset, TracTickets, TracReports, TracQuery, TracTimeline, TracRss, TracNotification)]]
The following control arguments change the default behaviour of the TOC macro:
Argument Meaning heading=<x> Override the default heading of "Table of Contents" noheading Suppress display of the heading. depth=<n> Display headings of subsequent pages to a maximum depth of <n>. inline Display TOC inline rather than as a side-bar. titleindex Only display the page name and title of each page, similar to TitleIndex.
Note that the current page must also be specified if individual wiki pages are given in the argument list.
Displays help for trac-admin commands.
[[TracAdminHelp]] # all commands [[TracAdminHelp(wiki)]] # all wiki commands [[TracAdminHelp(wiki export)]] # the "wiki export" command [[TracAdminHelp(upgrade)]] # the upgrade command
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.