wiki:Doc/Wiki

Quelques recommandations pour la contribution à ces pages…

L'édition de pages avec TracWiki est très simple. Se référer à la documentation pour la description des différentes commandes de formattage. D'une façon générale, les commandes de formattage consistent en des balises au fil du texte. Les balises encadrent le texte affecté.

Balises les Plus Courantes

Les plus utiles sont :

  • marqueur de titre : =. On peut avoir jusqu'à 5 niveaux de titre. Le nombre de = détermine le niveau du titre
  • les listes à puces (comme celle-ci ) : ligne commençant par une * (ou 1. pour une liste numérotée). Noter le blanc devant et derrière le marqueur. Pour un niveau de liste donné, toutes les * doivent être alignées sur la même colonne. On peut imbriquer les listes à puces en décalant les *.
  • souligner : le texte à souligner doit être encadré par __.
  • mettre en gras : le texte à mettre en gras doit être encadré par '''
  • mettre en italique : le texte à mettre en gras doit être encadré par ''
  • exposant : met le texte en exposant
  • indice : met le texte en indice
  • tableau : chaque cellule est séparé par ||. La ligne doit commencer par ||.

On peut écrire des mots, des morceaux de phrase ou des paragraphes en mode verbatim, en mettant le texte entre {{{ et }}} ou entre `. Si les balises {{{ et }}} sont seules sur la ligne, le texte compris entre les 2 balises est mis dans une division spécifique, comme dans l'exemple suivant :

Exemple de division verbatim

à la différence de (voir le source de cette page) :

Exemple de division verbatim

Editer une Nouvelle Page

Pour éditer une nouvelle page, il suffit de lui donner un nom, soit en la référençant dans un autre document, soit en donnant son url. Si vous écrivez une nouvelle page, merci de la commencer par un titre de premier niveau et de mettre en deuxième ligne la barre de navigation. Ceci se fait de la manière suivante :

= Titre de la page =
[[TracNav]]

Si on souhaite ajouter une table des matières en tête du document, on peut ajouter l'instruction suivante :

[[TOC(inline)]]

TOC, TracNav sont des macros qui étendent les fonctionnalités de base de TracWiki. Pour plus d'information sur les macros installés au LAL, se référer à la documentation Trac sur ce site, en particulier la documentation des principaux macros.

Il est possible d'ajouter votre nouveau document dans la barre de navigation, au moyen de son menu 'edit'. Le contenu de la barre de navigation est décrit dans une page qui obéit à la même syntaxe que celle de toutes pages de TracWiki mais sa partie utile est un ensemble de liste à puces qui sera décrit ultérieurement.

Cette page est une illustration de ces quelques principes. Vous pouvez voir la syntaxe utilisée en entrant le mode édition de cette page (bouton 'Edit this page' en bas de la page). Pour vous exercer, n'hésitez pas à utiliser la page prévue à cet effet.

Balisage Avancé

Il existe d'autres instructions de balisage moins utilisées et la liste s'enrichit avec les nouvelles versions de Trac. Pour la liste complète, voir Wiki Formatting dans l'aide en ligne.

Pour ecrire une énumération, on peut utiliser la syntaxe suivante (la première ligne doit commencer par un espace) :

 liste::
  un deux trois

qui sera affiché :

liste
un deux trois

Pour faire une citation, commencer la ligne par deux espaces.

Par exemple :

  Ceci est une citation

affichera :

Ceci est une citation

La Syntaxe WikiCreole

Le wiki de Trac supporte, en plus de sa propre syntaxe, une syntaxe adoptée par plusieurs des principaux Wiki (MediaWiki, Wikipedia, DokuWiki... mais pas TWiki!), appelé WikiCreole. Si on souhaite pouvoir migrer facilement le contenu d'un wiki à un autre, il est recommendé d'utiliser plutot cette syntaxe que la syntaxe native.

De même, grâce à WikiCreole, il est possible d'importer assez facilement dans Trac des pages écrites à l'originie pour d'autres Wiki.

Last modified 14 years ago Last modified on May 7, 2010, 8:42:18 AM