FrRedmineWikiFormatting » History » Version 7

Caille Rotie, 2012-09-04 11:53

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