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