Aide

Le site officiel de Dokuwiki offre une page d'aide en français, complète et bien faîte que vous consulterez avec plaisir et bienfait, ainsi que la page d'aide en anglais de Dokuwiki qui est régulièrement mise à jour. Cette aide s'en inspire largement.

Brève histoire

wiki veut dire vite en hawaïen. L'expression redoublée, signifiant très vite, a inspiré Ward Cunningham pour créer en 1995 le WikiWikiWeb pour la section d'un site en programmation informatique. What I Know Is semble être un bel acronyme selon le journal The Economist.

Andreas Gohr a créé Dokuwiki en 2004. Open Source, simple à utiliser et très polyvalent, il n'exige aucune base de données. Ses utilisateurs l'aiment pour sa syntaxe propre et lisible. Sa facilité de maintenance, de sauvegarde et d'intégration, en font l'un des favoris des administrateurs. Sur le site de WikiMatrix, vous pourrez comparer DokuWiki aux autres moteurs de wiki. C'est aussi un bel outil pour collaborer, écrire à plusieurs.


Le langage wiki est simple à apprendre et on l'apprend en écrivant et aussi en éditant une page pour voir sa syntaxe, même si celle-ci est en lecture seulement. De plus, la barre d'édition vous aide à faire vos premiers pas. Le mieux, c'est de l' essayer en mode édition et de voir le résultat.

La barre d'édition offre tous les outils de mise en forme. Au survol de la souris sur les icônes, une info bulle vous guide.


Dans la barre d'édition, en cliquant sur |H, un sous-menu apparaît pour choisir le niveau du titre. Titre 1 correspond au titre de plus haut niveau, l'usage est un seul titre de niveau 1 par page.

====== maximum 6 signes égal de chaque côté du titre ======

Le plus petit titre aura deux == de chaque côté ce qui permet 5 niveaux hiérarchiques.
====== Titre 1 ======
===== Titre 2 =====
==== Titre 3 ====
=== Titre 4 ===
== Titre 5==

La ligne de titre ne doit rien comporter d'autre ni avant, ni après les signes ====

Vos titres et sous-titres vont faire apparaître la table des matières, TOC en anglais.

Si vous ne souhaitez pas de table des matières, mettez ~~NOTOC~~ en haut de votre page.


  • Aux classiques gras, italique, souligné, code type «machine à écrire» et barré que vous pouvez combiner à votre guise,
  • vous pouvez aussi mettre en couleur des mots en encadrant de deux, trois ou quatre ; ou : ceci grâce au greffon emphasis
  • ajouter un caractère spécial
  • encadrer un texte sélectionné d'une note, astuce, important, attention

La barre d'Espace a du sens en langage wiki. Par exemple, deux espaces en début de ligne

et hop, nous voilà dans un bloc. Tout code dans cet espace, y compris wiki, ne sera pas considéré. 
Cela peut servir aussi à faire un encadré pour souligner une idée. Pour garder le formatage sur 
plusieurs lignes, la touche Entrée vous sera d'une grande aide. 

Deux retours chariot pour sortir du bloc. Maintenant, deux espaces ou un multiple de deux espaces et une étoile *

  • nous donne un liste à puces, que vous auriez aussi trouvé dans la barre d'édition
  • et si vous continuez par une touche entrée, vous enchaînez automatiquement.
    • ajouter encore deux espaces devant et vous voilà dans une sous liste
    • pour préciser des choses que vous voyez bien comme des détails du sujet supérieur
  • avec la touche Retour chariot, revenez en arrière.

cela forme un petit bloc, un paragraphe si l'on veut, et un saut de ligne nous fait changer d'ambiance. Voyons, essayons la même chose pour une liste numérotée deux Espaces plus le - de la touche 6

  1. ici
    1. et avec encore deux espaces, nous voilà dans une sous-liste.
      1. et encore plus détaillé
    2. avec la retour chariot, revenons en arrière
  2. et encore

une tabulation ou un saut de ligne pour sortir du bloc. Si vous sortez du bloc, vous perdez la numérotation mais si vous remontez, en enlevant les espaces, vous pouvez reprendre là où vous étiez.

Enfin, la touche espace sert aussi à aligner le texte avec les images. {{uneimage.png }} placera le texte à droite, {{ uneimage.png}} placera le texte à gauche et {{ uneimage.png }} laissera le texte à gauche et à droite de l'image centrée.

les balises <code [abr. du code]> </code> entourant du code crée un bloc où le code ne sera pas interprêté mais apparaîtra avec une coloration syntaxique. Il suit la syntaxe GeSHi. Dans cet exemple, ce qui est entre les balises <code php> </code> apparait ainsi :

<?php
phpinfo();
?>

Avec un signe > ou >> ou >>>

vous obtenez une citation
avec deux vous pouvez converser
et tenter des choses en les combinant
Mais vous pouvez aussi
signaler un
paragraphe entier c'est sobre et joli

Pour faire une note de pied de page encadrer simplement votre note entre des parenthèses doubles (( une note en pied de page )) et cela ajoutera 1)avec une info bulle au survol de la souris.


Le saut de ligne permet de changer de section. Il permet aussi d'aérer le texte, de lui donner de la lisibilité. Insérer une ligne horizontale peut aussi aider à structurer votre texte. Quatre tirets ou plus ---- vous crée une ligne.


Parfois, l'on peut avoir besoin d'aller à la ligne sans quitter le paragraphe dans lequel on est. \\ deux barres obliques inversées vous le permettent. Toutefois, n'en abusez pas car en même temps vous perdez l'enchaînement automatique du texte lorsque par exemple vous ajouterez une image ou que vous changerez de mise en page.

Si vous voulez qu'un mot, une phrase ou un paragraphe échappe à l'analyse du langage wiki, il vous   
suffit de %% l'encadrer avec un double caractère pourcentage %% ou de le mettre entre <nowiki> deux 
balises, l'une ouvrante et l'autre fermante </nowiki> 

En savoir plus tout de suite sur la syntaxe de Dokuwiki

La grande force des wikis est leur possibilité de mettre en relation des pages à l'intérieur d'un wiki mais aussi de créer facilement des liens inter-wiki ou vers des pages d'autres sites. Qui ne s'est pas perdu avec délice dans Wikipedia suivant le fil des liens, en cherchant une information. L'icône à droite “Liens vers cette page” permet de connaître tous les liens pointant vers la page actuelle. On les appelle rétroliens, liens inverses ou backlinks.

Les liens internes et externes vers des pages ont pour syntaxe : [[ URL du lien | nom du lien ]] soit deux crochets ouvrants, nom de l'URL du lien, le signe | de séparation, le nom du lien et les deux crochets fermants. Si vous oubliez un crochet, vous aurez des aberrations de mise en page.

Les liens externes et interwiki

Pour faire un lien, cliquer sur l’icône et cela vous affichera [[http://example.com|Lien externe]]. Pour faire un lien vers un site web, mettez l'URL de la page à la gauche du signe | et le nom que vous voulez donner à ce lien dans la partie droite du signe |. Pour le nom du lien, vous êtes libre de la syntaxe et de mettre des espaces. Si vous avez déjà une URL écrite dans votre texte [[http://example.com]], elle sera interprété comme un lien externe http://example.com mais vous perdez la mise en forme et le nom du lien. Dans ce cas, sélectionnez le texte de l'URL et cliquer sur l'icône qui se chargera de l'encadrer entre crochets.

Les liens interwiki évitent d'avoir à écrire l'URL en entier (la partie gauche) en proposant un “raccourci” vers un site en particulier. Ces sites sont définis dans un fichier de configuration interwiki.conf. Par exemple, pour faire un lien vers la page Système d'échanges local de Wikipedia, on écrira [[wp>Système_d'échange_local|Systèmes d'échanges local]], soit le raccourci wp suivi de > et du nom de la page souhaitée.

Les liens internes

Pour créer un lien interne vers une page, cliquer sur l'icône . Cela vous ouvre l'assistant de liens qui vous propose l’arborescence des pages et des dossiers du wiki. En double cliquant sur les dossiers, vous ouvrez le dossier et vous pouvez chercher la page désirée. Pour remonter dans l'arborescence, cliquer sur Allez à la catégorie parente. Enfin, cliquez sur la page vers laquelle vous souhaitez faire un lien. Vous pouvez aussi sélectionner un mot dans votre texte et aller chercher la page vers laquelle vous souhaitez faire un lien. Cela l'entourera de crochets, ajoutant à la gauche de | le chemin vers la page et votre texte sélectionné sera à droite du signe |. Par exemple, pour faire un lien vers la page Contact de ce site [[ressources:contact|Contact]]

Créer une nouvelle page

Avant de voir comment créer une nouvelle page, deux mots sur le plan du site ou la représentation de l'arborescence dans DokuWiki. Le répertoire racine de DokuWiki est représenté par deux points : et ce signe apparaît entre chaque page dans un chemin de pages. Son équivalent plus connu et commun à des systèmes d'exploitation UNIX like et à l'HTML est la / barre oblique.

Par exemple [[:ressources:plus:aide|Aide Wiki]], où :ressources:plus:aide représente le chemin pour cette page. On peut dire aussi que la page aide se trouve dans le dossier plus, dossier qui se trouve lui-même dans le dossier ressources. Le terme officiel employé est espace de noms (namespace en anglais) mais le mot “catégorie de pages” est le terme officiel utilisé dans la documentation DokuWiki. La barre verticale comme on l'a vu plus haut | permet de préciser le titre de la page ou le texte que l'on veut afficher à propos de ce lien, dans ce cas : Aide Wiki.

Dans le cas d'une page comportant une table des matières, on peut également préciser à quelle section de la page on se réfère en ajoutant # suivi du nom du titre comme dans [[ressources:plus:aide#les_liens| Aller à la section traitant des liens]]. C'est très pratique quand on est dans un long document. On peut également au sein d'une même page faire un lien vers une section en écrivant [[#les_liens|Aller à la section traitant des liens]] ce qui créera une ancre pour la section traitant des liens

Pour créer une nouvelle page, on créé un lien vers une page encore non existante et on suit le lien en cliquant dessus.

Par exemple nous sommes dans la page aide à cette adresse [[ressources:plus:aide]] et disons que cette page commence à être longue et que j'aimerais traiter du gestionnaire des médias dans une autre page, fille de celle-ci. Je vais donc ajouter :media à la fin [[ressources:plus:aide:media|Gestionnaire des médias]] et cela va me créer un lien vers cette nouvelle page Gestionnaire des médias

Comme vous le voyez, le lien est rouge. Il l'est et le restera tant que vous n'aurez pas cliqué dessus et répondu à la question : cette page n'existe pas encore, voulez-vous la créer ?

Selon vos autorisations sur le wiki, vous pourrez cliquer sur l'icône sur la droite et la page s'ouvre en modification, avec l'éditeur. Écrivez quelque chose et cliquer sur Enregistrer. Votre page est créée et le lien, désormais valide, change de couleur pour devenir bleu (selon le thème choisi, cela peut différer).

Pour supprimer une page, il vous suffit de retourner dedans, d'effacer le contenu et d'enregistrer. Il faudra aussi penser à supprimer le lien que vous avez créé vers cette page.

Le gestionnaire des médias permet de téléverser des images et autres fichiers, de les organiser dans des répertoires puis de les afficher où vous les souhaitez dans la page. Pour accéder au gestionnaire des médias, en mode modification d'une page, cliquez sur l'icône .

Dans la fenêtre qui s'ouvre, choisissez dans le panneau à gauche le répertoire où vous souhaitez mettre le média . Cliquer sur les signes + pour découvrir l'arborescence. L'endroit où vous vous trouvez est visible en haut, dans l'exemple dans l'image à droite :extensions:struct

Cliquez sur Sélection de fichiers et choisissez le(s) fichier(s) que vous souhaitez téléverser.

Une fois envoyé(s), cliquer sur Terminé. En faisant défiler l’ascenseur vers le bas, cliquer sur le fichier que vous souhaitez intégrer dans la page, ce qui fait apparaître une fenêtre de Paramètres de lien avec des options par défaut, s'agissant dans cet exemple d'une image :

label du fichier - optionnel

En laissant le curseur de la souris sur les options, une info-bulle vous renseigne sur les options. Cliquer sur Insérer. Le gestionnaire des médias se ferme et vous trouvez dans votre page la syntaxe suivante :

{{:extensions:struct:media1.png?200|label du fichier - optionnel mais conseillé}} les double accolades ouvrantes et fermantes signalent qu'il s'agit d'un média. Comme dans les liens vus plus haut le chemin est indiqué par :chemin:chemin: suivi par le nom du fichier suivi d'un ? et d'un chiffre (dans le cas d'une image). Enfin comme dans le chemin, après la barre verticale |, on peut donner un label (info-bulle) au fichier média pour l'accessibilité. Essayez d'inclure plusieurs fois le même fichier en faisant changer les options pour voir les changements de syntaxe, puis de constater en cliquant sur Aperçu les différences de comportements.

Comment créer un répertoire dans le gestionnaire de médias

à venir sous peu

FAQ

  • Comment rendre cliquable une image
  • Comment faire un tableau et pouvoir trier les colonnes
  • mise en page

Auteur : Gilles Kotzebtchouk


1)
une note en pied de page
  • ressources/plus/aide.txt
  • Dernière modification: 09/12/2017 13:29
  • (modification externe)