1# Visualindex 2 3[���� Français](README) | **���� English** | [���� Deutsch](README_DE) | [���� Español](README_ES) 4 5--- 6 7The **visualindex** plugin displays a visual index of pages (or media files) from a DokuWiki namespace. 8 9It is compatible with: 10- the classic editor; 11- ProseMirror. 12 13## How It Works 14 15The plugin reads a namespace, builds a list of readable items, then displays tiles with: 16- an image; 17- a title; 18- a link to the page or media file. 19 20If no item is available, a translated message is displayed. 21 22## Syntax 23 24Basic syntax: 25 26```txt 27{{visualindex>namespace}} 28``` 29 30Useful examples: 31 32```txt 33{{visualindex>.}} 34{{visualindex>wiki}} 35{{visualindex>wiki;filter=start|syntax*}} 36{{visualindex>wiki;desc=1}} 37{{visualindex>wiki;medias=1}} 38{{visualindex>.;filter=guide*;desc=1;medias=1}} 39``` 40 41Supported options: 42- `filter`: simple filter with `*` (e.g. `guide*|doc*`); 43- `desc`: descending order (`1` / `true`); 44- `medias`: show namespace media (`1` / `true`). 45 46Special namespace values: 47- `.`: current namespace; 48- `~sub:folder`: namespace relative to the current namespace. 49 50## Configuration Parameters 51 52In the configuration manager: 53 54- `icon_size`: icon size (e.g. `100px`); 55- `text_size`: text size (e.g. `13px`); 56- `text_color`: text color (hex, rgb/rgba, or CSS color name); 57- `skip_file`: regular expression for pages to ignore; 58- `show_in_editor_menu`: show Visualindex in editor menus (classic and ProseMirror); 59- `use_pagesicon`: use the `pagesicon` helper when available; 60- `default_image`: default image (media ID, e.g. `wiki:logo.png`); if empty, the plugin internal image is used. 61 62## Integration with pagesicon 63 64If the `pagesicon` plugin is present and enabled through `use_pagesicon`: 65- Visualindex retrieves page icons through the helper; 66- Visualindex also retrieves media icons; 67- if no icon is found, the default fallback is used. 68 69Fallback order: 701. icon provided by `pagesicon`; 712. Visualindex `default_image`; 723. plugin internal image (`images/default_image.png`). 73 74## ProseMirror 75 76The plugin exposes a `Visualindex` button in ProseMirror (when `show_in_editor_menu` is enabled), with a configuration popup. 77 78The popup lets you configure: 79- namespace; 80- filter; 81- descending order; 82- media display. 83
