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:

Don 09 Sep 2010 13:03:40 CEST

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

[[TagCloud]]

This macro displays a tag cloud (weighted list) of all tags.

Argument	Description
tagspace=<tagspace>	Specify the tagspace the macro should operate on.
tagspaces=(<tagspace>,...)	Specify a set of tagspaces the macro should operate on.
smallest=<n>	The lower bound of the font size for the tag cloud.
biggest=<n>	The upper bound of the font size for the tag cloud.
showcount=true|false	Show the count of objects for each tag?
mincount=<n>	Hide tags with a count less than <n>.

[[ListTagged]]

List tagged objects. Optionally accepts a list of tags to match against. The special tag . (dot) inserts the current Wiki page name.

[[ListTagged(<tag>, ...)]]

Argument	Description
tagspace=<tagspace>	Specify the tagspace the macro should operate on.
tagspaces=(<tagspace>,...)	Specify a set of tagspaces the macro should operate on.
operation=intersection|union	The set operation to perform on the discovered objects.
showheadings=true|false	List objects under the tagspace they occur in.
expression=<expr>	Match object tags against the given expression.

The supported expression operators are: unary - (not); binary +, - and | (and, and not, or). All values in the expression are treated as tags. Any tag not in the same form as a Python variable must be quoted.

eg. Match all objects tagged with ticket and workflow, and not tagged with wiki or closed.

(ticket+workflow)-(wiki|closed)

If an expression is provided operation is ignored.

[[TagIt]]

Deprecated. Does nothing.

[[ListTags]]

List all tags.

Argument	Description
tagspace=<tagspace>	Specify the tagspace the macro should operate on.
tagspaces=(<tagspace>,...)	Specify a set of tagspaces the macro should operate on.
shownames=true|false	Whether to show the objects that tags appear on (long).

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

[[RoadmapBox]]

Display a box with tickets concercing a certain Milestone AND Keyword. We use tagging to group certain keywords together based on featureset, since they might fall in different components. This is ideal in the Roadmap display, since it shows nice summary boxes of all open/closed tickets by keyword.

Syntax:

Quickies:

Bugfixes:

Other:

Created by: frido.ferdinand@gmail.com Based on: TicketBox?

[[PlannedMilestones]]

[[Folding]]

small macro to fold areas and toggle the visibility on click. first parameter is one of the following actions

"printscript" prints the necessary javascript "begin" marks the beginning of the area to be folded "end" marks the end of the area to be folded "activator" prints the area that will activate the folding

second parameter is the id of the area to be folded/unfolded third parameter can be

"visibility" of the area when the action is "begin" (possible values "inline","none") "formatting" of the content when the action is "activator" (possible values "wiki","none")

forth paramerter is the content for the activator action.

example usage:

Error: Macro Folding(activator,idoftheregiontobeunfolded,wiki,== click me to view ==) failed

href

this area is folded by default

<h2>click me to hide</h2> this area is visible by default

Author: Thorsten Ott (wanagi at web-helfer.de)

[[FootNote]]

Collates and generates foot-notes. Call the macro with the foot-note content as the only argument:

   [[FootNote(This is a footnote)]]

Foot-notes are numbered by the order in which they appear. To create a reference to an existing foot-note, pass the footnote number as argument to the macro:

   [[FootNote(1)]]

In addition, identical foot-notes are coalesced into one entry. The following will generate one footnote entry with two references:

   Some text[[FootNote(A footnote)]] and some more text [[FootNote(A footnote)]].

A list of footnotes generated by one or more of the above commands is produced by calling the macro without arguments:

   [[FootNote]]

Once a set of footnotes has been displayed, a complete new set of footnotes can be created. This allows multiple sets of footnotes per page.

[[formula]]

Convert a latex formula into an image. by Valient Gough <vgough@pobox.com>, David Douard <david.douard@gmail.com>

Changes:

2006-01-16 (David Douard):

• make this macro work with Trac 0.9
• make the generated images be saved in $PROJECT/htdocs/formulas
• make default image format be 'png'
• replaced every Tab by spaces
• make tmp dir creation recursive

2005-10-21: Ken McIvor? <mcivor@iit.edu>:

• Updated to support trac 0.9b2.
• Improved the error messages for missing configuration elements.

2005-10-03:

• make image format selectable via 'image_format' configuration option (defaults to 'jpg')
• allow paths to executables to be specified in configuration by setting 'latex_path', 'dvips_path', 'convert_path' to point to executable. Based on code by Reed Cartwright.

2005-10-01:

• add #display and #fleqn options to add html formatting around image (Christian Marquardt).

2005-09-21:

• add #center and #indent options to add html formatting around image.

2005-08-02:

• remove hard-coded paths, read from configuration. Fixes #26

2005-07-27:

• figured out how to get rid of the annoying internal error after latex was run. Redirected latex output to /dev/null..
• found out that #!figure ... runs wiki macro, and doesn't have the problem of not being able to use paranthesis. So this is the default usage now. Can still use
  Error: the formula macro requires the setting temp_dir in the configuration section latex
  for simple formula.
• add "nomode" command, which can be used to turn off automatic enclosure of commands in display-math mode ("$$ ... $$")

2005-07-26: first release

Installation:

1. Copy into wiki-macros directory.
2. Edit conf/trac.ini and add a [latex] group with three values:

[latex] # temp_dir points to directory where temporary files are created temp_dir = /var/tmp/trac # Set to 1 for fleqn style equations (default is centered) fleqn = 0 # Indentation width for fleqn style equations fleqn_width = '5%'

Usage:

Error: the formula macro requires the setting temp_dir in the configuration section latex

or, additional keywords can be specified before the latex code:

Error: the formula macro requires the setting temp_dir in the configuration section latex

Optional keywords (must be specified before the latex code):

#density=100

Density defaults to 100. Larger values produces larger images.

#nomode

Disable the default display mode setting. Use this if you want to include things outside of tex's display mode.

#display

Create a displayed equation (either centered or fleqn style, depending on the fleqn variable in the config file.

#center

Center the equation on the page.

#fleqn

fleqn style equation; indentation is controlled by fleqn_witdh in conf/trac.ini.

#indent [=class name]

places image link in a paragraph <p>...</p> If class name is specified, then it is used to specify a CSS class for the paragraph.

Notes:

A matrix macro is included in the tex code. This allows you to do things like:

\mat{1&2\3&4} to get a 2x2 matrix. The "\" separates rows, and "&" separates columns. Any size up to around 25? will work..

Images are automatically named based on a sha1 hash of the formula, the density, and the script version. This way the image doesn't have to be regenerated every time it is used, and if anything is changed then a new image is created.

Note that temporary files can build up in the tmpdir, and every time a formula is modified, a new image will be created in the imagePath directory. These can be considered as cached files. You can safely let the tmp file cleaner process remove old files from these directories.

PS. This is my first python program, so it is probably pretty ugly by python standards (whatever those may be). Feedback is welcome, but complaints about ugliness will be redirected to /dev/null.

[[YouTube]]

YouTube? macro.

[[Ohloh]]

YouTube? macro.

[[Screenshot]]

Allows embed screenshot image in wiki page. First mandatory argument is ID of the screenshot. Number or image attributes can be specified next:

• align - Specifies image alignment in wiki page. Possible values are: left, right and center.
• alt - Alternative description of image.
• border - Sets image border of specified width in pixels.
• class - Class of image for CSS styling.
• description - Brief description under the image. Accepts several variables (see bellow).
• format - Format of returned image or screenshot behind link.
• height - Height of image. Set to 0 if you want original image height.
• id - ID of image for CSS styling.
• longdesc - Detailed description of image.
• title - Title of image.
• usemap - Image map for clickable images.
• width - Width of image. Set to 0 if you want original image width.

Attribute description displays several variables:

• $id - ID of image.
• $name - Name of image.
• $author - User name who uploaded image.
• $time - Time when image was uploaded.
• $file - File name of image.
• $description - Detailed description of image.
• $width - Original width of image.
• $height - Original height of image.

Example:

 [[Screenshot(2,width=400,height=300,description=The $name by $author: $description,align=left)]]

[[ScreenshotsList]]

Displays list of all available screenshots on wiki page. Accepts one argument which is template for list items fromatting. Possible variables in this template are:

• $id - ID of image.
• $name - Name of image.
• $author - User name who uploaded image.
• $time - Time when image was uploaded.
• $file - File name of image.
• $description - Detailed description of image.
• $width - Original width of image.
• $height - Original height of image.
• $tags - Comma separated list of screenshot tags.
• $components - Comma separated list of screenshot components.
• $versions - Comma separated list of screenshot versions.

Example:

 [[ScreenshotsList($name - $description ($widthx$height))]]

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

[[ShowSmileys]]

Renders in a table the list of available smileys. Optional argument is the number of columns in the table (defaults 3).

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

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