Syntaxes de plugin
Parfois il n'y a pas grand chose à dire sur la syntaxe, faire une page pour chaque paraît un peu trop.
On pourrait sans doute en rapatrier plus ici.
Je crois qu'il vaut mieux séparer la syntaxe de base, propre au wiki, de celle des plugins. En cas de désinstallation/mise à jour foireuse, ce sera plus facile de s'y retrouver ? À discuter. — zatalyz 2013/02/14 18:02
Hidden
- Hidden : Fait des vraies balises de “spoil”.
La syntaxe de base est assez simple :
<hidden>Texte caché</hidden>
On peut changer le texte par défaut pour déplier la balise.
<hidden Bla bla>Texte caché</hidden>
Option | Effet | Exemple |
---|---|---|
onHidden=“Un texte” | Affiche ce texte quand la section est cachée | Voir dessous |
onVisible=“Un autre texte” | Affiche ce texte quand la section est dépliée | <hidden onHidden=“Cliquez pour lire plus” onVisible=“Cliquez pour en voir moins”>Texte caché</hidden> |
onExportPdf=“Un texte” | Affiche “Un texte” lorsque la page dw2pdf est exportée (par défaut le texte caché sera affiché sinon)1) | <hidden onExportPdf=“Vous lisez un pdf, vous ne pouvez cliquer”>Texte caché</hidden> |
initialState=“visible” | Le bloc est déplié par défaut. Les lecteurs peuvent cliquer pour le replier. | |
-noprint | Le texte “Cliquer pour afficher” n'apparaîtra pas à l'impression | |
-edit=“Un texte” | Ajoute un bouton “éditer” sous la section cachée.Le texte apparaît quand on laisse la souris sur le bouton. | |
-edit | Comme au dessus mais le texte par défaut est affiché. |
Nuage de Tags et de Mots
- Cloud : affiche des nuages de mots : les mots les plus utilisés sur le wiki, les tags, et les mots les plus recherchés.
Mots les plus uilisés sur le wiki :
~~CLOUD~~ ~~CLOUD:number~~
Par défaut, ce sont les 50 mots les plus utilisés qui sont affichés. Remplacez number par un chiffre entre 1 et 999 pour choisir combien seront affichés.
Tags du wiki :
~~TAGCLOUD~~ ~~TAGCLOUD:number~~ ~~TAGCLOUD:number>namespace1:subns11|.|namespace2~~
Vous pouvez n'afficher que les tags d'un certain espace de nom avec la syntaxe ci-dessus.
En théorie, on devrait aussi pouvoir afficher les mots les plus recherchés avec :
~~SEARCHCLOUD~~ ~~SEARCHCLOUD:number~~
En pratique, le plugin permettant de faire ça n'est pas installé car incompatible avec notre version de dokuwiki. À venir !
Catégories, tags, pagelist
Index, menus et recherche de pages
Couleurs
Wrap : Boîtes et mise en page
Le plugin Wrap, extrêment complet, permet un grand nombre de fantaisie de mise en page. Il est détaillé ici.
Menus
Lister les pages et les espaces de noms en générant automatiquement des menus. Article détaillé
Pages orphelines et demandées
* Orphanswanted : Listes les pages orphelines et les pages demandés.
Sur les pages utilisant les fonction d'Orphanswanted,il est recommandé de mettre
~~NOCACHE~~
Ça évite de lister des pages où l'utilisateur n'a pas les autorisations, entre autre. Ce plugin gère les accès ACL.
Pour lister les pages orphelines (page existant mais sans lien pointant sur elle) :
~~ORPHANSWANTED:orphans~~
Pour lister les pages demandés (qui n'existent pas, mais dont les liens apparaissent dans le wiki) :
~~ORPHANSWANTED:wanted~~
Pour lister les pages valides (page existant, accessible via un autre lien) :
~~ORPHANSWANTED:valid~~
On peut aussi afficher les trois types de fonction en une seul fois avec :
~~ORPHANSWANTED:all~~
On peut exclure de la liste les pages faisant partie d'un espace de nom en rajoutant un point d'exclamation puis le nom de l'espace de nom, par exemple :
~~ORPHANSWANTED:orphans|wanted|valid|all[!namespace!another!one:with:subspaces]~~ ~~ORPHANSWANTED:wanted!wiki~~ ~~ORPHANSWANTED:orphans!wiki!sys:personal~~
Inclure des morceaux de page
Include permet d'inclure des pages situé ailleurs dans le wiki. C'est parfois utile. Le plugin est très complet, cf le lien… mais pour faire rapide, si vous voulez ajouter une section (par exemple la section brosse de la page balai) :
{{page>fr:balai#brosse}}
Intégrer des vidéos
Parfois une vidéo appuie avec plaisir un long discours. Mais elle ne doit jamais se substituer à un discours !
Lorsque vous mettez une vidéo pour expliquer quelque chose, pensez à mettre aussi le texte, voir des images avec. Pensez aux malvoyants, aux épileptiques, aux sourds et à tous les adeptes de la lecture en survol !
Pour la syntaxe : vous avez la petite icone en forme de clap de cinéma dans la barre d'outil. Cliquez, collez le lien de la page, et voilà !
La syntaxe sinon est très simple et obéit à la logique habituelle de Dokuwiki :
{videosite>videoid?taille|titre}}
Où videosite
est le nom du site hébergeant la vidéo, videoid
est l'identifiant de la vidéo sur le site en question. Le paramètre taille
est facultatif et peut être renseigné en largeurxhauteur (comme 500 × 300), ou en utilisant les mots-clés small
, medium
ou large
. Le titre est aussi facultatif.
La vidéo peut être aligné en ajoutant des espaces sur la gauche, la droite ou des deux côtés (comme dans la syntaxe des images).
Par exemple une vidéo de youtube, centrée, petite, avec un titre :
{{ youtube>NjacC9cLYbQ?small |Ceci n'est pas un pendo}}
Changer la façon dont le sommaire automatique apparait
La balise suivante va permettre d'afficher le sommaire avec une autre mise en page :
{{INLINETOC}}
Mettre des commentaires cachés dans les articles
Il est possible de cacher des commentaires dans les articles. Quelqu'un qui lit l'article ne verra pas ce qui est commenté ; il faut regarder la source de l'article (ou l'éditer, c'est pareil) pour le voir. Cela permet de cacher un temps des liens qui sont morts, de laisser des précisions au prochain écrivain de la page, mais aussi sur l'um1 ou la mediateki, de cacher des infos pour des chasses au trésor.
Le texte /* entre les deux slash-astérisques */ est caché.
Le texte est caché.
On peut aussi cacher plusieurs lignes :
/**
* Bla bla sur plusieurs lignes
*
* Des tas de lignes !
*/
Et ceci marche aussi :
/********** Ajouté par Moi **********/
Taille de la police
Le plugin fontsize2 permet de mettre la police de caractère dans des tailles différentes. Il y a un bouton dans la barre d'édition. Le code et la taille correspondantes sont indiqués ci-dessous :
- <fs xx-small>Texte</fs> :
- <fs x-small>Texte</fs> :
- <fs small>Texte</fs> :
- <fs medium>Texte</fs> :
- <fs large>Texte</fs> :
- <fs x-large>Texte</fs> :
- <fs xx-large>Texte</fs> :
- <fs smaller>Texte</fs> :
- <fs larger>Texte</fs> :
On peut aussi utiliser les variables em et %, comme pour le code html. Ces deux notations sont équivalentes au pourcentage. 1em ou 100% donnent la police à la taille par défaut. 2em ou 200% doublent la taille de la police :
- em - <fs 2em>Texte à 2em</fs> :
- % - <fs 200%>Texte à 200%</fs> :
Barre de progression et gestion de "tâches"
Nous avons le plugin AV Task Box qui permet de faire une boîte avec une barre de progression.
A test task(Sherri) Some stuff for you. You can have newlines in this part. Description must be the last item. (10% of 4h) Priority: High
<task> TITLE: A test task PRIORITY: High ESTIMATE: 4h PROGRESS: 10% ASSIGNED: Sherri DESCRIPTION: Some stuff for you. You can have newlines in this part. Description must be the last item. </task>
Toutes les options dans la “taskbox” sont facultatives, mais ça donne un rendu un peu étrange :
(10% )