List 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.
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.
Display a structural outline of the current wiki page, each item in the outline being a link to the corresponding heading.
This macro accepts three optional parameters:
- The first is a number or range that allows configuring the minimum and maximum level of headings that should be included in the outline. For example, specifying "1" here will result in only the top-level headings being included in the outline. Specifying "2-3" will make the outline include all headings of level 2 and 3, as a nested list. The default is to include all heading levels.
- The second parameter can be used to specify a custom title (the default is no title).
- The third parameter selects the style of the outline. This can be either inline or pullout (the latter being the default). The inline style renders the outline as normal part of the content, while pullout causes the outline to be rendered in a box that is by default floated to the right side of the other content.
Embed an image in wiki-formatted text.
The first argument is the file specification. The file specification may reference attachments 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.
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 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:
o align, valign, border, width, height, alt, title, longdesc, class, margin, margin-(left,right,top,bottom), id and usemap o border, margin, and margin-* can only be a single number o margin is superseded by center which uses auto margins
[[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.
A macro to include other resources in wiki pages. More documentation to follow.
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 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)
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
Generate a table of contents for the current page or a set of pages. If no arguments are given, a table of contents is generated for the current page, with the top-level title stripped:
To generate a table of contents for a set of pages, simply pass them as comma separated arguments to the TOC macro, e.g. as in
[[TOC(TracGuide, TracInstall, TracUpgrade, TracIni, TracAdmin, TracBackup, TracLogging, TracPermissions, TracWiki, WikiFormatting, TracBrowser, TracRoadmap, TracChangeset, TracTickets, TracReports, TracQuery, TracTimeline, TracRss, TracNotification)]]
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 Meaning heading=<x> Override the default heading of "Table of Contents" noheading Suppress display of the heading. depth=<n> Display headings of subsequent pages to a maximum depth of <n>. inline Display TOC inline rather than as a side-bar. 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 TitleIndex. notitle Supress display of page title.
For 'titleindex' argument, an empty pagelist will evaluate to all pages:
[[TOC(titleindex, notitle, heading=All pages)]]
'sectionindex' allows to generate a title index 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.
Else 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 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.