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

=== Examples ===

{{{
 [[Timestamp]]
}}}
Display:
 [[Timestamp]]

{{{
 [[HelloWorld(Testing)]]
}}}
Display:
 [[HelloWorld(Testing)]]

== 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 [wiki:TracModPython mod_python].''

{{{#!html
<dl><dt id="InterTrac-macro"><code>[[InterTrac]]</code></dt><dd><p> 
Provide a list of known <a class="wiki" href="/wiki/InterTrac">InterTrac</a> prefixes.
</p> 
</dd><dt id="TitleIndex-macro"><code>[[TitleIndex]]</code></dt><dd><p> 
Inserts an alphabetic list of all wiki pages into the output.
</p> 
<p> 
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.
</p> 
<p> 
Alternate <tt>format</tt> and <tt>depth</tt> can be specified:
</p> 
<ul><li><tt>format=group</tt>: The list of page will be structured in groups
according to common prefix. This format also supports a <tt>min=n</tt> 
argument, where <tt>n</tt> is the minimal number of pages for a group.
</li><li><tt>depth=n</tt>: 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.
</li></ul></dd><dt id="RecentChanges-macro"><code>[[RecentChanges]]</code></dt><dd><p> 
Lists all pages that have recently been modified, grouping them by the
day they were last modified.
</p> 
<p> 
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.
</p> 
<p> 
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.
</p> 
</dd><dt id="PageOutline-macro"><code>[[PageOutline]]</code></dt><dd><p> 
Displays a structural outline of the current wiki page, each item in the
outline being a link to the corresponding heading.
</p> 
<p> 
This macro accepts three optional parameters:
</p> 
<ul><li>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.
</li><li>The second parameter can be used to specify a custom title (the default
is no title).
</li><li>The third parameter selects the style of the outline. This can be
either <tt>inline</tt> or <tt>pullout</tt> (the latter being the default). The <tt>inline</tt> 
style renders the outline as normal part of the content, while <tt>pullout</tt> 
causes the outline to be rendered in a box that is by default floated to
the right side of the other content.
</li></ul></dd><dt id="Image-macro"><code>[[Image]]</code></dt><dd><p> 
Embed an image in wiki-formatted text.
</p> 
<p> 
The first argument is the file specification. The file specification may
reference attachments in three ways:
</p> 
<ul><li><tt>module:id:file</tt>, where module can be either <strong>wiki</strong> or <strong>ticket</strong>,
to refer to the attachment named <i>file</i> of the specified wiki page or
ticket.
</li><li><tt>id:file</tt>: same as above, but id is either a ticket shorthand or a Wiki
page name.
</li><li><tt>file</tt> to refer to a local attachment named 'file'. This only works from
within that wiki page or a ticket.
</li></ul><p> 
Also, the file specification may refer to repository files, using the
<tt>source:file</tt> syntax (<tt>source:file@rev</tt> works also).
</p> 
<p> 
Files can also be accessed with a direct URLs; <tt>/file</tt> for a
project-relative, <tt>//file</tt> for a server-relative, or <tt>http://server/file</tt> 
for absolute location of the file.
</p> 
<p> 
The remaining arguments are optional and allow configuring the attributes
and style of the rendered <tt>&lt;img&gt;</tt> element:
</p> 
<ul><li>digits and unit are interpreted as the size (ex. 120, 25%)
for the image
</li><li><tt>right</tt>, <tt>left</tt>, <tt>top</tt> or <tt>bottom</tt> are interpreted as the alignment for
the image
</li><li><tt>link=some TracLinks...</tt> replaces the link to the image source by the
one specified using a <a class="wiki" href="/wiki/TracLinks">TracLinks</a>. If no value is specified, the link is
simply removed.
</li><li><tt>nolink</tt> means without link to image source (deprecated, use <tt>link=</tt>)
</li><li><tt>key=value</tt> style are interpreted as HTML attributes or CSS style
indications for the image. Valid keys are:
<ul><li>align, border, width, height, alt, title, longdesc, class, id
and usemap
</li><li><tt>border</tt> can only be a number
</li></ul></li></ul><p> 
Examples:
</p> 
<pre class="wiki">    [[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
</pre><p> 
You can use image from other page, other ticket or other module.
</p> 
<pre class="wiki">    [[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.
</pre><p> 
<i>Adapted from the Image.py macro created by Shun-ichi Goto
&lt;gotoh@…&gt;</i> 
</p> 
</dd><dt id="MacroList-macro"><code>[[MacroList]]</code></dt><dd><p> 
Displays a list of all installed Wiki macros, including documentation if
available.
</p> 
<p> 
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.
</p> 
<p> 
Note that this macro will not be able to display the documentation of
macros if the <tt>PythonOptimize</tt> option is enabled for mod_python!
</p> 
</dd><dt id="TracIni-macro"><code>[[TracIni]]</code></dt><dd><p> 
Produce documentation for Trac configuration file.
</p> 
<p> 
Typically, this will be used in the <a class="wiki" href="/wiki/TracIni">TracIni</a> 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.
</p> 
</dd><dt id="TracGuideToc-macro"><code>[[TracGuideToc]]</code></dt><dd><p> 
This macro shows a quick and dirty way to make a table-of-contents
for a set of wiki pages.
</p> 
</dd><dt id="TicketQuery-macro"><code>[[TicketQuery]]</code></dt><dd><p> 
Macro that lists tickets that match certain criteria.
</p> 
<p> 
This macro accepts a comma-separated list of keyed parameters,
in the form "key=value".
</p> 
<p> 
If the key is the name of a field, the value must use the syntax 
of a filter specifier as defined in <a class="wiki" href="/wiki/TracQuery#QueryLanguage">TracQuery#QueryLanguage</a>.
Note that this is <i>not</i> the same as the simplified URL syntax 
used for <tt>query:</tt> links starting with a <tt>?</tt> character.
</p> 
<p> 
In addition to filters, several other named parameters can be used
to control how the results are presented. All of them are optional.
</p> 
<p> 
The <tt>format</tt> parameter determines how the list of tickets is
presented: 
</p> 
<ul><li><strong>list</strong> -- the default presentation is to list the ticket ID next
to the summary, with each ticket on a separate line.
</li><li><strong>compact</strong> -- the tickets are presented as a comma-separated
list of ticket IDs. 
</li><li><strong>count</strong> -- only the count of matching tickets is displayed
</li><li><strong>table</strong>  -- a view similar to the custom query view (but without
the controls)
</li></ul><p> 
The <tt>max</tt> parameter can be used to limit the number of tickets shown
(defaults to <strong>0</strong>, i.e. no maximum).
</p> 
<p> 
The <tt>order</tt> parameter sets the field used for ordering tickets
(defaults to <strong>id</strong>).
</p> 
<p> 
The <tt>desc</tt> parameter indicates whether the order of the tickets
should be reversed (defaults to <strong>false</strong>).
</p> 
<p> 
The <tt>group</tt> parameter sets the field used for grouping tickets
(defaults to not being set).
</p> 
<p> 
The <tt>groupdesc</tt> parameter indicates whether the natural display
order of the groups should be reversed (defaults to <strong>false</strong>).
</p> 
<p> 
The <tt>verbose</tt> parameter can be set to a true value in order to
get the description for the listed tickets. For <strong>table</strong> format only.
<i>deprecated in favor of the <tt>rows</tt> parameter</i> 
</p> 
<p> 
The <tt>rows</tt> parameter can be used to specify which field(s) should 
be viewed as a row, e.g. <tt>rows=description|summary</tt> 
</p> 
<p> 
For compatibility with Trac 0.10, if there's a second positional parameter
given to the macro, it will be used to specify the <tt>format</tt>.
Also, using "&amp;" as a field separator still works (except for <tt>order</tt>)
but is deprecated.
</p> 
</dd><dt id="InterWiki-macro"><code>[[InterWiki]]</code></dt><dd><p> 
Provide a description list for the known <a class="wiki" href="/wiki/InterWiki">InterWiki</a> prefixes.
</p> 
</dd><dt id="TracAdminHelp-macro"><code>[[TracAdminHelp]]</code></dt><dd><p> 
Displays help for trac-admin commands.
</p> 
<p> 
Examples:
</p> 
<pre class="wiki">[[TracAdminHelp]]               # all commands
[[TracAdminHelp(wiki)]]         # all wiki commands
[[TracAdminHelp(wiki export)]]  # the "wiki export" command
[[TracAdminHelp(upgrade)]]      # the upgrade command
</pre></dd></dl> 
}}}

== Macros from around the world ==

The [http://trac-hacks.org/ Trac Hacks] site provides a wide collection of macros and other Trac [TracPlugins 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 [http://python.org/ Python programming language].

For more information about developing macros, see the [wiki:TracDev development resources] on the main project site.


== Implementation ==

Here are 2 simple examples on how to create a Macro with [wiki:0.11 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.

=== Macro without arguments ===
It should be saved as `TimeStamp.py` as Trac will use the module name as the Macro name
{{{
from trac.core import *
from trac.wiki.macros import WikiMacroBase
from StringIO import StringIO
import time

__all__ = ['TimestampMacro']

class TimestampMacro(WikiMacroBase):
        """
        Macro for inserting timestamp

        {{{
        [[Timestamp]]
        }}}
        """
        def expand_macro(self, formatter, name, args):
                buf = StringIO()
                t = time.localtime()
                buf = "<b>%s</b>" % time.strftime('%c', t)
                return buf
}}}

=== 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
{{{
"""Example macro."""
from trac.core import *
from trac.wiki.macros import WikiMacroBase
from trac.util import escape

__all__ = ['HelloWorldMacro']

class HelloWorldMacro(WikiMacroBase):
        """
        Demo macro for a greeting with an argument.

        {{{
        [[HelloWorld(args)]]
        }}}

        """
        def expand_macro(self, formatter, name, args):
                # args will be `None` if the macro is called without parenthesis.
                txt = args or 'No arguments'

                # then, as `txt` comes from the user, it's important to guard against
                # the possibility to inject malicious HTML/Javascript, by using `escape()`:
                return 'Hello World, args = ' + escape(txt)
}}}


=== {{{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.

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(formatter.context).format(text, out)
  return Markup(out.getvalue())
}}}