xref: /plugin/catmenu/README (revision aa591c9040aa9d58df44eaf65df693766613dc9f)
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. Accepte aussi la valeur spéciale `@hidepages` pour réutiliser automatiquement le paramètre `hidepages` de DokuWiki.
34- `skip_page_without_title` : ignorer les pages sans H1.
35- `show_in_editor_menu` : afficher le bouton d'insertion dans l'éditeur.
36- `context_menu_items` : cases à cocher pour choisir les actions disponibles dans le menu contextuel (clic droit). Toutes activées par défaut.
37- `footer_content` : DokuCode multiligne injecté à la fin de chaque menu (liens, notes, etc.). Vide par défaut.
38
39## Compatibilité
40
41- Compatible avec le plugin [ProseMirror](https://www.dokuwiki.org/plugin:prosemirror)
42- `catmenu` utilise le plugin [pagesicon](https://www.dokuwiki.org/plugin:pagesicon) pour afficher les icônes, si disponible. L'action "Gérer l'icône" dans le menu contextuel n'apparaît que si pagesicon est installé.
43- Compatible avec le plugin `newpagefill` pour la création de pages. S'il est présent, `catmenu` utilise son assistant de création.
44
45## Menu contextuel
46
47Clic droit sur un item (actions configurables individuellement) :
48
49- créer une nouvelle page (selon droits),
50- recharger le cache (`purge=true`),
51- ouvrir le gestionnaire de médias,
52- ouvrir la gestion d'icône (`pagesicon`) si disponible,
53- copier l'URL.
54
55## Permissions
56
57Le rendu respecte les ACL DokuWiki :
58
59- lecture minimale pour afficher un item,
60- actions contextuelles limitées selon les droits (create/edit/upload).
61