xref: /plugin/visualindex/DOKU_ES.md (revision 0f1d071cc4334147b0583b050b282eb326b1010c)
1====== Visualindex Plugin ======
2
3---- plugin ----
4description: Muestra un índice visual
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[[fr:plugin:visualindex|���� Français]] | [[plugin:visualindex|���� English]] | [[de:plugin:visualindex|���� Deutsch]] | **���� Español**
23
24===== Instalación =====
25
26Instalar el plugin desde el [[plugin:extension|Gestor de extensiones]].
27
28===== Descripción =====
29
30El plugin **visualindex** muestra un índice visual de las páginas (o archivos de medios) de un namespace de DokuWiki.
31
32Es compatible con:
33  * el editor clásico;
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===== Sintaxis =====
39
40Sintaxis básica:
41  * ''%%{{visualindex>namespace}}%%''
42
43Ejemplos:
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
51Opciones:
52  * ''filter'' : filtro simple con ''*'' (ejemplo: ''guide*|doc*'');
53  * ''desc'' : orden descendente (''1'' / ''true'');
54  * ''medias'' : listar medios del namespace (''1'' / ''true'').
55
56Namespace especial:
57  * ''.'' : namespace actual;
58  * ''~sub:carpeta'' : namespace relativo al namespace actual.
59
60===== Configuración =====
61
62^ Nombre ^ Descripción ^ Valor predeterminado ^
63| icon_size | Tamaño del icono (ej. ''100px''). | ''100px'' |
64| text_size | Tamaño del texto (ej. ''13px''). | ''13px'' |
65| text_color | Color del texto (hex, rgb/rgba o nombre CSS). | ''black'' |
66| skip_file | Regex de páginas a ignorar. | '''' |
67| show_in_editor_menu | Mostrar Visualindex en los menús del editor (clásico y ProseMirror). | ''true'' |
68| use_pagesicon | Usar el helper ''pagesicon'' cuando esté disponible. | ''true'' |
69| default_image | Imagen predeterminada (ID de medio), ej. ''wiki:logo.png''. | '''' |
70
71===== Integración con pagesicon =====
72
73Si [[https://www.dokuwiki.org/plugin:pagesicon|pagesicon]] está instalado y ''use_pagesicon'' activado:
74  * Visualindex resuelve los iconos de páginas;
75  * Visualindex resuelve los iconos de medios;
76  * se usa el fallback si no se encuentra ningún icono.
77
78Orden de fallback:
79  * icono proporcionado por ''pagesicon'';
80  * ''default_image'' de Visualindex;
81  * imagen interna del plugin (''images/default_image.png'').
82
83===== ProseMirror =====
84
85El plugin expone un botón ''Visualindex'' en ProseMirror (cuando ''show_in_editor_menu'' está activado) con un popup de configuración:
86  * namespace;
87  * filtro;
88  * orden descendente;
89  * visualización de medios.
90
91===== Archivos principales =====
92
93  * ''syntax/visualindex.php'' : análisis y renderizado XHTML;
94  * ''action/prosemirror.php'' : integración del editor;
95  * ''script/prosemirror.js'' : nodo ProseMirror;
96  * ''script/toolbar.js'' : botón y popup;
97  * ''style.css'' : estilos de visualización.
98