Description des Principaux Macros Trac

TOC(inline)

Vous avez utilisé un macro, il vous semble utile, n'hésitez pas à mettre quelques lignes décrivant son utilisation et un exemple.

Rappel : pour utiliser un macro dans une page Trac, il faut mettre le nom du macro entre [[ ]]. Si un macro reçoit des arguments, les mettre entre parenthèses après le nom du macro. Par exemle :

        [[TOC(inline)]]

BackLinks

Ce macro permet d'afficher une liste de référence à d'autres pages du projet qui référence la page indiquée en argument. Par exemple :

[[BackLinks(titleindex)]]

retourne la liste de tous les documents qui référencent une page titleindex (sans distinction minuscule/majuscule). Par exemple :

BackLinks(titleindex)

FootNote

Le Macro FootNote permet de gérer des notes de bas de page. Il permet à la fois de créer de nouvelles notes en les indexant automatiquement et de référencer une note existance en donnant son index. Il faut appeler le macro sans argument pour causer l'insertion des notes de bas de page dans le texte (à la fin du texte par exemple). Ci-dessous un exemple illustrant l'utilisation de ce macro :

Some text [[FootNote(This is a footnote)]]

This foot-note refers to the first[[FootNote(1)]].

...

Listing the foot-notes in this page:

[[FootNote]]

Image

Le macro Image permet d'afficher une image dans la page. Il peut être utilisé avec les pages WiKi ou les tickets. Les images doivent se trouver soit dans l'attachement d'une page, soit dans le repository Subversion.

Le premier argument est obligatoire et doit contenir le nom du fichier. Sans chemin, cela correspond à un fichier attaché à la page courante. Si l'image correspond à un fichier attaché à une autre page, un ticket, au repository subversion, il faut spécifier son chemin en utilisant une des notations décrites dans les exemples.

On peut indiquer d'autres paramètres pour spécifier la taille ou la position. Les différents types d'arguments possibles sont :

• Un nombre éventuellement suivi d'une unité (accolée) est interprété comme la taille ou l'échelle de l'image (ex. 120, 25%).
• right, left, top or bottom indiquent l'alignement de l'image.
• key=value indique un attribut de l'image.
• key:value indique le style de l'image.

Quelques exemples :

  [[Image(photo.jpg)]]                          # simplest
  [[Image(photo.jpg,120px)]]                    # with size
  [[Image(photo.jpg,right)]]                    # aligned by keyword
  [[Image(photo.jpg,align=right)]]              # aligned by attribute
  [[Image(photo.jpg,float:right)]]              # aligned by style
  [[Image(photo.jpg,border:solid 5px green)]]   # with any style

  [[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(file/images/bee.jpg)]]

Si on souhaite inclure des images dans la page courante sans qu'elles apparaissent dans la liste des fichiers attachés de la page, une solution est de créer une page dédiée à l'attachement des images, par exemple Images et de référencer les images de cette page.

Voilà ce que ça peut donner :

[Note : l'option size sous la forme 120px semble ne pas marcher. -CH]

TOC

TOC est un macro très puissant qui permet de construire une table des matières ou un title index.

Le macro TOC accepte les options suivantes :

Argument	Description
heading=<x>	Change la légende par défaut ("Table of Contents")
noheading	Supprime la légende
depth=<n>	Affiche les sections de niveau <= n
inline	Affiche le TOC dans le texte et non pas dans un menu
titleindex	Affiche le nom de la page et son titre (similaire à TitleIndex)

Ainsi :

        [[TOC(inline)]]

produira une table des matières de la page courante, en supprimant le titre de la page (contenu entre =), au fil du texte de la page. Sans le paramètre inline, la table des matières sera affiché dans une menu.

Tandis que :

        [[TOC(titleindex,inline)]]

affichera une liste de toutes les pages (leur nom) avec leur titre ayant le même parent que la page courante.

Dans les deux cas, les options peuvent être suivies d'une liste de pages explicite. Dans le premier cas, les sections de toutes les pages indiquées seront utilisées pour construire une table des matières unique. Dans le deuxième cas (title index), sera affiché l'ensemble des pages ayant pour parents les pages indiquées (il faut mettre un / à la fin du nom de la page si on ne veut pas afficher le parent).

Voir la liste des pages relatives à Trac pour un exemple.