xref: /plugin/catmenu/DOKU_EN (revision 339ba49c4f5b2a42161c07b899707ee1625d260f)
16983cdfdSLORTET====== CatMenu Plugin ======
26983cdfdSLORTET
36983cdfdSLORTET---- plugin ----
46983cdfdSLORTETdescription: Displays a namespace tree menu
56983cdfdSLORTETauthor     : Valentin LORTET
6aa591c90SLORTETemail      : contact@valentinlortet.fr
76983cdfdSLORTETtype       : Syntax, Action
8aa591c90SLORTETlastupdate : 2026-03-14
96983cdfdSLORTETcompatible : Librarian
106983cdfdSLORTETdepends    :
116983cdfdSLORTETconflicts  :
126983cdfdSLORTETsimilar    :
136983cdfdSLORTETtags       : Navigation, Menu, Namespace, ProseMirror
146983cdfdSLORTET
15aa591c90SLORTETdownloadurl: https://github.com/Lortet/dokuwiki-plugin-catmenu/zipball/master
16aa591c90SLORTETbugtracker : https://github.com/Lortet/dokuwiki-plugin-catmenu/issues
17aa591c90SLORTETsourcerepo : https://github.com/Lortet/dokuwiki-plugin-catmenu/
186983cdfdSLORTETdonationurl:
196983cdfdSLORTETscreenshot_img :
206983cdfdSLORTET----
216983cdfdSLORTET
22*339ba49cSLORTET[[fr:plugin:catmenu|���� Français]] | ���� **English** | [[de:plugin:catmenu|���� Deutsch]] | [[es:plugin:catmenu|���� Español]]
23*339ba49cSLORTET
246983cdfdSLORTET===== Installation =====
256983cdfdSLORTET
266983cdfdSLORTETInstall the plugin from the [[plugin:extension|Extension Manager]].
276983cdfdSLORTET
286983cdfdSLORTET===== Description =====
296983cdfdSLORTET
306983cdfdSLORTETThe **catmenu** plugin allows you to:
316983cdfdSLORTET  * display a tree menu (pages + subfolders) for a namespace;
326983cdfdSLORTET  * automatically open the branch matching the current page;
336983cdfdSLORTET  * handle namespace start pages (''$conf['start']'');
34aa591c90SLORTET  * provide a configurable right-click context menu (depending on permissions);
35aa591c90SLORTET  * inject custom DokuWiki markup at the bottom of the menu.
366983cdfdSLORTET
376983cdfdSLORTET===== Syntax =====
386983cdfdSLORTET
396983cdfdSLORTETUsage:
406983cdfdSLORTET  * ''{{catmenu>namespace}}''
416983cdfdSLORTET
426983cdfdSLORTETExamples:
436983cdfdSLORTET  * ''{{catmenu>.}}'' (current namespace)
446983cdfdSLORTET  * ''{{catmenu>wiki}}''
456983cdfdSLORTET  * ''{{catmenu>docs:project}}''
466983cdfdSLORTET
476983cdfdSLORTET===== Settings =====
486983cdfdSLORTET
496983cdfdSLORTET^ Name ^ Description ^ Default value ^
50aa591c90SLORTET| skip_file | Regex used to ignore page IDs. Also accepts ''@hidepages'' to reuse DokuWiki's ''hidepages'' setting. | '''' |
516983cdfdSLORTET| skip_page_without_title | Ignore pages without an H1 title. | ''true'' |
526983cdfdSLORTET| show_in_editor_menu | Show the insert button in the editor. | ''true'' |
53aa591c90SLORTET| context_menu_items | Actions available in the right-click context menu (checkboxes). | all enabled |
54aa591c90SLORTET| footer_content | Multiline DokuWiki markup injected at the bottom of every menu. | '''' |
556983cdfdSLORTET
566983cdfdSLORTET===== Compatibility =====
576983cdfdSLORTET
586983cdfdSLORTET  * Compatible with [[https://www.dokuwiki.org/plugin:prosemirror|ProseMirror]]
59aa591c90SLORTET  * 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.
60aa591c90SLORTET  * Compatible with the ''newpagefill'' plugin for page creation. When available, ''catmenu'' uses its creation helper.
616983cdfdSLORTET
626983cdfdSLORTET===== Context menu =====
636983cdfdSLORTET
64aa591c90SLORTETRight-click on a menu item. Each action can be individually enabled or disabled in the configuration:
65aa591c90SLORTET  * **Create a new page** (''newpage'') — if allowed;
66aa591c90SLORTET  * **Reload cache** (''reload'') — (''purge=true'');
67aa591c90SLORTET  * **Manage media** (''medias'') — opens the media manager;
68aa591c90SLORTET  * **Manage icon** (''pagesicon'') — only shown if ''pagesicon'' is installed;
69aa591c90SLORTET  * **Copy URL** (''url'').
70aa591c90SLORTET
71aa591c90SLORTET===== Footer DokuCode =====
72aa591c90SLORTET
73aa591c90SLORTETThe ''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.
746983cdfdSLORTET
756983cdfdSLORTET===== Permissions =====
766983cdfdSLORTET
776983cdfdSLORTETRendering follows DokuWiki ACL rules:
786983cdfdSLORTET  * read permission is required to show an item;
796983cdfdSLORTET  * context actions are limited by permissions (create/edit/upload).
80