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.
Trac macros can also be written as TracPlugins. This gives them some capabilities that macros do not have, such as being able to directly access the HTTP request.
Example
A list of 3 most recently changed wiki pages starting with 'Trac':
[[RecentChanges(Trac,3)]]
Display:
07/12/08
Available Macros
Note that the following list will only contain the macro documentation if you've not enabled -OO optimizations, or not set the PythonOptimize option for mod_python.
[[InterTrac]]Provide a list of known InterTrac prefixes.
[[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 attributeYou 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 but is deprecated.
[[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
[[IncludeRegressedRevisionNumber]][[IncludeLongTimeRegressions]][[RegressionResults]]Display regression results. Example: {{.{
Regression results for r2428
Thu Apr 24 22:49:20 2008: cd regression; ./regress.pike reading:235 FAIL 2 C1 [1 C1] reading 1.73 101557 0 0 owl 41.38 15090218 20032 92819 ld_owl 18.10 4743116 21456 5654 optics 1.36 259862 0 2689 filllib 6.42 1208554 1593 9805 atari_atari 9.24 3315901 2542 19015 connection 8.39 3630848 0 41483 break_in 1.02 505806 719 4572 blunder 11.45 3805770 3715 18007 unconditional 1.80 38618 0 0 trevora 34.47 15220895 57205 82211 nngs1 111.09 50347534 70363 388734 strategy 92.02 35712200 73875 272529 endgame 21.78 6781571 2791 66653 heikki 1.83 877887 1347 5912 neurogo 85.48 28182084 64658 159213 arb 13.24 4648596 6968 22032 rosebud 3.32 1206318 3683 8477 golife:1 PASS C7 [C7] golife 6.46 2557764 9777 8131 arion 12.12 5130965 5748 26910 viking 26.61 11582327 16094 95863 ego 13.94 6195029 5315 57415 dniwog 21.79 7708541 19685 37740 lazarus 85.53 23681547 73222 99648 trevorb 59.02 26317661 35819 230060 strategy2:73 PASS R17 [F7|R17|P15] strategy2 110.94 39168737 89129 282418 nicklas1 64.87 21992011 51495 139183 nicklas2:902 PASS critical PASS PASS [critical (.*) (.*)] nicklas2 10.44 3841561 13479 11893 nicklas3 1.99 652846 3469 540 nicklas4 14.56 5152862 10703 39051 nicklas5 28.75 10004884 22713 55544 manyfaces 23.50 10328299 19691 84178 niki 37.71 14261687 22313 123502 trevor:261 FAIL A2 [F9] trevor 41.25 16231341 43464 92822 tactics 12.59 4907181 6094 39801 buzco 19.66 8100630 15371 41115 nngs:240 FAIL T6 [R4|S4|Q2] nngs 277.50 111942368 187032 767564 trevorc:240 FAIL K3 [K2] trevorc:820 PASS A6 [A6] trevorc 111.31 48042336 79900 439649 strategy3 84.12 27427633 58019 244642 capture 0.20 17540 0 0 connect 1.27 286534 0 3689 global 92.83 33959342 73197 214254 vie 12.87 4240880 4809 29159 arend 70.66 33264286 26531 337601 13x13 109.35 44244234 124850 350523 semeai:107 PASS D6 [D6|C7] semeai:151 FAIL alive [dead] semeai:152 FAIL dead [alive] semeai:153 FAIL alive [dead] semeai 30.79 7833140 21930 39891 STS-RV_0 0.69 54500 262 42 STS-RV_1:69 PASS 1 1 D6 [1 1 D6] STS-RV_1:77 FAIL 1 0 G3 [1 1 (.*)] STS-RV_1:175 PASS 1 1 H2 [1 1 H2] STS-RV_1:179 PASS 1 0 Q17 [1 0 Q17] STS-RV_1:187 PASS 1 1 R4 [1 1 R4] STS-RV_1:188 PASS 1 0 R4 [1 0 R4] STS-RV_1 13.16 444199 11769 250 STS-RV_e:13 PASS 1 0 PASS [1 0 PASS] STS-RV_e:14 PASS 1 0 PASS [1 0 PASS] STS-RV_e:25 PASS 1 0 PASS [1 0 PASS] STS-RV_e:26 PASS 1 0 PASS [1 0 PASS] STS-RV_e:55 PASS 1 0 PASS [1 0 PASS] STS-RV_e:56 PASS 1 0 PASS [1 0 PASS] STS-RV_e:61 PASS 1 0 PASS [1 0 PASS] STS-RV_e:62 PASS 1 0 PASS [1 0 PASS] STS-RV_e:83 PASS 1 0 PASS [1 0 PASS] STS-RV_e:84 PASS 1 0 PASS [1 0 PASS] STS-RV_e:87 PASS 1 0 PASS [1 0 PASS] STS-RV_e:88 PASS 1 0 PASS [1 0 PASS] STS-RV_e:157 PASS 1 0 PASS [1 0 PASS] STS-RV_e:158 PASS 1 0 PASS [1 0 PASS] STS-RV_e:225 PASS 1 0 B9 [1 0 B9] STS-RV_e:229 PASS 1 0 T14 [1 0 T14] STS-RV_e:230 PASS 1 1 T14 [1 1 T14] STS-RV_e:231 PASS 1 0 H18 [1 0 H18] STS-RV_e:232 PASS 1 1 H18 [1 1 H18] STS-RV_e 3.63 187393 1452 636 STS-RV_Misc:7 FAIL 1 0 T7 [1 1 N7] STS-RV_Misc:8 PASS 1 1 T7 [1 1 T7] STS-RV_Misc:46 FAIL 1 1 C17 [1 1 D19] STS-RV_Misc 6.23 899494 6149 5261 trevord:680 PASS S16 [S16] trevord 141.27 62865834 49352 664941 strategy4 158.66 62228340 109607 522810 owl1:322 FAIL 1 D1 [0] owl1:354 FAIL 1 S13 [0] owl1:356 PASS 1 L3 [1 L3] owl1:372 FAIL 0 [1 D18] owl1:388 PASS 1 A2 [1 A2] owl1:397 FAIL 1 [0] owl1 30.96 12106863 9875 119155 handtalk 54.04 22033361 34493 197622 nngs2 143.46 51034374 102843 299896 nngs3:260 PASS G12 [G12|G11] nngs3 367.14 131575949 284016 914480 nngs4 294.69 108505209 245612 742034 strategy5:290 FAIL E2 [S16|S17|T16] strategy5 79.74 32261967 66476 214412 century2002 59.28 21715034 54279 151670 auto01 2.81 1168799 905 11303 auto02 5.25 2197783 3106 23867 auto03 3.34 1720833 661 18061 auto04 1.70 780803 466 7122 auto_handtalk 5.30 1919219 2508 22392 safety 5.21 2072626 4827 24338 ninestones 257.75 85117683 199372 535838 tactics1 9.28 3398526 4751 36753 manyfaces1 33.54 13558861 29188 108947 gunnar 182.14 67978337 96407 524342 arend2 69.30 27568268 54614 207493 nando:12 PASS 0 [0] nando 27.09 10738591 12484 105606 thrash:26 PASS A1 [E1|A1] thrash:27 PASS G3 [J6|G3|H2] thrash:28 PASS G3 [A2|G3|H2] thrash:29 PASS G3 [D3|G3|H2] thrash 28.12 9766845 16178 68045 13x13b 53.67 20759585 54300 148795 joseki 14.16 6656538 11390 30848 gifu03 98.06 41605388 55093 394128 seki 5.84 407192 8646 4691 9x9:197 FAIL D8 [E8|H5] 9x9:690 FAIL E9 [H1|J4] 9x9:700 FAIL A5 [B9] 9x9 100.55 41374487 170005 153158 cgf2004 26.18 11967221 10099 112066 kgs 218.82 86194533 161408 615187 olympiad2004 87.78 34205382 61983 228202 tiny 2.56 443778 6612 104 gifu05 27.04 10277841 12856 67067 13x13c 22.61 8706172 22144 29561 Total nodes: 1701249309 3346984 12403714 Total time: 4487.80 (4596.29) Total uncertainty: 47.88 39 PASS 18 FAIL
}}.}[[goban]][[tst]][[InterWiki]]Provide a description list for the known InterWiki prefixes.
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.
For more information about developing macros, see the development resources? on the main project site.
Implementation
Here are 2 simple examples on how to create a Macro with Trac 0.11? have a look at source:trunk/sample-plugins/Timestamp.py for an example that shows the difference between old style and new style macros and also source:trunk/wiki-macros/README which provides a little more insight about the transition.
Macro without arguments
It should be saved as TimeStamp.py as Trac will use the module name as the Macro name
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, args): t = datetime.now(utc) return tag.b(format_datetime(t, '%c'))
Macro with arguments
It should be saved as HelloWorld.py (in the plugins/ directory) as Trac will use the module name as the Macro name
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, 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'`), `args` 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 `args` is `None`. """ return 'Hello World, args = ' + unicode(args) # Note that there's no need to HTML escape the returned data, # as the template engine (Genshi) will do it for us.
expand_macro details
expand_macro should return either a simple Python string which will be interpreted as HTML, or preferably a Markup object (use from trac.util.html import Markup). Markup(string) just annotates the string so the renderer will render the HTML string as-is with no escaping. You will also need to import Formatter using from trac.wiki import Formatter.
If your macro creates wiki markup instead of HTML, you can convert it to HTML like this:
text = "whatever wiki markup you want, even containing other macros" # Convert Wiki markup to HTML, new style out = StringIO() Formatter(self.env, formatter.context).format(text, out) return Markup(out.getvalue())
