Project

General

Profile

FrRedmineWikiFormatting » History » Version 10

Toshi MARUYAMA, 2015-11-02 13:07
remove h3(#my_anchor) (#20987)

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 1 Fabrice Phung
h3. Paragraphes
151
152 3 Caille Rotie
<pre><code>p. Aligné à gauche
153
154
  p(. retrait gauche premier niveau
155
156
    p((. retrait gauche deuxième niveau
157
    Pour les lignes suivantes également
158
159
                                                                                   p>. aligné à droite
160
161
                                                                        p)))>. retrait à droite de troisième niveau
162
163
                           p=. paragraphe centré
164 1 Fabrice Phung
</code></pre>
165
166
p=. Ceci est un paragraphe centré.
167
168 5 Caille Rotie
h3. ligne de séparation
169
170 6 Caille Rotie
@----@
171 5 Caille Rotie
172
Affiche : 
173
174
----
175 3 Caille Rotie
176
h3. Block prédéfini 
177
178
Un bloc sans interprétation de la syntaxe wiki :
179
<pre> <pre> *Ce texte ne devient pas gras* </pre> </pre>
180
Display:
181
182
<pre> *Ce texte ne devient pas gras* </pre>
183
184
185 1 Fabrice Phung
h3. Citations
186
187 3 Caille Rotie
Débutez le paragraphe avec *bq.* ou > (empilables >>)
188 1 Fabrice Phung
189
<pre><code>bq. Rails est un framework complet pour développer des applications reposant sur une base de données,
190
en conformité avec le motif Modèle-Vue-Contrôleur.
191
Pour démarrer, vous avez seulement besoin d'une base de données et d'un serveur web.
192 4 Caille Rotie
193
>>  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.
194
>>Pour démarrer, vous avez seulement besoin d'une base de données et d'un serveur web.
195 1 Fabrice Phung
</code></pre>
196
197
Affiche:
198
199
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.
200
Pour démarrer, vous avez seulement besoin d'une base de données et d'un serveur web.
201
202 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.
203
>>Pour démarrer, vous avez seulement besoin d'une base de données et d'un serveur web.
204 3 Caille Rotie
205
h3. Listes non ordonnées
206
207
<pre>
208
* Item 1
209
* Item 2
210
** Item 21
211
** Item 22
212
* Item 3
213
</pre>
214
215
affiche :
216
217
* Item 1
218
* Item 2
219
** Item 21
220
** Item 22
221
* Item 3
222
223
h3. Listes ordonnées
224
225
<pre>
226 1 Fabrice Phung
# Item 1
227
# Item 2
228 4 Caille Rotie
## Item 2.1
229
## Item 2.2
230 3 Caille Rotie
# Item 3
231
</pre>
232
233 1 Fabrice Phung
affiche :
234
235 3 Caille Rotie
# Item 1
236
# Item 2
237 4 Caille Rotie
## Item 2.1
238
## Item 2.2
239 3 Caille Rotie
# Item 3
240
241
h3. Tableaux
242
243
<pre>
244
|_.UserID     |_.Name|_.Group|_. attribute list  |
245
|Starting with| a    |   simple|row |
246
|\3=.IT               |<. align left|
247
|1|Artur Pirozhkov |/2.Users |>. align right|
248
|2|Vasya Rogov        |=. center |
249
|3|John Smith |Admin
250
               (root)|^. valign top |
251
|4|-          |Nobody
252
               (anonymous)|~. valign bottom|
253
</pre>
254
255
affiche :
256
(Les espaces multiples et les tabulations sont affichées avec un unique espace):
257
258
|_.UserID     |_.Name|_.Group|_. attribute list   |
259
|Starting with| a    |   simple|row |
260
|\3=.IT                |<. align left|
261
|1|Artur Pirozhkov |/2.Users |>. align right|
262
|2|Vasya Rogov         |=. center |
263
|3|John Smith |Admin
264
               (root)|^. valign top |
265
|4|-          |Nobody
266
               (anonymous)|~. valign bottom|
267
268
h2. Macros
269
270
Les macros permettent de définir un affichage dynamique en fonction d'autres éléments.
271
De nombreux plugin ajoutent leur propres macros.
272
273 1 Fabrice Phung
h3. Table des matières
274
275
<pre><code>{{toc}} => table des matières alignée à gauche
276
{{>toc}} => table des matières alignée à droite
277
</code></pre>
278
279 3 Caille Rotie
h3. Liste des macro disponibles
280 1 Fabrice Phung
281 3 Caille Rotie
Redmine propose en standard les macros suivantes:
282 1 Fabrice Phung
283
{{macro_list}}
284
285
h2. Coloration syntaxique
286
287 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...
288 1 Fabrice Phung
289
Vous pouvez mettre en valeur le code dans vos pages wiki en utilisant cette syntaxe:
290
291
<pre><code><pre><code class="ruby">
292
  placez votre code ici.
293
</code></pre>
294
</pre></code>
295
296
Exemple:
297
298
<pre><code class="ruby">
299
# The Greeter class
300
class Greeter
301
  def initialize(name)
302
    @name = name.capitalize
303
  end
304
305
  def salute
306
    puts "Hello #{@name}!"
307
  end
308
end
309
</pre></code>