README
1# CatMenu
2
3���� Français | [���� English](README_EN) | [���� Deutsch](README_DE) | [���� Español](README_ES)
4
5`catmenu` affiche un menu arborescent (pages + sous-dossiers) pour un namespace DokuWiki.
6
7## Syntaxe
8
9```text
10{{catmenu>namespace}}
11```
12
13Exemples :
14
15```text
16{{catmenu>.}}
17{{catmenu>wiki}}
18{{catmenu>docs:projet}}
19```
20
21- `.` : utilise le namespace courant.
22- `namespace` : utilise le namespace indiqué.
23
24## Comportement
25
26- liste les pages et sous-dossiers accessibles en lecture.
27- ouvre automatiquement la branche correspondant à la page courante.
28- gère les pages d'accueil de namespace (`$conf['start']`).
29- masque les pages sans titre H1 si `skip_page_without_title` est activé.
30
31## Configuration
32
33Dans le gestionnaire de configuration :
34
35- `skip_file` : regex pour ignorer certains IDs de page. Accepte aussi la valeur spéciale `@hidepages` pour réutiliser automatiquement le paramètre `hidepages` de DokuWiki.
36- `skip_page_without_title` : ignorer les pages sans H1.
37- `show_in_editor_menu` : afficher le bouton d'insertion dans l'éditeur.
38- `context_menu_items` : cases à cocher pour choisir les actions disponibles dans le menu contextuel (clic droit). Toutes activées par défaut.
39- `footer_content` : DokuCode multiligne injecté à la fin de chaque menu (liens, notes, etc.). Vide par défaut.
40
41## Compatibilité
42
43- Compatible avec le plugin [ProseMirror](https://www.dokuwiki.org/plugin:prosemirror)
44- `catmenu` utilise le plugin [pagesicon](https://www.dokuwiki.org/plugin:pagesicon) pour afficher les icônes, si disponible. L'action "Gérer l'icône" dans le menu contextuel n'apparaît que si pagesicon est installé.
45- Compatible avec le plugin `newpagefill` pour la création de pages. S'il est présent, `catmenu` utilise son assistant de création.
46
47## Menu contextuel
48
49Clic droit sur un item (actions configurables individuellement) :
50
51- créer une nouvelle page (selon droits),
52- recharger le cache (`purge=true`),
53- ouvrir le gestionnaire de médias,
54- ouvrir la gestion d'icône (`pagesicon`) si disponible,
55- copier l'URL.
56
57## Permissions
58
59Le rendu respecte les ACL DokuWiki :
60
61- lecture minimale pour afficher un item,
62- actions contextuelles limitées selon les droits (create/edit/upload).
63
README_DE
1# CatMenu
2
3[���� Français](README) | [���� English](README_EN) | ���� Deutsch | [���� Español](README_ES)
4
5`catmenu` zeigt ein Baummenü (Seiten + Unterordner) für einen DokuWiki-Namespace an.
6
7## Syntax
8
9```text
10{{catmenu>namespace}}
11```
12
13Beispiele:
14
15```text
16{{catmenu>.}}
17{{catmenu>wiki}}
18{{catmenu>docs:projekt}}
19```
20
21- `.`: verwendet den aktuellen Namespace.
22- `namespace`: verwendet den angegebenen Namespace.
23
24## Verhalten
25
26- listet alle für den aktuellen Benutzer lesbaren Seiten und Unterordner.
27- öffnet automatisch den Ast, der zur aktuellen Seite gehört.
28- verarbeitet Namespace-Startseiten (`$conf['start']`).
29- blendet Seiten ohne H1-Titel aus, wenn `skip_page_without_title` aktiviert ist.
30
31## Konfiguration
32
33Im Konfigurationsmanager:
34
35- `skip_file`: regulärer Ausdruck zum Ignorieren von Seiten-IDs. Akzeptiert auch den Sonderwert `@hidepages`, um die globale DokuWiki-Einstellung `hidepages` automatisch zu übernehmen.
36- `skip_page_without_title`: Seiten ohne H1-Titel ausblenden.
37- `show_in_editor_menu`: Einfüge-Schaltfläche im Editor anzeigen.
38- `context_menu_items`: Kontrollkästchen zur Auswahl der Aktionen im Kontextmenü (Rechtsklick). Standardmäßig alle aktiviert.
39- `footer_content`: mehrzeiliges DokuWiki-Markup, das am Ende jedes Menüs eingefügt wird (Links, Hinweise usw.). Standardmäßig leer.
40
41## Kompatibilität
42
43- Kompatibel mit dem Plugin [ProseMirror](https://www.dokuwiki.org/plugin:prosemirror).
44- `catmenu` verwendet [pagesicon](https://www.dokuwiki.org/plugin:pagesicon) zur Anzeige von Symbolen, wenn das Plugin verfügbar ist. Die Aktion „Symbol verwalten" im Kontextmenü erscheint nur, wenn pagesicon installiert ist.
45- Kompatibel mit dem Plugin `newpagefill` zur Seitenerstellung. Wenn vorhanden, verwendet `catmenu` dessen Erstellungsassistenten.
46
47## Kontextmenü
48
49Rechtsklick auf einen Eintrag (jede Aktion ist individuell konfigurierbar):
50
51- neue Seite erstellen (je nach Berechtigungen),
52- Cache neu laden (`purge=true`),
53- Medien-Manager öffnen,
54- Symbol-Verwaltung öffnen (`pagesicon`), wenn verfügbar,
55- URL kopieren.
56
57## Berechtigungen
58
59Die Darstellung folgt den DokuWiki-ACL-Regeln:
60
61- Leseberechtigung ist erforderlich, um einen Eintrag anzuzeigen,
62- Kontextaktionen sind je nach Berechtigung eingeschränkt (create/edit/upload).
63
README_EN
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
README_ES
1# CatMenu
2
3[���� Français](README) | [���� English](README_EN) | [���� Deutsch](README_DE) | ���� Español
4
5`catmenu` muestra un menú en árbol (páginas + subcarpetas) para un namespace de DokuWiki.
6
7## Sintaxis
8
9```text
10{{catmenu>namespace}}
11```
12
13Ejemplos:
14
15```text
16{{catmenu>.}}
17{{catmenu>wiki}}
18{{catmenu>docs:proyecto}}
19```
20
21- `.`: utiliza el namespace actual.
22- `namespace`: utiliza el namespace indicado.
23
24## Comportamiento
25
26- lista las páginas y subcarpetas legibles por el usuario actual.
27- abre automáticamente la rama correspondiente a la página actual.
28- gestiona las páginas de inicio de namespace (`$conf['start']`).
29- oculta las páginas sin título H1 cuando `skip_page_without_title` está activado.
30
31## Configuración
32
33En el Gestor de Configuración:
34
35- `skip_file`: expresión regular para ignorar IDs de páginas. También acepta el valor especial `@hidepages` para reutilizar automáticamente el parámetro `hidepages` de DokuWiki.
36- `skip_page_without_title`: ignorar páginas sin título H1.
37- `show_in_editor_menu`: mostrar el botón de inserción en el editor.
38- `context_menu_items`: casillas de verificación para elegir las acciones disponibles en el menú contextual (clic derecho). Todas activadas por defecto.
39- `footer_content`: marcado DokuWiki multilínea insertado al final de cada menú (enlaces, notas, etc.). Vacío por defecto.
40
41## Compatibilidad
42
43- Compatible con el plugin [ProseMirror](https://www.dokuwiki.org/plugin:prosemirror).
44- `catmenu` usa [pagesicon](https://www.dokuwiki.org/plugin:pagesicon) para mostrar iconos cuando está disponible. La acción "Gestionar icono" en el menú contextual solo aparece si pagesicon está instalado.
45- Compatible con el plugin `newpagefill` para la creación de páginas. Cuando está disponible, `catmenu` usa su asistente de creación.
46
47## Menú contextual
48
49Clic derecho sobre un elemento (cada acción es configurable individualmente):
50
51- crear una nueva página (según permisos),
52- recargar la caché (`purge=true`),
53- abrir el gestor de archivos multimedia,
54- abrir la gestión de iconos (`pagesicon`) si está disponible,
55- copiar la URL.
56
57## Permisos
58
59El renderizado sigue las reglas ACL de DokuWiki:
60
61- se requiere permiso de lectura para mostrar un elemento,
62- las acciones contextuales están limitadas según los permisos (create/edit/upload).
63