Available Macros

[[InterTrac]]

Provide a list of known InterTrac prefixes.

[[TitleIndex]]

Inserts an alphabetic list of all wiki pages into the output.

Accepts a prefix string as parameter: if provided, only pages with names that start with the prefix are included in the resulting list. If this parameter is omitted, all pages are listed.

Alternate format and depth can be specified:

• format=group: The list of page 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.
• 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.

[[RecentChanges]]

Lists all pages that have recently been modified, grouping them by the day they were last modified.

This macro accepts two parameters. The first is a prefix string: if provided, only pages with names that start with the prefix are included in the resulting list. If this parameter is omitted, all pages are listed.

The second parameter is a number for limiting the number of pages returned. For example, specifying a limit of 5 will result in only the five most recently changed pages to be included in the list.

[[PageOutline]]

Displays a structural outline of the current wiki page, each item in the outline being a link to the corresponding heading.

This macro accepts three optional parameters:

• The first is a number or range that allows configuring the minimum and maximum level of headings that should be included in the outline. For example, specifying "1" here will result in only the top-level headings being included in the outline. Specifying "2-3" will make the outline include all headings of level 2 and 3, as a nested list. The default is to include all heading levels.
• The second parameter can be used to specify a custom title (the default is no title).
• The third parameter selects the style of the outline. This can be either inline or pullout (the latter being the default). The inline style renders the outline as normal part of the content, while pullout causes the outline to be rendered in a box that is by default floated to the right side of the other content.

[[Image]]

Embed an image in wiki-formatted text.

The first argument is the file specification. The file specification may reference attachments 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, top or bottom are interpreted as the alignment for the image
• 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.
• 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, border, width, height, alt, title, longdesc, class, id and usemap
  • border can only be a number

Examples:

    [[Image(photo.jpg)]]                           # simplest
    [[Image(photo.jpg, 120px)]]                    # with 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@…>

[[MacroList]]

Displays a list of all installed Wiki macros, including documentation if available.

Optionally, the name of a specific macro can be provided as an argument. In that case, only the documentation for that macro will be rendered.

Note that this macro will not be able to display the documentation of macros if the PythonOptimize option is enabled for mod_python!

[[TracIni]]

Produce documentation for Trac configuration file.

Typically, this will be used in the TracIni page. Optional arguments are a configuration section filter, and a configuration option name filter: only the configuration options whose section and name start with the filters are output.

[[TracGuideToc]]

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

[[TicketQuery]]

Macro that lists 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.

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)

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

[[InterWiki]]

Provide a description list for the known InterWiki prefixes.

[[TracAdminHelp]]

Displays help for trac-admin commands.

Examples:

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

[[GChart]]

Create a chart using the Google Chart API. The GChart macro is initialised with keyword arguments much like a Python function. The two required arguments are 'query' (a SQL query) and 'type' (the chart type).

You can describe your columns by passing a 'columns' list like this:

    columns = [('x', 'labels'), ('y', 'scaled', 0, 150)]

If you pass this, you must describe all columns in the output. The first tuple parameter is the axis. The second is the type, which can be one of:

• labels - this column contains data labels for this axis
• percentage - this column contains unscaled data (range 0..100)
• scaled - this column contains scaled data (arbitrary values)

If the type is 'scaled' you can also add arguments for the min and max values to scale to. Pass None to use the min/max of the range.

Other arguments are passed to the GChartWrapper plugin constructor. When rendered, the query will be executed. Each column will be sent to the Google Chart API as a dataset. Examples:

    [[GChart(query="SELECT id FROM ticket", type="line")]]
    [[GChart(query='SELECT id, time FROM ticket', type='line',                  chtt='My chart', columns=[('x', 'labels'), ('y', 'scaled')])]]

[[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 TracLinks, TracSyntaxColoring 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. 

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

[[numberedsections]]

Error: Can't get description for macro numberedsections

get_macro_description() takes exactly 1 argument (2 given)

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

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=inline	Renders an unordered list in the normal text flow (default).
format=float	A floating box out on the side of the page with slightly more detail.
format=full	Full 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.

[[ChangeLog]]

Provides the macro

   [[ChangeLog(path[,limit[,rev]])]]

which dumps the change log for path of revision rev, back limit revisions. "rev" can be 0 for the latest revision.

limit and rev may be keyword arguments

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

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

The incorrect example:

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

will be rendered as:

The correct example:

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

will be rendered as:

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:

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

[[NewsFlash]]

Makes a colored box from the contents of the macro.

[[NewsFlashStart]]

Start a newflash box.

[[NewsFlashEnd]]

End a newflash box.

[[LastModified]]

Displays the last modified time of the specified wiki page.

[[TicketStats]]

None

[[WikiCalendar]]

Inserts a small calendar where each day links to a wiki page whose name matches wiki-page-format. The current day is highlighted, and days with Milestones are marked in bold. This version makes heavy use of CSS for formatting.

Usage:

[[WikiCalendar([year, [month, [show-buttons, [wiki-page-format]]]])]]

Arguments:

1. year (4-digit year) - defaults to * (current year)
2. month (2-digit month) - defaults to * (current month)
3. show-buttons (boolean) - defaults to true
4. wiki-page-format (string) - defaults to %Y-%m-%d

Examples:

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