xref: /plugin/catmenu/README (revision 6983cdfd4483215ff5a1e573925c9c612964e790)
1# CatMenu
2
3`catmenu` affiche un menu arborescent (pages + sous-dossiers) pour un namespace DokuWiki.
4
5## Syntaxe
6
7```text
8{{catmenu>namespace}}
9```
10
11Exemples :
12
13```text
14{{catmenu>.}}
15{{catmenu>wiki}}
16{{catmenu>docs:projet}}
17```
18
19- `.` : utilise le namespace courant.
20- `namespace` : utilise le namespace indiqué.
21
22## Comportement
23
24- liste les pages et sous-dossiers accessibles en lecture.
25- ouvre automatiquement la branche correspondant à la page courante.
26- gère les pages d'accueil de namespace (`$conf['start']`).
27- masque les pages sans titre H1 si `skip_page_without_title` est activé.
28
29## Configuration
30
31Dans le gestionnaire de configuration :
32
33- `skip_file` : regex pour ignorer certains IDs de page.
34- `skip_page_without_title` : ignorer les pages sans H1.
35- `show_in_editor_menu` : afficher le bouton d'insertion dans l'éditeur.
36
37## Compatibilité
38
39- Compatible avec le plugin [ProseMirror](https://www.dokuwiki.org/plugin:prosemirror)
40- `catmenu` utilise le plugin [pagesicon](https://www.dokuwiki.org/plugin:pagesicon) pour afficher les icônes, si `pagesicon` est disponible.
41
42## Menu contextuel
43
44Clic droit sur un item :
45
46- créer une nouvelle page (selon droits),
47- recharger le cache (`purge=true`),
48- ouvrir le gestionnaire de médias,
49- ouvrir la gestion d'icône (`pagesicon`) si disponible,
50- copier l'URL.
51
52## Permissions
53
54Le rendu respecte les ACL DokuWiki :
55
56- lecture minimale pour afficher un item,
57- actions contextuelles limitées selon les droits (create/edit/upload).
58