wiki:syntaxe

====== Syntaxe DOKUWIKI ====== Pour un aperçu rapide (en français) -> [[abc_syntaxe]]\\ Page d'origine en anglais -> [[syntax]] ===== Guide de la mise en page - Traduction de la page "Formatting syntax" ===== [[wiki:DokuWiki]] supporte un langage simple de balises pour rendre les fichiers de données aussi lisibles que possible. Cette page décrit de manière complète la syntaxe que vous pouvez utiliser pour éditer les pages. Vous pouvez simplement regarder le source de la page en cliquant sur le bouton //Editer la page// en haut ou en bas de la page. Pour faire des essais, utilisez le [[bac à sable:]]. Les balises les plus courantes sont également accessibles via la [[doku>wiki:quickbuttons|barre d'outils]]. ===== Formatage de texte ===== DokuWiki supporte le texte **en gras**, //en italique//, __souligné__ et à ''fonte fixe''. Bien évidemment, vous pouvez **__//''combiner''//__** plusieurs de ces formatages. DokuWiki supporte le texte **en gras**, //en italique//, __souligné__ et à ''fonte fixe''. Bien évidemment, vous pouvez **__//''combiner''//__** plusieurs de ces formatages. Vous pouvez utiliser les indices et les exposants. Vous pouvez utiliser les indices et les exposants. Vous pouvez également indiquer une <del>suppression</del>. Vous pouvez également indiquer une <del>suppression</del>. Les **paragraphes** sont créés après les lignes vides. Si vous voulez forcer le **retour à la ligne** sans créer de nouveau paragraphe, vous pouvez utiliser deux anti-slashs suivi d'un espace ou d'une fin de ligne. Voici du texte avec des sauts de ligne\\ Notez que les deux anti-slashs sont seulement reconnus à la fin d'une ligne\\ ou suivi d'un\\ espace. \\Voici ce qui arrive sinon. Voici du texte avec des sauts de ligne\\ Notez que les deux anti-slashs sont seulement reconnus à la fin d'une ligne\\ ou suivi d'un\\ espace. \\Voici ce qui arrive sinon. Ne forcez les retours à la ligne que si c'est vraiment nécessaire. ===== Liens ===== DokuWiki supporte plusieurs manières de créer des liens. ==== Liens externes ==== Les liens externes sont reconnus automatiquement : http://www.google.fr ou simplement www.google.fr - Vous pouvez également définir un libellé pour le lien : [[http://www.google.fr|Ce lien pointe vers google]]. Les adresses mail sont également reconnues, par exemple : <andi@splitbrain.org>. Les liens externes sont reconnus automatiquement : http://www.google.fr ou simplement www.google.fr - Vous pouvez également définir un libellé pour le lien : [[http://www.google.fr|Ce lien pointe vers google]]. Les adresses mail sont également reconnues, par exemple : <andi@splitbrain.org>. ==== Liens internes ==== Les liens internes sont créés en utilisant des crochets. Vous pouvez soit utiliser un simple [[nomdepage]] ou utiliser un [[nomdepage|Titre]]. Les noms de page Wiki sont automatiquement convertis en minuscules et les caractères spéciaux ne sont pas admis. Les liens internes sont créés en utilisant des crochets. Vous pouvez soit utiliser un simple [[nomdepage]] ou utiliser un [[nomdepage|Titre]]. Les noms de page Wiki sont automatiquement convertis en minuscules et les caractères spéciaux ne sont pas admis. Vous pouvez utiliser des [[wiki:categories]] en indiquant deux points dans le nom de la page. Vous pouvez utiliser des [[wiki:categories]] en indiquant deux points dans le nom de la page. Pour plus de détails à propos des catégories, consulter la page [[doku>wiki:namespaces]]. Il est également possible de pointer vers une section spécifique. Ajoutez simplement le nom de la section derrière un caractère dièse comme en HTML. Par exemple, un lien vers [[syntax#interne|cette section]]. Par exemple, un lien vers [[syntax#interne|cette section]]. Notes : * Les liens vers des [[wiki:syntax|pages existantes]] sont affichés dans un style différent de ceux pointant des [[wiki:pages qui n'existent pas]]. * DokuWiki n'utilise pas automatiquement les mots Wiki (mots collés commençant par une majuscule, exemple : MotWiki) pour créer des liens par défaut, mais ce comportement peut être activé dans le fichier [[doku>config]]. NB : si DokuWiki est un lien alors il est activé. * Quand le titre d'une section est modifié, les liens pointant vers elle ne sont plus valables. Donc, ne vous fiez pas trop aux liens vers les sections. ==== Liens interwiki ==== DokuWiki supporte les liens [[doku>wiki:interwiki|interwiki]]. Il s'agit d'une syntaxe spéciale pour les liens vers d'autres Wikis. Par exemple, ceci est un lien vers la page Wikipédia à propos des Wikis : [[wp>Wiki]]. DokuWiki supporte les liens [[doku>wiki:interwiki|interwiki]]. Il s'agit d'une syntaxe spéciale pour les liens vers d'autres Wikis. Par exemple, ceci est un lien vers la page Wikipédia à propos des Wikis : [[wp>Wiki]]. ==== Windows Shares ==== Windows shares like [[\\server\share|this]] are recognized, too. Please note that these only make sense in a homogenous user group like a corporate [[wp>Intranet]]. Windows Shares like [[\\server\share|this]] are recognized, too. Notes: * For security reasons direct browsing of windows shares only works in Microsoft Internet Explorer per default (and only in the "local zone"). * For Mozilla and Firefox it can be enabled through the config option [[http://www.mozilla.org/quality/networking/docs/netprefs.html#file|security.checkloaduri]] but this is not recommended. * See [[dokubug>151]] for more info. ==== Les liens images ==== Vous pouvez également utiliser une image pour créer un lien vers une page interne ou externe en combinant la syntaxe des liens et celle des images (voir plus bas) comme ceci : [[http://www.php.net|{{wiki:php-powered.png}}]] [[http://www.php.net|{{wiki:php-powered.png}}]] NB : le formatage d'image est la seule syntaxe acceptée dans les noms de lien. ===== Notes de bas de page ===== Vous pouvez ajouter des notes de bas de page ((Ceci est une note de bas de page)) en tapant une double parenthèse ((comme cela)). Vous pouvez ajouter des notes de bas de page ((Ceci est une note de bas de page)) en tapant une double parenthèse ((comme cela)). ===== Découpage en sections ===== Vous pouvez utiliser jusqu'à cinq niveaux d'en-tête pour structurer votre contenu. Si vous avez plus de trois en-têtes, une table des matières est automatiquement générée -- elle peut être désactivée en incluant ''<nowiki>~~NOTOC~~</nowiki>'' dans le document. ==== En-tête niveau 3 ==== === En-tête niveau 4 === == En-tête niveau 5 == ==== En-tête niveau 3 ==== === En-tête niveau 4 === == En-tête niveau 5 == En tapant 4 traits d'union, vous pouvez créer une ligne horizontale : ---- ===== Images et autres fichiers ===== Vous pouvez inclure des [[doku>images]] internes ou externes avec des accolades. Vous pouvez éventuellement spécifier leur taille. Taille réelle : {{wiki:dokuwiki-128.png}} Modifier la largeur : {{wiki:dokuwiki-128.png?50}} Redimensionner : {{wiki:dokuwiki-128.png?200x50}} Redimensionner une image externe : {{http://de3.php.net/images/php.gif?100x100&nocache}} Taille réelle : {{wiki:dokuwiki-128.png}} Modifier la largeur : {{wiki:dokuwiki-128.png?50}} Redimensionner : {{wiki:dokuwiki-128.png?200x50}} Redimensionner une image externe : {{http://de3.php.net/images/php.gif?100x100}} En laissant un espace à gauche ou à droite, vous pouvez choisir l'alignement {{ wiki:dokuwiki-128.png}} {{wiki:dokuwiki-128.png }} {{ wiki:dokuwiki-128.png }} {{ wiki:dokuwiki-128.png}} {{wiki:dokuwiki-128.png }} {{ wiki:dokuwiki-128.png }} Vous pouvez bien évidemment ajouter un titre (affiché dans une info-bulle sur la plupart des navigateurs). {{ wiki:dokuwiki-128.png |Voici le titre}} {{ wiki:dokuwiki-128.png |Voici le titre}} Si vous spécifiez un nom de fichier (externe ou interne) qui n'est pas une image (''gif, jpeg, png''), un lien sera affiché à la place. ===== Listes ===== DokuWiki supporte les listes ordonnées et non ordonnées. Pour créer une liste d'items, indentez votre texte avec deux espaces et tapez ''*'' pour une liste non ordonnée ou ''-'' pour une liste ordonnée. * Voici une liste * Le second élément * Vous pouvez avoir plusieurs niveaux * Un autre élément - La même liste mais ordonnée - Un second élément - Utilisez l'indentation pour ajouter un niveau - Voilà <code> * Voici une liste * Le second élément * Vous pouvez avoir plusieurs niveaux * Un autre élément - La même liste mais ordonnée - Un second élément - Utilisez l'indentation pour ajouter un niveau - Voilà </code> ===== Citations ===== Vous pouvez parfois avoir envie de mettre en évidence une réponse ou un commentaire. Vous pouvez utiliser la syntaxe suivante : <code> Je pense que nous devrions le faire. > Non, nous ne devrions pas. >> Eh bien, je pense que nous devrions. > En êtes-vous sûr ? >> Certain ! >>> D'accord, faisons-le ! Je pense que nous devrions le faire. </code> Je pense que nous devrions le faire. > Non, nous ne devrions pas. >> Eh bien, je pense que nous devrions. > En êtes-vous sûr ? >> Certain ! >>> D'accord, faisons-le ! Je pense que nous devrions le faire. ===== Tableaux ===== DokuWiki supporte un syntaxe simple pour créer des tableaux. ^ En-tête 1 ^ En-tête 2 ^ En-tête 3 ^ | Lig 1 Col 1 | Lig 1 Col 2 | Lig 1 Col 3 | | Lig 2 Col 1 | Fusion (notez le double pipe) || | Lig 3 Col 1 | Lig 2 Col 2 | Lig 2 Col 3 | Les lignes normales du tableau doivent commencer et se terminer par un ''|'', les lignes d'en-tête par un ''^''. ^ En-tête 1 ^ En-tête 2 ^ En-tête 3 ^ | Lig 1 Col 1 | Lig 1 Col 2 | Lig 1 Col 3 | | Lig 2 Col 1 | Fusion (notez le double pipe) || | Lig 3 Col 1 | Lig 2 Col 2 | Lig 2 Col 3 | Pour fusionner des cellules (colspan), laissez vide la cellule suivante comme dans l'exemple ci-dessus. Vérifiez bien le nombre de séparateurs de cellule ! Les en-têtes de lignes sont également possibles. | ^ En-tête 1 ^ En-tête 2 ^ ^ En-tête 3 | Lig 1 Col 2 | Lig 1 Col 3 | ^ En-tête 4 | Pas de fusion cette fois | | ^ En-tête 5 | Lig 2 Col 2 | Lig 2 Col 3 | Comme vous pouvez le voir, c'est le séparateur précédant la cellule qui définit le formatage : | ^ En-tête 1 ^ En-tête 2 ^ ^ En-tête 3 | Lig 1 Col 2 | Lig 1 Col 3 | ^ En-tête 4 | Pas de fusion cette fois | | ^ En-tête 5 | Lig 2 Col 2 | Lig 2 Col 3 | Note : la fusion verticale de cellules (rowspan) n'est pas possible. Vous pouvez également aligner le contenu des cellules. Ajoutez simplement au moins deux espaces du côté opposé au texte: ajoutez deux espaces à gauche pour aligner à droite, deux espaces à droite pour aligner à gauche et deux espaces à droite et deux à gauche pour centrer le texte. ^ Tableau avec alignement ^^^ | droite| centré |gauche | |gauche | droite| centré | | xxxxxxxxxxxx | xxxxxxxxxxxx | xxxxxxxxxxxx | Voici comment cela apparaît dans le fichier source: ^ Tableau avec alignement ^^^ | droite| centré |gauche | |gauche | droite| centré | | xxxxxxxxxxxx | xxxxxxxxxxxx | xxxxxxxxxxxx | ===== Non-parsed Blocks ===== You can include non-parsed blocks into your documents by either indenting them by at least two spaces (like used for the previous examples) or by using the tags ''code'' or ''file''. <code> This is preformatted code all spaces are preserved: like <-this </code> <file> This is pretty much the same, but you could use it to show that you quoted a file. </file> To let the parser ignore an area completely (ie. do no formatting on it), enclose the area either with ''nowiki'' tags or even simpler, with double percent signs ''<nowiki>%%</nowiki>''. <nowiki> This is some text which contains addresses like this: http://www.splitbrain.org and **formatting**, but nothing is done with it. </nowiki> See the source of this page to see how to use these blocks. ===== Syntax Highlighting ===== [[DokuWiki]] can highlight sourcecode, which makes it easier to read. It uses the [[http://qbnz.com/highlighter/|GeSHi]] Generic Syntax Highlighter -- so any language supported by GeSHi is supported. The syntax is the same like in the code block in the previous section, but this time the name of the used language is inserted inside the tag. Eg. ''<nowiki><code java></nowiki>''. <code java> /** * The HelloWorldApp class implements an application that * simply displays "Hello World!" to the standard output. */ class HelloWorldApp { public static void main(String[] args) { System.out.println("Hello World!"); //Display the string. } } </code> The following language strings are currently recognized: //actionscript-french, actionscript, ada, apache, applescript, asm, asp, autoit, bash, blitzbasic, bnf, caddcl, cadlisp, cfdg, cfm, c_mac, c, cpp, cpp-qt, csharp, css, delphi, diff, div, dos, d, eiffel, fortran, freebasic, gml, groovy, html, idl, ini, inno, io, java5, java, javascript, latex, lisp, lua, matlab, mirc, mpasm, mysql, nsis, objc, ocaml-brief, ocaml, oobas, oracle8, pascal, perl, php-brief, php, plsql, python, qbasic, rails, reg, robots, ruby, sas, scheme, sdlbasic, smalltalk, smarty, sql, tcl, text, thinbasic, tsql, vbnet, vb, vhdl, visualfoxpro, winbatch, xml, xpp, z80// ===== RSS/ATOM Feed Aggregation ===== [[DokuWiki]] can integrate data from external XML feeds. For parsing the XML feeds, [[http://simplepie.org/|SimplePie]] is used. All formats understood by SimplePie can be used in DokuWiki as well. You can influence the rendering by multiple additional space separated parameters: ^ Parameter ^ Description ^ | any number | will be used as maximum number items to show, defaults to 8 | | reverse | display the last items in the feed first | | author | show item authors names | | date | show item dates | | description| show the item description. If [[doku>wiki:config#htmlok|HTML]] is disabled all tags will be stripped | | //n//[dhm] | refresh period, where d=days, h=hours, m=minutes. (e.g. 12h = 12 hours). | The refresh period defaults to 4 hours. Any value below 10 minutes will be treated as 10 minutes. [[DokuWiki]] will generally try to supply a cached version of a page, obviously this is inappropriate when the page contains dynamic external content. The parameter tells [[DokuWiki]] to re-render the page if it is more than //refresh period// since the page was last rendered. **Example:** {{rss>http://slashdot.org/index.rss 5 author date 1h }} {{rss>http://slashdot.org/index.rss 5 author date 1h }} ===== Embedding HTML and PHP ===== You can embed raw HTML or PHP code into your documents by using the ''html'' or ''php'' tags like this: <code> <html> This is some HTML </html> </code> <html> This is some HTML </html> **Please Note**: HTML and PHP embedding is disabled by default in the configuration. If disabled, the code is displayed instead of executed. ===== Syntax Plugins ===== DokuWiki's syntax can be extended by [[doku>wiki:plugins|Plugins]]. How the installed plugins are used is described on their appropriate description pages. The following syntax plugins are available in this particular DokuWiki installation: ~~INFO:syntaxplugins~~