You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

wiki_syntax_detailed_textile.html 15KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333
  1. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN" "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
  2. <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">
  3. <head>
  4. <title>RedmineWikiFormatting</title>
  5. <meta http-equiv="content-type" content="text/html; charset=utf-8" />
  6. <style type="text/css">
  7. body { font:80% Verdana,Tahoma,Arial,sans-serif; }
  8. h1, h2, h3, h4 { font-family: Trebuchet MS,Georgia,"Times New Roman",serif; }
  9. pre, code { font-size:120%; }
  10. pre code { font-size:100%; }
  11. pre {
  12. margin: 1em 1em 1em 1.6em;
  13. padding: 2px;
  14. background-color: #fafafa;
  15. border: 1px solid #dadada;
  16. width:95%;
  17. overflow-x: auto;
  18. }
  19. a.new { color: #b73535; }
  20. .syntaxhl .line-numbers { padding: 2px 4px 2px 4px; background-color: #eee; margin:0 }
  21. .syntaxhl .comment { color:#666; }
  22. .syntaxhl .class { color:#B06; font-weight:bold }
  23. .syntaxhl .delimiter { color:black }
  24. .syntaxhl .function { color:#06B; font-weight:bold }
  25. .syntaxhl .inline { background: #eee }
  26. .syntaxhl .inline .inline-delimiter { font-weight: bold; color: #888 }
  27. .syntaxhl .instance-variable { color:#33B }
  28. .syntaxhl .reserved { color:#080; font-weight:bold }
  29. .syntaxhl .string { background-color:#fff0f0; color: #D20; }
  30. .syntaxhl .string .delimiter { color:#710 }
  31. </style>
  32. </head>
  33. <body>
  34. <h1><a name="1" class="wiki-page"></a>Mise en page Wiki</h1>
  35. <h2><a name="2" class="wiki-page"></a>Liens</h2>
  36. <h3><a name="3" class="wiki-page"></a>Liens Redmine</h3>
  37. <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>
  38. <ul>
  39. <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>
  40. <li>Lien vers une note d'une demande: <strong>#124-6</strong>, ou <strong>#124#note-6</strong></li>
  41. </ul>
  42. <p>Liens entre Wiki:</p>
  43. <ul>
  44. <li><strong>[[Guide]]</strong> affiche un lien vers la page nommé 'Guide': <a href="#" class="wiki-page">Guide</a></li>
  45. <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>
  46. <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>
  47. </ul>
  48. <p>Vous pouvez aussi faire des liens vers des pages du Wiki d'un autre projet:</p>
  49. <ul>
  50. <li><strong>[[sandbox:une page]]</strong> affiche un lien vers une page nommée 'Une page' du Wiki du projet Sandbox</li>
  51. <li><strong>[[sandbox:]]</strong> affiche un lien vers la page principal du Wiki du projet Sandbox</li>
  52. </ul>
  53. <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>
  54. <p>Liens vers d'autres ressources:</p>
  55. <ul>
  56. <li>Documents:
  57. <ul>
  58. <li><strong>document#17</strong> (lien vers le document dont l'id est 17)</li>
  59. <li><strong>document:Salutations</strong> (lien vers le document dont le titre est "Salutations")</li>
  60. <li><strong>document:"Un document"</strong> (Les guillements peuvent être utilisé quand le titre du document comporte des espaces)</li>
  61. <li><strong>sandbox:document:"Un document"</strong> (Lien vers le document dont le titre est "Un document" dans le projet différent "sandbox")</li>
  62. </ul></li>
  63. </ul>
  64. <ul>
  65. <li>Versions:
  66. <ul>
  67. <li><strong>version#3</strong> (lien vers la version dont l'id est 3)</li>
  68. <li><strong>version:1.0.0</strong> (lien vers la version nommée "1.0.0")</li>
  69. <li><strong>version:"1.0 beta 2"</strong></li>
  70. <li><strong>sandbox:version:1.0.0</strong> (lien vers la version nommée "1.0.0" dans le projet "sandbox")</li>
  71. </ul></li>
  72. </ul>
  73. <ul>
  74. <li>Pièces jointes:
  75. <ul>
  76. <li><strong>attachment:file.zip</strong> (lien vers la pièce jointe de l'objet nommée file.zip)</li>
  77. <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>
  78. </ul></li>
  79. </ul>
  80. <ul>
  81. <li>Révisions:
  82. <ul>
  83. <li><strong>r758</strong> (lien vers une révision)</li>
  84. <li><strong>commit:c6f4d0fd</strong> (lien vers une révision sans référence numérique)</li>
  85. <li><strong>svn1|r758</strong> (lien vers un dépôt spécifique, pour les projets ayant plusieurs dépôts)</li>
  86. <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>
  87. <li><strong>sandbox:r758</strong> (Lien vers une révision d'un projet différent)</li>
  88. <li><strong>sandbox:commit:c6f4d0fd</strong> (lien vers une révision sans référence numérique d'un autre projet)</li>
  89. </ul></li>
  90. </ul>
  91. <ul>
  92. <li>Fichier de dépôt:
  93. <ul>
  94. <li><strong>source:un/fichier</strong> (Lien vers le fichier situé dans /un/fichier dans le dépôt du projet)</li>
  95. <li><strong>source:un/fichier@52</strong> (Lien vers le fichier de la révison 52)</li>
  96. <li><strong>source:un/fichier#L120</strong> (Lien vers la ligne 120 du fichier fichier)</li>
  97. <li><strong>source:un/fichier@52#L120</strong> (Lien vers la ligne 120 du fichier de la révison 52)</li>
  98. <li><strong>source:"un fichier@52#L120"</strong> (Utilisez des guillemets quand l'url contient des espaces)</li>
  99. <li><strong>export:un/fichier</strong> (Force le téléchargement du fichier)</li>
  100. <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>
  101. <li><strong>sandbox:source:un/fichier</strong> (Lien vers le fichier situé dans /un/fichier dans le dépôt du projet "sandbox")</li>
  102. <li><strong>sandbox:export:un/fichier</strong> (Force le téléchargement du fichier dans le dépôt du projet "sandbox")</li>
  103. </ul></li>
  104. </ul>
  105. <ul>
  106. <li>Forums:
  107. <ul>
  108. <li><strong>forum#1</strong> (link to forum with id 1</li>
  109. <li><strong>forum:Support</strong> (link to forum named Support)</li>
  110. <li><strong>forum:"Technical Support"</strong> (use double quotes if forum name contains spaces)</li>
  111. </ul></li>
  112. </ul>
  113. <ul>
  114. <li>Messages du forum:
  115. <ul>
  116. <li><strong>message#1218</strong> (Lien vers le message dont l'id est 1218)</li>
  117. </ul></li>
  118. </ul>
  119. <ul>
  120. <li>Projet:
  121. <ul>
  122. <li><strong>project#3</strong> (Lien vers le projet dont l'id est 3)</li>
  123. <li><strong>project:unprojet</strong> (Lien vers le projet nommé "unprojet")</li>
  124. <li><strong>project:"un projet"</strong> (use double quotes if project name contains spaces)</li>
  125. </ul></li>
  126. </ul>
  127. <ul>
  128. <li>News:
  129. <ul>
  130. <li><strong>news#2</strong> (link to news item with id 2)</li>
  131. <li><strong>news:Greetings</strong> (link to news item named "Greetings")</li>
  132. <li><strong>news:"First Release"</strong> (use double quotes if news item name contains spaces)</li>
  133. </ul></li>
  134. </ul>
  135. <p>Eviter ces lien:</p>
  136. <ul>
  137. <li>Vous pouvez empêcher les liens Redmine de se faire en les précédant d'un point d'exclamaion : !</li>
  138. </ul>
  139. <h3><a name="4" class="wiki-page"></a>Liens externes</h3>
  140. <p>Les URLs HTTP et les adresses email sont automatiquement transformé en liens:</p>
  141. <pre>
  142. http://www.redmine.org, someone@foo.bar
  143. </pre>
  144. <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>
  145. <p>Si vous voulez afficher un texte spécifique à la place de l'URL, vous pouvez utilisez la syntaxe standard textile:</p>
  146. <pre>
  147. "Site Web Redmine":http://www.redmine.org
  148. </pre>
  149. <p>affiche: <a href="http://www.redmine.org" class="external">Site Web Redmine</a></p>
  150. <h2><a name="5" class="wiki-page"></a>Formatage du texte</h2>
  151. <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>
  152. <h3><a name="6" class="wiki-page"></a>Police d'écriture</h3>
  153. <pre>
  154. * *gras*
  155. * _italique_
  156. * _*gras _italique_*_
  157. * +sous-ligné+
  158. * -barré-
  159. </pre>
  160. <p>Affiche:</p>
  161. <ul>
  162. <li><strong>gras</strong></li>
  163. <li><em>_italique_</em></li>
  164. <li><em><strong>gras italique</strong></em></li>
  165. <li><ins>sous-ligné</ins></li>
  166. <li><del>barré</del></li>
  167. </ul>
  168. <h3><a name="7" class="wiki-page"></a>Afficher une image</h3>
  169. <ul>
  170. <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>
  171. <li><strong>!&gt;url_de_l_image!</strong> Image affichée à droite</li>
  172. <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>
  173. </ul>
  174. <h3><a name="8" class="wiki-page"></a>Titre</h3>
  175. <pre>
  176. h1. Titre
  177. h2. Sous-titre
  178. h3. Sous-sous-titre
  179. </pre>
  180. <p>Redmine assigne une balise à chacun de ses titres, vous pouvez donc les lier avec "#Titre", "#Sous-titre" et ainsi de suite.</p>
  181. <h3><a name="9" class="wiki-page"></a>Paragraphes</h3>
  182. <pre>
  183. p&gt;. aligné à droite
  184. p=. centré
  185. </pre>
  186. <p style="text-align:center;">Ceci est un paragraphe centré.</p>
  187. <h3><a name="10" class="wiki-page"></a>Blockquotes</h3>
  188. <p>Commencer le paragraphe par <strong>bq.</strong></p>
  189. <pre>
  190. 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.
  191. Pour commencer à l'utiliser, il ne vous faut qu'un serveur web et une base de données.
  192. </pre>
  193. <p>Affiche</p>
  194. <blockquote>
  195. <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>
  196. </blockquote>
  197. <h3><a name="11" class="wiki-page"></a>Table des matières</h3>
  198. <pre>
  199. {{toc}} =&gt; table des matières centrées à gauche
  200. {{&gt;toc}} =&gt; table des matières centrées à droite
  201. </pre>
  202. <h3><a name="14" class="wiki-page"></a>Règle horizontale</h3>
  203. <pre>
  204. ---
  205. </pre>
  206. <h2><a name="12" class="wiki-page"></a>Macros</h2>
  207. <p>Redmine possède les macros suivantes:</p>
  208. <p>
  209. <dl>
  210. <dt><code>hello_world</code></dt>
  211. <dd><p>Macro d'exemple.</p></dd>
  212. <dt><code>macro_list</code></dt>
  213. <dd><p>Affiche une liste de toutes les macros disponibles, les descriptions sont incluses si celles-ci sont disponibles.</p></dd>
  214. <dt><code>child_pages</code></dt>
  215. <dd><p>Affiche une liste des sous-pages. Sans argument, cela affiche les sous-pages de la page courante. Exemples :</p>
  216. <pre><code>{{child_pages}} -- peut être utilisé depuis une page wiki uniquement
  217. {{child_pages(depth=2)}} -- affiche deux niveaux d'arborescence seulement</code></pre></dd>
  218. <dt><code>include</code></dt>
  219. <dd><p>Inclut une page Wiki. Exemple :</p>
  220. <pre><code>{{include(Foo)}}</code></pre>
  221. <p>ou pour inclure une page d'un wiki de projet spécifique :</p>
  222. <pre><code>{{include(projectname:Foo)}}</code></pre></dd>
  223. <dt><code>collapse</code></dt>
  224. <dd><p>Insère un bloc de texte enroulé. Exemple :</p>
  225. <pre><code>{{collapse(Voir les détails...)
  226. Ceci est un bloc de texte qui est caché par défaut.
  227. Il peut être déroulé en cliquant sur le lien.
  228. }}</code></pre></dd>
  229. <dt><code>thumbnail</code></dt>
  230. <dd><p>Affiche une miniature cliquable d'une image jointe. Exemples :</p>
  231. <pre>{{thumbnail(image.png)}}
  232. {{thumbnail(image.png, size=300, title=Miniature)}}</pre></dd>
  233. </dl>
  234. </p>
  235. <h2><a name="13" class="wiki-page"></a>Coloration syntaxique</h2>
  236. <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. Elle supporte actuellement les langages C, C++, CSS, delphi, groovy, HTML, java, javascript, json, PHP, python, RHTML, ruby, scheme, SQL, XML et YAML.</p>
  237. <p>Vous pouvez colorer votre code dans vos pages Wiki en utilisant la syntaxe suivante:</p>
  238. <pre>
  239. &lt;pre&gt;&lt;code class="ruby"&gt;
  240. Placez votre code ici.
  241. &lt;/code&gt;&lt;/pre&gt;
  242. </pre>
  243. <p>Exemple:</p>
  244. <pre><code class="ruby syntaxhl"><span class="line-numbers"> 1</span> <span class="comment"># The Greeter class</span>
  245. <span class="line-numbers"> 2</span> <span class="reserved">class</span> <span class="class">Greeter</span>
  246. <span class="line-numbers"> 3</span> <span class="reserved">def</span> <span class="function">initialize</span>(name)
  247. <span class="line-numbers"> 4</span> <span class="instance-variable">@name</span> = name.capitalize
  248. <span class="line-numbers"> 5</span> <span class="reserved">end</span>
  249. <span class="line-numbers"> 6</span>
  250. <span class="line-numbers"> 7</span> <span class="reserved">def</span> <span class="function">salute</span>
  251. <span class="line-numbers"> 8</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>
  252. <span class="line-numbers"> 9</span> <span class="reserved">end</span>
  253. <span class="line-numbers"><strong>10</strong></span> <span class="reserved">end</span></code>
  254. </pre>
  255. </body>
  256. </html>