Les deux révisions précédentes Révision précédente Prochaine révision | Révision précédente Prochaine révisionLes deux révisions suivantes |
asso:tuto:wiki [2020/02/14 20:52] – [Organisation] qduchemi | asso:tuto:wiki [2021/01/20 16:56] – qduchemi |
---|
# Wiki : guide d'utilisation et de contribution | # Utilisation et contribuer au Wiki |
| |
## Organisation | ## Organisation |
| |
## Contribution | ## Contribution |
| |
| On préférera la syntaxe Markdown pour la facilité d'édition. |
| |
| <bootnote>Le plugin [bootnote](https://www.dokuwiki.org/plugin:bootnote) permet de créer des cadres attirant l'attention sur une information.</bootnote> |
| |
| ### Gestion des liens |
| |
| Pour faire référence à une page interne au wiki, on utilisera **les références internes de Dokuwiki**, via le bouton ![](https://wiki.picasoft.net/lib/images/toolbar/link.png) |
| |
| En effet, ces références seront automatiquement mises à jour si les pages sont déplacées avec le [plugin move](https://www.dokuwiki.org/plugin:move) de Dokuwiki, ce qui permet d'éviter les liens morts. |
| |
| <bootnote important>Lorsque vous bougez une page avec le plugin `move`, elle n'est plus accessible à son ancien lien. Cela peut être un souci si le lien est référencé sur des outils externes. Le plugin [redirect](https://www.dokuwiki.org/plugin:redirect) permet de créer des redirections entre pages et est configurable depuis l'interface d'administration.</bootnote> |
| |
| Pour les images, on préférera utiliser le [Gestionnaire Multimédia](https://wiki.picasoft.net/doku.php?id=asso:tuto:wiki&do=media&ns=asso%3Atuto) et l'insertion d'image via le bouton ![](https://wiki.picasoft.net/lib/images/toolbar/image.png) |
| |
| En effet, on ne peut pas garantir que des images provenant d'un site extérieur persistent, tandis qu'en les téléversant sur le wiki, elles sont pérennes. |
| |
### Édition d'une page | ### Édition d'une page |
Vous remarquerez que par défaut, les catégories n'ont pas de nom "lisible par l'homme", mais que leur identifiant s'affiche. Pour des raisons de lisibilité, si on veut y attribuer un nom arbitraire, il faudra créer une page `start` dans la catégorie nouvellement créée, et lui assigner un titre (avec `#` en Markdown). | Vous remarquerez que par défaut, les catégories n'ont pas de nom "lisible par l'homme", mais que leur identifiant s'affiche. Pour des raisons de lisibilité, si on veut y attribuer un nom arbitraire, il faudra créer une page `start` dans la catégorie nouvellement créée, et lui assigner un titre (avec `#` en Markdown). |
| |
La catégorie deviendra alors cliquable dans l'arborescence et amènera sur la page `start`, qui ne contient que le titre. Il est alors de bon ton d'y ajouter un index auto-généré, ce qui peut être fait avec cette syntaxe (remplacez `categorie` et `sous-categorie` par les bons noms) : | La catégorie deviendra alors cliquable dans l'arborescence et amènera sur la page `start`, qui ne contient que le titre. Il est alors de bon ton d'y ajouter un index auto-généré, ce qui peut être fait avec cette syntaxe : |
| |
``` | ``` |
{{indexmenu>:categorie:sous-categorie:...|js#bitrix tsort nsort notoc nomenu nocookie navbar}} | {{.|js#bitrix msort tsort msort nsort notoc nomenu nocookie navbar}} |
``` | ``` |
| |
| <bootnote learn>Le `.` indique de commencer l'arborescence à partir du niveau courant, celui de la page `start`. Le reste permet d'indiquer les critères utilisés pour l'ordonnancement, le thème...</bootnote> |
| |
| <bootnote>Il est possible d'utiliser une catégorie "en dur" à la place du `.`, comme `:txs:secu:p20`, mais en cas de déplacement de la catégorie, l'arborescence ne suivra pas. Il est donc préférable d'utiliser des chemins relatifs.</bootnote> |
| |
### Exemple concret | ### Exemple concret |
# Audit de sécurité de l'infrastructure de Picasoft | # Audit de sécurité de l'infrastructure de Picasoft |
| |
{{indexmenu>:txs:secu:p20|js#bitrix tsort nsort notoc nomenu nocookie navbar}} | {{indexmenu>.|js#bitrix msort tsort msort nsort notoc nomenu nocookie navbar}} |
``` | ``` |
| |
| |
Comme vous pouvez le voir, la nouvelle catégorie et l'ensemble des pages créées sous cette catégorie sont correctement et automatiquement référencées. | Comme vous pouvez le voir, la nouvelle catégorie et l'ensemble des pages créées sous cette catégorie sont correctement et automatiquement référencées. |
| |
| ## Tri des pages |
| |
| Par défaut, Dokuwiki trie les pages dans la barre de navigation (à gauche ou avec un sommaire autogénéré par la balise `{{indexmenu}}`) par ordre alphabétique **du titre**, ou à défaut de l'identifiant de la page. |
| |
| Parfois, on voudrait choisir l'ordre au sein d'une catégorie pour montrer une progression logique, par exemple : |
| |
| **Administrer le serveur mail** |
| |
| 1. Vérifier les journaux |
| 2. Changer un paramètre |
| 3. Modifier le mode de connexion LDAP |
| |
| Une première solution serait de créer un sommaire à la main, mais celui-ci est figé et n'évolue pas lors de l'ajout d'une nouvelle page, ce qui le rend inutile. |
| |
| ### Première solution : ajouter des chiffres aux titres |
| |
| C'est la solution la plus évidente, assez peu élégante mais fonctionnelle. |
| |
| ### Deuxième solution : utiliser les méta-données. |
| |
| Dokuwiki peut trier les pages en fonction de métadonnées, avant de passer à l'ordre alphabétique des titres. |
| La solution la plus simple pour utiliser ce type de tri est d'ajouter au début de chaque page le code suivant : |
| |
| ``` |
| {{indexmenu_n>N}} |
| ``` |
| |
| où `N` est un nombre entier qui servira à spécifier l'ordre de tri. |
| |
| Une bonne pratique est d'utiliser des dizaines dans un premier temps : `1` pour la première page, `10` pour la deuxième, `20` pour la troisième, etc. De cette manière, l'insertion d'une page entre la première et la deuxième pourra se faire avec `N = 2`, sans avoir à tout décaler. |
| |
| Cette solution est préférée car automatique et sans besoin d'intervention manuelle quand une nouvelle page est intercalée. |