xref: /plugin/catmenu/README (revision 339ba49c4f5b2a42161c07b899707ee1625d260f)
1# CatMenu
2
3���� Français | [���� English](README_EN) | [���� Deutsch](README_DE) | [���� Español](README_ES)
4
5`catmenu` affiche un menu arborescent (pages + sous-dossiers) pour un namespace DokuWiki.
6
7## Syntaxe
8
9```text
10{{catmenu>namespace}}
11```
12
13Exemples :
14
15```text
16{{catmenu>.}}
17{{catmenu>wiki}}
18{{catmenu>docs:projet}}
19```
20
21- `.` : utilise le namespace courant.
22- `namespace` : utilise le namespace indiqué.
23
24## Comportement
25
26- liste les pages et sous-dossiers accessibles en lecture.
27- ouvre automatiquement la branche correspondant à la page courante.
28- gère les pages d'accueil de namespace (`$conf['start']`).
29- masque les pages sans titre H1 si `skip_page_without_title` est activé.
30
31## Configuration
32
33Dans le gestionnaire de configuration :
34
35- `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.
36- `skip_page_without_title` : ignorer les pages sans H1.
37- `show_in_editor_menu` : afficher le bouton d'insertion dans l'éditeur.
38- `context_menu_items` : cases à cocher pour choisir les actions disponibles dans le menu contextuel (clic droit). Toutes activées par défaut.
39- `footer_content` : DokuCode multiligne injecté à la fin de chaque menu (liens, notes, etc.). Vide par défaut.
40
41## Compatibilité
42
43- Compatible avec le plugin [ProseMirror](https://www.dokuwiki.org/plugin:prosemirror)
44- `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é.
45- Compatible avec le plugin `newpagefill` pour la création de pages. S'il est présent, `catmenu` utilise son assistant de création.
46
47## Menu contextuel
48
49Clic droit sur un item (actions configurables individuellement) :
50
51- créer une nouvelle page (selon droits),
52- recharger le cache (`purge=true`),
53- ouvrir le gestionnaire de médias,
54- ouvrir la gestion d'icône (`pagesicon`) si disponible,
55- copier l'URL.
56
57## Permissions
58
59Le rendu respecte les ACL DokuWiki :
60
61- lecture minimale pour afficher un item,
62- actions contextuelles limitées selon les droits (create/edit/upload).
63