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 Wiki Formatting. Its syntax is [[macro-name(optional-arguments)]].

The Wiki Processors are another kind of macros. They typically deal with alternate markup formats and transformation of larger "blocks" of information (like source code highlighting). They are used for processing the multiline {{{#!wiki-processor-name ... }}} blocks.

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

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

[[AboutWikiBoxes]]

Display a wiki page on how to use boxes.

[[AboutWikiIcons]]

Display a wiki page on how to use icons.

[[AboutWikiPhrases]]

Display a wiki page on how to use attentional phrases.

[[AllAttachments]]

Shows all attachments on the Trac site.

The first argument is the filter for which attachments to show. The filter can have the value 'ticket' or 'wiki'. Omitting the filter argument shows all attachments.

Examples:

    [[AllAttachments()]]       # Show all attachments
    [[AllAttachments(ticket)]] # Show attachments linked to tickets
    [[AllAttachments(wiki)]]   # Show attachments linked to wiki pages

[[BibAdd]]

Loads the correspondig BibTeX source provider implementing IBibSourceProvider

[[BibCite]]

Macro to cite BibTeX entries

[[BibFullRef]]

Macro to show the plugin where to place all loaded references on the page

[[BibNoCite]]

Macro to add BibTeX entries to the references, which are not cited

[[BibRef]]

Macro to show the plugin where to place the cited references on the page

[[Cards]]

Show kanban-style stacks of cards.

The arguments are:

  • stack: |-separated list of stack names. (required)
  • width: Width of the stacks. (Defaults to 400.)
  • label: |-separated list of labels shown instead of the stack names. (Defaults to the stack names.)

Example:

    [[Cards(stack=todo|active|done)]]

[[ChangeLog]]

Write repository change log to output.

The ChangeLog macro writes a log of the last changes of a repository at a given path. Following variants are possible to use:

1. [[ChangeLog(/path)]]
2. [[ChangeLog(/path@rev)]]
3. [[ChangeLog(/path@rev, limit)]]
4. [[ChangeLog(/path@from-to)]]
5. [[ChangeLog(/path, limit, rev)]]
  1. Default repository is used if reponame is left out. To show the last five changes of the default repository:
    [[ChangeLog(/)]]
    
    To show the last five changes of the trunk folder in a named otherrepo:
    [[ChangeLog(/otherrepo/trunk)]]
    
  2. The ending revision can be set. To show the last five changes up to revision 99:
    [[ChangeLog(/otherrepo/trunk@99)]]
    
  3. The limit can be set by an optional parameter. To show the last 10 changes, up to revision 99:
    [[ChangeLog(/otherrepo/trunk@99, 10)]]
    
  4. A range of revisions can be logged.
    [[ChangeLog(/otherrepo/trunk@90-99)]]
    
    To lists all changes:
    [[ChangeLog(/otherrepo/trunk@1-HEAD)]]
    
    HEAD can be left out:
    [[ChangeLog(/otherrepo/trunk@1-)]]
    
  5. For backwards compatibility, revision can be stated as a third parameter:
    [[ChangeLog(/otherrepo/trunk, 10, 99)]]
    

limit and rev may be keyword arguments.

[[ChangeLog(/otherrepo/trunk, limit=10, rev=99)]]

[[Color]]

Decorate text with colors.

Syntax:

[[Color(text, fg/bg/size)]]

where

  • text is the text to decorate. Enter a leading and/or trailing space character to surround the text with a decorated space.
  • fg/bg/size defines the foreground and background colors, and a font size. All parameters are optional and separated by slash character (/).

Colors may be specified as an RGB triplet in hexadecimal format (a hex triplet; e.g. #000 or #000000 for black); they may also be specified according to their common English names (e.g. red, green, blue etc.). See here for details.

Examples:

[[Color(Large red on yellow, red/yellow/150%)]]
[[Color(Red on yellow, red/yellow)]]
[[Color(Yellow background, /yellow)]]
[[Color(Large red, #f00/2em)]]
[[Color(Large on yellow, /yellow/20px)]]
[[Color(Text, can, have, commas, /yellow)]]
[[Color( Surrounding space is also decorated , white/red)]]

To set the foreground color for a larger block, the processor variant can be used (background color and font size may not display as expected due to the mechanisms of cascading style sheets, be advised and use the color parameter only):

{{{#!Color color=green
...
}}}

[[CommitTicketReference]]

Insert a changeset message into the output.

This macro must be called using wiki processor syntax as follows:

{{{
#!CommitTicketReference repository="reponame" revision="rev"
}}}

where the arguments are the following:

  • repository: the repository containing the changeset
  • revision: the revision of the desired changeset

[[ExtractUrl]]

Provides test macro for the tracextracturl.extract_url function.

This macro is intended for code testing by the developers of the above function and has no real usage for normal Trac users.

Macro usage: [[ExtractUrl(traclink)]]
Result: The URL extracted by extract_url

$Id: macro.py 17115 2018-04-12 21:50:07Z rjollos $

Description for extract_url()

Extracts an URL from an Wiki link, e.g. to used in macro produced HTML code.

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

$Id: extracturl.py 17115 2018-04-12 21:50:07Z rjollos $

Description

Returns an (possible relative) URL which can be used in HTML code.

If raw is true the returned link will point to a downloadable version of the linked resource otherwise the same link is returned which would be used in the resulting Wiki page.

The raw links are also usable as online resouces, e.g. if the link target is to be used as input for a flash application etc.

Usage

General:

from tracextracturl import extract_url
# ...
  url = extract_url(env, context, wikilink, raw=False)

Inside Wiki Macros:

from tracextracturl import extract_url

def MyMacro(WikiMacroBase):
  def expand_macro (self, formatter, name, content):
     # e.g. wikilink = 'wiki:WikiStart' or 'attachment:file.ext'
     url = extract_url(self.env, formatter.context, wikilink)
     rawurl = extract_url(self.env, formatter.context, wikilink, True)

Example

Inside a Trac macro called from the wiki page 'Example Page?' of project 'project1' on a multi-project trac server:

    extract_url(self.env, formatter, 'attachment:file.js', True)

will return /project1/raw-attachment/wiki/ExamplePage/file.js, which could be directly accessed by the browser inside some javascript or flash HTML object code produced by the macro.

[[Fold]]

Expands to a foldable section.

The Wiki processor content is the folded wiki text.

Wiki processor parameters:

  • title: The text in the folding header.
  • tag: The HTML element used for the title (Default: span)

Example:

    {{{#!Fold title="A title for the folded section" tag=h2
    This section of the wiki page is folded up and can be expanded by
    clicking on the title.

    This can contain any ''formatted'' **wiki** content, including macros
    and nested Fold sections.
    }}}

[[Icon]]

Shows a named icon that can be in line with text.

Syntax:

[[Icon(name, size)]]

where

  • name is the name of the icon. When name contains a pattern character (* or ?), a 2-column preview of matching icons is presented, which should mainly be used for finding and selecting an icon during wiki page editing in side-by-side mode (however, no more than 32 icons are presented to prevent exhaustive network traffic.)
  • size is optionally one of small, medium or large or an abbreviation thereof (defaults small).

Example:

[[Icon(smiley)]]

Use ShowIcons for static presentation of available icons. Smileys like :-) are automatically rendered as icons. Use ShowSmileys to se all available smileys.

Following wiki markup is equivalent to using this macro:

(|name, size|)

[[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 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, 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 Trac Links. If no value is specified, the link is simply removed.
  • 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
    • 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 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@…>

[[Include]]

A macro to include other resources in wiki pages.

More documentation to follow.

[[IncludeSource]]

Includes a source file from the repository into the Wiki.

There is one required parameter, which is the path to the file to include. This should be the repository path, not a full URL.

Optional named parameters are:

  • start The first line of the file to include. Defaults to the beginning of the file. Otherwise should be a numeric value.

Note that files start with line 1, not line 0.

  • end The last line of the file to include. Defaults to the end of the file.

Note that both 'start' and 'end' are used for array slicing the lines of the file, so if (for example) you want the last 20 lines of the file, you can use start=-20 and leave end blank.

  • rev Which revision to include. This defaults to HEAD if not supplied. Otherwise this should be a valid numeric revision number in your version control repository.
  • mimetype Which mimetype to use to determine syntax highlighting. If not supplied, this is determined by the file extension (which is normally what you want)

Examples:

    # include entire file
    [[IncludeSource(trunk/proj/file.py)]]

    # includes line 20-50 inclusive
    [[IncludeSource(trunk/proj/file.py, start=20, end=50)]]

    # includes last 30 lines of file at revision 1200
    [[IncludeSource(trunk/proj/file.py, start=-30, rev=1200)]]

    # include entire file but formatted plain
    [[IncludeSource(trunk/proj/file.py, mimetype=text/plain)]]

    # includes line 20-50 inclusive and overrides file name link
    # in header text
    [[IncludeSource(trunk/proj/file.py, start=20, end=50, header=New header text)]]

    # includes line 20-50 inclusive and overrides file name link
    # in header text, along with a specific CSS class (class must exist
    # in CSS on page; there is no provision for defining it in this macro)
    [[IncludeSource(trunk/proj/file.py, start=20, end=50, header=New header text, header_class=my_class)]]

    # includes line 20-50 inclusive, but suppresses the display of line numbers.
    # (0, no, false, and none are all honored for suppressing - case insensitive)
    [[IncludeSource(trunk/proj/file.py, start=20, end=50, line_numbers=0)]]

See Trac Links, Trac Syntax Coloring and trac/mimeview/api.py

TODO

* Fix non-localized strings

* Fix proper encoding of output

* Implement some sort of caching (especially in cases where the
revision is known and we know that the contents won't change).

* Allow multiple chunks from the file in one call. You can do this
with the existing code, but it will pull the entire file out of
version control and trim it for each chunk, so this could be
optimized a bit.  This could be done with the Ranges object

* Refactor code a bit - there are enough special cases in it now
that the expand_macro call is getting a bit unwieldy.

[[InterTrac]]

Provide a list of known Inter Trac prefixes.

[[InterWiki]]

Provide a description list for the known Inter Wiki prefixes.

[[KnownMimeTypes]]

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

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 17126 2018-04-14 09:18:09Z rjollos $

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

List tagged resources.

Usage:

[[ListTagged(<query>[,exclude=<list>],[[format=<format>],cols=<columns>])]]
format
result list presentation; supported values:
compact comma-separated inline list of "linked-description"
oldlist (default) " * linked-id description (tags)" list
table table… (see corresponding column option too)
short or other value bulleted list of "linked-description"
cols
columns for 'table' format using a "|"-separated list of column names (order matters); supported columns: realm, id, description, tags
exclude
exclude tagged resources that match a name in the colon-separated list of resource ids, accepts shell-style patterns

See tags documentation for the query syntax.

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

[[Markdown]]

Implements Markdown syntax WikiProcessor as a Trac macro.

[[NewPage]]

A macro to add scrippets to a page. Usage:

[[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 Wiki Macros 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 17133 2018-04-16 19:36:40Z rjollos $

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.

[[PdfImg]]

Insert PDFs or vector graphics like SVGs as PNG-images into a wikipage or ticket.

Requires convert from ImageMagick, convert may fail on specific files.

The handling and the parameters are inspired by LaTeX includegraphics and the trac ImageMacro.

Examples:

[[PdfImg(Book.pdf,width=400,page=100,caption="Page 100 from Book Example")]]
[[PdfImg(source:testpro/drawing.svg@10,width=600,caption="SVG-image from repository in version 10")]]
[[PdfImg(ticket:1:file.pdf)]]

Possible trac links for resource: The Location of the file can be an attachment (wikipage, ticket, svn) or a local file (keyword "file:").

trac link alternatives comment
wiki JustPageName Attachment in wikipage
ticket #1
source browser,repos
file need configuration file.prepath

Parameters:

Parameter Value default
pdffile location of PDF-file required
page Page to display 1 starting with 1
width width in pixel 600 must be absolute value
caption Caption under Image none
label anchor to link to
cache build once or each time True time consumption or changing vectorgraphics
align left|right nothing

[[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 Trac Wiki, 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]]

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

[[RecentTopics]]

Lists all topics, that have been recently active, grouping them by the day they were lastly active. Accepts two parameters: First one is a forum ID. If provided, only topics in that forum are included in the resulting list. Otherwise topics from all forums are listed. Second parameter is a number. I. e. specifying 5 will result in only the five most recently active topics to be included in the list.

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

[[ShowEntities]]

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

[[ShowIcons]]

Renders in a table a list of available icons. No more than 96 icons are displayed to prevent exhaustive network traffic.

Syntax:

[[ShowIcons(cols, name-pattern, size, header, limit)]]

where

  • cols is optionally the number of columns in the table (defaults 3).
  • name-pattern selects which icons to list (use * and ?).
  • size is optionally one of small, medium or large or an abbreviation thereof (defaults small).
  • header is optionally one of header and noheader or an abbreviation thereof (header is displayed by default)
  • limit specifies an optional upper limit of number of displayed icons (however, no more than 96 will be displayed).

The last three optional parameters (size, header and limit) can be stated in any order.

Example:

[[ShowIcons(smile*)]]              # all small icons matching smile*
[[ShowIcons(4, smile*)]]           # four columns
[[ShowIcons(smile*, 10)]]          # limit to 10 icons
[[ShowIcons(smile*, 10, nohead)]]  # no header
[[ShowIcons(smile*, m)]]           # medium-size

[[ShowPhrases]]

Renders in a table the list of known phrases that are highlighted to catch attention.

Comment: Any delimiter ():<> adjacent to a phrase will not be presented. This makes it possible to naturally write FIXME:, for example, but view the phrase highlighted without the colon (:) which would not look natural. Prefixing a phrase with ! prevents it from being highlighted.

[[ShowSmileys]]

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

Comment: Prefixing a character sequence with ! prevents it from being interpreted as a smiley.

[[ShowSymbols]]

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

[[TOC]]

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:

[[TOC]]

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

A wildcard * can be used to fetch a sorted list of all pages starting with the preceding pagename stub:

[[TOC(Trac*, WikiFormatting, WikiMacros)]]

The following control arguments change the default behaviour of the TOC macro:

Argument Description
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.
sectionindex Only display the page name and title of each page in the wiki section.
titleindex Only display the page name and title of each page, similar to Title Index.
notitle Supress display of page title.
reverse Display TOC sorted in reversed order. (Since 11.0.0.4)
from=page Obtain the list of pages to show from the content (one page name per line) of another wiki page.
nonumbering Suppress automatic numbering for inline TOC (Since 11.0.0.7)

For titleindex argument, an empty pagelist will evaluate to all pages:

[[TOC(titleindex, notitle, heading=All pages)]]

The sectionindex argument allows a title index to be generated for all pages in a given section of the wiki. A section is defined by wiki page name, using / as a section level delimiter (like directories in a file system). Giving / or * as the page name produces the same result as titleindex (title of all pages). If a page name ends with a /, only children of this page will be processed. Otherwise, the page given in the argument is also included, if it exists. For sectionindex argument, an empty pagelist will evaluate to all page below the same parent as the current page:

[[TOC(sectionindex, notitle, heading=This section pages)]]

The 'from' option allows you to read the lines of content from another wiki page and use that as the pagelist for the table of contents. The page names listed there are processed as if they are named in the TOC macro (start a line with a # to treat it as a comment). If the wiki page TOC/Guide contains

TracGuide
TracInstall
TracReports/Active

then these two calls to TOC are equivalent:

[[TOC(from=TOC/Guide)]]
[[TOC(TracGuide, TracInstall, TracReports/Active)]]

However, updating page TOC/Guide changes the TOC in all places that use from= to refer to it. This can be useful instead of custom macros like [[TracGuideToc]].

[[TagCloud]]

Display a tag cloud.

Show a tag cloud for all tags on resources matching query.

Usage:

[[TagCloud(<query>[,caseless_sort=<bool>][,mincount=<n>])]]
caseless_sort
Whether the tag cloud should be sorted case-sensitive.
mincount
Optional integer threshold to hide tags with smaller count.

See tags documentation for the query syntax.

[[TeamRoster]]

Returns project's team roster.

Usage:

# Without arguments returns current active user profiles (with enabled='1')
[[TeamRoster]]
# Returns all userProfiles with role='developer' and enabled='1'
[[TeamRoster(role='developer', enabled='1')]]
# Returns all userProfiles with name like 'someName'
[[TeamRoster(name='%someName%')]]
# Returns cbalan's profile and user profiles with role='%arh%'
[[TeamRoster({id='cbalan'},{role='%arh%'})]]
# Adds style and class attributes to box layout
[[TeamRoster(|class=someCSS_Class, style=border:1px solid green;padding:12px)]]

Please use User Profiles List? macro insted of Team Roster? macro. Keeping this for backward compatibility with TeamRosterPlugin.

[[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 Trac Query#Query Language. 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 litteral 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

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

[[TracForm]]

Docs for Trac Forms? macro…

[[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 Wiki Formatting pages, and can't be customized. Search for Toc Macro? for a a more customizable table of contents.

[[TracIni]]

Produce documentation for the Trac configuration file.

Typically, this will be used in the Trac Ini 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.

[[User]]

Sorry, no documentation found

[[UserProfilesList]]

Returns project's team roster.

Usage:

# Without arguments returns current active user profiles (with enabled='1')
[[UserProfilesList]]
# Returns all userProfiles with role='developer' and enabled='1'
[[UserProfilesList(role='developer', enabled='1')]]
# Returns all userProfiles with name like 'someName'
[[UserProfilesList(name='%someName%')]]
# Returns cbalan's profile and user profiles with role='%arh%'
[[UserProfilesList({id='cbalan'},{role='%arh%'})]]
# Adds style and class attributes to box layout
[[UserProfilesList(|class=someCSS_Class, style=border:1px solid green;padding:12px)]]

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

[[ViewTopic]]

Displays content of a discussion topic. Unless argument passed, it tries to find the topic with the same name as the current wiki page. If a name is passed, displays that topic.

[[WantedPages]]

Aliases: [[wantedPages]]

Lists all wiki pages that are linked but not created in wiki pages. Use [[WantedPages(show_referrers)]] to show referring pages.

[[WikiCalendar]]

Inserts a small calendar, where each day links to a wiki page, whose name matches the format set by wiki. The current day is highlighted, and days with a due Milestone are marked in bold.

Usage:

[[WikiCalendar([year, month, nav, wiki, base=<page.name>)]]

Arguments (all optional, but positional - order matters):

  1. year (4-digit year), defaults to * (current year)
  2. month (2-digit month), defaults to * (current month)
  3. nav (boolean) - show previous/next navigation, defaults to true
  4. wiki (valid strftime expression) - page name format, defaults to %Y-%m-%d

Keyword-only argument:

  • base (page name string) - create new pages from that template in Page Templates, defaults to '' (empty string)

Examples:

[[WikiCalendar(2006,07)]]
[[WikiCalendar(2006,07,false)]]
[[WikiCalendar(*,*,true,Meeting-%Y-%m-%d)]]
[[WikiCalendar(2006,07,false,Meeting-%Y-%m-%d)]]
[[WikiCalendar(*,*,true,Meeting-%Y-%m-%d,base=MeetingNotes)]]

[[WikiFormInclude]]

A macro to include wiki forms (wiki pages) with optional parameters.

[[WikiForms]]

Docs for Wiki Forms? wiki processor.

[[WikiTicketCalendar]]

Display Milestones and Tickets in a calendar view.

Days include links to:

  • all milestones, that are due on that day
  • all tickets, that are due on that day
  • all tickets created on that day (configurable)
  • one or more wiki pages with name matching the configured format

preparing links for creating new wiki pages from a template too

Usage:

[[WikiTicketCalendar(year, month, nav, wiki, cdate, base, query,
                     short, width)]]

Arguments (all optional, but positional - order matters):

  1. year (4-digit year), defaults to * (current year)
  2. month (2-digit month), defaults to * (current month)
  3. nav (boolean) - show previous/next navigation, defaults to true
  4. wiki (valid strftime expression) - page name format, defaults to %Y-%m-%d
  5. cdate (boolean) - show tickets created on that day too, defaults to true
  6. base (page name string) - create new pages from that template in Page Templates, defaults to '' (empty string)
  7. query (valid Trac Query) - including expressions grouped by AND (OR since 0.12) for general ticket selection, defaults to id!=0
  8. short (integer) - total ticket count per day, that will have ticket list display condensed to just ticket numbers, defaults to 0 (never condense ticket list
  9. width (valid CSS size), prefixed + forces more, defaults to 100%;

Examples:

[[WikiTicketCalendar(2006,07)]]
[[WikiTicketCalendar(2006,07,false)]]
[[WikiTicketCalendar(*,*,true,Meeting-%Y-%m-%d)]]
[[WikiTicketCalendar(2006,07,false,Meeting-%Y-%m-%d)]]
[[WikiTicketCalendar(2006,07,true,*,true)]]
[[WikiTicketCalendar(2006,07,true,Meeting-%Y-%m-%d,true,Meeting)]]

Equivalent keyword arguments are available for all but the first two arguments.

Examples:

[[WikiTicketCalendar(wiki=Talk-%Y-%m-%d,base=Talk)]]
 same as [[WikiTicketCalendar(*,*,true,Talk-%Y-%m-%d,true,Talk)]]
[[WikiTicketCalendar(wiki=Meeting-%Y-%m-%d,query=type=task)]]
[[WikiTicketCalendar(wiki=Meeting_%Y/%m/%d,short=6)]]

Mixed use of both, simple and keyword arguments is possible, while order of simple arguments (see above) still applies and keyword arguments in-between do not count for positional argument mapping.

Example:

[[WikiTicketCalendar(wiki=Meeting_%Y/%m/%d,*,*,true,width=+75%;)]]

Keyword-only argument:

  • subpages (list of page names separated by '|') - replace wiki page link per day with one link per sub-page labeled by first character of sub-page name, defaults to an empty list

Example:

[[WikiTicketCalendar(wiki=Meetings_%Y/%m/%d,
                     subpages=Morning|Afternoon)]]

[[Wikinfo]]

Output wiki page info.

Currently supported arguments:

author - Author of first version version - Latest version of page changed_by - Page last changed by comment - Latest comment of changed by changed_ts - Page last changed timestamp

[[Workflow]]

Render a workflow graph.

This macro accepts a Trac Workflow configuration and renders the states and transitions as a directed graph. If no parameters are given, the current ticket workflow is rendered. In Wiki Processors 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
    }}}

[[box]]

View wiki text in a box.

Syntax:

{{{#!box type align=... width=...
wiki text
}}}

or preferably when content is short:

[[box(wiki text, type=..., align=..., width=...)]]

where

  • type is an optional flag, or parameter, to call for attention depending on type of matter. When type is set, the box is decorated with an icon (except for news) and colored, depending on what urgency the type represents:
Urgency (box color) type
warn (red) bug, critical, error, important, stop, warning
highlight (yellow) help, information, note, question, tips
elaborate (blue) bad, chat, comment, discussion, good, no, nok, ok, talk, yes
news (green) news
normal (white) configuration, configure, details, look, magnifier, tool

type may be abbreviated as long as the abbreviation is unique for one of the keywords above.

  • align is optionally one of right, left or center. The rbox macro is an alias for align=right.
  • width is optional and sets the width of the box (defaults auto except for right aligned boxes which defaults a fixed width). width should be set when align=center for proper results.

Examples:

{{{#!box warn
= Warning
Beware of the bugs
}}}

[[box(Beware of the bugs, type=warn)]]

A style parameter is also accepted, to allow for custom styling of the box. See also the rbox, newsbox and imagebox macros (processors).

[[email]]

Aliases: [[Email]]

Email wrapping formatter

This macro takes an email message and will wrap lines to 72 characters (default), or a length specified. It will also put the emails inside a preformatted block.

Invocation:

<email stuff here>

To wrap to a specified length, the line imediately following the invocation should contain cols: followed by the number of columns at wich we wrap. For example:

<email stuff here>

It is important that the cols: starts at the beginning of the line and that only a number follows it.

[[graphviz]]

The Graphviz Plugin? (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

[[imagebox]]

Present a centered box suitable for one image.

Syntax:

{{{#!imagebox
wiki text
}}}

This box is typically used together with the Image macro:

{{{#!imagebox
[[Image(file)]]

Caption
}}}

Note that the size parameter of the Image macro may not behave as expected when using relative sizes (%).

The following parameters are also accepted:

  • align — One of right, left or center (defaults center).
  • width — Set the width of the box (defaults auto except for right aligned boxes which defaults a fixed width).
  • style — Custom styling of the box.

See also the box, rbox and newsbox macros (processors).

[[latex]]

This plugin allows embedded equations in Trac markup. Basically a port of http://www.amk.ca/python/code/mt-math to Trac.

Simply use

  {{{
  #!latex
  [latex code]
  }}}

for a block of LaTeX code.

If use_dollars is enabled in trac.ini, then you can also use $[latex formula]$ for inline math or $$[latex formula]$$ for display math.

[[lbox]]

View a left-aligned box. (This is a shorthand for box align=left)

Syntax:

{{{#!lbox type width=...
wiki text
}}}

or preferably when content is short:

[[lbox(wiki text, type=..., width=...)]]

where

  • type is an optional flag, or parameter, to call for attention depending on type of matter. When type is set, the box is decorated with an icon (except for news) and colored, depending on what urgency the type represents:
Urgency (box color) type
warn (red) bug, critical, error, important, stop, warning
highlight (yellow) help, information, note, question, tips
elaborate (blue) bad, chat, comment, discussion, good, no, nok, ok, talk, yes
news (green) news
normal (white) configuration, configure, details, look, magnifier, tool

type may be abbreviated as long as the abbreviation is unique for one of the keywords above.

  • width is optional and sets the width of the box (defaults a fixed width). Use width=auto for an automatically sized box.

Examples:

{{{#!lbox warn
= Warning
Beware of the bugs
}}}

[[lbox(Beware of the bugs, type=warn)]]

A style parameter is also accepted, to allow for custom styling of the box. See also the box, newsbox and imagebox macros (processors).

[[newsbox]]

Present a news box to the right. (This is a shorthand for rbox news)

Syntax:

{{{#!newsbox
wiki text
}}}

The following parameters are also accepted:

  • width — Set the width of the box (defaults a fixed width).
  • style — Custom styling of the box.

See also the box, rbox and imagebox macros (processors). (Comment: This box corresponds to the well-known NewsFlash macro.)

[[rbox]]

View a right-aligned box. (This is a shorthand for box align=right)

Syntax:

{{{#!rbox type width=...
wiki text
}}}

or preferably when content is short:

[[rbox(wiki text, type=..., width=...)]]

where

  • type is an optional flag, or parameter, to call for attention depending on type of matter. When type is set, the box is decorated with an icon (except for news) and colored, depending on what urgency the type represents:
Urgency (box color) type
warn (red) bug, critical, error, important, stop, warning
highlight (yellow) help, information, note, question, tips
elaborate (blue) bad, chat, comment, discussion, good, no, nok, ok, talk, yes
news (green) news
normal (white) configuration, configure, details, look, magnifier, tool

type may be abbreviated as long as the abbreviation is unique for one of the keywords above.

  • width is optional and sets the width of the box (defaults a fixed width). Use width=auto for an automatically sized box.

Examples:

{{{#!rbox warn
= Warning
Beware of the bugs
}}}

[[rbox(Beware of the bugs, type=warn)]]

A style parameter is also accepted, to allow for custom styling of the box. See also the box, newsbox and imagebox macros (processors).

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 Trac Plugins.

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 Trac Environment'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 Trac Environment'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" -silent verbose
<Hello World!>
}}}

{{{#!HelloWorld
<Hello World!>
}}}

[[HelloWorld(<Hello World!>)]]

One should get:

Hello World, text = <Hello World!> , args = {'style': u'polite', 'silent': False, 'verbose': True}
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())
Last modified 7 years ago Last modified on 2013-12-24T20:28:30+01:00