xref: /plugin/catmenu/DOKU (revision 6983cdfd4483215ff5a1e573925c9c612964e790)
1====== CatMenu Plugin ======
2
3---- plugin ----
4description: Affiche un menu arborescent de namespace
5author     : Valentin LORTET
6email      : contact@lortet.fr
7type       : Syntax, Action
8lastupdate : 2026-03-09
9compatible : Librarian
10depends    :
11conflicts  :
12similar    :
13tags       : Navigation, Menu, Namespace, ProseMirror
14
15downloadurl:
16bugtracker :
17sourcerepo :
18donationurl:
19screenshot_img :
20----
21
22===== Installation =====
23
24Installer le plugin depuis le [[fr:plugin:extension|Gestionnaire d'extensions]].
25
26===== Description =====
27
28Le plugin **catmenu** permet :
29  * d'afficher un menu arborescent (pages + sous-dossiers) pour un namespace ;
30  * d'ouvrir automatiquement la branche correspondant à la page courante ;
31  * de gérer les pages d'accueil de namespace (''$conf['start']'') ;
32  * de proposer un menu contextuel d'actions (selon permissions).
33
34===== Syntaxe =====
35
36Utilisation :
37  * ''{{catmenu>namespace}}''
38
39Exemples :
40  * ''{{catmenu>.}}'' (namespace courant)
41  * ''{{catmenu>wiki}}''
42  * ''{{catmenu>docs:projet}}''
43
44===== Paramètres =====
45
46^ Nom ^ Description ^ Valeur par défaut ^
47| skip_file | Regex pour ignorer des IDs de page. | '''' |
48| skip_page_without_title | Ignorer les pages sans titre H1. | ''true'' |
49| show_in_editor_menu | Afficher le bouton d'insertion dans l'éditeur. | ''true'' |
50
51===== Compatibilité =====
52
53  * Compatible avec [[https://www.dokuwiki.org/plugin:prosemirror|ProseMirror]]
54  * Utilise [[https://www.dokuwiki.org/plugin:pagesicon|pagesicon]] pour afficher les icônes quand disponible.
55
56===== Icônes (pagesicon) =====
57
58Si le helper ''pagesicon'' est installé :
59  * récupération des icônes via l'API helper ;
60  * fallback possible vers l'image par défaut ''pagesicon'' sur versions récentes ;
61  * fallback legacy conservé pour anciennes signatures helper.
62
63Si aucune icône n'est trouvée, l'entrée est affichée sans image.
64
65===== Menu contextuel =====
66
67Clic droit sur un item du menu :
68  * créer une nouvelle page (si autorisé) ;
69  * recharger le cache (''purge=true'') ;
70  * ouvrir le gestionnaire de médias ;
71  * ouvrir la gestion d'icône (''pagesicon'') si disponible ;
72  * copier l'URL.
73
74===== Permissions =====
75
76Le rendu respecte les ACL DokuWiki :
77  * lecture minimale pour afficher un item ;
78  * actions contextuelles limitées selon les droits (create/edit/upload).
79