xref: /plugin/catmenu/README_EN (revision 6983cdfd4483215ff5a1e573925c9c612964e790)
1*6983cdfdSLORTET# CatMenu
2*6983cdfdSLORTET
3*6983cdfdSLORTET`catmenu` displays a tree menu (pages + subfolders) for a DokuWiki namespace.
4*6983cdfdSLORTET
5*6983cdfdSLORTET## Syntax
6*6983cdfdSLORTET
7*6983cdfdSLORTET```text
8*6983cdfdSLORTET{{catmenu>namespace}}
9*6983cdfdSLORTET```
10*6983cdfdSLORTET
11*6983cdfdSLORTETExamples:
12*6983cdfdSLORTET
13*6983cdfdSLORTET```text
14*6983cdfdSLORTET{{catmenu>.}}
15*6983cdfdSLORTET{{catmenu>wiki}}
16*6983cdfdSLORTET{{catmenu>docs:projet}}
17*6983cdfdSLORTET```
18*6983cdfdSLORTET
19*6983cdfdSLORTET- `.`: uses the current namespace.
20*6983cdfdSLORTET- `namespace`: uses the specified namespace.
21*6983cdfdSLORTET
22*6983cdfdSLORTET## Behavior
23*6983cdfdSLORTET
24*6983cdfdSLORTET- lists pages and subfolders readable by the current user.
25*6983cdfdSLORTET- automatically opens the branch matching the current page.
26*6983cdfdSLORTET- handles namespace start pages (`$conf['start']`).
27*6983cdfdSLORTET- hides pages without an H1 title when `skip_page_without_title` is enabled.
28*6983cdfdSLORTET
29*6983cdfdSLORTET## Configuration
30*6983cdfdSLORTET
31*6983cdfdSLORTETIn the Configuration Manager:
32*6983cdfdSLORTET
33*6983cdfdSLORTET- `skip_file`: regex used to ignore matching page IDs.
34*6983cdfdSLORTET- `skip_page_without_title`: ignore pages without H1.
35*6983cdfdSLORTET- `show_in_editor_menu`: show the insert button in the editor.
36*6983cdfdSLORTET
37*6983cdfdSLORTET## Compatibility
38*6983cdfdSLORTET
39*6983cdfdSLORTET- Compatible with [ProseMirror](https://www.dokuwiki.org/plugin:prosemirror).
40*6983cdfdSLORTET- `catmenu` uses [pagesicon](https://www.dokuwiki.org/plugin:pagesicon) to display icons when `pagesicon` is available.
41*6983cdfdSLORTET
42*6983cdfdSLORTET## Context Menu
43*6983cdfdSLORTET
44*6983cdfdSLORTETRight-click on an item to:
45*6983cdfdSLORTET
46*6983cdfdSLORTET- create a new page (depending on permissions),
47*6983cdfdSLORTET- reload cache (`purge=true`),
48*6983cdfdSLORTET- open the media manager,
49*6983cdfdSLORTET- open icon management (`pagesicon`) when available,
50*6983cdfdSLORTET- copy the URL.
51*6983cdfdSLORTET
52*6983cdfdSLORTET## Permissions
53*6983cdfdSLORTET
54*6983cdfdSLORTETRendering follows DokuWiki ACL rules:
55*6983cdfdSLORTET
56*6983cdfdSLORTET- read permission is required to show an item,
57*6983cdfdSLORTET- context actions are limited by permissions (create/edit/upload).
58