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