xref: /plugin/visualindex/DOKU.md (revision 7f5290b8d6d83542fd5b939a9c568e40224c0ec8)
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: 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===== Syntaxe =====
37
38Syntaxe de base :
39  * ''{{visualindex>namespace}}''
40
41Exemples :
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'' : filtre simple avec ''*'' (ex. ''guide*|doc*'') ;
51  * ''desc'' : tri descendant (''1'' / ''true'') ;
52  * ''medias'' : affiche les médias du namespace (''1'' / ''true'').
53
54Namespace spécial :
55  * ''.'' : namespace courant ;
56  * ''~sous:dossier'' : namespace relatif au namespace courant.
57
58===== Paramètres =====
59
60^ Nom ^ Description ^ Valeur par défaut ^
61| icon_size | Taille de l'icône (ex. ''100px''). | ''100px'' |
62| text_size | Taille du texte (ex. ''13px''). | ''13px'' |
63| text_color | Couleur du texte (hex, rgb/rgba, ou nom CSS). | ''black'' |
64| skip_file | Regex des pages à ignorer. | '''' |
65| show_in_editor_menu | Afficher Visualindex dans les menus d'édition (classique et ProseMirror). | ''true'' |
66| use_pagesicon | Utiliser le helper ''pagesicon'' si disponible. | ''true'' |
67| default_image | Image par défaut (ID média), ex. ''wiki:logo.png''. | '''' |
68
69===== Intégration pagesicon =====
70
71Si [[https://www.dokuwiki.org/plugin:pagesicon|pagesicon]] est installé et ''use_pagesicon'' activé :
72  * Visualindex récupère les icônes de pages ;
73  * Visualindex récupère les icônes de médias ;
74  * fallback par défaut si aucune icône n'est trouvée.
75
76Ordre de fallback :
77  * icône fournie par ''pagesicon'' ;
78  * ''default_image'' de Visualindex ;
79  * image interne du plugin (''images/default_image.png'').
80
81===== ProseMirror =====
82
83Le plugin expose un bouton ''Visualindex'' dans ProseMirror (si ''show_in_editor_menu'' est activé), avec une popup de configuration :
84  * namespace ;
85  * filtre ;
86  * ordre descendant ;
87  * affichage des médias.
88
89===== Fichiers principaux =====
90
91  * ''syntax/visualindex.php'' : parsing et rendu XHTML ;
92  * ''action/prosemirror.php'' : intégration éditeur ;
93  * ''script/prosemirror.js'' : nœud ProseMirror ;
94  * ''script/toolbar.js'' : bouton et popup ;
95  * ''style.css'' : styles d'affichage.
96