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