Outils pour utilisateurs


Différences

Ci-dessous, les différences entre deux révisions de la page.

Lien vers cette vue comparative

Les deux révisions précédentes Révision précédente
Prochaine révision
Révision précédente
wiki:syntax [22/12/2014 19:46]
cad01
wiki:syntax [06/08/2017 21:22] (Version actuelle)
Ligne 1: Ligne 1:
-Ecrire sur un wiki est très simple : c'est une écriture en texte brut, dont le rendu final est obtenu par quelques balises simples (les balises de formatage).+====== Formatting Syntax ======
  
-Voyons l'​essentiel en quelques mots.+[[doku>​DokuWiki]] supports some simple markup language, which tries to make the datafiles to be as readable as possible. This page contains all possible syntax you may use when editing the pages. Simply have a look at the source of this page by pressing "Edit this page". If you want to try something, just use the [[playground:​playground|playground]] page. The simpler markup is easily accessible via [[doku>​toolbar|quickbuttons]],​ too.
  
-====== La syntaxe de formatage ======+===== Basic Text Formatting ​=====
  
-[[doku>DokuWiki]] utilise des balise de formatage qui ont pour but de laisser le texte aussi lisible que possible. Il n'est pas nécessaire de toutes les connaître, car l'​éditeur de texte est là pour ça ! L'aide des boutons de l'​éditeur est sur [[doku>​toolbar|ce lien]]. +DokuWiki ​supports ​**bold**, //italic//, __underlined__ ​and ''​monospaced'' ​textsOf course you can **__//''​combine''//​__** ​all these.
- +
-Cette page contient toutes les balises possibles. +
- +
-Regardez quel est le code de cette page en utilisant le bouton "​Modifier cette page"​. +
- +
-Si vous faites des modifications dans cette page, vous pouvez voir ce que cela donne en cliquant sur le bouton "​Aperçu"​ (évitez de cliquer sur "​Enregistrer"​). +
- +
-Et si vous voulez essayer quelque chose, utilisez le [[playground:​playground|bac à sable]]. +
- +
- +
-===== Les balises basiques ===== +
- +
-DokuWiki comprend les textes ​**gras**, //italique//, __souligné__ ​and ''​monospacé''​. ​Bien sûr, ils sont tous compbinables**__//''​combine''//​__**.+
  
   DokuWiki supports **bold**, //italic//, __underlined__ and ''​monospaced''​ texts.   DokuWiki supports **bold**, //italic//, __underlined__ and ''​monospaced''​ texts.
Ligne 43: Ligne 30:
 You should use forced newlines only if really needed. You should use forced newlines only if really needed.
  
-===== Liens =====+===== Links =====
  
 DokuWiki supports multiple ways of creating links. DokuWiki supports multiple ways of creating links.
  
-==== Liens externes ​====+==== External ​====
  
 External links are recognized automagically:​ http://​www.google.com or simply www.google.com - You can set the link text as well: [[http://​www.google.com|This Link points to google]]. Email addresses like this one: <​andi@splitbrain.org>​ are recognized, too. External links are recognized automagically:​ http://​www.google.com or simply www.google.com - You can set the link text as well: [[http://​www.google.com|This Link points to google]]. Email addresses like this one: <​andi@splitbrain.org>​ are recognized, too.
Ligne 56: Ligne 43:
   addresses like this one: <​andi@splitbrain.org>​ are recognized, too.   addresses like this one: <​andi@splitbrain.org>​ are recognized, too.
  
-==== Liens internes ​====+==== Internal ​====
  
 Internal links are created by using square brackets. You can either just give a [[pagename]] or use an additional [[pagename|link text]]. Internal links are created by using square brackets. You can either just give a [[pagename]] or use an additional [[pagename|link text]].
Ligne 81: Ligne 68:
   * When a section'​s heading is changed, its bookmark changes, too. So don't rely on section linking too much.   * When a section'​s heading is changed, its bookmark changes, too. So don't rely on section linking too much.
  
-==== Liens Interwiki ====+==== Interwiki ====
  
 DokuWiki supports [[doku>​Interwiki]] links. These are quick links to other Wikis. For example this is a link to Wikipedia'​s page about Wikis: [[wp>​Wiki]]. DokuWiki supports [[doku>​Interwiki]] links. These are quick links to other Wikis. For example this is a link to Wikipedia'​s page about Wikis: [[wp>​Wiki]].
Ligne 88: Ligne 75:
   For example this is a link to Wikipedia'​s page about Wikis: [[wp>​Wiki]].   For example this is a link to Wikipedia'​s page about Wikis: [[wp>​Wiki]].
  
-==== Liens de partage ​====+==== Windows Shares ​====
  
 Windows shares like [[\\server\share|this]] are recognized, too. Please note that these only make sense in a homogeneous user group like a corporate [[wp>​Intranet]]. Windows shares like [[\\server\share|this]] are recognized, too. Please note that these only make sense in a homogeneous user group like a corporate [[wp>​Intranet]].
Ligne 101: Ligne 88:
   LANG.nosmblinks = '';​   LANG.nosmblinks = '';​
  
-==== Liens image ====+==== Image Links ====
  
 You can also use an image to link to another internal or external page by combining the syntax for links and [[#​images_and_other_files|images]] (see below) like this: You can also use an image to link to another internal or external page by combining the syntax for links and [[#​images_and_other_files|images]] (see below) like this:
Ligne 113: Ligne 100:
 The whole [[#​images_and_other_files|image]] and [[#​links|link]] syntax is supported (including image resizing, internal and external images and URLs and interwiki links). The whole [[#​images_and_other_files|image]] and [[#​links|link]] syntax is supported (including image resizing, internal and external images and URLs and interwiki links).
  
-===== Notes de pied de page =====+===== Footnotes ​=====
  
-Vous pouvez utiliser des notes de pied de page ((C'est une note de pied de page)) en utilisant des double-parenthèses.+You can add footnotes ​((This is a footnote)) by using double ​parentheses.
  
-  ​Vous pouvez utiliser des notes de pied de page ((C'est une note de pied de page)) en utilisant des double-parenthèses.+  ​You can add footnotes ​((This is a footnote)) by using double ​parentheses.
  
-===== Découpage avec des titres de section ​=====+===== Sectioning ​=====
  
-Il y a différents niveaux de titres, pour structurer votre contenuSi vous avez plus que trois ligne de titreune table des matières est générée automatiquement ​-- on peut désactiver cela en intégrant la balise ​''<​nowiki>​~~NOTOC~~</​nowiki>'' ​dans le document.+You can use up to five different levels of headlines to structure your contentIf you have more than three headlinestable of contents is generated automatically ​-- this can be disabled by including the string ​''<​nowiki>​~~NOTOC~~</​nowiki>'' ​in the document.
  
-==== Titre niveau ​3 ==== +==== Headline Level 3 ==== 
-=== Titre niveau ​4 === +=== Headline Level 4 === 
-== Titre niveau ​5 ==+== Headline Level 5 ==
  
-  ==== Titre niveau ​3 ==== +  ==== Headline Level 3 ==== 
-  === Titre niveau ​4 === +  === Headline Level 4 === 
-  == Titre niveau ​5 ==+  == Headline Level 5 ==
  
 By using four or more dashes, you can make a horizontal line: By using four or more dashes, you can make a horizontal line:
Ligne 135: Ligne 122:
 ---- ----
  
-===== Fichier multimedia ​=====+===== Media Files =====
  
 You can include external and internal [[doku>​images|images,​ videos and audio files]] with curly brackets. Optionally you can specify the size of them. You can include external and internal [[doku>​images|images,​ videos and audio files]] with curly brackets. Optionally you can specify the size of them.
Ligne 173: Ligne 160:
 For linking an image to another page see [[#Image Links]] above. For linking an image to another page see [[#Image Links]] above.
  
-==== Formats ​supportés ​====+==== Supported Media Formats ====
  
 DokuWiki can embed the following media formats directly. DokuWiki can embed the following media formats directly.
Ligne 184: Ligne 171:
 If you specify a filename that is not a supported media format, then it will be displayed as a link instead. If you specify a filename that is not a supported media format, then it will be displayed as a link instead.
  
-==== Formats ​incompatibles ​====+==== Fallback ​Formats ====
  
 Unfortunately not all browsers understand all video and audio formats. To mitigate the problem, you can upload your file in different formats for maximum browser compatibility. Unfortunately not all browsers understand all video and audio formats. To mitigate the problem, you can upload your file in different formats for maximum browser compatibility.
Ligne 196: Ligne 183:
 Additionally DokuWiki supports a "​poster"​ image which will be shown before the video has started. That image needs to have the same filename as the video and be either a jpg or png file. In the example above a ''​video.jpg''​ file would work. Additionally DokuWiki supports a "​poster"​ image which will be shown before the video has started. That image needs to have the same filename as the video and be either a jpg or png file. In the example above a ''​video.jpg''​ file would work.
  
-===== Listes ​=====+===== Lists =====
  
 Dokuwiki supports ordered and unordered lists. To create a list item, indent your text by two spaces and use a ''​*''​ for unordered lists or a ''​-''​ for ordered ones. Dokuwiki supports ordered and unordered lists. To create a list item, indent your text by two spaces and use a ''​*''​ for unordered lists or a ''​-''​ for ordered ones.
Ligne 224: Ligne 211:
 Also take a look at the [[doku>​faq:​lists|FAQ on list items]]. Also take a look at the [[doku>​faq:​lists|FAQ on list items]].
  
-===== Conversions ​de texte =====+===== Text Conversions =====
  
 DokuWiki can convert certain pre-defined characters or strings into images or other text or HTML. DokuWiki can convert certain pre-defined characters or strings into images or other text or HTML.
Ligne 230: Ligne 217:
 The text to image conversion is mainly done for smileys. And the text to HTML conversion is used for typography replacements,​ but can be configured to use other HTML as well. The text to image conversion is mainly done for smileys. And the text to HTML conversion is used for typography replacements,​ but can be configured to use other HTML as well.
  
-==== Conversions ​de textes en images ​====+==== Text to Image Conversions ====
  
 DokuWiki converts commonly used [[wp>​emoticon]]s to their graphical equivalents. Those [[doku>​Smileys]] and other images can be configured and extended. Here is an overview of Smileys included in DokuWiki: DokuWiki converts commonly used [[wp>​emoticon]]s to their graphical equivalents. Those [[doku>​Smileys]] and other images can be configured and extended. Here is an overview of Smileys included in DokuWiki:
Ligne 255: Ligne 242:
   * DELETEME %% DELETEME %%   * DELETEME %% DELETEME %%
  
-==== Conversions de textes en HTML ====+==== Text to HTML Conversions ​====
  
 Typography: [[DokuWiki]] can convert simple text characters to their typographically correct entities. Here is an example of recognized characters. Typography: [[DokuWiki]] can convert simple text characters to their typographically correct entities. Here is an example of recognized characters.
Ligne 271: Ligne 258:
 There are three exceptions which do not come from that pattern file: multiplication entity (640x480), '​single'​ and "​double quotes"​. They can be turned off through a [[doku>​config:​typography|config option]]. There are three exceptions which do not come from that pattern file: multiplication entity (640x480), '​single'​ and "​double quotes"​. They can be turned off through a [[doku>​config:​typography|config option]].
  
-===== Retraits=====+===== Quoting ​=====
  
 Some times you want to mark some text to show it's a reply or comment. You can use the following syntax: Some times you want to mark some text to show it's a reply or comment. You can use the following syntax:
Ligne 361: Ligne 348:
 Note: Vertical alignment is not supported. Note: Vertical alignment is not supported.
  
-===== Désactivation du formatage ​=====+===== No Formatting ​=====
  
 If you need to display text exactly like it is typed (without any formatting),​ enclose the area either with ''​%%<​nowiki>​%%''​ tags or even simpler, with double percent signs ''<​nowiki>​%%</​nowiki>''​. If you need to display text exactly like it is typed (without any formatting),​ enclose the area either with ''​%%<​nowiki>​%%''​ tags or even simpler, with double percent signs ''<​nowiki>​%%</​nowiki>''​.
Ligne 375: Ligne 362:
   The same is true for %%//​__this__ text// with a smiley ;-)%%.   The same is true for %%//​__this__ text// with a smiley ;-)%%.
  
-===== Blocs de codes =====+===== Code Blocks ​=====
  
 You can include code 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>​%%''​. You can include code 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>​%%''​.
Ligne 401: Ligne 388:
   </​file>​   </​file>​
  
-==== Surlignage de syntaxe ​====+==== Syntax Highlighting ​====
  
 [[wiki:​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 uses the same code and file blocks described in the previous section, but this time the name of the language syntax to be highlighted is included inside the tag, e.g. ''<​nowiki><​code java></​nowiki>''​ or ''<​nowiki><​file java></​nowiki>''​. [[wiki:​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 uses the same code and file blocks described in the previous section, but this time the name of the language syntax to be highlighted is included inside the tag, e.g. ''<​nowiki><​code java></​nowiki>''​ or ''<​nowiki><​file java></​nowiki>''​.
Ligne 419: Ligne 406:
 The following language strings are currently recognized: //4cs, 6502acme, 6502kickass,​ 6502tasm, 68000devpac,​ abap, actionscript-french,​ actionscript,​ actionscript3,​ ada, algol68, apache, applescript,​ asm, asp, autoconf, autohotkey, autoit, avisynth, awk, bascomavr, bash, basic4gl, bf, bibtex, blitzbasic, bnf, boo, c, c_loadrunner,​ c_mac, caddcl, cadlisp, cfdg, cfm, chaiscript, cil, clojure, cmake, cobol, coffeescript,​ cpp, cpp-qt, csharp, css, cuesheet, d, dcs, delphi, diff, div, dos, dot, e, epc, ecmascript, eiffel, email, erlang, euphoria, f1, falcon, fo, fortran, freebasic, fsharp, gambas, genero, genie, gdb, glsl, gml, gnuplot, go, groovy, gettext, gwbasic, haskell, hicest, hq9plus, html, html5, icon, idl, ini, inno, intercal, io, j, java5, java, javascript, jquery, kixtart, klonec, klonecpp, latex, lb, lisp, llvm, locobasic, logtalk, lolcode, lotusformulas,​ lotusscript,​ lscript, lsl2, lua, m68k, magiksf, make, mapbasic, matlab, mirc, modula2, modula3, mmix, mpasm, mxml, mysql, newlisp, nsis, oberon2, objc, objeck, ocaml-brief,​ ocaml, oobas, oracle8, oracle11, oxygene, oz, pascal, pcre, perl, perl6, per, pf, php-brief, php, pike, pic16, pixelbender,​ pli, plsql, postgresql, povray, powerbuilder,​ powershell, proftpd, progress, prolog, properties, providex, purebasic, pycon, python, q, qbasic, rails, rebol, reg, robots, rpmspec, rsplus, ruby, sas, scala, scheme, scilab, sdlbasic, smalltalk, smarty, sql, systemverilog,​ tcl, teraterm, text, thinbasic, tsql, typoscript, unicon, uscript, vala, vbnet, vb, verilog, vhdl, vim, visualfoxpro,​ visualprolog,​ whitespace, winbatch, whois, xbasic, xml, xorg_conf, xpp, yaml, z80, zxbasic// The following language strings are currently recognized: //4cs, 6502acme, 6502kickass,​ 6502tasm, 68000devpac,​ abap, actionscript-french,​ actionscript,​ actionscript3,​ ada, algol68, apache, applescript,​ asm, asp, autoconf, autohotkey, autoit, avisynth, awk, bascomavr, bash, basic4gl, bf, bibtex, blitzbasic, bnf, boo, c, c_loadrunner,​ c_mac, caddcl, cadlisp, cfdg, cfm, chaiscript, cil, clojure, cmake, cobol, coffeescript,​ cpp, cpp-qt, csharp, css, cuesheet, d, dcs, delphi, diff, div, dos, dot, e, epc, ecmascript, eiffel, email, erlang, euphoria, f1, falcon, fo, fortran, freebasic, fsharp, gambas, genero, genie, gdb, glsl, gml, gnuplot, go, groovy, gettext, gwbasic, haskell, hicest, hq9plus, html, html5, icon, idl, ini, inno, intercal, io, j, java5, java, javascript, jquery, kixtart, klonec, klonecpp, latex, lb, lisp, llvm, locobasic, logtalk, lolcode, lotusformulas,​ lotusscript,​ lscript, lsl2, lua, m68k, magiksf, make, mapbasic, matlab, mirc, modula2, modula3, mmix, mpasm, mxml, mysql, newlisp, nsis, oberon2, objc, objeck, ocaml-brief,​ ocaml, oobas, oracle8, oracle11, oxygene, oz, pascal, pcre, perl, perl6, per, pf, php-brief, php, pike, pic16, pixelbender,​ pli, plsql, postgresql, povray, powerbuilder,​ powershell, proftpd, progress, prolog, properties, providex, purebasic, pycon, python, q, qbasic, rails, rebol, reg, robots, rpmspec, rsplus, ruby, sas, scala, scheme, scilab, sdlbasic, smalltalk, smarty, sql, systemverilog,​ tcl, teraterm, text, thinbasic, tsql, typoscript, unicon, uscript, vala, vbnet, vb, verilog, vhdl, vim, visualfoxpro,​ visualprolog,​ whitespace, winbatch, whois, xbasic, xml, xorg_conf, xpp, yaml, z80, zxbasic//
  
-==== Blocs de code téléchargeables ​====+==== Downloadable Code Blocks ​====
  
 When you use the ''​%%<​code>​%%''​ or ''​%%<​file>​%%''​ syntax as above, you might want to make the shown code available for download as well. You can do this by specifying a file name after language code like this: When you use the ''​%%<​code>​%%''​ or ''​%%<​file>​%%''​ syntax as above, you might want to make the shown code available for download as well. You can do this by specifying a file name after language code like this:
Ligne 436: Ligne 423:
  
  
-===== HTML ou PHP embarqué ​=====+===== Embedding ​HTML and PHP =====
  
 You can embed raw HTML or PHP code into your documents by using the ''​%%<​html>​%%''​ or ''​%%<​php>​%%''​ tags. (Use uppercase tags if you need to enclose block level elements.) You can embed raw HTML or PHP code into your documents by using the ''​%%<​html>​%%''​ or ''​%%<​php>​%%''​ tags. (Use uppercase tags if you need to enclose block level elements.)
Ligne 486: Ligne 473:
 **Please Note**: HTML and PHP embedding is disabled by default in the configuration. If disabled, the code is displayed instead of executed. **Please Note**: HTML and PHP embedding is disabled by default in the configuration. If disabled, the code is displayed instead of executed.
  
-===== Intégration ​RSS/ATOM =====+===== 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: [[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:
  
Ligne 506: Ligne 493:
  
  
-===== Macros ​de contrôle ​=====+===== Control ​Macros =====
  
 Some syntax influences how DokuWiki renders a page without creating any output it self. The following control macros are availble: Some syntax influences how DokuWiki renders a page without creating any output it self. The following control macros are availble:
Ligne 514: Ligne 501:
 | %%~~NOCACHE~~%% | DokuWiki caches all output by default. Sometimes this might not be wanted (eg. when the %%<​php>​%% syntax above is used), adding this macro will force DokuWiki to rerender a page on every call | | %%~~NOCACHE~~%% | DokuWiki caches all output by default. Sometimes this might not be wanted (eg. when the %%<​php>​%% syntax above is used), adding this macro will force DokuWiki to rerender a page on every call |
  
-===== Syntaxe des Plugins =====+===== Syntax ​Plugins =====
  
 DokuWiki'​s syntax can be extended by [[doku>​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:​ DokuWiki'​s syntax can be extended by [[doku>​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~~ ~~INFO:​syntaxplugins~~
 +