xref: /plugin/catmenu/DOKU_EN (revision 6983cdfd4483215ff5a1e573925c9c612964e790)
1====== CatMenu Plugin ======
2
3---- plugin ----
4description: Displays a namespace tree menu
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
24Install the plugin from the [[plugin:extension|Extension Manager]].
25
26===== Description =====
27
28The **catmenu** plugin allows you to:
29  * display a tree menu (pages + subfolders) for a namespace;
30  * automatically open the branch matching the current page;
31  * handle namespace start pages (''$conf['start']'');
32  * provide a context menu with actions (depending on permissions).
33
34===== Syntax =====
35
36Usage:
37  * ''{{catmenu>namespace}}''
38
39Examples:
40  * ''{{catmenu>.}}'' (current namespace)
41  * ''{{catmenu>wiki}}''
42  * ''{{catmenu>docs:project}}''
43
44===== Settings =====
45
46^ Name ^ Description ^ Default value ^
47| skip_file | Regex used to ignore page IDs. | '''' |
48| skip_page_without_title | Ignore pages without an H1 title. | ''true'' |
49| show_in_editor_menu | Show the insert button in the editor. | ''true'' |
50
51===== Compatibility =====
52
53  * Compatible with [[https://www.dokuwiki.org/plugin:prosemirror|ProseMirror]]
54  * Uses [[https://www.dokuwiki.org/plugin:pagesicon|pagesicon]] to display icons when available.
55
56===== Icons (pagesicon) =====
57
58If the ''pagesicon'' helper is installed:
59  * icons are retrieved through the helper API;
60  * default ''pagesicon'' image fallback is available on recent versions;
61  * legacy fallback is kept for older helper signatures.
62
63If no icon is found, the item is rendered without an image.
64
65===== Context menu =====
66
67Right-click on a menu item:
68  * create a new page (if allowed);
69  * reload cache (''purge=true'');
70  * open media manager;
71  * open icon management (''pagesicon'') when available;
72  * copy URL.
73
74===== Permissions =====
75
76Rendering follows DokuWiki ACL rules:
77  * read permission is required to show an item;
78  * context actions are limited by permissions (create/edit/upload).
79