1# CatMenu 2 3`catmenu` displays a tree menu (pages + subfolders) for a DokuWiki namespace. 4 5## Syntax 6 7```text 8{{catmenu>namespace}} 9``` 10 11Examples: 12 13```text 14{{catmenu>.}} 15{{catmenu>wiki}} 16{{catmenu>docs:project}} 17``` 18 19- `.`: uses the current namespace. 20- `namespace`: uses the specified namespace. 21 22## Behavior 23 24- lists pages and subfolders readable by the current user. 25- automatically opens the branch matching the current page. 26- handles namespace start pages (`$conf['start']`). 27- hides pages without an H1 title when `skip_page_without_title` is enabled. 28 29## Configuration 30 31In the Configuration Manager: 32 33- `skip_file`: regex used to ignore matching page IDs. Also accepts the special value `@hidepages` to automatically reuse DokuWiki's built-in `hidepages` setting. 34- `skip_page_without_title`: ignore pages without H1. 35- `show_in_editor_menu`: show the insert button in the editor. 36- `context_menu_items`: checkboxes to choose which actions appear in the right-click context menu. All enabled by default. 37- `footer_content`: multiline DokuWiki markup injected at the bottom of every menu (links, notes, etc.). Empty by default. 38 39## Compatibility 40 41- Compatible with [ProseMirror](https://www.dokuwiki.org/plugin:prosemirror). 42- `catmenu` uses [pagesicon](https://www.dokuwiki.org/plugin:pagesicon) to display icons when available. The "Manage icon" context menu action only appears if pagesicon is installed. 43- Compatible with the `newpagefill` plugin for page creation. When available, `catmenu` uses its creation helper. 44 45## Context Menu 46 47Right-click on an item (each action is individually configurable): 48 49- create a new page (depending on permissions), 50- reload cache (`purge=true`), 51- open the media manager, 52- open icon management (`pagesicon`) when available, 53- copy the URL. 54 55## Permissions 56 57Rendering follows DokuWiki ACL rules: 58 59- read permission is required to show an item, 60- context actions are limited by permissions (create/edit/upload). 61