Aller au contenu

Outils du site

Vous n'êtes pas identifié(e).


wiki:syntax

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
Dernière révision Les deux révisions suivantes
wiki:syntax [2013/11/14 16:26]
Opitux
wiki:syntax [2018/09/06 16:55]
Pala2 [Image Links] =>FR
Ligne 1: Ligne 1:
-~~NOTOC~~+====== Syntaxe de mise en page ====== 
 +[[doku>​fr:​dokuwiki|DokuWiki]] utilise un langage de balisage simple, qui essaie de rendre les fichiers de données aussi lisibles que possible. Cette page contient toutes les syntaxes possibles que vous pouvez utiliser en éditant les pages. Regardez simplement le code source de cette page en cliquant sur le bouton //Modifier cette page//. Si vous souhaitez essayer quelque chose, rendez-vous dans la page du [[playground:​playground|bac à sable]]. Les balises les plus simples sont également facilement accessibles depuis la [[fr:​toolbar|barre d'​outils]]. 
 +===== Mise en forme de texte basique =====
  
-<note tuyau>​Version française: [[guide:​notice_du_wiki]]<​/note>+DokuWiki accepte les textes en **gras**, ​//​italique//,​ __souligné__
  
-====== Formatting Syntax ====== 
  
-[[wiki:DokuWiki]] supports some simple markup languagewhich 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 the //Edit this page// button at the top or bottom of the page. If you want to try somethingjust use the [[playground:​playground|playground]] pageThe simpler markup is easily accessible via [[doku>​wiki:​quickbuttons|quickbuttons]]too.+  ​DokuWiki ​accepte les textes en **gras**, //italique//, __souligné__ et ''​à chasse fixe''​Bien sûrvous pouvez tous les **__//''​combiner''//​__**.
  
-===== Basic text formatting =====+Vous pouvez aussi utiliser des <​sub>​indices</​sub>​ et <​sup>​exposants</​sup>​.
  
-DokuWiki supports **bold**, ​//italic//, __underlined__ and ''​monospaced''​ texts. Of course you can **__//''​combine''//​__** all these.+  Vous pouvez aussi utiliser des <​sub>​indices<​/sub> et <​sup>​exposants<​/sup>.
  
-  DokuWiki supports **bold**, //italic//, __underlined__ and ''​monospaced''​ texts. +De plusvous pouvez marquer un passage comme <​del>​supprimé<​/del>.
-  Of course you can **__//''​combine''//​__** all these.+
  
-You can use <sub>subscript</suband <​sup>​superscript</​sup>,​ too.+  De plus, vous pouvez marquer un passage comme <del>supprimé</del>.
  
-  You can use <​sub>​subscript</​sub>​ and <​sup>​superscript</​sup>​too.+**Les paragraphes** sont créés à partir des lignes vides. Si vous souhaitez **forcer un saut de ligne** sans paragraphevous pouvez utiliser deux contre-obliques suivies par un espace ou une fin de ligne
  
-You can mark something as <​del>​deleted</​del>​ as well.+Voici du texte avec des sauts de ligne\\ remarquez que les 
 +deux contre-obliques sont reconnues uniquement en fin de ligne\\ 
 +ou suivies par\\ un espace ; \\ceci se produit sinon.
  
-  ​You can mark something as <​del>​deleted</​del>​ as well.+  ​Voici du texte avec des sauts de ligne\\ remarquez que les 
 +  deux contre-obliques sont reconnues uniquement en fin de ligne\\ 
 +  ou suivies par\\ un espace ; \\ceci se produit sinon.
  
-**Paragraphs** are created from blank lines. If you want to **force a newline** without a paragraph, you can use two backslashes followed by a whitespace or the end of line.+Vous ne devriez forcer des sauts de ligne que si c'est vraiment nécessaire
  
-This is some text with some linebreaks Note that the +===== Liens =====
-two backslashes are only recognized at the end of a line +
-or followed by a whitespace this happens without it.+
  
-  This is some text with some linebreaks Note that the +DokuWiki propose plusieurs moyens pour créer des liens
-  two backslashes are only recognized at the end of a line +
-  or followed by a whitespace this happens without it.+
  
-You should use forced newlines only if really needed.+==== Externes ====
  
-===== Links =====+Les liens externes sont reconnus automagiquement : http://​www.google.fr ou simplement www.google.fr - Vous pouvez aussi donner des noms aux liens : [[http://​www.google.fr|Ce lien pointe vers Google]]. Les adresses de courriel comme celle-ci : <​andi@splitbrain.org>​ sont également reconnues. ​
  
-DokuWiki supports multiple ways of creating links.+  Les liens externes sont reconnus automagiquement : http://www.google.fr  
 +  ou simplement www.google.fr - Vous pouvez aussi donner des noms aux  
 +  liens : [[http://​www.google.fr|Ce lien pointe vers Google]]. Les adresses  
 +  de courriel comme celle-ci : <​andi@splitbrain.org>​ sont également reconnues.  
 +==== Internes ====
  
-==== External ====+Les liens internes sont créés en utilisant des crochets. Vous pouvez juste utiliser un [[nom de page]] ou utiliser un [[nom de page|texte de lien]].
  
-External links are recognized automagically:​ http://www.google.com or simply www.google.com - You can set Linknames, too: [[http://​www.google.com|This Link points to google]]. Email addresses like this one: <​andi@splitbrain.org>​ are recognized, too.+  Les liens internes sont créés en utilisant des crochetsVous pouvez juste 
 +  utiliser un [[nom de page]] ou utiliser un [[nom de page|texte de lien]].
  
-  DokuWiki supports multiple ways of creating links. External links are recognized +Les [[doku>fr:pagename|noms de pages wiki]] sont automatiquement convertis en minuscules ; les caractères spéciaux ne sont pas autorisés.
-  automagically:​ http://​www.google.com or simply www.google.com - You can set +
-  Linknames, too: [[http://​www.google.com|This Link points to google]]. Email +
-  addresses like this one: <​andi@splitbrain.org>​ are recognized, too.+
  
-==== Internal ====+Vous pouvez utiliser les [[voici:​des:​categories]] en utilisant les deux points dans le nom de page.
  
-Internal links are created by using square brackets. You can either just give a [[doku>​wiki:pagename]] or use an additional [[doku>​wiki:pagename|Title Text]]. Wiki pagenames are converted to lowercase automatically,​ special characters are not allowed+  Vous pouvez utiliser les [[voici:des:categories]] en utilisant 
 +  les deux points dans le nom de page.
  
-  Internal links are created by using square brackets. You can either just give +Pour plus de détails sur les catégories,​ voir [[doku>​fr:​namespaces|Catégories]].
-  a [[pagename]] or use an additional [[pagename|Title Text]]. Wiki pagenames +
-  are converted to lowercase automatically,​ special chars are not allowed.+
  
-You can use [[wiki:​namespaces]] by using a colon in the pagename.+Les liens vers une section spécifique d'une page sont également possibles (voir la partie ​[[syntax#​decoupage_en_sections|Découpage en sections]]). Ajoutez simplement le nom de la section après un caractère dièse comme en HTML. Ce lien renvoie vers [[syntax#​internes|cette section]].
  
-  ​You can use [[wiki:​namespaces]] by using a colon in the pagename.+  ​Ce lien renvoie vers [[syntax#​internes|cette section]].
  
-For details about namespaces see [[doku>​wiki:​namespaces]]. +Notes :
- +
-Linking to a specific section is possible, too. Just add the section name behind a hash character as known from HTML. This links to [[syntax#​internal|this Section]]. +
- +
-  This links to [[syntax#​internal|this Section]]. +
- +
-Notes: +
- +
-  * Links to [[wiki:​syntax|existing pages]] are shown in a different style from [[wiki:​nonexisting]] ones. +
-  * DokuWiki does not use [[wp>​CamelCase]] to automatically create links by default, but this behaviour can be enabled in the [[doku>​wiki:​config]] file. Hint: If DokuWiki is a link, then it's enabled. +
-  * When a section'​s heading is changed, its bookmark changes, too. So don't rely on section linking too much.+
  
 +  * Les liens vers des [[syntax|pages existantes]] sont montrés dans un style différent des liens vers des pages [[inexistantes]].
 +  * Par défaut, DokuWiki n'​utilise pas la syntaxe [[wpfr>​CamelCase]] pour créer des liens, mais ce comportement peut être activé dans le fichier de [[doku>​fr:​config|configuration]]. Astuce : si le mot DokuWiki apparaît sur cette page comme un lien, alors c'est que la syntaxe CamelCase est activée. ​
 +  * Lorsque le titre d'une section est modifié, alors son lien change aussi. Donc ne comptez pas trop sur les liens de section. ​
 ==== Interwiki ==== ==== Interwiki ====
  
-DokuWiki supports ​[[doku>wiki:​interwiki|Interwiki]] ​links. These are quick links to other Wikis. For example this is a link to Wikipedia's page about Wikis[[wp>​Wiki]].+Les liens [[doku>fr:​interwiki|Interwiki]] ​sont des liens rapides vers d'autres ​Wikis.\\ 
 +Par exemple [[wpfr>​Wiki|Wiki]] ou [[wp>fr:Wiki|Wiki]] ​sont des liens vers la définition des Wikis dans Wikipedia en français.
  
-  ​DokuWiki supports ​[[doku>wiki:​interwiki|Interwiki]] ​links. These are quick links to other Wikis. +  ​Les liens [[doku>fr:​interwiki|Interwiki]] ​sont des liens rapides vers d'​autres ​Wikis.\\ 
-  ​For example this is a link to Wikipedia'​s page about Wikis: ​[[wp>​Wiki]].+  ​Par exemple [[wpfr>​Wiki|Wiki]] ou [[wp>fr:Wiki|Wiki]] ​sont des liens vers la définition des Wikis dans Wikipedia en français. 
 +==== Partages Windows ====
  
-==== Windows ​Shares ====+Les partages ​Windows ​tels que [[\\serveurnt4\partage|ceci]] sont également reconnus. Veuillez noter qu'ils n'ont un sens que dans un groupe d'​utilisateurs homogène tels qu'un [[wpfr>​Intranet]] d'​entreprise. ​
  
-Windows ​shares like [[servershare|this]] are recognized, too. Please note that these only make sense in a homogenous user group like a corporate [[wp>​Intranet]].+  Les partages ​Windows ​tels que [[\\serveur\partage|ceci]] sont également reconnus.
  
-  Windows Shares like [[servershare|this]] are recognized, too.+Notes :
  
-Notes:+  * Pour des raisons de sécurité, la navigation directe sur partages Windows ne fonctionne que dans //Microsoft Internet Explorer// par défaut (et seulement dans la « zone locale »).  
 +  * Pour //Mozilla// et //​Firefox//,​ sans réglages, ça ne fonctionne pas. Voir [[http://​kb.mozillazine.org/​Links_to_local_pages_do_not_work|cette fiche]] de la base de connaissance de Mozilla pour les contournements possibles. Il restera cependant un avertissement JavaScript. Pour supprimer cet avertissement,​ pour tous les visiteurs du wiki, ajouter cette ligne dans le fichier texte ''​conf/​userscript.js'':<​code javascript>​ 
 +LANG.nosmblinks = '';​ 
 +</​code>​
  
-  * For security reasons direct browsing of windows shares only works in Microsoft Internet Explorer per default (and only in the "local zone"​). +==== Liens images ====
-  * 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 [[bug>​151]] for more info.+
  
-==== Image Links ==== +Vous pouvez aussi utiliser une image afin de créer un lien vers une autre page interne ou externe en combinant les syntaxes des liens et des [[#Images et autres fichiers|images]] (voir plus bascomme ceci :
- +
-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 belowlike this:+
  
   [[http://​www.php.net|{{wiki:​dokuwiki-128.png}}]]   [[http://​www.php.net|{{wiki:​dokuwiki-128.png}}]]
Ligne 98: Ligne 93:
 [[http://​www.php.net|{{wiki:​dokuwiki-128.png}}]] [[http://​www.php.net|{{wiki:​dokuwiki-128.png}}]]
  
-Please noteThe image formatting is the only formatting syntax accepted in link names. +NB la mise en forme image est la seule syntaxe de mise en forme acceptée comme nom de lien.
- +
-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).+
  
 +la totalité des syntaxes d'​[[#​Images et autres fichiers|image]] et de [[#Liens]] est possible (y compris le redimensionnement d'​image,​ les images internes et externes, les URL et les liens interwikis).
 ===== Footnotes ===== ===== Footnotes =====
  
Ligne 124: Ligne 118:
 ---- ----
  
-===== Images and other files =====+===== Media Files =====
  
-You can include external and internal [[doku>wiki:images]] 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.
  
 Real size:                        {{wiki:​dokuwiki-128.png}} Real size:                        {{wiki:​dokuwiki-128.png}}
Ligne 132: Ligne 126:
 Resize to given width: ​           {{wiki:​dokuwiki-128.png?​50}} Resize to given width: ​           {{wiki:​dokuwiki-128.png?​50}}
  
-Resize to given width and height: {{wiki:​dokuwiki-128.png?​200x50}}+Resize to given width and height((when the aspect ratio of the given width and height doesn'​t match that of the image, it will be cropped to the new ratio before resizing)): {{wiki:​dokuwiki-128.png?​200x50}}
  
-Resized external image: ​          ​{{http://​de3.php.net/​images/​php.gif?​200x50}}+Resized external image: ​          ​{{http://​php.net/​images/​php.gif?​200x50}}
  
   Real size:                        {{wiki:​dokuwiki-128.png}}   Real size:                        {{wiki:​dokuwiki-128.png}}
   Resize to given width: ​           {{wiki:​dokuwiki-128.png?​50}}   Resize to given width: ​           {{wiki:​dokuwiki-128.png?​50}}
   Resize to given width and height: {{wiki:​dokuwiki-128.png?​200x50}}   Resize to given width and height: {{wiki:​dokuwiki-128.png?​200x50}}
-  Resized external image: ​          ​{{http://​de3.php.net/​images/​php.gif?​200x50}}+  Resized external image: ​          ​{{http://​php.net/​images/​php.gif?​200x50}}
  
  
Ligne 159: Ligne 153:
  
   {{ wiki:​dokuwiki-128.png |This is the caption}}   {{ wiki:​dokuwiki-128.png |This is the caption}}
- 
-If you specify a filename (external or internal) that is not an image (''​gif,​ jpeg, png''​),​ then it will be displayed as a link instead. 
  
 For linking an image to another page see [[#Image Links]] above. For linking an image to another page see [[#Image Links]] above.
 +
 +==== Supported Media Formats ====
 +
 +DokuWiki can embed the following media formats directly.
 +
 +| Image | ''​gif'',​ ''​jpg'',​ ''​png'' ​ |
 +| Video | ''​webm'',​ ''​ogv'',​ ''​mp4''​ |
 +| Audio | ''​ogg'',​ ''​mp3'',​ ''​wav'' ​ |
 +| Flash | ''​swf'' ​                   |
 +
 +If you specify a filename that is not a supported media format, then it will be displayed as a link instead.
 +
 +By adding ''?​linkonly''​ you provide a link to the media without displaying it inline
 +
 +  {{wiki:​dokuwiki-128.png?​linkonly}}
 +
 +{{wiki:​dokuwiki-128.png?​linkonly}} This is just a link to the image.
 +
 +==== 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.
 +
 +For example consider this embedded mp4 video:
 +
 +  {{video.mp4|A funny video}}
 +
 +When you upload a ''​video.webm''​ and ''​video.ogv''​ next to the referenced ''​video.mp4'',​ DokuWiki will automatically add them as alternatives so that one of the three files is understood by your browser.
 +
 +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.
  
 ===== Lists ===== ===== Lists =====
Ligne 190: Ligne 211:
 </​code>​ </​code>​
  
-===== Smileys =====+Also take a look at the [[doku>​faq:​lists|FAQ on list items]].
  
-DokuWiki converts commonly used [[wp>​emoticon]]s to their graphical equivalents. ​More smileys ​can be placed in the ''​smiley''​ directory and configured ​in the ''​conf/​smileys.conf''​ file. Here is an overview of Smileys included in DokuWiki.+===== Text Conversions ===== 
 + 
 +DokuWiki can convert certain pre-defined characters or strings into images or other text or HTML. 
 + 
 +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. 
 + 
 +==== 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:
  
   * 8-) %%  8-)  %%   * 8-) %%  8-)  %%
Ligne 200: Ligne 229:
   * =)  %%  =)   %%   * =)  %%  =)   %%
   * :-/ %%  :-/  %%   * :-/ %%  :-/  %%
-  * :- %%  :-  %%+  * :-%%  :- %%
   * :-? %%  :-?  %%   * :-? %%  :-?  %%
   * :-D %%  :-D  %%   * :-D %%  :-D  %%
Ligne 215: Ligne 244:
   * DELETEME %% DELETEME %%   * DELETEME %% DELETEME %%
  
-===== Typography =====+==== Text to HTML Conversions ​====
  
-[[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.
  
 -> <- <-> => <= <=> >> << -- --- 640x480 (c) (tm) (r) -> <- <-> => <= <=> >> << -- --- 640x480 (c) (tm) (r)
Ligne 227: Ligne 256:
 </​code>​ </​code>​
  
-Please note: These conversions ​can be turned off through a [[doku>wiki:​config#​typography|config option]] and a [[doku>wiki:entities|pattern file]].+The same can be done to produce any kind of HTML, it just needs to be added to the [[doku>entities|pattern file]]
 + 
 +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]].
  
 ===== Quoting ===== ===== Quoting =====
Ligne 233: Ligne 264:
 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:
  
-  ​I think we should do it +<​code>​ 
-   +I think we should do it 
-  > No we shouldn'​t + 
-   +> No we shouldn'​t 
-  >> Well, I say we should + 
-   +>> Well, I say we should 
-  > Really? + 
-   +> Really? 
-  >> Yes! + 
-   +>> Yes! 
-  >>>​ Then lets do it!+ 
 +>>>​ Then lets do it! 
 +</​code>​
  
 I think we should do it I think we should do it
Ligne 259: Ligne 292:
 ===== Tables ===== ===== Tables =====
  
-DokuWiki supports a simple syntax to create tables. ​+DokuWiki supports a simple syntax to create tables.
  
 ^ Heading 1      ^ Heading 2       ^ Heading 3          ^ ^ Heading 1      ^ Heading 2       ^ Heading 3          ^
 | Row 1 Col 1    | Row 1 Col 2     | Row 1 Col 3        | | Row 1 Col 1    | Row 1 Col 2     | Row 1 Col 3        |
 | Row 2 Col 1    | some colspan (note the double pipe) || | Row 2 Col 1    | some colspan (note the double pipe) ||
-| Row 3 Col 1    | Row Col 2     | Row Col 3        |+| Row 3 Col 1    | Row Col 2     | Row Col 3        |
  
 Table rows have to start and end with a ''​|''​ for normal rows or a ''​^''​ for headers. Table rows have to start and end with a ''​|''​ for normal rows or a ''​^''​ for headers.
Ligne 271: Ligne 304:
   | Row 1 Col 1    | Row 1 Col 2     | Row 1 Col 3        |   | Row 1 Col 1    | Row 1 Col 2     | Row 1 Col 3        |
   | Row 2 Col 1    | some colspan (note the double pipe) ||   | Row 2 Col 1    | some colspan (note the double pipe) ||
-  | Row 3 Col 1    | Row Col 2     | Row Col 3        |+  | Row 3 Col 1    | Row Col 2     | Row Col 3        |
  
 To connect cells horizontally,​ just make the next cell completely empty as shown above. Be sure to have always the same amount of cell separators! To connect cells horizontally,​ just make the next cell completely empty as shown above. Be sure to have always the same amount of cell separators!
Ligne 289: Ligne 322:
   ^ Heading 5    | Row 2 Col 2          | Row 2 Col 3        |   ^ Heading 5    | Row 2 Col 2          | Row 2 Col 3        |
  
-NoteVertical ​spans (rowspan) are not possible.+You can have rowspans (vertically connected cells) by adding ''​%%:::​%%''​ into the cells below the one to which they should connect. 
 + 
 +^ Heading 1      ^ Heading 2                  ^ Heading 3          ^ 
 +| Row 1 Col 1    | this cell spans vertically | Row 1 Col 3        | 
 +| Row 2 Col 1    | :::                        | Row 2 Col 3        | 
 +| Row 3 Col 1    | :::                        | Row 2 Col 3        | 
 + 
 +Apart from the rowspan ​syntax those cells should ​not contain anything else. 
 + 
 +  ^ Heading 1      ^ Heading 2                  ^ Heading 3          ^ 
 +  | Row 1 Col 1    | this cell spans vertically | Row 1 Col 3        | 
 +  | Row 2 Col 1    | :::                        | Row 2 Col 3        | 
 +  | Row 3 Col 1    | :::                        | Row 2 Col 3        |
  
 You can align the table contents, too. Just add at least two whitespaces at the opposite end of your text: Add two spaces on the left to align right, two spaces on the right to align left and two spaces at least at both ends for centered text. You can align the table contents, too. Just add at least two whitespaces at the opposite end of your text: Add two spaces on the left to align right, two spaces on the right to align left and two spaces at least at both ends for centered text.
Ligne 305: Ligne 350:
   | xxxxxxxxxxxx | xxxxxxxxxxxx | xxxxxxxxxxxx |   | xxxxxxxxxxxx | xxxxxxxxxxxx | xxxxxxxxxxxx |
  
-===== Non-parsed Blocks =====+Note: Vertical alignment is not supported.
  
-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''​.+===== 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>''​. 
 + 
 +<​nowiki>​ 
 +This is some text which contains addresses like this: http://​www.splitbrain.org and **formatting**,​ but nothing is done with it. 
 +</​nowiki>​ 
 +The same is true for %%//​__this__ text// with a smiley ;-)%%. 
 + 
 +  <​nowiki>​ 
 +  This is some text which contains addresses like this: http://​www.splitbrain.org and **formatting**,​ but nothing is done with it. 
 +  </​nowiki>​ 
 +  The same is true for %%//​__this__ text// with a smiley ;-)%%. 
 + 
 +===== 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>%%''​
 + 
 +  This is text is indented by two spaces.
  
 <​code>​ <​code>​
Ligne 314: Ligne 377:
  
 <​file>​ <​file>​
-This is pretty much the same, but you could use it to show that you quoted a file.  +This is pretty much the same, but you could use it to show that you quoted a file.
 </​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>''​.+Those blocks were created by this source:
  
-<​nowiki>​ +    ​This is text is indented by two spaces.
-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.+  <​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>​
  
-===== Syntax Highlighting ​=====+==== 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>''​.+[[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>''​.
  
 <code java> <code java>
-/** +/**
  * The HelloWorldApp class implements an application that  * The HelloWorldApp class implements an application that
  * simply displays "Hello World!"​ to the standard output.  * simply displays "Hello World!"​ to the standard output.
Ligne 342: Ligne 408:
 </​code>​ </​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_macc, cpp, 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, python, qbasic, reg, robots, ruby, sas, scheme, sdlbasic, smalltalk, smarty, sql, tcl, text, thinbasic, tsql, vbnet, vb, vhdl, visualfoxpro,​ winbatch, xml//+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, chaiscriptcil, 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// 
 + 
 +==== 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: 
 + 
 +<​code>​ 
 +<file php myexample.php>​ 
 +<?php echo "hello world!";​ ?> 
 +</​file>​ 
 +</​code>​ 
 + 
 +<file php myexample.php>​ 
 +<?php echo "hello world!";​ ?> 
 +</​file>​ 
 + 
 +If you don't want any highlighting but want a downloadable file, specify a dash (''​-''​) as the language code: ''​%%<​code - myfile.foo>​%%''​. 
  
 ===== Embedding HTML and PHP ===== ===== Embedding HTML and PHP =====
  
-You can embed raw HTML or PHP code into your documents by using the ''​html''​ or ''​php''​ tags like this:+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.) 
 + 
 +HTML example: 
 <​code>​ <​code>​
 <​html>​ <​html>​
-This is some <font color="red" ​size="+1">​HTML</​font>+This is some <span style="color:red;font-size:150%;">inline ​HTML</span>
 </​html>​ </​html>​
 +<​HTML>​
 +<p style="​border:​2px dashed red;">​And this is some block HTML</​p>​
 +</​HTML>​
 </​code>​ </​code>​
  
 <​html>​ <​html>​
-This is some <font color="red" ​size="+1">​HTML</​font>+This is some <span style="color:red;font-size:150%;">inline ​HTML</span>
 </​html>​ </​html>​
 +<​HTML>​
 +<p style="​border:​2px dashed red;">​And this is some block HTML</​p>​
 +</​HTML>​
 +
 +PHP example:
  
 <​code>​ <​code>​
 <php> <php>
-echo 'A logo generated by PHP:';​ +echo 'The PHP version: '
-echo '<img src="'​ . $_SERVER['​PHP_SELF'​] . '?​='​ . php_logo_guid() . '"​ alt="​PHP Logo !" />';+echo phpversion()
 +echo ' (generated inline HTML)';
 </​php>​ </​php>​
 +<PHP>
 +echo '<​table class="​inline"><​tr><​td>​The same, but inside a block level element:</​td>';​
 +echo '<​td>'​.phpversion().'</​td>';​
 +echo '</​tr></​table>';​
 +</​PHP>​
 </​code>​ </​code>​
  
 <php> <php>
-echo 'A logo generated by PHP:';​ +echo 'The PHP version: '
-echo '<img src="'​ . $_SERVER['​PHP_SELF'​] . '?​='​ . php_logo_guid() . '"​ alt="​PHP Logo !" />';+echo phpversion()
 +echo ' (inline HTML)';
 </​php>​ </​php>​
 +<PHP>
 +echo '<​table class="​inline"><​tr><​td>​The same, but inside a block level element:</​td>';​
 +echo '<​td>'​.phpversion().'</​td>';​
 +echo '</​tr></​table>';​
 +</​PHP>​
  
 **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.
 +
 +===== 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>​config:​htmlok|HTML]] is disabled all tags will be stripped |
 +| nosort ​    | do not sort the items in the feed |
 +| //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. [[wiki:​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 [[wiki:​DokuWiki]] to re-render the page if it is more than //refresh period// since the page was last rendered.
 +
 +By default the feed will be sorted by date, newest items first. You can sort it by oldest first using the ''​reverse''​ parameter, or display the feed as is with ''​nosort''​.
 +
 +**Example:​**
 +
 +  {{rss>​http://​slashdot.org/​index.rss 5 author date 1h }}
 +
 +{{rss>​http://​slashdot.org/​index.rss 5 author date 1h }}
 +
 +
 +===== Control Macros =====
 +
 +Some syntax influences how DokuWiki renders a page without creating any output it self. The following control macros are availble:
 +
 +^ Macro           ^ Description |
 +| %%~~NOTOC~~%% ​  | If this macro is found on the page, no table of contents will be created |
 +| %%~~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 |
  
 ===== Syntax Plugins ===== ===== 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:​+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~~
 +
wiki/syntax.txt · Dernière modification: 2018/09/06 16:56 par Pala2