Formalisme Wiki

Formatage du texte et de liens dans Redmine.

Liens

Liens Redmine

Redmine permet les hyperliens entre demandes, changesets et pages wiki partout où le formalisme wiki est utilisé.

  • Lien vers une demande: #124 (affiche #124, le lien est barré si la demande est fermée)
  • Lien vers un changeset: r758 (affiche r758)
  • Lien vers un changeset avec un hachage non numérique: commit:c6f4d0fd (affiche c6f4d0fd). Ajouté dans r1236.

Liens wiki:

  • [[FrGuide]] affiche un lien vers la page nommée 'Guide': FrGuide
  • [[FrGuide|Manuel utilisateur]] affiche un lien vers la même page mais avec un texte différent: Manuel utilisateur
  • [[FrGuide#Guide-de-lutilisateur|Guide-de-lutilisateur]] affiche un lien vers le titre Guide-de-lutilisateur de la même page
    Guide-de-lutilisateur

Vous pouvez aussi établir des liens vers les pages wiki d'autre projets:

  • [[bacasable:une page]] affiche un lien vers la page nommée 'Une page' du wiki de Bacasable
  • [[bacasable:]] affiche un lien vers la page principale du wiki de Bacasable

Les liens wiki sont affichés en rouge lorsque la page n'existe pas encore, exemple: Page inexistante.

Liens vers d'autres ressources :

  • Documents:
    • document#17 (lien vers le document portant l'id 17)
    • document:Greetings (lien vers le document dont le titre est "Greetings")
    • document:"un document" (les guillements peuvent être utilisés lorsqu'un titre de document comporte des espaces)
    • document:autre_project:"un document" (lien vers un document dans un projet différent)
  • Versions:
    • version#3 (lien vers la version portant l'id 3)
    • version:1.0.0 (lien vers la version nommée "1.0.0")
    • version:"1.0 beta 2"
  • Projets:
    • project#<id> (lien vers le projet avec l'id <id>)
    • project:<Identifiant>
    • project:<Nom>
  • Pièces jointes:
    • attachment:fichier.zip (lien vers la pièce jointe de l'objet courant nommée fichier.zip)
    • attachment:"fichier.zip" (les guillements peuvent être utilisés quand le nom contient des caractères spéciaux)
    • Pour l'instant, seules les pièces jointes de l'objet courant peuvent être référencées (si vous êtes dans une demande, seules les pièces jointes de cette demande peuvent être référencées)
  • Fichiers du dépôt de sources
    • source:un/fichier -- Lien vers le fichier situé à /un/fichier dans le dépôt du projet
    • source:un/fichier@52 -- Lien vers la révision 52 du fichier
    • source:un/fichier#L120 -- Lien vers la ligne 120 du fichier
    • source:un/fichier@52#L120 -- Lien vers la ligne 120 de la révision 52 du fichier
    • source:"un fichier@52#L120"-- Les guillemets sont utilisés quand l'url contient des espaces
    • export:un/fichier -- Force le téléchargement du fichier

Échappement :

  • Vous pouvez empêcher les liens Redmine d'être interprêtés en les faisant précéder d'un point d'exclamation: !

Liens externes

HTTP URLs et adresses de messagerie sont automatiquement convertis en liens cliquables: HTTP URLs et adresses de messagerie peuvent être affichée avec un un autre texte que le lien lui même, voire avec une image :
  • "Site de Redmine":http://www.redmine.org -- Lien externe avec un texte différent : Site de Redmine
  • !http://www.redmine.org/attachments/7069/Redmine_logo.png(Site de Redmine)!:http://www.redmine.org -- image externe avec le titre "Site de Redmine" et lien vers l'url http://www.redmine.org

Site de Redmine

  • "Email untel":mailto:untel@foo.bar -- Email avec un texte différent: Email untel
Des instructions plus complexes peuvent être ajoutée aux liens vers les adresses de messagerie, comme un sujet par défaut, un corps de message par défaut ou des information sur les destinataires en copie carbone (cc). Ces champs doivent être encodés en RFC 3986, en particulier les espaces sont remplacés par le code %20.
  • "Email webmaster and admin":mailto:webmaster@foo.bar?cc=admin@foo.bar -- Email to webmaster, CC admin: Email webmaster and admin
  • "Email someone for help":mailto:someone@foo.bar?subject=Website%20Help -- Email link with the subject "Website Help": Email someone for help
  • "Email someone for help":mailto:someone@foo.bar?subject=Website%20Help&body=My%20problem%20is%20 -- Email link with the subject "Website Help" and a default body: Email someone for help

Formatage de texte

Pour mettre en forme le texte avec des titres, des listes, des tableaux, Redmine utilise la syntaxe Textile. Nous en donnons quelques exemples ci-dessous. Pour des mises en formes plus complexes, consultez http://redcloth.org/hobix.com/textile/ (en anglais).

Acronyme

JPL(Jean-Philippe Lang)

Affiche:

JPL

Style de police

* *gras*
* _italique_
* _*gras italique*_
* +souligné+
* -barré-
* Normal ^exposant^
* Normal ~indice~
* @inline monospace@

Affiche:

  • gras
  • italique
  • gras italique
  • souligné
  • barré
  • Normal exposant
  • Normal indice
  • inline monospace

Images en ligne

  • !image_url! affiche une image située à image_url (syntaxe textile)
  • !>image_url! image flottante à droite
  • !image_url(Image title)! Affiche une image avec les attributs titres et alt
  • !image_url!:URL Affiche une image avec un lien vers l'URL indiquée

Si vous avez attaché une image à votre page wiki, elle peut être affichée en ligne en utilisant son nom de fichier: !attached_image.png!

Titres

h1. Titre

h2. Sous-titre

h3. Sous-titre

Paragraphes

p. Aligné à gauche

  p(. retrait gauche premier niveau

    p((. retrait gauche deuxième niveau
    Pour les lignes suivantes également

                                                                                   p>. aligné à droite

                                                                        p)))>. retrait à droite de troisième niveau

                           p=. paragraphe centré

Ceci est un paragraphe centré.

ligne de séparation

----

Affiche :


Block prédéfini

Un bloc sans interprétation de la syntaxe wiki :

 <pre> *Ce texte ne devient pas gras* </pre> 

Display:

 *Ce texte ne devient pas gras* 

Citations

Débutez le paragraphe avec bq. ou > (empilables >>)

bq. Rails est un framework complet pour développer des applications reposant sur une base de données,
en conformité avec le motif Modèle-Vue-Contrôleur.
Pour démarrer, vous avez seulement besoin d'une base de données et d'un serveur web.

>>  Rails est un framework complet pour développer des applications reposant sur une base de données, en conformité avec le motif Modèle-Vue-Contrôleur.
>>Pour démarrer, vous avez seulement besoin d'une base de données et d'un serveur web.

Affiche:

Rails est un framework complet pour développer des applications reposant sur une base de données, en conformité avec le motif Modèle-Vue-Contrôleur.
Pour démarrer, vous avez seulement besoin d'une base de données et d'un serveur web.

Rails est un framework complet pour développer des applications reposant sur une base de données, en conformité avec le motif Modèle-Vue-Contrôleur.
Pour démarrer, vous avez seulement besoin d'une base de données et d'un serveur web.

Listes non ordonnées

* Item 1
* Item 2
** Item 21
** Item 22
* Item 3

affiche :

  • Item 1
  • Item 2
    • Item 21
    • Item 22
  • Item 3

Listes ordonnées

# Item 1
# Item 2
## Item 2.1
## Item 2.2
# Item 3

affiche :

  1. Item 1
  2. Item 2
    1. Item 2.1
    2. Item 2.2
  3. Item 3

Tableaux

|_.UserID     |_.Name|_.Group|_. attribute list  |
|Starting with| a    |   simple|row |
|\3=.IT               |<. align left|
|1|Artur Pirozhkov |/2.Users |>. align right|
|2|Vasya Rogov        |=. center |
|3|John Smith |Admin
               (root)|^. valign top |
|4|-          |Nobody
               (anonymous)|~. valign bottom|

affiche :
(Les espaces multiples et les tabulations sont affichées avec un unique espace):

UserID Name Group attribute list
Starting with a simple row
IT align left
1 Artur Pirozhkov Users align right
2 Vasya Rogov center
3 John Smith Admin
(root)
valign top
4 - Nobody
(anonymous)
valign bottom

Macros

Les macros permettent de définir un affichage dynamique en fonction d'autres éléments.
De nombreux plugin ajoutent leur propres macros.

Table des matières

{{toc}} => table des matières alignée à gauche
{{>toc}} => table des matières alignée à droite

Liste des macro disponibles

Redmine propose en standard les macros suivantes:

hello_world

Sample macro.

macro_list

Displays a list of all available macros, including description if available.

child_pages

Displays a list of child pages. With no argument, it displays the child pages of the current wiki page. Examples:

!{{child_pages}} -- can be used from a wiki page only
!{{child_pages(depth=2)}} -- display 2 levels nesting only
include

Include a wiki page. Example:

!{{include(Foo)}}

or to include a page of a specific project wiki:

!{{include(projectname:Foo)}}
collapse

Inserts of collapsed block of text. Example:

{{collapse(View details...)
This is a block of text that is collapsed by default.
It can be expanded by clicking a link.
}}
thumbnail

Displays a clickable thumbnail of an attached image. Examples:

{{thumbnail(image.png)}}
{{thumbnail(image.png, size=300, title=Thumbnail)}}
sample_macro

Sample macro

Coloration syntaxique

La coloration syntaxique repose sur CodeRay, une librairie rapide de coloration syntaxique écrite entièrement en Ruby. Elle supporte de nombreux langages comme c, java, html, javascript, rhtml, ruby, scheme, xml, sql...

Vous pouvez mettre en valeur le code dans vos pages wiki en utilisant cette syntaxe:

<pre><code class="ruby">
  placez votre code ici.
</code></pre>

Exemple:

# The Greeter class
class Greeter
  def initialize(name)
    @name = name.capitalize
  end

  def salute
    puts "Hello #{@name}!" 
  end
end