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