Project

General

Profile

FrRedmineWikiFormatting » History » Version 9

Caille Rotie, 2015-08-21 11:40

1 1 Fabrice Phung
h1. Formalisme Wiki
2
3
{{>TOC}}
4
5 3 Caille Rotie
Formatage du texte et de liens dans Redmine.
6
7 1 Fabrice Phung
h2. Liens
8
9
h3. Liens Redmine
10
11
Redmine permet les hyperliens entre demandes, changesets et pages wiki partout où le formalisme wiki est utilisé.
12
13
* Lien vers une demande: *!#124* (affiche #124, le lien est barré si la demande est fermée)
14
* Lien vers un changeset: *!r758* (affiche r758)
15 2 Jean-Philippe Lang
* Lien vers un changeset avec un hachage non numérique: *commit:c6f4d0fd* (affiche c6f4d0fd).  Ajouté dans r1236.
16 1 Fabrice Phung
17
Liens wiki:
18
19 3 Caille Rotie
* *[[FrGuide]]* affiche un lien vers la page nommée 'Guide': [[FrGuide]]
20
* *[[FrGuide|Manuel utilisateur]]* affiche un lien vers la même page mais avec un texte différent: [[FrGuide|Manuel utilisateur]]
21
* *[[FrGuide#Guide-de-lutilisateur|Guide-de-lutilisateur]]* affiche un lien vers le titre _Guide-de-lutilisateur_ de la même page 
22
[[FrGuide#Guide-de-lutilisateur|Guide-de-lutilisateur]]
23 1 Fabrice Phung
24
Vous pouvez aussi établir des liens vers les pages wiki d'autre projets:
25
26
* *[[bacasable:une page]]* affiche un lien vers la page nommée 'Une page' du wiki de Bacasable
27
* *[[bacasable:]]* affiche un lien vers la page principale du wiki de Bacasable
28
29
Les liens wiki sont affichés en rouge lorsque la page n'existe pas encore, exemple: [[Page inexistante]].
30
31 3 Caille Rotie
Liens vers d'autres ressources :
32 1 Fabrice Phung
33
* Documents:
34
35
  * *!document#17* (lien vers le document portant l'id 17)
36
  * *!document:Greetings* (lien vers le document dont le titre est "Greetings")
37
  * *!document:"un document"* (les guillements peuvent être utilisés lorsqu'un titre de document comporte des espaces)
38 3 Caille Rotie
  * *!document:autre_project:"un document"* (lien vers un document dans un projet différent)
39 1 Fabrice Phung
40
* Versions:
41
42
  * *!version#3* (lien vers la version portant l'id 3)
43
  * *!version:1.0.0* (lien vers la version nommée "1.0.0")
44
  * *!version:"1.0 beta 2"*
45
46 3 Caille Rotie
* Projets:
47
48
  * *project#<id>* (lien vers le projet avec l'id <id>)
49
  * *!project:<Identifiant>*
50
  * *!project:<Nom>*
51
52 1 Fabrice Phung
* Pièces jointes:
53
54
  * *!attachment:fichier.zip* (lien vers la pièce jointe de l'objet courant nommée fichier.zip)
55 3 Caille Rotie
  * *!attachment:"fichier.zip"* (les guillements peuvent être utilisés quand le nom contient des caractères spéciaux)
56 1 Fabrice Phung
  * 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)
57
58 3 Caille Rotie
* Fichiers du dépôt de sources
59 1 Fabrice Phung
60 3 Caille Rotie
  * *!source:un/fichier*          -- Lien vers le fichier situé à /un/fichier dans le dépôt du projet
61
  * *!source:un/fichier@52*       -- Lien vers la révision 52 du fichier
62
  * *!source:un/fichier#L120*     -- Lien vers la ligne 120 du fichier
63
  * *!source:un/fichier@52#L120*  -- Lien vers la ligne 120 de la révision 52 du fichier
64
  * *!source:"un fichier@52#L120"*-- Les guillemets sont utilisés quand l'url contient des espaces 
65
  * *!export:un/fichier*          -- Force le téléchargement du fichier
66 1 Fabrice Phung
67 3 Caille Rotie
Échappement :
68 1 Fabrice Phung
69
* Vous pouvez empêcher les liens Redmine d'être interprêtés en les faisant précéder d'un point d'exclamation: !
70
71
h3. Liens externes
72
73 3 Caille Rotie
HTTP URLs et adresses de messagerie sont automatiquement convertis en liens cliquables: 
74
* *http&#58;//www.redmine.org* -- Lien externe vers le site de redmine : http://www.redmine.org
75
* *untel&#64;foo.bar* -- lien vers l'adresse email untel@foo.bar
76 1 Fabrice Phung
77 3 Caille Rotie
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 : 
78
* *"Site de Redmine"&#58;http&#58;//www.redmine.org* -- Lien externe avec un texte différent : "Site de Redmine":http://www.redmine.org
79
* *!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
80 1 Fabrice Phung
81 3 Caille Rotie
p=. !http://www.redmine.org/attachments/7069/Redmine_logo.png(Site de Redmine)!:http://www.redmine.org
82 1 Fabrice Phung
83 3 Caille Rotie
* *"Email untel"&#58;mailto&#58;untel&#64;foo.bar* -- Email avec un texte différent: "Email untel":mailto:untel@foo.bar
84 1 Fabrice Phung
85 3 Caille Rotie
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.
86
* *"Email webmaster and admin"&#58;mailto&#58;webmaster&#64;foo.bar?cc=admin&#64;foo.bar* -- Email to webmaster, CC admin:  "Email webmaster and admin":mailto:webmaster@foo.bar?cc=admin@foo.bar
87
* *"Email someone for help"&#58;mailto&#58;someone&#64;foo.bar?subject=Website%20Help* -- Email link with the subject "Website Help": "Email someone for help":mailto:someone@foo.bar?subject=Website%20Help
88
* *"Email someone for help"&#58;mailto&#58;someone&#64;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":mailto:someone@foo.bar?subject=Website%20Help&body=My%20problem%20is%20
89 1 Fabrice Phung
90
91 3 Caille Rotie
92 1 Fabrice Phung
h2. Formatage de texte
93
94 3 Caille Rotie
Pour mettre en forme le texte avec des titres, des listes, des tableaux, Redmine utilise la "syntaxe Textile":http://en.wikipedia.org/wiki/Textile_%28markup_language%29. Nous en donnons quelques exemples ci-dessous. Pour des mises en formes plus complexes, consultez http://redcloth.org/hobix.com/textile/ (en anglais). 
95 1 Fabrice Phung
96 3 Caille Rotie
h3. Acronyme
97
98
<pre>
99
JPL(Jean-Philippe Lang)
100
</pre>
101
102
Affiche: 
103
104
JPL(Jean-Philippe Lang)
105
106 1 Fabrice Phung
h3. Style de police
107
108
<pre><code>* *gras*
109
* _italique_
110
* _*gras italique*_
111
* +souligné+
112
* -barré-
113 3 Caille Rotie
* Normal ^exposant^
114
* Normal ~indice~
115
* @inline monospace@
116 1 Fabrice Phung
</code></pre>
117
118
Affiche:
119
120
 * *gras*
121
 * _italique_
122
 * _*gras italique*_
123
 * +souligné+
124
 * -barré-
125 7 Caille Rotie
 * Normal ^exposant^
126
 * Normal ~indice~
127
 * @inline monospace@
128 1 Fabrice Phung
129
h3. Images en ligne
130
131
* *&#33;image_url&#33;* affiche une image située à image_url (syntaxe textile)
132
* *&#33;>image_url&#33;* image flottante à droite
133 3 Caille Rotie
* *&#33;image_url(Image title)&#33;* Affiche une image avec les attributs titres et alt
134
* *&#33;image_url&#33;:URL* Affiche une image avec un lien vers l'URL indiquée
135 1 Fabrice Phung
136 3 Caille Rotie
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;*
137
138 1 Fabrice Phung
h3. Titres
139
140
<pre><code>h1. Titre
141 3 Caille Rotie
142 1 Fabrice Phung
h2. Sous-titre
143 3 Caille Rotie
144 1 Fabrice Phung
h3. Sous-titre
145
</code></pre>
146
147 8 Caille Rotie
Redmine ajoute automatiquement une ancre aux titres, vous pouvez dont y faire des liens direct en utilisant @#Titre@ ou @#Sous-titre@.
148 9 Caille Rotie
exemple : @[[RedmineTextFormatting#Tables]]@ : [[RedmineTextFormatting#Tables]]
149 8 Caille Rotie
150
On peut également spécifier une ancre particulière avec la syntaxe @h3(#my_anchor). My title@
151
152 1 Fabrice Phung
h3. Paragraphes
153
154 3 Caille Rotie
<pre><code>p. Aligné à gauche
155
156
  p(. retrait gauche premier niveau
157
158
    p((. retrait gauche deuxième niveau
159
    Pour les lignes suivantes également
160
161
                                                                                   p>. aligné à droite
162
163
                                                                        p)))>. retrait à droite de troisième niveau
164
165
                           p=. paragraphe centré
166 1 Fabrice Phung
</code></pre>
167
168
p=. Ceci est un paragraphe centré.
169
170 5 Caille Rotie
h3. ligne de séparation
171
172 6 Caille Rotie
@----@
173 5 Caille Rotie
174
Affiche : 
175
176
----
177 3 Caille Rotie
178
h3. Block prédéfini 
179
180
Un bloc sans interprétation de la syntaxe wiki :
181
<pre> <pre> *Ce texte ne devient pas gras* </pre> </pre>
182
Display:
183
184
<pre> *Ce texte ne devient pas gras* </pre>
185
186
187 1 Fabrice Phung
h3. Citations
188
189 3 Caille Rotie
Débutez le paragraphe avec *bq.* ou > (empilables >>)
190 1 Fabrice Phung
191
<pre><code>bq. Rails est un framework complet pour développer des applications reposant sur une base de données,
192
en conformité avec le motif Modèle-Vue-Contrôleur.
193
Pour démarrer, vous avez seulement besoin d'une base de données et d'un serveur web.
194 4 Caille Rotie
195
>>  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.
196
>>Pour démarrer, vous avez seulement besoin d'une base de données et d'un serveur web.
197 1 Fabrice Phung
</code></pre>
198
199
Affiche:
200
201
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.
202
Pour démarrer, vous avez seulement besoin d'une base de données et d'un serveur web.
203
204 4 Caille Rotie
>>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.
205
>>Pour démarrer, vous avez seulement besoin d'une base de données et d'un serveur web.
206 3 Caille Rotie
207
h3. Listes non ordonnées
208
209
<pre>
210
* Item 1
211
* Item 2
212
** Item 21
213
** Item 22
214
* Item 3
215
</pre>
216
217
affiche :
218
219
* Item 1
220
* Item 2
221
** Item 21
222
** Item 22
223
* Item 3
224
225
h3. Listes ordonnées
226
227
<pre>
228 1 Fabrice Phung
# Item 1
229
# Item 2
230 4 Caille Rotie
## Item 2.1
231
## Item 2.2
232 3 Caille Rotie
# Item 3
233
</pre>
234
235 1 Fabrice Phung
affiche :
236
237 3 Caille Rotie
# Item 1
238
# Item 2
239 4 Caille Rotie
## Item 2.1
240
## Item 2.2
241 3 Caille Rotie
# Item 3
242
243
h3. Tableaux
244
245
<pre>
246
|_.UserID     |_.Name|_.Group|_. attribute list  |
247
|Starting with| a    |   simple|row |
248
|\3=.IT               |<. align left|
249
|1|Artur Pirozhkov |/2.Users |>. align right|
250
|2|Vasya Rogov        |=. center |
251
|3|John Smith |Admin
252
               (root)|^. valign top |
253
|4|-          |Nobody
254
               (anonymous)|~. valign bottom|
255
</pre>
256
257
affiche :
258
(Les espaces multiples et les tabulations sont affichées avec un unique espace):
259
260
|_.UserID     |_.Name|_.Group|_. attribute list   |
261
|Starting with| a    |   simple|row |
262
|\3=.IT                |<. align left|
263
|1|Artur Pirozhkov |/2.Users |>. align right|
264
|2|Vasya Rogov         |=. center |
265
|3|John Smith |Admin
266
               (root)|^. valign top |
267
|4|-          |Nobody
268
               (anonymous)|~. valign bottom|
269
270
h2. Macros
271
272
Les macros permettent de définir un affichage dynamique en fonction d'autres éléments.
273
De nombreux plugin ajoutent leur propres macros.
274
275 1 Fabrice Phung
h3. Table des matières
276
277
<pre><code>{{toc}} => table des matières alignée à gauche
278
{{>toc}} => table des matières alignée à droite
279
</code></pre>
280
281 3 Caille Rotie
h3. Liste des macro disponibles
282 1 Fabrice Phung
283 3 Caille Rotie
Redmine propose en standard les macros suivantes:
284 1 Fabrice Phung
285
{{macro_list}}
286
287
h2. Coloration syntaxique
288
289 3 Caille Rotie
La coloration syntaxique repose sur "CodeRay":http://coderay.rubychan.de/, 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...
290 1 Fabrice Phung
291
Vous pouvez mettre en valeur le code dans vos pages wiki en utilisant cette syntaxe:
292
293
<pre><code><pre><code class="ruby">
294
  placez votre code ici.
295
</code></pre>
296
</pre></code>
297
298
Exemple:
299
300
<pre><code class="ruby">
301
# The Greeter class
302
class Greeter
303
  def initialize(name)
304
    @name = name.capitalize
305
  end
306
307
  def salute
308
    puts "Hello #{@name}!"
309
  end
310
end
311
</pre></code>