Outils pour utilisateurs

Outils du site


wiki:syntax

Ceci est une ancienne révision du document !


Syntaxe de mise en page

(Pour la mise en forme des articles : articles)

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 bac à sable. Les balises les plus simples sont également facilement accessibles depuis la barre d'outils.

Mise en forme de texte basique

DokuWiki accepte les textes en gras, italique, souligné et à chasse fixe. Bien sûr, vous pouvez tous les combiner.

DokuWiki accepte les textes en **gras**, //italique//, __souligné__ et ''à chasse fixe''. Bien sûr, vous pouvez tous les **__//''combiner''//__**.

Vous pouvez aussi utiliser des indices et exposants.

Vous pouvez aussi utiliser des <sub>indices</sub> et <sup>exposants</sup>.

De plus, vous pouvez marquer un passage comme supprimé.

De plus, vous pouvez marquer un passage comme <del>supprimé</del>.

Les paragraphes sont créés à partir des lignes vides. Si vous souhaitez forcer un saut de ligne sans paragraphe, vous pouvez utiliser deux contre-obliques suivies par un espace ou une fin de ligne.

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.

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.

Vous ne devriez forcer des sauts de ligne que si c'est vraiment nécessaire.

Liens

DokuWiki propose plusieurs moyens pour créer des liens.

Externes

Les liens externes sont reconnus automatiquement : http://www.google.fr ou simplement www.google.fr - Vous pouvez aussi donner des noms aux liens : Ce lien pointe vers Google. Les adresses de courriel comme celle-ci : andi@splitbrain.org sont également reconnues.

Les liens externes sont reconnus automatiquement : 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

Les liens internes sont créés en utilisant des crochets. Vous pouvez juste utiliser un nom de page ou utiliser un texte de lien.

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]].

Les noms de pages wiki sont automatiquement convertis en minuscules ; les caractères spéciaux ne sont pas autorisés.

Vous pouvez utiliser les categories en utilisant les deux points dans le nom de page.

Vous pouvez utiliser les [[voici:des:categories]] en utilisant
les deux points dans le nom de page.

Pour plus de détails sur les catégories, voir Catégories.

Les liens vers une section spécifique d'une page sont également possibles (voir la partie 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 cette section.

Ce lien renvoie vers [[syntax#internes|cette section]].

Notes :

  • Les liens vers des 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 CamelCase pour créer des liens, mais ce comportement peut être activé dans le fichier de 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

Les liens Interwiki sont des liens rapides vers d'autres Wikis.
Par exemple Wiki ou Wiki sont des liens vers la définition des Wikis dans Wikipedia en français.

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.

Partages Windows

Les partages Windows tels que ceci sont également reconnus. Veuillez noter qu'ils n'ont un sens que dans un groupe d'utilisateurs homogène tels qu'un Intranet d'entreprise.

Les partages Windows tels que [[\\serveur\partage|ceci]] sont également reconnus.

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 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:
    LANG.nosmblinks = '';

Liens images

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 (voir plus bas) comme ceci :

[[http://www.php.net|{{wiki:dokuwiki-128.png}}]]

NB : la mise en forme image est la seule syntaxe de mise en forme acceptée comme nom de lien.

la totalité des syntaxes d'image et de Liens est possible (y compris le redimensionnement d'image, les images internes et externes, les URL et les liens interwikis).

Notes de pied de page

Vous pouvez ajouter des notes de pied de page 1) en utilisant des parenthèses doubles.

Vous pouvez ajouter des notes de pied de page ((Ceci est une note de pied de page)) en utilisant des parenthèses doubles.

Découpage en sections

Vous pouvez utiliser jusqu'à cinq niveaux de titres différents afin de structurer le contenu. Si vous avez plus de trois titres, une table des matières est construite automatiquement – ceci peut être désactivé en incluant la chaîne ~~NOTOC~~ dans le document.

Titre niveau 3

Titre niveau 4

Titre niveau 5
==== Titre niveau 3 ====
=== Titre niveau 4 ===
== Titre niveau 5 ==

En utilisant quatre tirets ou plus, vous pouvez créer une ligne horizontale :



----

Images et autres fichiers

Vous pouvez insérer des images, fichiers audio et vidéo (ou autres fichiers) internes ou externes avec des accolades. Additionnelement, vous pouvez en préciser la taille.

taille originale :

largeur donnée :

hauteur et largeur données2) :

Image externe redimensionnée

taille originale :                {{wiki:dokuwiki-128.png}}
largeur donnée :                  {{wiki:dokuwiki-128.png?50}}
hauteur et largeur données :      {{wiki:dokuwiki-128.png?200x50}}
Image externe redimensionnée :    {{http://de3.php.net/images/php.gif?200x50}}

Par défaut les images se placent au fil du texte, centrées verticalement.

Vous pouvez les aligner avec des espaces à gauche ou à droite :

{{ wiki:dokuwiki-128.png}}
{{wiki:dokuwiki-128.png }}
{{ wiki:dokuwiki-128.png }}

Bien sûr, vous pouvez ajouter un titre, affiché comme une bulle d'aide par les navigateurs.

Ceci est le titre

{{ wiki:dokuwiki-128.png |Ceci est le titre}}

Les fichiers qui ne sont pas affichables (voir tableau des médias pris en charge dans la section suivante), sont représentés uniquement comme un lien de téléchargement. Par défaut, les images disposent d'un lien vers une page de détails.

Vous pouvez modifier ce comportement :

Pas de lien.
Lien direct sur le media.
dokuwiki-128.png Uniquement le lien direct.
Lien vers une page. Voir liens images ci dessus

{{wiki:dokuwiki-128.png?nolink}} Pas de lien.
{{wiki:dokuwiki-128.png?direct}} Lien direct sur le media.
{{wiki:dokuwiki-128.png?linkonly}} Uniquement le lien direct.
[[http://www.php.net|{{wiki:dokuwiki-128.png}}]] Lien vers une page. Voir [[#liens images]] ci dessus

Vous pouvez combiner plusieurs effets avec & :

Le titre

{{wiki:dokuwiki-128.png?50&nolink|Le titre}}

Médias pris en charge

DokuWiki peut directement présenter les formats de fichiers suivants

Image gif, jpg, png
Vidéo webm, ogv, mp4
Audio ogg, mp3, wav
Flash swf

Si vous indiquez un fichier dans un format non pris en charge, DokuWiki le présentera comme un lien de téléchargement.

Formats de repli

Malheureusement, certains navigateurs ne comprennent qu'un ensemble restreint de formats vidéo et audio. Pour atténuer ce problème, vous pouvez téléverser vos vidéos et audio dans différents formats pour augmenter la compatibilité avec les divers navigateurs. DokuWiki présentera alors des alternatives au navigateur.

Par exemple, si vous avez téléversé film.webm, film.ogv et film.mp4, lorsque vous présentez la vidéo mp4 comme ceci :

{{film.mp4|une vidéo sympa}}

DokuWiki indiquera automatiquement les alternatives film.webm, film.ogv de telle sorte que l'un des formats au moins soit reconnu par le navigateur.

De plus, DokuWiki permet d'utiliser une image poster qui est affichée avant le démarrage de la vidéo. Cette image doit avoir le même nom que la vidéo et être soit une image jpeg, soit une image png. Dans l'exemple précédent, on aurait pu utiliser une image nommée film.jpg.

Listes

DokuWiki accepte les listes ordonnées et non ordonnées. Pour créer un élément de liste, indentez votre texte par deux espaces et utilisez une * pour une liste non ordonnée ou un - pour une liste ordonnée.

  • Ceci est une liste
  • Le second élément
    • Vous pouvez avoir plusieurs niveaux
  • Un autre élément
  1. La même liste mais ordonnée
  2. Un autre élément
    1. Utilisez simplement l'indentation pour des niveaux plus profonds
  3. Et voilà
  * Ceci est une liste
  * Le second élément
    * Vous pouvez avoir plusieurs niveaux
  * Un autre élément

  - La même liste mais ordonnée
  - Un autre élément
    - Utilisez simplement l'indentation pour des niveaux plus profonds
  - Et voilà

Vous pouvez aussi consulter notre FAQ sur les listes

Conversions textuelles

DokuWiki peut convertir certains caractères ou chaînes de caractère prédéfinis en image, autre texte, ou HTML.

Les conversions en image sont principalement utilisée pour les émoticônes (smileys). Les conversions en texte ou HTML sont utilisées pour des raisons de typographie, mais peuvent également être configurées pour utiliser d'autres balises HTML.

Emoticônes (smileys)

DokuWiki transforme les Émoticônes courantes en leurs équivalents graphiques. On peut facilement en ajouter d'autres. Voici une vue d'ensemble des émoticônes incluses dans DokuWiki.

  • 8-) 8-)
  • 8-O 8-O
  • :-( :-(
  • :-) :-)
  • =) =)
  • :-/ :-/
  • :-\ :-\
  • :-? :-?
  • :-D :-D
  • :-P :-P
  • :-O :-O
  • :-X :-X
  • :-| :-|
  • ;-) ;-)
  • ^_^ ^_^
  • :?: :?:
  • :!: :!:
  • LOL LOL
  • FIXME FIXME
  • DELETEME DELETEME

Typographie

DokuWiki peut convertir de simples caractères de texte brut en leurs entités typographiques correctes. Voici un exemple des caractères reconnus.

→ ← ↔ ⇒ ⇐ ⇔ » « – — 640×480 © ™ ® “He thought 'It's a man's world'…”

-> <- <-> => <= <=> >> << -- --- 640x480 (c) (tm) (r)
"He thought 'It's a man's world'..."

Il est possible de faire la même chose pour n'importe quelle balise HTML. Il suffit pour cela de rajouter une ligne dans le fichier de motifs.

Il existe trois exceptions à ce mécanisme. le symbole de multiplication (640×480), les 'apostrophes' et les “guillemets”. On peut toutefois désactiver ces trois substitutions par une option de configuration.

Citations

Parfois vous souhaitez marquer du texte afin de montrer que c'est une réponse ou un commentaire. Vous pouvez utiliser la syntaxe suivante :

Je pense que nous devrions le faire

> Non nous ne devrions pas

>> Eh bien, je pense que si

> Vraiment ?

>> Oui !

>>> Alors faisons-le !

Je pense que nous devrions le faire

Non nous ne devrions pas
Eh bien, je pense que si
Vraiment ?
Oui !
Alors faisons-le !

Tableaux

DokuWiki propose une syntaxe simple pour créer des tableaux.

Titre 1 Titre 2 Titre 3
Ligne 1 Col 1 Ligne 1 Col 2 Ligne 1 Col 3
Ligne 2 Col 1 colonnes fusionnées (notez la double barre verticale)
Ligne 3 Col 1 Ligne 2 Col 2 Ligne 2 Col 3

Les lignes de tableau doivent commencer et se terminer avec une barre verticale | pour des lignes normales ou avec un ^ pour les titres.

^ Titre 1         ^ Titre 2           ^ Titre 3                            ^
| Ligne 1 Col 1   | Ligne 1 Col 2     | Ligne 1 Col 3                      |
| Ligne 2 Col 1   | colonnes fusionnées (notez la double barre verticale) ||
| Ligne 3 Col 1   | Ligne 2 Col 2     | Ligne 2 Col 3                      |

Pour fusionner des cellules horizontalement, videz simplement complètement la cellule suivante comme il est montré ci-dessus. Assurez-vous d'avoir toujours le même nombre de séparateurs de cellules !

Les titres de tableau verticaux sont également possibles.

Titre 1 Titre 2
Titre 3 Ligne 1 Col 2 Ligne 1 Col 3
Titre 4 pas de fusion cette fois
Titre 5 Ligne 2 Col 2 Ligne 2 Col 3

Comme vous pouvez le constater, c'est le séparateur ('|' ou '^') précédant une cellule qui détermine le format :

|              ^ Titre 1                  ^ Titre 2          ^
^ Titre 3      | Ligne 1 Col 2            | Ligne 1 Col 3    |
^ Titre 4      | pas de fusion cette fois |                  |
^ Titre 5      | Ligne 2 Col 2            | Ligne 2 Col 3    |

Vous pouvez fusionner des cellules verticalement en ajoutant ::: dans les cellules sous celles avec laquelle elles doivent fusionner. :!: Cette fonctionnalité n'est disponible que pour les versions supérieures à 2009-02-14b

Titre 1 Titre 2 Titre 3
Ligne 1 Col 1 Cette cellule s'étend
verticalement
Ligne 1 Col 3
Ligne 2 Col 1 Ligne 2 Col 3
Ligne 3 Col 1 Ligne 3 Col 3

Ces cellules ne doivent rien contenir d'autre que l'indicateur de fusion vertical.

^ Titre 1       ^ Titre 2                                  ^ Titre 3       ^
| Ligne 1 Col 1 |  Cette cellule s'étend\\ verticalement   | Ligne 1 Col 3 |
| Ligne 2 Col 1 | :::                                      | Ligne 2 Col 3 |
| Ligne 3 Col 1 | :::                                      | Ligne 3 Col 3 |

Vous pouvez également aligner les contenus du tableau (uniquement horizontalement). Ajoutez simplement au moins deux espaces à l'extrémité opposée de votre texte : ajoutez deux espaces sur la gauche pour aligner à droite, deux espaces sur la droite pour aligner à gauche et deux espaces au moins à chaque extrémité pour centrer le texte.

Tableau avec alignement
droite centré gauche
gauche droite centré
xxxxxxxxxxxx xxxxxxxxxxxx xxxxxxxxxxxx

Voici à quoi ça ressemble dans le code source :

^          Tableau avec alignement         ^^^
|        droite|    centré    |gauche        |
|gauche        |        droite|    centré    |
| xxxxxxxxxxxx | xxxxxxxxxxxx | xxxxxxxxxxxx |

Blocs non analysés

Si vous avez besoin d'afficher du texte exactement comme il est saisi (sans aucun formatage), entourez le texte soit de balises <nowiki> soit, plus simplement encore, de double signe pourcent %%.

Voilà du texte qui contient une adresse : http://www.splitbrain.org et de la **mise en formee** ; mais il est reproduit tel quel. La même chose est vraie pour //__ce__ texte// avec une émoticône ;-).

<nowiki>
Voilà du texte qui contient une adresse : http://www.splitbrain.org et de la **mise en formee** ; mais
il est reproduit tel quel.
</nowiki>
La même chose est vraie pour  %%//__ce__ texte// avec une émoticône ;-)%%.
<nowiki>

Extensions de syntaxe : WRAP

Basic Syntax:

<WRAP classes #id width :language>
"big" content
</WRAP>

**or**
<block classes #id width :language>
"big" content
</block>

or
<div classes #id width :language>
"big" content
</div>

An uppercase <WRAP> (or alternatively <block> or <div>) creates a div and should be used for “big” containers, surrounding paragraphs, lists, tables, etc.

<wrap classes #id width :language>"small" content</wrap>

or
<inline classes #id width :language>"small" content</inline>

or
<span classes #id width :language>"small" content</span>

A lowercase <wrap> (or alternatively <inline> or <span>) creates a span and should be used for “small” containers, inside paragraphs, lists, tables, etc.

Since version 2013-06-13 there is also a shorthand syntax (for wraps without content):

<WRAP classes #id /> or <block classes #id /> or <div classes #id />

and

<wrap classes #id /> or <inline classes #id /> or <span classes #id />

:!: Please note, some things won't work with spans: alignments (including alignments generated by changing the text direction), multi-columns and widths if the according wrap isn't floated as well.

Classes

The following classes are currently available:

class name description/notes
columns – similar to columns, side_note, styler, tip
column same as left in LTR languages and same as right in RTL languages
left same as column, will let you float your container on the left
right will let the container float right
center will position the container in the horizontal center of the page
col2..col5 will show the text in multiple columns determined by their amount (2, 3, 4 or 5), only works in modern browsers (no IE9 and below)
colsmall, colmedium, collarge will also show the text in multiple columns but determined by their width (small, medium or large), only works in modern browsers (no IE9 and below)
widths:!: experimental, might not work as expected, includes mobile support
half fits two columns in a row, should be used in pairs
third fits three or two columns in a row, should be used in triplets or together with twothirds
twothirds fits two columns in a row when used together with third, one 1/3 wide and another 2/3 wide
quarter fits four columns in a row, should be used in quads
alignments – similar to divalign, columns, styler:!: don't work with spans!
leftalign aligns text on the left
rightalign aligns text on the right
centeralign centers the text
justify justifies the text
boxes and notes – similar to box, note, tip
box creates a box around the container (uses colours from style.ini)
info (was information in first version) creates a blue box with an info icon
important creates an orange box with an important icon
alert (:!: was warning in previous versions) creates a red box with an alert icon
tip creates a yellow box with a tip icon
help creates a violet box with a help icon
todo creates a cyan box with an todo icon
download creates a green box with a download icon
round adds rounded corners to any container with a background colour or a border (only works in modern browsers, i.e. no IE)
danger creates a red danger safety note
warning creates an orange warning safety note
caution creates a yellow caution safety note
notice creates a blue notice safety note
safety creates a green safety note
marks – similar to emphasis, important_paragraf, importanttext
hi marks text as highlighted
lo marks text as less significant
em marks text as especially emphasised
miscellaneous
clear similar to clearfloat, should preferably be used with divs, i.e. uppercase <WRAP>s
tabs if wrapped around a list of links, will show those as tabs
hide hides the text per CSS (the text will still appear in the source code, in non-modern browsers and is searchable)
noprint displays text on the screen, but not in print, similar to noprint
onlyprint displays text only in print, but not on the screen
pagebreak forces a new page in printouts (not visible on the screen), similar to pagebreak
nopagebreak tries to avoid a pagebreak in printouts (not visible on the screen)
spoiler shows white text on a white background, only to be revealed by highlighting it; similar to hide
button when wrapped around a link, styles it like a button
tablewidth sets widths of tables inside to whichever width the wrap gets, partly replaces tablewidth
indent indents the text, could be used instead of tab
outdent “outdents” the text, could partly be used instead of outdent
prewrap wraps text inside pre-formatted code blocks, similar to wpre

Widths

You can set any valid widths on any uppercase <WRAP> container: %, px, em, rem, ex, ch, vw, vh, pt, pc, cm, mm, in. Just set the width before or after or with the classes, e.g.

<WRAP someclass 50% anotherclass>...

All except percentages will be reduced to have the maximum width available on smaller screens.

You can also use the width keywords half, third, twothirds and quarter. To work correctly they need another wrap around them. E.g.

<WRAP group>
  <WRAP half column>...</WRAP>
  <WRAP half column>...</WRAP>
</WRAP>

will result in two columns next to each other, which will wrap underneath each other on smaller screens and mobile devices.

Anchor

To define an anchor, the following syntax applies:

<wrap #ankername />

The anchor is accessible via: #ankername

Languages and Text Directions

You can change the language and the direction of a container by simply adding a colon followed by the language code, like this:

<wrap :en>This text is explicitly marked as English.</wrap>

The text direction (rtl, right to left or ltr, left to right) will get inserted automatically and is solely dependent on the language. The list of currently supported languages is taken from: http://meta.wikimedia.org/wiki/Template:List_of_language_names_ordered_by_code

If you like to mark a text with a different text direction than the default one, you should use divs, i.e. uppercase <WRAP>s. Otherwise the text alignment won't change as well.

This makes it a better replacement of ltr (and lang).

Examples

The plugin comes with an example page, which should explain a lot and looks like this in the default template (see below).

Demo

You can see a demo of the plugin on demo.selfthinker.org.

1)
Ceci est une note de pied de page
2)
Si les proportions de l'image ne sont pas respectées, celle-ci sera découpée avant redimensionnement selon les nouvelles proportions
wiki/syntax.1680173181.txt.gz · Dernière modification : 30/03/2023 10:46 de cahethel