xref: /plugin/catmenu/README_EN (revision 339ba49c4f5b2a42161c07b899707ee1625d260f)
16983cdfdSLORTET# CatMenu
26983cdfdSLORTET
3*339ba49cSLORTET[���� Français](README) | ���� English | [���� Deutsch](README_DE) | [���� Español](README_ES)
4*339ba49cSLORTET
56983cdfdSLORTET`catmenu` displays a tree menu (pages + subfolders) for a DokuWiki namespace.
66983cdfdSLORTET
76983cdfdSLORTET## Syntax
86983cdfdSLORTET
96983cdfdSLORTET```text
106983cdfdSLORTET{{catmenu>namespace}}
116983cdfdSLORTET```
126983cdfdSLORTET
136983cdfdSLORTETExamples:
146983cdfdSLORTET
156983cdfdSLORTET```text
166983cdfdSLORTET{{catmenu>.}}
176983cdfdSLORTET{{catmenu>wiki}}
18aa591c90SLORTET{{catmenu>docs:project}}
196983cdfdSLORTET```
206983cdfdSLORTET
216983cdfdSLORTET- `.`: uses the current namespace.
226983cdfdSLORTET- `namespace`: uses the specified namespace.
236983cdfdSLORTET
246983cdfdSLORTET## Behavior
256983cdfdSLORTET
266983cdfdSLORTET- lists pages and subfolders readable by the current user.
276983cdfdSLORTET- automatically opens the branch matching the current page.
286983cdfdSLORTET- handles namespace start pages (`$conf['start']`).
296983cdfdSLORTET- hides pages without an H1 title when `skip_page_without_title` is enabled.
306983cdfdSLORTET
316983cdfdSLORTET## Configuration
326983cdfdSLORTET
336983cdfdSLORTETIn the Configuration Manager:
346983cdfdSLORTET
35aa591c90SLORTET- `skip_file`: regex used to ignore matching page IDs. Also accepts the special value `@hidepages` to automatically reuse DokuWiki's built-in `hidepages` setting.
366983cdfdSLORTET- `skip_page_without_title`: ignore pages without H1.
376983cdfdSLORTET- `show_in_editor_menu`: show the insert button in the editor.
38aa591c90SLORTET- `context_menu_items`: checkboxes to choose which actions appear in the right-click context menu. All enabled by default.
39aa591c90SLORTET- `footer_content`: multiline DokuWiki markup injected at the bottom of every menu (links, notes, etc.). Empty by default.
406983cdfdSLORTET
416983cdfdSLORTET## Compatibility
426983cdfdSLORTET
436983cdfdSLORTET- Compatible with [ProseMirror](https://www.dokuwiki.org/plugin:prosemirror).
44aa591c90SLORTET- `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.
45aa591c90SLORTET- Compatible with the `newpagefill` plugin for page creation. When available, `catmenu` uses its creation helper.
466983cdfdSLORTET
476983cdfdSLORTET## Context Menu
486983cdfdSLORTET
49aa591c90SLORTETRight-click on an item (each action is individually configurable):
506983cdfdSLORTET
516983cdfdSLORTET- create a new page (depending on permissions),
526983cdfdSLORTET- reload cache (`purge=true`),
536983cdfdSLORTET- open the media manager,
546983cdfdSLORTET- open icon management (`pagesicon`) when available,
556983cdfdSLORTET- copy the URL.
566983cdfdSLORTET
576983cdfdSLORTET## Permissions
586983cdfdSLORTET
596983cdfdSLORTETRendering follows DokuWiki ACL rules:
606983cdfdSLORTET
616983cdfdSLORTET- read permission is required to show an item,
626983cdfdSLORTET- context actions are limited by permissions (create/edit/upload).
63