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

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

Lista todas as páginas que foram modificadas recentemente, ordenadas pela data de sua última modificação.

Esta macro aceita dois argumentos ordenados e um argumento nomeado. O argumento nomeado pode ser colocado em qualquer posição dentro da lista de argumentos.

O primeiro parâmetro é uma string de prefixo: se fornecido, somente páginas que começem com esse prefixo serão incluídas na lista resultante. Se esse parâmetro for omitido, todas as páginas serão incluídas na lista.

O segundo parâmetro é o número máximo de páginas a serem incluídas na lista.

O parâmetro group (grupo) determina como a lista é mostrada:

group=date
As páginas são mostradas em uma lista de itens agrupadas por data (padrão).
group=none
As páginas são mostradas em uma única lista de itens.

Dica: se você só quer especificar um número máximo de entradas e não deseja filtrar por prefixo, especifique um primeiro parâmetro vazio, por exemplo, [[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.

[[BackLinksMenu]]

Inserts a menu with a list of all wiki pages with links to the page where this macro is used.

Accepts a page name as a parameter: if provided, pages that link to the provided page name are listed instead.

[[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 rfc2397 data URL scheme is also supported if the URL is enclosed in quotes.

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. 120px, 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.
  • inline specifies that the content generated be an inline XHTML element. By default, inline content is not generated, therefore images won't be rendered in section headings and other one-line content.
  • 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 (units are pixels).
    • 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 an image from a wiki page, ticket or other module.

[[Image(OtherPage:foo.bmp)]]    # from a wiki page
[[Image(base/sub:bar.bmp)]]     # from hierarchical wiki page
[[Image(#3:baz.bmp)]]           # from another ticket
[[Image(ticket:36:boo.jpg)]]    # from another ticket (long form)
[[Image(source:/img/bee.jpg)]]  # from the repository
[[Image(htdocs:foo/bar.png)]]   # from project htdocs dir
[[Image(shared:foo/bar.png)]]   # from shared htdocs dir (since 1.0.2)

Adapted from the Image.py macro created by Shun-ichi Goto <gotoh@…>

[[InterTrac]]

Fornece uma lista de prefixos InterTrac conhecidos.

[[InterWiki]]

Fornece uma lista de descrições para os prefixos InterWiki conhecidos.

[[KnownMimeTypes]]

Listar todos os mime-types conhecidos que podem ser usados como WikiProcessors.

Pode ser fornecido um argumento opcional que serár interpretado como um filtro mime-type.

[[MacroList]]

Mostra uma lista de todas as macros Wiki instaladas, incluindo documentação de disponível.

Opcionalmente, o nome de uma macro específica pode ser fornecido como argumento. Nesse caso, somente a documentação para essa macro será mostrada.

Observe que essa macro não será capaz de mostrar a documentação de macros se a

opção PythonOptimize estiver habilitada para o mod_python!

[[PageOutline]]

Mostra uma lista de estrutura de tópicos da página wiki corrente, cada ítem na lista sendo um link para o cabeçalho correspondente.

Essa macro aceita quatro parâmetros opcionais:

  • O primeiro é um número ou faixa de valores que permite configurar o nível mínimo e máximo de cabeçalhos que deve ser incluído na lista. Por exemplo, especificando "1" resultará em somente os cabeçalhos de nível mais alto serem incluídos na lista. Especificando "2-3" fará com que todos os cabeçalhos de nível 2 e 3 sejam incluídos em uma lista identada. O padrão é incluir todos os níveis de cabeçalho.
  • O segundo parâmetros pode ser usado para especificar um título customizado (o padrão é sem título).
  • O terceiro parâmetro seleciona o estilo da lista. Esse pode ser ou inline ou pullout (o último sendo o padrão). O estilo inline renderiza a lista como uma parte normal do conteúdo, enquanto que o estilo pullout faz com que a lista seja renderizada em uma caixa que, por padrão, flutua no lado direito do outro conteúdo.
  • O quarto parâmetro especifica se a lista será numerada ou não. Ele pode ser ou numbered ou unnumbered (o último sendo o padrão). Esse parâmetro afeta somente o estilo inline.

[[RecentChanges]]

Lista todas as páginas que foram modificadas recentemente, ordenadas pela data de sua última modificação.

Esta macro aceita dois argumentos ordenados e um argumento nomeado. O argumento nomeado pode ser colocado em qualquer posição dentro da lista de argumentos.

O primeiro parâmetro é uma string de prefixo: se fornecido, somente páginas que começem com esse prefixo serão incluídas na lista resultante. Se esse parâmetro for omitido, todas as páginas serão incluídas na lista.

O segundo parâmetro é o número máximo de páginas a serem incluídas na lista.

O parâmetro group (grupo) determina como a lista é mostrada:

group=date
As páginas são mostradas em uma lista de itens agrupadas por data (padrão).
group=none
As páginas são mostradas em uma única lista de itens.

Dica: se você só quer especificar um número máximo de entradas e não deseja filtrar por prefixo, especifique um primeiro parâmetro vazio, por exemplo, [[RecentChanges(,10,group=none)]].

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

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

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

The col parameter can be used to specify which fields should be viewed as columns. For table format only.

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

Insere uma lista alfabética de todas as páginas wiki na saída.

Aceita uma string de prefixo como parâmetro: se fornecida, somente páginas cujos nomes iniciem com o prefixo serão incluídas na lista resultante. Se esse parâmetro for omitido, todas as páginas serão listadas Se o prefixo for especificado, um segundo argumento de valor escondeprefixo também pode ser informado, de modo a remover o prefixo da saída.

Os parâmetros format e depth alternativamente podem ser especificados:

  • format=compact: As páginas são mostradas como links separados por vírgulas.
  • format=group: A lista de páginas será estruturada em grupos de acordo com o prefixo comum. Esse formato também suporta um argumento min=n onde n é o número mínimo de páginas para um grupo.
  • format=hierarchy: A lista de páginas será estruturada de acordo com o nome do caminho da página na hierarquia. Esse formato também suporta um argumento min=n onde, quanto maior o n mais plana a mostra da hierarquia
  • depth=n: limita a quantidade de páginas a serem listadas. Se atribuído para 0, somente as páginas de primeiro nível serão mostradas, se atribuído para 1, somente as páginas filhas imediatas serão mostradas, etc. Se não atribuído, ou atribuído para -1, todas as páginas na hierarquia serão mostradas.
  • include=page1:page*2: inclui somente as páginas que casam com um item na lista separada por dois pontos. Se a lista estiver vazia, ou nenhum argumento include for dado, inclui todas as páginas.
  • exclude=page1:page*2: exclui somente as páginas que casam com um item na lista separada por dois pontos.

As listas include e exclude aceitam padrões ao estilo do shell (shell-style patterns).

[[TracAdminHelp]]

Mostra a ajuda para os comandos do trac-admin.

Exemplos:

[[TracAdminHelp]]               # todos os comandos
[[TracAdminHelp(wiki)]]         # todos os comandos do wiki
[[TracAdminHelp(wiki export)]]  # o comando "wiki export" 
[[TracAdminHelp(upgrade)]]      # o comando upgrade 

[[TracGuideToc]]

Mostra um sumário para o guia do Trac.

Essa macro mostra uma maneira rápida e direta de fazer um sumário para o Help/Guide?. O sumário irá conter todas as páginas Trac* e WikiFormatting, e não pode ser customizado. Pesquise por TocMacro? para um sumário mais customizável.

[[TracIni]]

Produz documentação para o arquivo de configuração do Trac.

Tipicamente essa informação será usada na página TracIni. Argumentos opcionais são um filtro de seção de configuração, e uma opção de nome de filtro de configuração: somente as opções de configuração cuja seção e nome iniciarem com os filtros serão mostradas.

[[Workflow]]

Render a workflow graph.

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

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

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 TracEnvironment'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 TracEnvironment'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())
Última modificação 7 anos atrás Última modificação em 18/11/2013 19:42:23
 

The contents and data of this website are published under license:
Creative Commons 4.0 Brasil - Atribuir Fonte - Compartilhar Igual.