xref: /plugin/visualindex/DOKU_DE.md (revision 4b021f8094236bf00ad856fb4370d96be5c4f106)
1====== Visualindex Plugin ======
2
3---- plugin ----
4description: Zeigt einen visuellen Index an
5author     : Valentin LORTET, Gabriel CHOIMET
6email      : contact@valentinlortet.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[[fr:plugin:visualindex|���� Français]] | [[plugin:visualindex|���� English]] | **���� Deutsch** | [[es:plugin:visualindex|���� Español]]
23
24===== Installation =====
25
26Plugin über den [[plugin:extension|Extension Manager]] installieren.
27
28===== Beschreibung =====
29
30Das Plugin **visualindex** zeigt einen visuellen Index der Seiten (oder Mediendateien) eines DokuWiki-Namespace.
31
32Es ist kompatibel mit:
33  * dem klassischen Editor;
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===== Syntax =====
39
40Grundsyntax:
41  * ''%%{{visualindex>namespace}}%%''
42
43Beispiele:
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
51Optionen:
52  * ''filter'' : einfacher Wildcard-Filter mit ''*'' (Beispiel: ''guide*|doc*'');
53  * ''desc'' : absteigende Sortierung (''1'' / ''true'');
54  * ''medias'' : Medien des Namespace auflisten (''1'' / ''true'').
55
56Besonderer Namespace:
57  * ''.'' : aktueller Namespace;
58  * ''~sub:ordner'' : Namespace relativ zum aktuellen Namespace.
59
60===== Einstellungen =====
61
62^ Name ^ Beschreibung ^ Standardwert ^
63| icon_size | Symbolgröße (z. B. ''100px''). | ''100px'' |
64| text_size | Textgröße (z. B. ''13px''). | ''13px'' |
65| text_color | Textfarbe (hex, rgb/rgba oder CSS-Farbname). | ''black'' |
66| skip_file | Regex für zu ignorierende Seiten. | '''' |
67| show_in_editor_menu | Visualindex in den Editor-Menüs anzeigen (klassisch und ProseMirror). | ''true'' |
68| use_pagesicon | ''pagesicon''-Helfer verwenden, wenn verfügbar. | ''true'' |
69| default_image | Standardbild (Medien-ID), z. B. ''wiki:logo.png''. | '''' |
70
71===== pagesicon-Integration =====
72
73Wenn [[https://www.dokuwiki.org/plugin:pagesicon|pagesicon]] installiert und ''use_pagesicon'' aktiviert ist:
74  * Visualindex löst Seitensymbole auf;
75  * Visualindex löst Mediensymbole auf;
76  * Fallback wird verwendet, wenn kein Symbol gefunden wird.
77
78Fallback-Reihenfolge:
79  * Symbol von ''pagesicon'';
80  * Visualindex ''default_image'';
81  * internes Plugin-Bild (''images/default_image.png'').
82
83===== ProseMirror =====
84
85Das Plugin stellt eine ''Visualindex''-Schaltfläche in ProseMirror bereit (wenn ''show_in_editor_menu'' aktiviert ist) mit einem Konfigurations-Popup:
86  * Namespace;
87  * Filter;
88  * absteigende Reihenfolge;
89  * Medienanzeige.
90
91===== Hauptdateien =====
92
93  * ''syntax/visualindex.php'' : Parsing und XHTML-Rendering;
94  * ''action/prosemirror.php'' : Editor-Integration;
95  * ''script/prosemirror.js'' : ProseMirror-Knoten;
96  * ''script/toolbar.js'' : Schaltfläche und Popup;
97  * ''style.css'' : Anzeigestile.
98