wiki_syntax_detailed_textile.html 14.3 KB
Newer Older
1 2 3 4 5
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN" "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">
<head>
<title>RedmineWikiFormatting</title>
<meta http-equiv="content-type" content="text/html; charset=utf-8" />
6
<link rel="stylesheet" type="text/css" href="../wiki_syntax_detailed.css" />
7 8 9
</head>

<body>
10
<h1><a name="1" class="wiki-page"></a>Mise en page Wiki</h1>
11

12
    <h2><a name="2" class="wiki-page"></a>Liens</h2>
13

14
        <h3><a name="3" class="wiki-page"></a>Liens Redmine</h3>
15

16
        <p>Redmine autorise les hyperliens entre différentes ressources (Demandes, révisions, pages wiki...) n'importe où la mise en page Wiki est utilisée.</p>
17
        <ul>
18 19
            <li>Lien vers une demande: <strong>#124</strong> (affiche <del><a href="#" class="issue" title="bulk edit doesn't change the category or fixed version properties (Closed)">#124</a></del>, le lien est barré si la demande est fermée)</li>
            <li>Lien vers une note d'une demande: <strong>#124-6</strong>, ou <strong>#124#note-6</strong></li>
20 21
        </ul>

22
        <p>Liens entre Wiki:</p>
23 24

        <ul>
25 26 27
            <li><strong>[[Guide]]</strong> affiche un lien vers la page nommé 'Guide': <a href="#" class="wiki-page">Guide</a></li>
            <li><strong>[[Guide#balise-avancée]]</strong> vous emmène à la balise "balise-avancée". Les titres ont automatiquement une balise assignée afin de pouvoir s'y référer: <a href="#" class="wiki-page">Guide</a></li>
            <li><strong>[[Guide|Manuel Utilisateur]]</strong> affiche un lien vers la même page mais avec un texte différent: <a href="#" class="wiki-page">Manuel Utilisateur</a></li>
28 29
        </ul>

30
        <p>Vous pouvez aussi faire des liens vers des pages du Wiki d'un autre projet:</p>
31 32

        <ul>
33 34
            <li><strong>[[sandbox:une page]]</strong> affiche un lien vers une page nommée 'Une page' du Wiki du projet Sandbox</li>
            <li><strong>[[sandbox:]]</strong> affiche un lien vers la page principal du Wiki du projet Sandbox</li>
35 36
        </ul>

37
        <p>Les liens Wiki sont affichés en rouge si la page n'existe pas encore, ie: <a href="#" class="wiki-page new">Page inexistante</a>.</p>
38

39
        <p>Liens vers d'autres ressources:</p>
40 41 42 43

        <ul>
            <li>Documents:
                <ul>
44 45 46 47
                    <li><strong>document#17</strong> (lien vers le document dont l'id est 17)</li>
                    <li><strong>document:Salutations</strong> (lien vers le document dont le titre est "Salutations")</li>
                    <li><strong>document:"Un document"</strong> (Les guillements peuvent être utilisé quand le titre du document comporte des espaces)</li>
                    <li><strong>sandbox:document:"Un document"</strong> (Lien vers le document dont le titre est "Un document" dans le projet différent "sandbox")</li>
48 49 50 51 52 53
                </ul></li>
        </ul>

        <ul>
            <li>Versions:
                <ul>
54 55
                    <li><strong>version#3</strong> (lien vers la version dont l'id est 3)</li>
                    <li><strong>version:1.0.0</strong> (lien vers la version nommée "1.0.0")</li>
56
                    <li><strong>version:"1.0 beta 2"</strong></li>
57
                    <li><strong>sandbox:version:1.0.0</strong> (lien vers la version nommée "1.0.0" dans le projet "sandbox")</li>
58 59 60 61
                </ul></li>
        </ul>

        <ul>
62
            <li>Pièces jointes:
63
                <ul>
64 65
                    <li><strong>attachment:file.zip</strong> (lien vers la pièce jointe de l'objet nommée file.zip)</li>
                    <li>Pour le moment, seules les pièces jointes de l'objet peuvent être référencées (si vous êtes sur une demande, il est possibe de faire référence aux pièces jointes de cette demande uniquement)</li>
66 67 68 69
                </ul></li>
        </ul>

        <ul>
70
            <li>Révisions:
71
                <ul>
72 73 74 75 76 77
                    <li><strong>r758</strong>                       (lien vers une révision)</li>
                    <li><strong>commit:c6f4d0fd</strong>            (lien vers une révision sans référence numérique)</li>
                    <li><strong>svn1|r758</strong>                  (lien vers un dépôt spécifique, pour les projets ayant plusieurs dépôts)</li>
                    <li><strong>commit:hg|c6f4d0fd</strong>         (lien vers une révision sans référence numérique d'un dépôt spécifique)</li>
                    <li><strong>sandbox:r758</strong>               (Lien vers une révision d'un projet différent)</li>
                    <li><strong>sandbox:commit:c6f4d0fd</strong>    (lien vers une révision sans référence numérique d'un autre projet)</li>
78 79 80 81
                </ul></li>
        </ul>

        <ul>
82
             <li>Fichier de dépôt:
83
                <ul>
84 85 86 87 88 89 90 91 92
                    <li><strong>source:un/fichier</strong>           (Lien vers le fichier situé dans /un/fichier dans le dépôt du projet)</li>
                    <li><strong>source:un/fichier@52</strong>        (Lien vers le fichier de la révison 52)</li>
                    <li><strong>source:un/fichier#L120</strong>      (Lien vers la ligne 120 du fichier fichier)</li>
                    <li><strong>source:un/fichier@52#L120</strong>   (Lien vers la ligne 120 du fichier de la révison 52)</li>
                    <li><strong>source:"un fichier@52#L120"</strong> (Utilisez des guillemets quand l'url contient des espaces)</li>
                    <li><strong>export:un/fichier</strong>           (Force le téléchargement du fichier)</li>
                    <li><strong>source:svn1|un/fichier</strong>      (Lien vers le fichier dans un dépôt spécifique, pour les projets contenant plusieurs dépôts)</li>
                    <li><strong>sandbox:source:un/fichier</strong>   (Lien vers le fichier situé dans /un/fichier dans le dépôt du projet "sandbox")</li>
                    <li><strong>sandbox:export:un/fichier</strong>   (Force le téléchargement du fichier dans le dépôt du projet "sandbox")</li>
93 94 95
                </ul></li>
        </ul>

96 97
        <ul>
            <li>Forums:
98
                <ul>
99 100 101 102 103 104
                    <li><strong>forum#1</strong> (link to forum with id 1</li>
                    <li><strong>forum:Support</strong> (link to forum named Support)</li>
                    <li><strong>forum:"Technical Support"</strong> (use double quotes if forum name contains spaces)</li>
                </ul></li>
        </ul>

105
        <ul>
106
            <li>Messages du forum:
107
                <ul>
108
                    <li><strong>message#1218</strong> (Lien vers le message dont l'id est 1218)</li>
109 110 111 112
                </ul></li>
        </ul>

        <ul>
113
            <li>Projet:
114
                <ul>
115 116
                    <li><strong>project#3</strong> (Lien vers le projet dont l'id est 3)</li>
                    <li><strong>project:unprojet</strong> (Lien vers le projet nommé "unprojet")</li>
117
                    <li><strong>project:"un projet"</strong> (use double quotes if project name contains spaces)</li>
118 119 120
                </ul></li>
        </ul>

121 122
        <ul>
            <li>News:
123
                <ul>
124 125 126 127 128
                    <li><strong>news#2</strong> (link to news item with id 2)</li>
                    <li><strong>news:Greetings</strong> (link to news item named "Greetings")</li>
                    <li><strong>news:"First Release"</strong> (use double quotes if news item name contains spaces)</li>
                </ul></li>
        </ul>
129

130
        <p>Eviter ces lien:</p>
131 132

        <ul>
133
            <li>Vous pouvez empêcher les liens Redmine de se faire en les précédant d'un point d'exclamaion : !</li>
134 135 136
        </ul>


137
        <h3><a name="4" class="wiki-page"></a>Liens externes</h3>
138

139
        <p>URLs (starting with: www, http, https, ftp, ftps, sftp and sftps) and email addresses are automatically turned into clickable links:</p>
140 141 142 143 144

<pre>
http://www.redmine.org, someone@foo.bar
</pre>

145
        <p>affiche: <a class="external" href="http://www.redmine.org">http://www.redmine.org</a>, <a href="mailto:someone@foo.bar" class="email">someone@foo.bar</a></p>
146

147
        <p>Si vous voulez afficher un texte spécifique à la place de l'URL, vous pouvez utilisez la syntaxe standard textile:</p>
148 149

<pre>
150
"Site Web Redmine":http://www.redmine.org
151 152
</pre>

153
        <p>affiche: <a href="http://www.redmine.org" class="external">Site Web Redmine</a></p>
154 155


156
    <h2><a name="5" class="wiki-page"></a>Formatage du texte</h2>
157 158


159
    <p>Pour les éléments tel que, gras, tableau, listes, Redmine utilise la syntaxe Textile. Voir <a class="external" href="http://fr.wikipedia.org/wiki/Textile_%28langage%29">http://fr.wikipedia.org/wiki/Textile_(langage)</a> pour les informations sur l'utilisation de ces fonctionnalités. Quelques exemples sont inclus ci-dessous, mais le moteur est capable de beaucoup plus.</p>
160

161
        <h3><a name="6" class="wiki-page"></a>Police d'écriture</h3>
162 163

<pre>
164 165 166 167 168
* *gras*
* _italique_
* _*gras _italique_*_
* +sous-ligné+
* -barré-
169 170
</pre>

171
        <p>Affiche:</p>
172 173

        <ul>
174 175
            <li><strong>gras</strong></li>
            <li><em>_italique_</em></li>
176
            <li><em><strong>gras italique</strong></em></li>
177 178
            <li><ins>sous-ligné</ins></li>
            <li><del>barré</del></li>
179 180
        </ul>

181
        <h3><a name="7" class="wiki-page"></a>Afficher une image</h3>
182 183

        <ul>
184
            <li><strong>!url_de_l_image!</strong> affiche une image situé à l'adresse displays an image located at url_de_l_image (syntaxe Textile)</li>
185
            <li><strong>!&gt;url_de_l_image!</strong> Image affichée à droite</li>
186
            <li>Si vous avez une image en pièce jointe de votre page Wiki, elle peut être affiché en utilisant simplement sont nom: <strong>!image_en_piece_jointe.png!</strong></li>
187 188
        </ul>

189
        <h3><a name="8" class="wiki-page"></a>Titre</h3>
190 191

<pre>
192 193 194
h1. Titre
h2. Sous-titre
h3. Sous-sous-titre
195 196
</pre>

197
        <p>Redmine assigne une balise à chacun de ses titres, vous pouvez donc les lier avec "#Titre", "#Sous-titre" et ainsi de suite.</p>
198 199


200
        <h3><a name="9" class="wiki-page"></a>Paragraphes</h3>
201 202

<pre>
203
p&gt;. aligné à droite
204
p=. centré
205 206
</pre>

207
        <p style="text-align:center;">Ceci est un paragraphe centré.</p>
208 209 210 211


        <h3><a name="10" class="wiki-page"></a>Blockquotes</h3>

212
        <p>Commencer le paragraphe par <strong>bq.</strong></p>
213 214

<pre>
215 216
bq. Ruby on Rails, également appelé RoR ou Rails est un framework web libre écrit en Ruby. Il suit le motif de conception Modèle-Vue-Contrôleur aussi nommé MVC.
Pour commencer à l'utiliser, il ne vous faut qu'un serveur web et une base de données.
217 218
</pre>

219
        <p>Affiche</p>
220 221

        <blockquote>
222
                <p>Ruby on Rails, également appelé RoR ou Rails est un framework web libre écrit en Ruby. Il suit le motif de conception Modèle-Vue-Contrôleur aussi nommé MVC.<br />Pour commencer à l'utiliser, il ne vous faut qu'un serveur web et une base de données.</p>
223 224 225
        </blockquote>


226
        <h3><a name="11" class="wiki-page"></a>Table des matières</h3>
227 228

<pre>
229 230
{{toc}} =&gt;  table des matières centrées à gauche
{{&gt;toc}} =&gt; table des matières centrées à droite
231 232
</pre>

233
        <h3><a name="14" class="wiki-page"></a>Règle horizontale</h3>
234 235 236 237 238 239 240

<pre>
---
</pre>

    <h2><a name="12" class="wiki-page"></a>Macros</h2>

241
    <p>Redmine possède les macros suivantes:</p>
242

243 244 245 246 247 248 249 250 251 252
    <p>
    <dl>
      <dt><code>hello_world</code></dt>
      <dd><p>Macro d'exemple.</p></dd>

      <dt><code>macro_list</code></dt>
      <dd><p>Affiche une liste de toutes les macros disponibles, les descriptions sont incluses si celles-ci sont disponibles.</p></dd>

      <dt><code>child_pages</code></dt>
      <dd><p>Affiche une liste des sous-pages. Sans argument, cela affiche les sous-pages de la page courante. Exemples :</p>
253 254
      <pre><code>{{child_pages}} -- peut être utilisé depuis une page wiki uniquement
{{child_pages(depth=2)}} -- affiche deux niveaux d'arborescence seulement</code></pre></dd>
255 256 257

      <dt><code>include</code></dt>
      <dd><p>Inclut une page Wiki. Exemple :</p>
258
      <pre><code>{{include(Foo)}}</code></pre>
259
      <p>ou pour inclure une page d'un wiki de projet spécifique :</p>
260
      <pre><code>{{include(projectname:Foo)}}</code></pre></dd>
261 262 263 264 265 266 267 268 269 270 271 272 273 274

      <dt><code>collapse</code></dt>
      <dd><p>Insère un bloc de texte enroulé. Exemple :</p>
      <pre><code>{{collapse(Voir les détails...)
Ceci est un bloc de texte qui est caché par défaut.
Il peut être déroulé en cliquant sur le lien.
}}</code></pre></dd>

      <dt><code>thumbnail</code></dt>
      <dd><p>Affiche une miniature cliquable d'une image jointe. Exemples :</p>
      <pre>{{thumbnail(image.png)}}
{{thumbnail(image.png, size=300, title=Miniature)}}</pre></dd>
    </dl>
    </p>
275

276
    <h2><a name="13" class="wiki-page"></a>Coloration syntaxique</h2>
277

278
    <p>La coloration syntaxique par défaut repose sur <a href="http://coderay.rubychan.de/" class="external">CodeRay</a>, une librairie rapide de coloration syntaxique complètement codée en Ruby. It currently supports c, clojure, cpp (c++, cplusplus), css, delphi (pascal), diff (patch), erb (eruby, rhtml), go, groovy, haml, html (xhtml), java, javascript (ecmascript, ecma_script, java_script, js), json, lua, php, python, ruby (irb), sass, sql, taskpaper, text (plain, plaintext), xml and yaml (yml) languages, where the names inside parentheses are aliases.</p>
279

280
    <p>You can highlight code at any place that supports wiki formatting using this syntax (note that the language name or alias is case-insensitive):</p>
281 282 283

<pre>
&lt;pre&gt;&lt;code class="ruby"&gt;
284
  Placez votre code ici.
285 286 287
&lt;/code&gt;&lt;/pre&gt;
</pre>

288
    <p>Exemple:</p>
289

290 291 292 293 294 295 296 297 298 299
<pre><code class="ruby syntaxhl"><span class="CodeRay"><span class="comment"># The Greeter class</span>
<span class="keyword">class</span> <span class="class">Greeter</span>
  <span class="keyword">def</span> <span class="function">initialize</span>(name)
    <span class="instance-variable">@name</span> = name.capitalize
  <span class="keyword">end</span>

  <span class="keyword">def</span> <span class="function">salute</span>
    puts <span class="string"><span class="delimiter">"</span><span class="content">Hello </span><span class="inline"><span class="inline-delimiter">#{</span><span class="instance-variable">@name</span><span class="inline-delimiter">}</span></span><span class="content">!</span><span class="delimiter">"</span></span>
  <span class="keyword">end</span>
<span class="keyword">end</span></span></code>
300 301 302
</pre>
</body>
</html>