1====== CatMenu Plugin ====== 2 3---- plugin ---- 4description: Displays a namespace tree menu 5author : Valentin LORTET 6email : contact@valentinlortet.fr 7type : Syntax, Action 8lastupdate : 2026-03-14 9compatible : Librarian 10depends : 11conflicts : 12similar : 13tags : Navigation, Menu, Namespace, ProseMirror 14 15downloadurl: https://github.com/Lortet/dokuwiki-plugin-catmenu/zipball/master 16bugtracker : https://github.com/Lortet/dokuwiki-plugin-catmenu/issues 17sourcerepo : https://github.com/Lortet/dokuwiki-plugin-catmenu/ 18donationurl: 19screenshot_img : 20---- 21 22[[fr:plugin:catmenu|���� Français]] | ���� **English** | [[de:plugin:catmenu|���� Deutsch]] | [[es:plugin:catmenu|���� Español]] 23 24===== Installation ===== 25 26Install the plugin from the [[plugin:extension|Extension Manager]]. 27 28===== Description ===== 29 30The **catmenu** plugin allows you to: 31 * display a tree menu (pages + subfolders) for a namespace; 32 * automatically open the branch matching the current page; 33 * handle namespace start pages (''$conf['start']''); 34 * provide a configurable right-click context menu (depending on permissions); 35 * inject custom DokuWiki markup at the bottom of the menu. 36 37===== Syntax ===== 38 39Usage: 40 * ''{{catmenu>namespace}}'' 41 42Examples: 43 * ''{{catmenu>.}}'' (current namespace) 44 * ''{{catmenu>wiki}}'' 45 * ''{{catmenu>docs:project}}'' 46 47===== Settings ===== 48 49^ Name ^ Description ^ Default value ^ 50| skip_file | Regex used to ignore page IDs. Also accepts ''@hidepages'' to reuse DokuWiki's ''hidepages'' setting. | '''' | 51| skip_page_without_title | Ignore pages without an H1 title. | ''true'' | 52| show_in_editor_menu | Show the insert button in the editor. | ''true'' | 53| context_menu_items | Actions available in the right-click context menu (checkboxes). | all enabled | 54| footer_content | Multiline DokuWiki markup injected at the bottom of every menu. | '''' | 55 56===== Compatibility ===== 57 58 * Compatible with [[https://www.dokuwiki.org/plugin:prosemirror|ProseMirror]] 59 * 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. 60 * Compatible with the ''newpagefill'' plugin for page creation. When available, ''catmenu'' uses its creation helper. 61 62===== Context menu ===== 63 64Right-click on a menu item. Each action can be individually enabled or disabled in the configuration: 65 * **Create a new page** (''newpage'') — if allowed; 66 * **Reload cache** (''reload'') — (''purge=true''); 67 * **Manage media** (''medias'') — opens the media manager; 68 * **Manage icon** (''pagesicon'') — only shown if ''pagesicon'' is installed; 69 * **Copy URL** (''url''). 70 71===== Footer DokuCode ===== 72 73The ''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. 74 75===== Permissions ===== 76 77Rendering follows DokuWiki ACL rules: 78 * read permission is required to show an item; 79 * context actions are limited by permissions (create/edit/upload). 80