xref: /plugin/visualindex/DOKU.md (revision 3c9c7f3beeea1dce712c368cb507b309c63f5d06)
1====== Visualindex Plugin ======
2
3---- plugin ----
4description: Affiche un sommaire visuel
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:
16bugtracker :
17sourcerepo :
18donationurl:
19screenshot_img :
20----
21
22===== Installation =====
23
24Installer le plugin depuis le [[fr:plugin:extension|Gestionnaire d'extensions]].
25
26===== Description =====
27
28Le plugin **visualindex** affiche un index visuel des pages (ou des médias) d'un namespace DokuWiki.
29
30Il est compatible avec :
31  * l'éditeur classique ;
32  * [[https://www.dokuwiki.org/plugin:prosemirror|ProseMirror]].
33
34===== Syntaxe =====
35
36Syntaxe de base :
37  * ''{{visualindex>namespace}}''
38
39Exemples :
40  * ''{{visualindex>.}}''
41  * ''{{visualindex>wiki}}''
42  * ''{{visualindex>wiki;filter=start|syntax*}}''
43  * ''{{visualindex>wiki;desc=1}}''
44  * ''{{visualindex>wiki;medias=1}}''
45  * ''{{visualindex>.;filter=guide*;desc=1;medias=1}}''
46
47Options :
48  * ''filter'' : filtre simple avec ''*'' (ex. ''guide*|doc*'') ;
49  * ''desc'' : tri descendant (''1'' / ''true'') ;
50  * ''medias'' : affiche les médias du namespace (''1'' / ''true'').
51
52Namespace spécial :
53  * ''.'' : namespace courant ;
54  * ''~sous:dossier'' : namespace relatif au namespace courant.
55
56===== Paramètres =====
57
58^ Nom ^ Description ^ Valeur par défaut ^
59| taille_icone | Taille de l'icône (ex. ''100px''). | ''100px'' |
60| taille_texte | Taille du texte (ex. ''13px''). | ''13px'' |
61| couleur_texte | Couleur du texte (hex, rgb/rgba, ou nom CSS). | ''black'' |
62| skip_file | Regex des pages à ignorer. | '''' |
63| show_in_editor_menu | Afficher Visualindex dans les menus d'édition (classique et ProseMirror). | ''true'' |
64| use_pagesicon | Utiliser le helper ''pagesicon'' si disponible. | ''true'' |
65| default_image | Image par défaut (ID média), ex. ''wiki:logo.png''. | '''' |
66
67===== Intégration pagesicon =====
68
69Si [[https://www.dokuwiki.org/plugin:pagesicon|pagesicon]] est installé et ''use_pagesicon'' activé :
70  * Visualindex récupère les icônes de pages ;
71  * Visualindex récupère les icônes de médias ;
72  * fallback par défaut si aucune icône n'est trouvée.
73
74Ordre de fallback :
75  * icône fournie par ''pagesicon'' ;
76  * ''default_image'' de Visualindex ;
77  * image interne du plugin (''images/default_image.png'').
78
79===== ProseMirror =====
80
81Le plugin expose un bouton ''Visualindex'' dans ProseMirror (si ''show_in_editor_menu'' est activé), avec une popup de configuration :
82  * namespace ;
83  * filtre ;
84  * ordre descendant ;
85  * affichage des médias.
86
87===== Fichiers principaux =====
88
89  * ''syntax/visualindex.php'' : parsing et rendu XHTML ;
90  * ''action/prosemirror.php'' : intégration éditeur ;
91  * ''script/prosemirror.js'' : nœud ProseMirror ;
92  * ''script/toolbar.js'' : bouton et popup ;
93  * ''style.css'' : styles d'affichage.
94