1# Visualindex 2 3Le plugin **visualindex** affiche un index visuel des pages (ou des médias) d’un namespace DokuWiki. 4 5Il est compatible avec : 6- l’éditeur classique ; 7- ProseMirror. 8 9## Fonctionnement 10 11Le plugin lit un namespace, construit une liste d’éléments accessibles en lecture, puis affiche des tuiles avec : 12- une image ; 13- un titre ; 14- un lien vers la page ou le média. 15 16Si aucun élément n’est disponible, un message traduit est affiché. 17 18## Syntaxe 19 20Syntaxe de base : 21 22```txt 23{{visualindex>namespace}} 24``` 25 26Exemples utiles : 27 28```txt 29{{visualindex>.}} 30{{visualindex>wiki}} 31{{visualindex>wiki;filter=start|syntax*}} 32{{visualindex>wiki;desc=1}} 33{{visualindex>wiki;medias=1}} 34{{visualindex>.;filter=guide*;desc=1;medias=1}} 35``` 36 37Options supportées : 38- `filter` : filtre simple avec `*` (ex. `guide*|doc*`) ; 39- `desc` : tri descendant (`1` / `true`) ; 40- `medias` : affiche les médias du namespace (`1` / `true`). 41 42Namespace spécial : 43- `.` : namespace courant ; 44- `~sous:dossier` : namespace relatif au namespace courant. 45 46## Paramètres de configuration 47 48Dans le gestionnaire de configuration : 49 50- `taille_icone` : taille de l’icône (ex. `100px`) ; 51- `taille_texte` : taille du texte (ex. `13px`) ; 52- `couleur_texte` : couleur du texte (hex, rgb/rgba, ou nom CSS) ; 53- `skip_file` : expression régulière des pages à ignorer ; 54- `show_in_editor_menu` : afficher Visualindex dans les menus d’édition (classique et ProseMirror) ; 55- `use_pagesicon` : utiliser le helper `pagesicon` si disponible ; 56- `default_image` : image par défaut (ID média, ex : `wiki:logo.png`) ; si vide, l’image interne du plugin est utilisée. 57 58## Intégration avec pagesicon 59 60Si le plugin `pagesicon` est présent et activé via `use_pagesicon` : 61- Visualindex récupère les icônes des pages via le helper ; 62- Visualindex récupère aussi les icônes des médias ; 63- si aucune icône n’est trouvée, le fallback par défaut est utilisé. 64 65Ordre de fallback : 661. icône fournie par `pagesicon` ; 672. `default_image` de Visualindex ; 683. image interne du plugin (`images/default_image.png`). 69 70## ProseMirror 71 72Le plugin expose un bouton `Visualindex` dans ProseMirror (si `show_in_editor_menu` est activé) avec une popup de configuration. 73 74La popup permet de renseigner : 75- le namespace ; 76- le filtre ; 77- l’ordre descendant ; 78- l’affichage des médias. 79 80## Fichiers principaux 81 82- `syntax/visualindex.php` : parsing et rendu XHTML ; 83- `action/prosemirror.php` : intégration éditeur ; 84- `script/prosemirror.js` : nœud ProseMirror ; 85- `script/toolbar.js` : bouton et popup ; 86- `style.css` : styles d’affichage. 87
