Les deux révisions précédentes Révision précédente Prochaine révision | Révision précédenteDernière révisionLes deux révisions suivantes |
asso:tuto:wiki [2020/09/07 13:09] – qduchemi | asso:tuto:wiki [2021/01/27 23:34] – qduchemi |
---|
# Utilisation et contribuer au Wiki | # Utilisation et contribution au Wiki |
| |
## Organisation | ## Organisation |
## Contribution | ## Contribution |
| |
### Bonnes pratiques générales | 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) | 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. | 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) | 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. | 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. |
| |
Enfin, on préférera la syntaxe Markdown pour la facilité d'édition. | |
| |
### É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 msort 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 msort nsort notoc nomenu nocookie navbar}} | {{indexmenu>.|js#bitrix msort tsort msort nsort notoc nomenu nocookie navbar}} |
``` | ``` |
| |