wiki:WikiMacros

Version 2 (modified by trac, 8 years ago) (diff)

--

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

2013-03-11

2013-02-18

[[RecentChanges?(Trac,3)]]

[[RecentChanges]]

List all pages that have recently been modified, ordered by the time they were last modified.

This macro accepts two ordered arguments and a named argument. The named argument can be placed in any position within the argument list.

The first parameter 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 included in the list.

The second parameter is the maximum number of pages to include in the list.

The group parameter determines how the list is presented:

group=date
The pages are presented in bulleted lists that are grouped by date (default).
group=none
The pages are presented in a single bulleted list.

Tip: if you only want to specify a maximum number of entries and don't want to filter by prefix, specify an empty first parameter, e.g. [[RecentChanges(,10,group=none)]].

[[?]]

[[Image]]

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

[[InterTrac]]

Provide a list of known InterTrac prefixes.

[[InterWiki]]

Provide a description list for the known InterWiki prefixes.

[[KnownMimeTypes]]

List all known mime-types which can be used as WikiProcessors. Can be …

etc.

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.

[[AddComment]]

A macro to add comments to a page. Usage:

[[AddComment]]

The macro accepts one optional argument that allows appending to the wiki page even though user may not have modify permission:

[[AddComment(appendonly)]]

[[BlogList]]

A macro to display list of posts and extracts outside (or inside) the Blog module - most commonly Wiki pages.

All arguments are optional:

[[BlogList]]

Available named arguments:

  • recent= - max. number of posts
  • category= - a category
  • author= - an author
  • period= - time period of the format YYYY/MM
  • heading= - a heading for the list
  • format= - type of display (see below for details)
  • max_size= - max. number of characters to render for each post
  • meta= - use =off to hide date, author and categories (default 'on')

Example showing some available named arguments:

[[BlogList(recent=5, max_size=250, period=2007/12, author=osimons, format=float, heading=Some Trac Posts)]]

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=inlineRenders an unordered list in the normal text flow (default).
format=floatA floating box out on the side of the page with slightly more detail.
format=fullFull 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.

[[CSV]]

Display CSV data in a table. Simply copy and paste the CSV data into the macro body and hope for the best.

Example:

{{{
#!CSV
123 123     123     123
234 234     234     234
}}}

Renders as

123 123 123 123
234 234 234 234

[[CodeExample]]

Render a code example box that supports syntax highlighting. It support three types of examples: simple, correct, and incorrect. The SELECT ALL link highlights all of the code in the box to simplify the copy and paste action.

The simple example:

{{{
#!CodeExample
#!python
@staticmethod
def get_templates_dirs():
    """ Notify Trac about templates dir. """
    from pkg_resources import resource_filename
    return [resource_filename(__name__, 'templates')]
}}}

will be rendered as:

/chrome/ce/img/example1.png

The incorrect example:

{{{
#!CodeExample
## type = bad
#!haskell
fibs = 0 : 1 : [ a + b | a <- fibs | b <- tail fibs ]
}}}

will be rendered as:

/chrome/ce/img/example2.png

The correct example:

{{{
#!CodeExample
## type = good
#!haskell
fibs = 0 : 1 : zipWith (+) fibs (tail fibs)
}}}

will be rendered as:

/chrome/ce/img/example3.png

There is also support for getting sources from the repository:

{{{
#!CodeExample
## path=GPGMail/Source/GPGMailPreferences.m
## regex=".*updater\s*{"
## lines=3
#!objective-c
}}}

will be rendered as:

/chrome/ce/img/example4.png

Parameters:

  • type - (optional) a type of the example: simple (default), good, bad
  • title - (optional) the title of the example
  • path - (optional) a file in the repository (using TracLinks format for source code)
  • repo - (optional) repository to use (Trac 0.12 and upper only)
  • regex - (optional) a regular expression indicates where to start an example
  • lines - (optional) number of lines to show

[[Embed]]

Macro produces html code for embedding flash content from certain service, by it's 'key' and content id. It also can embed simple SWF by it's URL.

Syntax and examples:

 [[Embed(youtube=emYqURahUKI)]]
 [[Embed(vimeo=3840952,w=400,h=300)]]
 [[Embed(swf=http://media.nadprof.org/flash/rudy/flowers/flowers.swf,w=500,h=400)]]
 [[Embed(flv=video.flv,purl=/jwplayer.swf,w=500,h=400)]]

Available keys:

Optional parameters:

  • w and h: width and height of embedded flash object

[[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 rfc2397 data URL scheme is also supported if 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, 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.
  • inline specifies 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.
  • nolink means without link to image source (deprecated, use link=)
  • key=value style 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, and margin-* can only be a single number (units are pixels).
    • margin is superseded by center which 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@…>

[[Include]]

A macro to include other resources in wiki pages. More documentation to follow.

[[IncludePages]]

Inserts the contents of another wiki page. It takes one mandatory item and two optional positional items. The mandatory item is the page name. The optional items are the class of the generated heading and the class of the div surrounding the included page. If the first positional item is missing, no heading will be generated. If the second is missing, no div will be generated.

Example:

[[IncludePages(Foo)]]
[[IncludePages(Foo,headclass)]]
[[IncludePages(Foo,headclass,blockclass)]]

[[InterTrac]]

Provide a list of known InterTrac prefixes.

[[InterWiki]]

Provide a description list for the known InterWiki prefixes.

[[KnownMimeTypes]]

List all known mime-types which can be used as WikiProcessors.

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

[[LastChangesBy]]

This macro prints a table similar to the [[ListOfWikiPages]] only with the By column missing and the author name in the table head.

[[LastChangesBy(martin_s)]]          # the last 5 changes by user `martin_s`
[[LastChangesBy(martin_s,10)]]       # the last 10 changes by user `martin_s`

[[LastChangesBy]]                    # or
[[LastChangesBy()]]                  # the last 5 changes by the current user (i.e. every user sees it's own changes, if logged-on)
[[LastChangesBy(,12)]]               # the last 12 changes by the current user

[[LastChangesBy(...,format=...]]     # Selects `long` or `short` table format
[[LastChangesBy(...,from=..,to=..]]  # Selects `from` and `to` time/date range

[[LastChangesBy(...,headline=...]]   # Overwrites headline, may not contain `','`

[[LastChangesBy(...,order=reverse]]  # Lists the wikis in reverse order. Only really useful with few wikis or with `to`/`from`.

[[LastChangesBy(..,exclude=pattern]] # Excludes wikis matching `pattern`. Wildcards `*` and `?` are supported.

[[ListOfWikiPages]]

Description

Website: http://trac-hacks.org/wiki/ListOfWikiPagesMacro

$Id: macro.py 7975 2010-05-21 14:19:27Z martin_s $

The macro ListOfWikiPages prints a table of all (user generated, i.e. non-trac-default) wiki pages with last changed date and author as requested in Request-a-Hack th:#2427. Version 0.2 provides also a long format which also includes the newest version number and links to the difference and the history as well as the last comment. This was requested by th:#4717.

The second macro provided by this package is LastChangesBy which prints the last changes made by the given user or the logged-in user if no username is given.

Usage

You can use the ListOfWikiPages macro like this:

[[ListOfWikiPages]]                     # default format as configured in the config file
[[ListOfWikiPages(format=short)]]       # short format
[[ListOfWikiPages(format=long)]]        # long format (new v0.2)

which prints a table of all wiki pages, or with a list of wiki pages:

[[ListOfWikiPages(ThatWikiPage,ThisWikiPage,AnotherWikiPage,format=...)]]

Since v0.3 the optional arguments from and to can be used to specify a time/date range as requested by th:#5344. The values of this arguments are taken as negative offsets to the current time (i.e. the time the wiki page is displayed). Allowed is a number followed by a unit which can be s,m,h,d,w,o,y for seconds, minutes, hours, days, weeks, month and years. If the unit is missing seconds are assumed.

[[ListOfWikiPages(from=3d)]]            # displays all wiki pages changed in the last three days
[[ListOfWikiPages(to=15m)]]             # displays all wiki pages was where changed longer than 15 minutes ago
[[ListOfWikiPages(from=4.5w,to=15h)]]   # displays all wiki pages was where changed between 4 1/2 week and 15 hours ago

A headline can be given using a headline argument:

[[ListOfWikiPages(headline=Headline text without any comma)]]     # sets a table headline, may not contain '`,`'

The order can be reversed, i.e. list the oldest wikis first, using:

[[ListOfWikiPages(order=reverse)]]

Unwanted wiki ranges (e.g. Trac*) can be excluded by the exclude=pattern option which can be given multiple times. The wildcards '*' (matches everything) and '?' (matches a single character) can be used in the pattern. (Requested by #6074)

[[ListOfWikiPages(exclude=Trac*,exclude=abc?)]]

[[ListTagged]]

Sorry, no documentation found

[[MacroChain]]

Chain together multiple macros.

This macro allows you to chain together multiple macros; that is, feed the output from one macro to the input of the next. Usually the second and subsequent macros will be WikiProcessors, but this is not a requirement (if they aren't then the output from the previous macro will be treated as the arguments to the next macro).

Arguments: a comma-separated list of macro names; the first macro may also have a list of arguments enclosed in parentheses. Any known macro may be specified, including all the wiki processors.

Examples:

  [[MacroChain(macro1, macro2, macro3, macro4)]]
  [[MacroChain(Include(http://www.example.com/), text/html)]]  # Same as MimeInclude macro
  [[MacroChain(Include(http://www.example.com/foo.csv), CsvMacro)]]
  [[MacroChain(Xslt(graph.xslt, doc.xml), graphviz.dot)]]

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

[[NoteBox]]

The NoteBox macro will render a small colored box with an icon and text.

To display a NoteBox on a page, you must call the NoteBox macro and pass the style and text as arguments. The text may contain wiki formatting, however it is not possible to embed other wiki macros within the macro. Also, commas must be escaped with a backslash.

A third optional argument allows the width of the NoteBox to be specified. The width can be specified in pixels as a percent of the page width. The default width is 70%.

The following styles are available: warn, tip and note.

Examples:

[[NoteBox(warn,If you don't run `update` before `commit`\, your checkin may fail.)]]
[[NoteBox(tip,The !NoteBox macro can bring '''attention''' to text within a page.,50%)]]
[[NoteBox(note,More styles may be added in a ''future'' release.,350px)]]

If you don't run update before commit, your checkin may fail.

The NoteBox macro can bring attention to text within a page.

More styles may be added in a future release.

[[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 four 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.
  • The fourth parameter specifies whether the outline is numbered or not. It can be either numbered or unnumbered (the former being the default). This parameter only has an effect in inline style.

[[ParseArgsTest]]

Test macro for tracadvparseargs.parse_args function.

This macro is intended to be used by the developers of the above function to simplify the testing process and has no real value for normal Trac users.

Macro usage

[[ParseArgsTest(parser_options|||arguments_to_parse)]]

will call

parse_args(arguments_to_parse, **parser_options)

and will display its return value. See below for the list of parser options.

Example

[[ParseArgsTest(strict=True,delquotes=True|||key1=val1,key2="val2a,val2b")]]

will call

parse_args('key1=val1,key2="val2a,val2b"', strict=True, delquotes=True)

Description for parse_args()

Website: http://trac-hacks.org/wiki/AdvParseArgsPlugin

This function is used in WikiMacros to parse the macro arguments. This enhanced version is meant as a replacement of trac.wiki.macros.parse_args and supports several advanced options (see section #Parameters). The most important feature is the support for quoting the delimiter, e.g. 'key1=val1,key2="some,text",key3=val3' will correctly return 'some,text' as the value of key2. The original parse_args function would return '"some' and handle 'text"' as separate argument.

$Id: parseargs.py 8541 2010-08-30 21:57:20Z martin_s $

Documentation

Definition

def parse_args (args, strict = True, multi = False, listonly = False, minlen = 0,
        quotechar = '"', escchar = '\\', delim = ',', delquotes = False)

Usage Example

# Instead of: from trac.wiki.macros import parse_args
# Use:
from tracadvparseargs import parse_args

class SomeMacro(WikiMacroBase):
    def expand_macro(self, formatter, name, args):
        largs, kwargs = parse_args( args, <options> )

Parameters

args
The argument string; 'content' in `expand_macro.
strict
Enables strict checking of keys.
multi
Enables folding of muliple given keys into list.
If set to True, values of multiple given keys will be returned as list, but single given keys will return a scalar.
If set to a list, only the values of the listed keys will be returned as list, but always as list even when there is only one value.
If this list contains '*', all values are always returned as list.
listonly
If true only a list is returned, no directionary.
minlen
Extend returned list to given minimum length. Only used when listonly=True.

Parser parameters

quotechar
The quote character to be used.
escchar
The escape character to be used.
delim
The delimiter character to be used.
delquotes
Selects if quotes should be removed.

[[RecentChanges]]

List all pages that have recently been modified, ordered by the time they were last modified.

This macro accepts two ordered arguments and a named argument. The named argument can be placed in any position within the argument list.

The first parameter 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 included in the list.

The second parameter is the maximum number of pages to include in the list.

The group parameter determines how the list is presented:

group=date
The pages are presented in bulleted lists that are grouped by date (default).
group=none
The pages are presented in a single bulleted list.

Tip: if you only want to specify a maximum number of entries and don't want to filter by prefix, specify an empty first parameter, e.g. [[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

(since 0.12)

[[SQLScalar]]

Output a number from a scalar (1x1) SQL query.

Examples:

    {{{
    #!SQLScalar
        SELECT count(id) as 'Number of Tickets'
        FROM ticket
    }}}

[[SQLTable]]

Draw a table from a SQL query in a wiki page.

Examples:

    {{{
    #!SQLTable
        SELECT count(id) as 'Number of Tickets'
        FROM ticket
    }}}

[[TagCloud]]

Sorry, no documentation found

[[TicketBox]]

Display list of ticket numbers in a box on the right side of the page. The purpose of this macro is show related tickets compactly. You can specify ticket number or report number which would be expanded as ticket numbers. Tickets will be displayed as sorted and uniq'ed.

Example:

[[TicketBox(#1,#7,#31)]]               ... list of tickets
[[TicketBox(1,7,31)]]                  ... '#' char can be omitted
[[TicketBox({1})]]                     ... expand report result as ticket list
[[TicketBox([report:1])]]              ... alternate format of report
[[TicketBox([report:9?name=val])]]     ... report with dynamic variable
[[TicketBox([query:status=new])]]]     ... query string
[[TicketBox({1},[query:status=new])]]  ... conbination
[[TicketBox(500pt,{1})]]               ... with box width as 50 point
[[TicketBox(200px,{1})]]               ... with box width as 200 pixel
[[TicketBox(25%,{1})]]                 ... with box width as 25%
[[TicketBox(width=25%,{1})]]           ... another style for with
[[TicketBox(float=left,{1})]]          ... place box on the left
[[TicketBox(background=yellow,{1})]]   ... set background color as yellow
[[TicketBox('Hello, world',#1,#2)]]    ... Specify title
[[TicketBox("Other Title",#1,#2)]]     ... likewise
[[TicketBox('%d tickets',#1,#2)]]      ... embed ticket count in title
[[TicketBox({1}, inline)]]             ... display the box as block element.
[[TicketBox({1}, summary)]]            ... display with summary per line
[[TicketBox({1}, summary=Titre)]]      ... specify field name of summary
[[TicketBox({1}, ticket=ID)]]          ... specify sql field name of ticket num.
[[TicketBox({1}, nosort)]]             ... display numbers without sort
[[TicketBox({1}, inline_total)]]       ... inline text of total number /wo box.

Dynamic Variables is supported for report. Variables can be specified like [report:9?PRIORITY=high&COMPONENT=ui]. Of course, the special variable '$USER' is available. The login name (or 'anonymous) is used as $USER if not specified explicitly.

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

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.
  • 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 no include argument 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]]

Display 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

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

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

[[TracJSGanttChart]]

Displays a Gantt chart for the specified tickets.

The chart display can be controlled with a number of macro arguments:

ArgumentDescriptionDefault
formatsWhat to display in the format control. A pipe-separated list of minute, hour, day, week, month, and quarter (though minute may not be very useful). 'day|week|month|quarter'
formatInitial display format, one of those listed in formats First format
sampleDisplay sample tasks (1) or not (0) 0
resShow resource column (1) or not (0) 1
durShow duration colunn (1) or not (0) 1
compShow percent complete column (1) or not (0) 1
captionCaption to place to right of tasks: None, Caption, Resource, Duration, %Complete Resource
startDateShow start date column (1) or not (0) 1
endDateShow end date column (1) or not (0) 1
dateDisplayDate display format: 'mm/dd/yyyy', 'dd/mm/yyyy', or 'yyyy-mm-dd' 'mm/dd/yyyy'
openLevelNumber of levels of tasks to show. 1 = only top level task. 999
colorByField to use to choose task colors. Each unique value of the field will have a different color task. Other likely useful values are owner and milestone but any field can be used. priority
rootWhen using something like Subtickets plugin to maintain a tree of tickets and subtickets, you may create a Gantt showing a ticket and all of its descendants with root=<ticket#>. The macro uses the configured parent field to find all descendant tasks and build an id= argument for Trac's native query handler.

Multiple roots may be provided like root=1|12|32.

When used in a ticket description or comment, root=self will display the current ticket's descendants.
None
goalWhen using something like MasterTickets? plugin to maintain ticket dependencies, you may create a Gantt showing a ticket and all of its predecessors with goal=<ticket#>. The macro uses the configured succ field to find all predecessor tasks and build an id= argument for Trac's native query handler.

Multiple goals may be provided like goal=1|12|32.

When used in a ticket description or comment, goal=self will display the current ticket's predecessors.
None
lwidthThe width, in pixels, of the table of task names, etc. on the left of the Gantt.
showdepShow dependencies (1) or not (0)1
userMapMap user !IDs to full names (1) or not (0).1
omitMilestonesShow milestones for displayed tickets (0) or only those specified by milestone= (1)0
scheduleSchedule tasks based on dependenies and estimates. Either as soon as possible (asap) or as late as possible (alap)alap
doResourceLevelingResolve resource conflicts (1) or not (0) when scheduling tickets.0
displayFilter for limiting display of tickets. owner:fred shows only tickets owned by fred. status:closed shows only closed tickets.None
orderOrder of fields used to sort tickets before display. order=milestone sorts by milestone. May include ticket fields, including custom fields, or "wbs" (work breakdown structure).wbs

Site-wide defaults for macro arguments may be set in the trac-jsgantt section of trac.ini. option.<opt> overrides the built-in default for <opt> from the table above.

All other macro arguments are treated as TracQuery specification (e.g., milestone=ms1|ms2) to control which tickets are displayed.

[[VisitCounter]]

Macro displays how many times was wiki page displayed.

This macro accepts up to tree parameters. First parameter is wiki page name which visit count you want to display. If no parameters specified current page visit count is displayed. Second parameter determines if displaying of macro should update specified page visit count. Accepted values of this parameter are: True, False, true, false, 1, 0. Default value is true. Third parameter specifies number of digits for visit count display. If its value is 0 then visit count is displayed as simple text. Default value is 4.

Examples:

 [[VisitCounter(WikiStart)]]
 [[VisitCounter(WikiStart, True)]]
 [[VisitCounter(WikiStart, True, 3)]]

[[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 WikiProcessors mode the width and height arguments can be specified.

(Defaults: width = 800 and heigth = 600)

Examples:

    [[Workflow()]]

    [[Workflow(go = here -> there; return = there -> here)]]

    {{{
    #!Workflow width=700 height=700
    leave = * -> *
    leave.operations = leave_status
    leave.default = 1

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

[[ZhTracGuideToc]]

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.

[[graphviz]]

The GraphvizPlugin? (http://trac-hacks.org/wiki/GraphvizPlugin) provides a plugin for Trac to render graphviz (http://www.graphviz.org/) graph layouts within a Trac wiki page.

[[graphviz.dot/png]]

Aliases: [[graphviz.dot/jpg]] [[graphviz.dot/gif]] [[graphviz.dot/svg]] [[graphviz.dot/svgz]] [[graphviz.dot]] [[graphviz.neato/png]] [[graphviz.neato/jpg]] [[graphviz.neato/gif]] [[graphviz.neato/svg]] [[graphviz.neato/svgz]] [[graphviz.neato]] [[graphviz.twopi/png]] [[graphviz.twopi/jpg]] [[graphviz.twopi/gif]] [[graphviz.twopi/svg]] [[graphviz.twopi/svgz]] [[graphviz.twopi]] [[graphviz.circo/png]] [[graphviz.circo/jpg]] [[graphviz.circo/gif]] [[graphviz.circo/svg]] [[graphviz.circo/svgz]] [[graphviz.circo]] [[graphviz.fdp/png]] [[graphviz.fdp/jpg]] [[graphviz.fdp/gif]] [[graphviz.fdp/svg]] [[graphviz.fdp/svgz]] [[graphviz.fdp]] [[graphviz/png]] [[graphviz/jpg]] [[graphviz/gif]] [[graphviz/svg]] [[graphviz/svgz]]

Sorry, no documentation found

[[plantuml]]

Aliases: [[PlantUml]] [[PlantUML]]

A wiki processor that renders PlantUML diagrams in wiki text.

Example:

{{{
#!PlantUML
@startuml
Alice -> Bob: Authentication Reque
st
Bob --> Alice: Authentication Response
Alice -> Bob: Another authentication Request
Alice <-- Bob: another authentication Response
@enduml
}}}

Results in:

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:

from genshi.core import Markup
from trac.wiki.macros import WikiMacroBase
from trac.wiki import Formatter
import StringIO

class HelloWorldMacro(WikiMacroBase):
        def expand_macro(self, formatter, name, text, args):
                text = "whatever '''wiki''' markup you want, even containing other macros"
                # Convert Wiki markup to HTML, new style
                out = StringIO.StringIO()
                Formatter(self.env, formatter.context).format(text, out)
                return Markup(out.getvalue())