DokuWiki se caractérise entre autres par un formatage simple du texte. Cela permet de conserver une bonne lisibilité des fichiers contenant le contenu. Les sections suivantes énumèrent les types de formatage possibles qui peuvent être utilisés au sein de l'éditeur. Certains des formatages présentés ici sont également directement accessibles via les Quickbuttons. Tu trouveras un premier exemple de la structure d'une page en affichant cette page en mode texte source. Pour cela, clique sur le bouton „Aperçu“.
Pour essayer ou s'entraîner, on peut utiliser le terrain de jeu.
Comme nous voulons que PC CADDIE soit toujours sur une ligne dans le wiki, nous l'écrivons comme suit : PC CADDIE
S'il vous plaît, allez éditer et regardez ! Sinon, vous ne voyez pas ce que l'on veut dire…
DokuWiki supporte mettre en gras, l'italique, souligné et en caractères gras
(texte épais). Bien sûr, tout peut être combinés
peut être utilisé.
DokuWiki supporte **en gras**, //l'italique//, __souligné__ et ''en caractères gras'' le texte. Bien sûr, tout peut être **__//''combinés''//__** peuvent être combinées.
Il existe également des à la position basse et en exposant Texte.
De même, il existe <sub>des textes en indice</sub> et <sup>en exposant</sup> Texte.
Le texte peut être défini comme supprimé1).
Le texte peut être marqué comme <del>supprimé</del> peut être marqué.
Un paragraphe est créé par une ligne vide. Une nouvelle ligne (retour à la ligne) peut être créée par deux „backslashs“ (barres obliques inversées : \\) suivies d'un espace.
Voici un exemple de texte avec quelques sauts de ligne.
Remarque : les deux barres obliques inversées
ne sont reconnues que si elles sont placées en fin de ligne
ou si elles sont suivies d'une
sont suivis d'un espace.
Voilà\\se présente sans espace.
Il s'agit d'un exemple de texte avec quelques retours à la ligne.\\ Attention : les deux barres obliques inversées ne sont reconnus que s'ils sont placés en fin de ligne\\ ou si elles sont suivies d'une\\ sont suivis d'un espace.\\ Voilà\\se présente sans espace.
Les retours à la ligne par deux „backslashs“ (barres obliques inversées : \\) ne doivent être utilisées que si elles sont absolument nécessaires.
Cinq niveaux différents, séparés par des titres, permettent de structurer le contenu d'une page. Les titres sont encadrés par six „=“ au maximum, en fonction de leur taille. H1 est le titre de niveau le plus élevé. Le plus simple pour créer des titres est d'utiliser la barre d'outils. L'insertion des titres se fait à l'aide des boutons qui affichent un „H“.
Il est judicieux de consulterIl est judicieux de toujours placer un titre de niveau 1 au début d'un article.
S'il y a plus de trois titres dans une page, une table des matières est automatiquement créée, qui répertorie tous les titres.
Si cette table des matières ne doit pas être créée, il faut utiliser la commande : ~~NOTOC~~
doit être incluse dans la page.
====== Titre niveau 1 ====== ===== Titre niveau 2 ===== ==== Titre niveau 3 ==== === Titre niveau 4 === == Titre niveau 5 ==
Par défaut, aucun autre formatage ne peut être effectué à l'intérieur des titres ! (s. FAQ - Liens d'en-tête)
Pour afficher le texte tel qu'il a été écrit, qu'il contienne des mises en forme DokuWiki ou autres, on peut faire en sorte que chaque ligne soit séparée par deux lignes. ligne commence par deux espaces (comme cela a été appliqué dans cette page) ou utiliser l'un des identificateurs „code“ ou „file“ :
Mit "code": In diesem Text werden keine überflüssigen Leerzeichen entfernt: wie hier <-- zwischen
<file plain Beispiel.txt> Mit dem Bezeichner "file" kann ein bestimmter Abschnitt als einzelner Bestandteil auf einer Seite zum Download angeboten werden. </file>
Dans „file“, il est également possible d'activer la mise en évidence de la syntaxe, décrite dans la section ci-dessous. Mise en évidence de la syntaxe.
#!/usr/bin/perl print "Hello World!\n";
<file perl HelloWorld.pl> #!/usr/bin/perl print "Hello World!\n"; </file>
Pour empêcher toute conversion par DokuWiki, entoure la zone correspondante avec des identificateurs „nowiki“ ou, plus brièvement, avec des signes de pourcentage doubles %%
.
Ce texte contient des liens tels que : http://www.splitbrain.org et **des mises en forme** mais ils ne sont pas mis en œuvre et apparaissent comme du texte normal.
Ce texte est maintenant marqué avec .%%
est marqué et a le même effet que "nowiki".
"Ce texte contient des liens tels que : http://www.splitbrain.org et **des mises en forme** mais ils ne seront pas mis en œuvre et apparaîtront comme du texte normal."
Il suffit de regarder le code source de cette page (appuyer sur le bouton „Edit“) pour voir comment ces blocs sont appliqués.
DokuWiki connaît la surbrillance syntaxique pour le code source afin d'en améliorer la lisibilité. Pour cela GeSHi „Generic Syntax Highlighter“ est utilisé. Ainsi, chaque langage de programmation que GeSHi connaît est supporté.
Le même identificateur que dans la section précédente est utilisé, sauf qu'il contient maintenant aussi le nom du langage :
<code java> Quelltext </code>
/** * 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. } }
Les langages suivants sont pris en charge : actionscript, actionscript-french, ada, apache, applescript, asm, asp, bash, caddcl, cadlisp, c, c_mac, cpp, csharp, css, delphi, diff, d, div, dos, eiffel, freebasic, gml, html4strict, ini, inno, java, javascript, lisp, lua, matlab, mpasm, nsis, objc, ocaml, ocaml-brief, oobas, oracle8, pascal, perl, php-brief, php, python, qbasic, scheme, sdlbasic, smarty, sql, ruby, vb, vbnet, vhdl, visualfoxpro, xml
Pour indiquer qu'un texte est une citation ou un commentaire, le signe „plus grand que“ est utilisé de la manière suivante :
Je pense que nous devrions le faire.
> Non, on ne devrait pas.
>> Si !
> Vraiment ?
>> Oui !
>>> Alors, faisons-le !
>>> Les commentaires ou citations peuvent aussi s'étendre sur plusieurs lignes, comme le montre ce texte totalement absurde. Pour indiquer qu'un texte est une citation ou un commentaire, le signe "plus grand que" est utilisé de la manière suivante
Je pense que nous devrions le faire
Non, on ne devrait pas.
Si !
Vraiment ?
Oui !
Alors, faisons-le
Les commentaires ou citations peuvent aussi s'étendre sur plusieurs lignes, comme le montre ce texte totalement absurde. Pour indiquer qu'un texte est une citation ou un commentaire, le signe „plus grand que“ est utilisé de la manière suivante
Si l'on veut empêcher DokuWiki d'effectuer un quelconque formatage ou une quelconque transformation dans le texte, on peut utiliser les signes de pourcentage
%%[[wiki:testseite|Testseite]]%%
La sortie ressemblerait alors à .[[wiki:testseite|Page de test]]
Les notes de bas de page 2) sont représentées par une double parenthèse ronde 3). Le texte entre les parenthèses est écrit en bas de la page. L'ordre et donc la numérotation sont assurés par DokuWiki.
Les notes de bas de page ((ceci est une note de bas de page)) sont représentées par une double parenthèse ronde ((une deuxième note de bas de page)).
Cinq types de liens différents peuvent être utilisés avec DokuWiki :
Les liens externes (références à d'autres sites web ou fichiers) sont automatiquement reconnus : http://www.google.com ou simplement www.google.com. Les renvois peuvent également être cachés derrière des termes propres : hier est google. Les adresses e-mail sont placées entre parenthèses pointues : andi@splitbrain.org.
Les liens externes sont automatiquement reconnus : http://www.google.com ou simplement www.google.com. Les renvois peuvent également être cachés derrière des termes propres : [[http://www.google.com|hier est google]]. Les adresses e-mail sont placées entre parenthèses pointues : <andi@splitbrain.org>.
Les liens internes, c'est-à-dire les renvois à des pages à l'intérieur de DokuWiki, sont placés entre doubles crochets („Alt Gr+8“ ou Alt Gr+9 sous Windows ou Option+5 et Option+6 sur les systèmes d'exploitation Apple) : pagename
Un lien peut également être caché derrière un terme ou une description : Description pour un lien.
Les liens internes sont placés entre doubles crochets :
Un lien peut également être caché derrière un terme ou une description : [[pagename|Description pour un lien]].
Les noms de fichiers pour les nouvelles pages du wiki sont automatiquement convertis en minuscules ! Les trémas, tout comme les caractères spéciaux, ne sont pas autorisés !
Les deux-points permettent de dissoudre les espaces de noms dans le wiki : namespaces
Les deux points dissolvent les espaces de noms dans le wiki :[[de:namespaces]]
Pour plus d'informations sur les espaces de noms : de:namespaces .
Il est également possible de créer un lien vers une section spécifique au sein du document (ancre). Le nom de la section, séparé par un double-croix (#), est ajouté au nom de la page.
Cet exemple crée un lien vers cette section.
Cet exemple fait un lien vers la section [[fr:wiki:syntax#intern|cette section]].
Notes :
DokuWiki supporte également les liens vers d'autres wikis, appelés de:interwiki liens. Un lien vers la page Wikipedia sur les wikis :Wiki
DokuWiki supporte également des liens vers d'autres wikis, appelés liens [[doku>de:interwiki]] . Un lien vers la page Wikipedia sur les wikis :[[wpde>Wiki]]
DokuWiki connaît aussi des liens vers des partages Windows : dossier partagé. Cela n'a cependant de sens que dans un groupe d'utilisateurs homogène (voir Intranet ).
[[\\server\freigabe|this]].
Remarque :
Les images peuvent être utilisées pour créer un lien vers un fichier interne ou externe. Pour cela, il suffit de combiner la syntaxe d'affichage des liens avec celle d'affichage des images (voir ci-dessous) :
[[http://www.php.net|{{wiki:dokuwiki-128.png}}]]
Attention : le formatage des images est le seul formatage qui peut être utilisé dans les noms de liens !
Pour pouvoir enregistrer des images dans le DokuWiki, l'utilisateur doit disposer de l'autorisation correspondante (ACL). Pour le téléchargement, il faut au moins l'autorisation „Télécharger“ (angl. „Upload“), pour la suppression, l'autorisation „Supprimer“ (angl. „Delete“) pour l'espace de travail „WikiLeaks“. namespaces est nécessaire.
Les accolades permettent d'intégrer des images externes et internes. images peuvent être intégrées à. Dans cet exemple, l'image s'appelle „dokuwiki-128.png“. Leur taille peut être indiquée en option :
Préciser la largeur et la hauteur :
Préciser la taille des images externes :
Taille originale : {{wiki:dokuwiki-128.png}} Définir une largeur : {{wiki:dokuwiki-128.png?50}} Préciser la largeur et la hauteur : {{wiki:dokuwiki-128.png?200x50}} Préciser la taille pour les images externes : {{http://de3.php.net/images/php.gif?200x50}}
Avec des espaces à droite et/ou à gauche à l'intérieur des parenthèses, une image peut être alignée horizontalement (gauche, centrée, droite).
Lors de l'alignement et de l'utilisation d'un titre, il faut veiller à ce que le titre soit placé après l'espace :
{{wiki:dokuwiki-128.png |Alignement à gauche}} {{ wiki:dokuwiki-128.png |Centré }} {{ wiki:dokuwiki-128.png|Aligné à droite}}
Il est également possible d'indiquer des titres, affichés sous forme d'infobulles dans la plupart des navigateurs.
{{ wiki:dokuwiki-128.png |Ceci est un titre}}
Si un fichier est indiqué qui ne contient pas d'image (gif, jpeg, png
), il est affiché sous forme de lien et proposé ainsi au téléchargement.
{{ wiki:dokuwiki-128.txt |Beispiel}}
Les images sont automatiquement créées avec un lien vers votre Metadaten - Ex :
Ce comportement peut être empêché par l'option ?nolink4)5) :
En outre, ?direct permet de créer un lien direct vers l'image, par exemple en plein écran :
DokuWiki connaît des listes non triées et des listes numérotées. Pour créer une entrée de liste, commencez une ligne par deux espaces. Ces espaces sont suivis d'un „*“ pour les listes non triées ou d'un „-“ pour les listes numérotées.
* Dies ist ein Eintrag einer unsortierten Liste * Ein zweiter Eintrag * Unterschiedliche Ebenen einer Liste durch Hinzufügen von weiteren zwei Leerzeichen * Noch ein Eintrag - Dies ist ein Eintrag einer nummerierte Liste - Ein zweiter Eintrag - Unterschiedliche Ebenen einer Liste durch Hinzufügen von weiteren zwei Leerzeichen - Noch ein Eintrag
Avec DokuWiki, il est très facile de créer des tableaux :
Les champs d'un tableau commencent par „|“ pour un champ normal ou par un „^“ pour un champ mis en évidence.
^ mis en évidence ^ par exemple pour ^ une ligne de titre ^ | ligne 1 colonne 1 | ligne 1 colonne 2 | ligne 1 colonne 3 | | ligne 2 colonne 1 | double largeur de colonne (remarquez le double trait vertical) || | ligne 3 colonne 1 | ligne 2 colonne 2 | ligne 2 colonne 3 |
Les cellules sur plusieurs colonnes sont créées en plaçant à la fin d'une telle colonne, comme indiqué ci-dessus, autant de „|“ ou „^“ sans espace entre eux que de colonnes à enjamber. En résumé, toutes les lignes d'un tableau doivent avoir le même nombre de séparateurs de champs „|“ ou „^“.
Il est également possible de mettre des champs en surbrillance dans l'alignement vertical.
en surbrillance 1 | en surbrillance 2 | |
---|---|---|
en surbrillance 3 | Ligne 1 colonne 2 | Ligne 1 colonne 3 |
en surbrillance 4 | Ligne 2 Colonne 2 | |
en surbrillance 5 | Ligne 3 Colonne 2 | Ligne 3 Colonne 3 |
Comme nous le voyons, le séparateur de champ („|“ ou „^“) placé devant une cellule décide de son apparence :
| ^ en surbrillance 1 ^ en surbrillance 2 ^ ^ en surbrillance 3 | Ligne 1 colonne 2 | Ligne 1 colonne 3 | ^ en surbrillance 4 | Ligne 2 Colonne 2 | | ^ en surbrillance 5 | Ligne 3 Colonne 2 | Ligne 3 Colonne 3 |
Champs sur plusieurs lignes (cellules reliées verticalement) peuvent être modifiées en ajoutant :: :
dans la cellule à fusionner.
Ligne de titre 1 | Ligne de titre 2 | Ligne de titre 3 |
---|---|---|
Ligne 1 Colonne 1 | Cette cellule est reliée verticalement | Ligne 1 Colonne 3 |
Ligne 2 Colonne 1 | :: : | Ligne 2 Colonne 3 |
Ligne 3 Colonne 1 | :: : | Ligne 3 Colonne 3 |
En dehors des trois deux points, la cellule à relier ne doit pas avoir d'autre contenu.
^ Ligne de titre 1 ^ Ligne de titre 2 ^ Ligne de titre 3 ^ | Ligne 1 Colonne 1 | Cette cellule est reliée verticalement | Ligne 1 Colonne 3 | | Ligne 2 Colonne 1 | :: : | Ligne 2 Colonne 3 | | Ligne 3 Colonne 1 | :: : | Ligne 3 Colonne 3 |
Champs sur plusieurs colonnes (cellules reliées horizontalement) peuvent être modifiées en ajoutant des ^
ou |
dans la cellule à fusionner.
Ligne de titre 1 | Ligne de titre 2 | Ligne de titre 3 |
---|---|---|
Ligne 1 Colonne 1 | Cette cellule est reliée horizontalement | |
Ligne 2 Colonne 1 | Ligne 2 Colonne 2 | Ligne 2 Colonne 3 |
Ligne 3 Colonne 1 | Ligne 3 Colonne 2 | Ligne 3 Colonne 3 |
En dehors des trois deux points, la cellule à relier ne doit pas avoir d'autre contenu.
^ Ligne de titre 1 ^ Ligne de titre 2 ^ Ligne de titre 3 ^ | Ligne 1 Colonne 1 | Cette cellule est reliée horizontalement || | Ligne 2 Colonne 1 | Ligne 2 Colonne 2 | Ligne 2 Colonne 3 | | Ligne 3 Colonne 1 | Ligne 3 Colonne 2 | Ligne 3 Colonne 3 |
Le contenu d'une cellule peut être aligné horizontalement à l'intérieur de la cellule :
Tableau avec alignement | ||
---|---|---|
Droite | Centre | Gauche |
Gauche | Droite | Centre |
xxxxxxxxxx | xxxxxxxxxx | xxxxxxxxxx |
Voici à quoi ressemble le formatage :
^ Tableau avec alignement ^^^ | Droite| Centre |Gauche | |Gauche | Droite| Centre | | xxxxxxxxxx | xxxxxxxxxx | xxxxxxxxxx |
Remarque concernant le caractère de barre verticale : ce caractère est accessible sur un clavier d'ordinateur via la touche „ .<“ bei zusätzlich gedrückter „AltGr“-Taste. Ist dort auch aufgedruckt. Apple-Nutzer erreichen das Zeichen mit der Wahltaste („Alt“) und der „7“. |
Mit vier aufeinander folgenden Minuszeichen (alleine in einer Zeile) kann eine horizontale Linie erzeugt werden:
----
DokuWiki verwandelt oft genutzte Emoticons zu kleinen Smiley-Grafiken.
Weitere Smiley-Grafiken können im Ordner „smily“ abgelegt und dann in der Datei conf/smileys.conf
bzw. für benutzereigene Smileys unter conf/smileys.local.conf
eingetragen werden.
Hier ist nun eine Übersicht der standardmäßig in DokuWiki enthaltenen Smileys:
| | | | | | | | | | | | | | | | | | | |
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
8-) | 8-O | :-( | :-) | =) | :-/ | :-\ | :-? | :-D | :-P | :-O | :-X | :-| | ;-) | :?: | :!: | ^_^ | LOL | FIXME | DELETEME |
DokuWiki kann einfache Textzeichen in ihre typografischen Entsprechungen umwandeln. Hier eine Liste aller Zeichen, die DokuWiki kennt:
→ ← ↔ ⇒ ⇐ ⇔ » « – — 640×480 © ™ ® „He thought 'It's a man's world'…“
-> <- <-> => <= <=> >> << -- --- 640x480 (c) (tm) (r) "He thought 'It's a man's world'..."
Bitte beachtet: Diese Umwandlungen können in der Konfigurationsdatei abgestellt werden
In einer Seite kann sowohl HTML als auch PHP direkt benutzt werden.
<html> This is some <font color=„red“ size=„+1“>HTML-Code</font> </html>
<html> This is some <font color="red" size="+1">HTML-Code</font> </html>
<php> echo 'A logo generated by PHP:'; echo '<img src=„' . $_SERVER['PHP_SELF'] . '?=' . php_logo_guid() . '“ alt=„PHP Logo !“ />' ; </php>
<php> echo 'A logo generated by PHP:'; echo '<img src="' . $_SERVER['PHP_SELF'] . '?=' . php_logo_guid() . '" alt="PHP Logo !" />'; </php>
Attention: L'intégration du HTML et du PHP dans une page peut être désactivée dans le fichier de configuration6). Si cette option est activée, le code source de ces sections sera affiché sous forme de texte et ne sera pas exécuté.
AttentionL'intégration de HTML et de PHP sur une page Internet constitue généralement un risque de sécurité important ! Cette fonction est uniquement destinée à l'Intranet !
Certaines commandes syntaxiques influencent la manière dont Dokuwiki affiche une page lors de l'appel. Les macros de contrôle suivantes sont disponibles :
Macro | Description |
---|---|
~~NOTOC~~ | Lorsque cette macro est intégrée dans une page, le Table of Content n'est pas créée. |
~~NOCACHE~~ | Toutes les pages sont mises en cache pour des raisons de performance. Dans certaines circonstances, ce comportement n'est toutefois pas souhaité. Lorsque cette macro est insérée, DokuWiki reçoit l'instruction de reconstruire le contenu de la page. |
La syntaxe de DokuWiki peut être améliorée par des Plugins peuvent être étendus. L'utilisation de chaque plugin est décrite dans les pages de description correspondantes. Les plugins suivants sont disponibles sur cette installation de DokuWiki :