xref: /plugin/catmenu/DOKU_EN (revision aa591c9040aa9d58df44eaf65df693766613dc9f)
16983cdfdSLORTET====== CatMenu Plugin ======
26983cdfdSLORTET
36983cdfdSLORTET---- plugin ----
46983cdfdSLORTETdescription: Displays a namespace tree menu
56983cdfdSLORTETauthor     : Valentin LORTET
6*aa591c90SLORTETemail      : contact@valentinlortet.fr
76983cdfdSLORTETtype       : Syntax, Action
8*aa591c90SLORTETlastupdate : 2026-03-14
96983cdfdSLORTETcompatible : Librarian
106983cdfdSLORTETdepends    :
116983cdfdSLORTETconflicts  :
126983cdfdSLORTETsimilar    :
136983cdfdSLORTETtags       : Navigation, Menu, Namespace, ProseMirror
146983cdfdSLORTET
15*aa591c90SLORTETdownloadurl: https://github.com/Lortet/dokuwiki-plugin-catmenu/zipball/master
16*aa591c90SLORTETbugtracker : https://github.com/Lortet/dokuwiki-plugin-catmenu/issues
17*aa591c90SLORTETsourcerepo : https://github.com/Lortet/dokuwiki-plugin-catmenu/
186983cdfdSLORTETdonationurl:
196983cdfdSLORTETscreenshot_img :
206983cdfdSLORTET----
216983cdfdSLORTET
226983cdfdSLORTET===== Installation =====
236983cdfdSLORTET
246983cdfdSLORTETInstall the plugin from the [[plugin:extension|Extension Manager]].
256983cdfdSLORTET
266983cdfdSLORTET===== Description =====
276983cdfdSLORTET
286983cdfdSLORTETThe **catmenu** plugin allows you to:
296983cdfdSLORTET  * display a tree menu (pages + subfolders) for a namespace;
306983cdfdSLORTET  * automatically open the branch matching the current page;
316983cdfdSLORTET  * handle namespace start pages (''$conf['start']'');
32*aa591c90SLORTET  * provide a configurable right-click context menu (depending on permissions);
33*aa591c90SLORTET  * inject custom DokuWiki markup at the bottom of the menu.
346983cdfdSLORTET
356983cdfdSLORTET===== Syntax =====
366983cdfdSLORTET
376983cdfdSLORTETUsage:
386983cdfdSLORTET  * ''{{catmenu>namespace}}''
396983cdfdSLORTET
406983cdfdSLORTETExamples:
416983cdfdSLORTET  * ''{{catmenu>.}}'' (current namespace)
426983cdfdSLORTET  * ''{{catmenu>wiki}}''
436983cdfdSLORTET  * ''{{catmenu>docs:project}}''
446983cdfdSLORTET
456983cdfdSLORTET===== Settings =====
466983cdfdSLORTET
476983cdfdSLORTET^ Name ^ Description ^ Default value ^
48*aa591c90SLORTET| skip_file | Regex used to ignore page IDs. Also accepts ''@hidepages'' to reuse DokuWiki's ''hidepages'' setting. | '''' |
496983cdfdSLORTET| skip_page_without_title | Ignore pages without an H1 title. | ''true'' |
506983cdfdSLORTET| show_in_editor_menu | Show the insert button in the editor. | ''true'' |
51*aa591c90SLORTET| context_menu_items | Actions available in the right-click context menu (checkboxes). | all enabled |
52*aa591c90SLORTET| footer_content | Multiline DokuWiki markup injected at the bottom of every menu. | '''' |
536983cdfdSLORTET
546983cdfdSLORTET===== Compatibility =====
556983cdfdSLORTET
566983cdfdSLORTET  * Compatible with [[https://www.dokuwiki.org/plugin:prosemirror|ProseMirror]]
57*aa591c90SLORTET  * Uses [[https://www.dokuwiki.org/plugin:pagesicon|pagesicon]] to display icons when available. The "Manage icon" context menu action only appears if ''pagesicon'' is installed.
58*aa591c90SLORTET  * Compatible with the ''newpagefill'' plugin for page creation. When available, ''catmenu'' uses its creation helper.
596983cdfdSLORTET
606983cdfdSLORTET===== Context menu =====
616983cdfdSLORTET
62*aa591c90SLORTETRight-click on a menu item. Each action can be individually enabled or disabled in the configuration:
63*aa591c90SLORTET  * **Create a new page** (''newpage'') — if allowed;
64*aa591c90SLORTET  * **Reload cache** (''reload'') — (''purge=true'');
65*aa591c90SLORTET  * **Manage media** (''medias'') — opens the media manager;
66*aa591c90SLORTET  * **Manage icon** (''pagesicon'') — only shown if ''pagesicon'' is installed;
67*aa591c90SLORTET  * **Copy URL** (''url'').
68*aa591c90SLORTET
69*aa591c90SLORTET===== Footer DokuCode =====
70*aa591c90SLORTET
71*aa591c90SLORTETThe ''footer_content'' setting accepts multiline DokuWiki markup. It is rendered as HTML and injected inside a ''<div class="catmenu-footer">'' below every menu. Useful for adding permanent links, notes or shortcuts.
726983cdfdSLORTET
736983cdfdSLORTET===== Permissions =====
746983cdfdSLORTET
756983cdfdSLORTETRendering follows DokuWiki ACL rules:
766983cdfdSLORTET  * read permission is required to show an item;
776983cdfdSLORTET  * context actions are limited by permissions (create/edit/upload).
78