xref: /plugin/visualindex/DOKU_DE.md (revision 7f5290b8d6d83542fd5b939a9c568e40224c0ec8)
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===== Syntax =====
37
38Grundsyntax:
39  * ''%%{{visualindex>namespace}}%%''
40
41Beispiele:
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
49Optionen:
50  * ''filter'' : einfacher Wildcard-Filter mit ''*'' (Beispiel: ''guide*|doc*'');
51  * ''desc'' : absteigende Sortierung (''1'' / ''true'');
52  * ''medias'' : Medien des Namespace auflisten (''1'' / ''true'').
53
54Besonderer Namespace:
55  * ''.'' : aktueller Namespace;
56  * ''~sub:ordner'' : Namespace relativ zum aktuellen Namespace.
57
58===== Einstellungen =====
59
60^ Name ^ Beschreibung ^ Standardwert ^
61| icon_size | Symbolgröße (z. B. ''100px''). | ''100px'' |
62| text_size | Textgröße (z. B. ''13px''). | ''13px'' |
63| text_color | Textfarbe (hex, rgb/rgba oder CSS-Farbname). | ''black'' |
64| skip_file | Regex für zu ignorierende Seiten. | '''' |
65| show_in_editor_menu | Visualindex in den Editor-Menüs anzeigen (klassisch und ProseMirror). | ''true'' |
66| use_pagesicon | ''pagesicon''-Helfer verwenden, wenn verfügbar. | ''true'' |
67| default_image | Standardbild (Medien-ID), z. B. ''wiki:logo.png''. | '''' |
68
69===== pagesicon-Integration =====
70
71Wenn [[https://www.dokuwiki.org/plugin:pagesicon|pagesicon]] installiert und ''use_pagesicon'' aktiviert ist:
72  * Visualindex löst Seitensymbole auf;
73  * Visualindex löst Mediensymbole auf;
74  * Fallback wird verwendet, wenn kein Symbol gefunden wird.
75
76Fallback-Reihenfolge:
77  * Symbol von ''pagesicon'';
78  * Visualindex ''default_image'';
79  * internes Plugin-Bild (''images/default_image.png'').
80
81===== ProseMirror =====
82
83Das Plugin stellt eine ''Visualindex''-Schaltfläche in ProseMirror bereit (wenn ''show_in_editor_menu'' aktiviert ist) mit einem Konfigurations-Popup:
84  * Namespace;
85  * Filter;
86  * absteigende Reihenfolge;
87  * Medienanzeige.
88
89===== Hauptdateien =====
90
91  * ''syntax/visualindex.php'' : Parsing und XHTML-Rendering;
92  * ''action/prosemirror.php'' : Editor-Integration;
93  * ''script/prosemirror.js'' : ProseMirror-Knoten;
94  * ''script/toolbar.js'' : Schaltfläche und Popup;
95  * ''style.css'' : Anzeigestile.
96