Project

General

Profile

FrRedmineWikiFormatting » History » Version 2

Jean-Philippe Lang, 2008-09-13 19:18

1 1 Fabrice Phung
h1. Formalisme Wiki
2
3
{{>TOC}}
4
5
h2. Liens
6
7
h3. Liens Redmine
8
9
Redmine permet les hyperliens entre demandes, changesets et pages wiki partout où le formalisme wiki est utilisé.
10
11
* Lien vers une demande: *!#124* (affiche #124, le lien est barré si la demande est fermée)
12
* Lien vers un changeset: *!r758* (affiche r758)
13 2 Jean-Philippe Lang
* Lien vers un changeset avec un hachage non numérique: *commit:c6f4d0fd* (affiche c6f4d0fd).  Ajouté dans r1236.
14 1 Fabrice Phung
15
Liens wiki:
16
17
* *[[Guide]]* affiche un lien vers la page nommée 'Guide': [[Guide]]
18
* *[[Guide|Manuel utilisateur]]* affiche un lien vers la même page mais avec un texte différent: [[Guide|Manuel utilisateur]]
19
20
Vous pouvez aussi établir des liens vers les pages wiki d'autre projets:
21
22
* *[[bacasable:une page]]* affiche un lien vers la page nommée 'Une page' du wiki de Bacasable
23
* *[[bacasable:]]* affiche un lien vers la page principale du wiki de Bacasable
24
25
Les liens wiki sont affichés en rouge lorsque la page n'existe pas encore, exemple: [[Page inexistante]].
26
27
Liens vers d'autres ressources (0.7):
28
29
* Documents:
30
31
  * *!document#17* (lien vers le document portant l'id 17)
32
  * *!document:Greetings* (lien vers le document dont le titre est "Greetings")
33
  * *!document:"un document"* (les guillements peuvent être utilisés lorsqu'un titre de document comporte des espaces)
34
35
* Versions:
36
37
  * *!version#3* (lien vers la version portant l'id 3)
38
  * *!version:1.0.0* (lien vers la version nommée "1.0.0")
39
  * *!version:"1.0 beta 2"*
40
41
* Pièces jointes:
42
43
  * *!attachment:fichier.zip* (lien vers la pièce jointe de l'objet courant nommée fichier.zip)
44
  * 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)
45
46
* Fichiers du dépôt
47
48
  * *source:un/fichier*          -- Lien vers le fichier situé à /un/fichier dans le dépôt du projet
49
  * *source:un/fichier@52*       -- Lien vers la révision 52 du fichier
50
  * *source:un/fichier#L120*     -- Lien vers la ligne 120 du fichier
51
  * *source:un/fichier@52#L120*  -- Lien vers la ligne 120 de la révision 52 du fichier
52
  * *export:un/fichier*          -- Force le téléchargement du fichier
53
54
Echappement (0.7):
55
56
* Vous pouvez empêcher les liens Redmine d'être interprêtés en les faisant précéder d'un point d'exclamation: !
57
58
h3. Liens externes
59
60
HTTP URLs et adresses de messagerie sont autoamtiquement convertis en liens cliquables: 
61
62
<pre>
63
http://www.redmine.org, untel@foo.bar
64
</pre>
65
66
affiche: http://www.redmine.org, untel@foo.bar
67
68
Si vous voulez afficher un texte spécifique à la place de l'URL, vous pouvez utiliser la syntaxe textile standarde:
69
70
<pre>
71
"site web Redmine":http://www.redmine.org
72
</pre>
73
74
affiche: "site web Redmine":http://www.redmine.org
75
76
h2. Formatage de texte
77
78
Pour les choses du genre titres, gas, tableaux, listes, Redmine supporte la syntaxe Textile. Voir http://hobix.com/textile/ pour 
79
information sur l'utilisation de ces fonctionnalités. Quelques exemples sont proposés ci-dessous, mais le moteur est capable de bien plus.
80
81
h3. Style de police
82
83
<pre><code>* *gras*
84
* _italique_
85
* _*gras italique*_
86
* +souligné+
87
* -barré-
88
</code></pre>
89
90
Affiche:
91
92
 * *gras*
93
 * _italique_
94
 * _*gras italique*_
95
 * +souligné+
96
 * -barré-
97
98
h3. Images en ligne
99
100
* *&#33;image_url&#33;* affiche une image située à image_url (syntaxe textile)
101
* *&#33;>image_url&#33;* image flottante à droite
102
* Si vous avez attaché une image à votre page wiki, elle peut être affichée en ligne en utilisant son nom de fichier: *&#33;attached_image.png&#33;*
103
104
h3. Titres
105
106
<pre><code>h1. Titre
107
h2. Sous-titre
108
h3. Sous-titre
109
</code></pre>
110
111
h3. Paragraphes
112
113
<pre><code>p>. aligné à gauche
114
p=. centré
115
</code></pre>
116
117
p=. Ceci est un paragraphe centré.
118
119
h3. Citations
120
121
Débutez le paragraphe avec *bq.*
122
123
<pre><code>bq. Rails est un framework complet pour développer des applications reposant sur une base de données,
124
en conformité avec le motif Modèle-Vue-Contrôleur.
125
Pour démarrer, vous avez seulement besoin d'une base de données et d'un serveur web.
126
</code></pre>
127
128
Affiche:
129
130
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.
131
Pour démarrer, vous avez seulement besoin d'une base de données et d'un serveur web.
132
133
h3. Table des matières
134
135
<pre><code>{{toc}} => table des matières alignée à gauche
136
{{>toc}} => table des matières alignée à droite
137
</code></pre>
138
139
h2. Macros
140
141
Redmine propose d'emblée les macros suivantes:
142
143
{{macro_list}}
144
145
h2. Coloration syntaxique
146
147
La coloration syntaxique repose sur "CodeRay":http://coderay.rubychan.de/, une librairie rapide de coloration syntaxique écrite entièrement en Ruby. Elle supporte actuellement les langages c, html, javascript, rhtml, ruby, scheme, xml.
148
149
Vous pouvez mettre en valeur le code dans vos pages wiki en utilisant cette syntaxe:
150
151
<pre><code><pre><code class="ruby">
152
  placez votre code ici.
153
</code></pre>
154
</pre></code>
155
156
Exemple:
157
158
<pre><code class="ruby">
159
# The Greeter class
160
class Greeter
161
  def initialize(name)
162
    @name = name.capitalize
163
  end
164
165
  def salute
166
    puts "Hello #{@name}!"
167
  end
168
end
169
</pre></code>