1====== Visualindex Plugin ====== 2 3---- plugin ---- 4description: Displays a visual index 5author : Valentin LORTET, Gabriel CHOIMET 6email : contact@lortet.fr 7type : Syntax, Action 8lastupdate : 2026-03-09 9compatible : Librarian 10depends : 11conflicts : 12similar : 13tags : Navigation, Index, Media, ProseMirror, pagesicon 14 15downloadurl: https://github.com/Lortet/dokuwiki-plugin-visualindex/zipball/master 16bugtracker : https://github.com/Lortet/dokuwiki-plugin-visualindex/issues 17sourcerepo : https://github.com/Lortet/dokuwiki-plugin-visualindex/ 18donationurl: 19screenshot_img : 20---- 21 22[[fr:plugin:visualindex|���� Français]] | **���� English** | [[de:plugin:visualindex|���� Deutsch]] | [[es:plugin:visualindex|���� Español]] 23 24===== Installation ===== 25 26Install the plugin from the [[plugin:extension|Extension Manager]]. 27 28===== Description ===== 29 30The plugin **visualindex** displays a visual index of pages (or media files) from a DokuWiki namespace. 31 32It is compatible with: 33 * the classic editor; 34 * [[https://www.dokuwiki.org/plugin:prosemirror|ProseMirror]]. 35 36===== Syntax ===== 37 38Base syntax: 39 * ''{{visualindex>namespace}}'' 40 41Examples: 42 * ''{{visualindex>.}}'' 43 * ''{{visualindex>wiki}}'' 44 * ''{{visualindex>wiki;filter=start|syntax*}}'' 45 * ''{{visualindex>wiki;desc=1}}'' 46 * ''{{visualindex>wiki;medias=1}}'' 47 * ''{{visualindex>.;filter=guide*;desc=1;medias=1}}'' 48 49Options: 50 * ''filter'' : simple wildcard filter with ''*'' (example: ''guide*|doc*''); 51 * ''desc'' : descending sort (''1'' / ''true''); 52 * ''medias'' : list media from namespace (''1'' / ''true''). 53 54Special namespace: 55 * ''.'' : current namespace; 56 * ''~sub:folder'' : namespace relative to current namespace. 57 58===== Settings ===== 59 60^ Name ^ Description ^ Default value ^ 61| icon_size | Icon size (example: ''100px''). | ''100px'' | 62| text_size | Text size (example: ''13px''). | ''13px'' | 63| text_color | Text color (hex, rgb/rgba, or CSS color name). | ''black'' | 64| skip_file | Regex of pages to ignore. | '''' | 65| show_in_editor_menu | Show Visualindex in editor menus (classic and ProseMirror). | ''true'' | 66| use_pagesicon | Use ''pagesicon'' helper when available. | ''true'' | 67| default_image | Default image (media ID), e.g. ''wiki:logo.png''. | '''' | 68 69===== pagesicon integration ===== 70 71If [[https://www.dokuwiki.org/plugin:pagesicon|pagesicon]] is installed and ''use_pagesicon'' is enabled: 72 * Visualindex resolves page icons; 73 * Visualindex resolves media icons; 74 * fallback is used if no icon is found. 75 76Fallback order: 77 * icon provided by ''pagesicon''; 78 * Visualindex ''default_image''; 79 * plugin internal image (''images/default_image.png''). 80 81===== ProseMirror ===== 82 83The plugin exposes a ''Visualindex'' button in ProseMirror (when ''show_in_editor_menu'' is enabled), with a configuration popup: 84 * namespace; 85 * filter; 86 * descending order; 87 * media listing. 88 89===== Main files ===== 90 91 * ''syntax/visualindex.php'' : parsing and XHTML rendering; 92 * ''action/prosemirror.php'' : editor integration; 93 * ''script/prosemirror.js'' : ProseMirror node; 94 * ''script/toolbar.js'' : button and popup; 95 * ''style.css'' : display styles. 96
