xref: /plugin/visualindex/README_DE.md (revision 7f5290b8d6d83542fd5b939a9c568e40224c0ec8)
1# Visualindex
2
3���� [Français](README) | ���� [English](README_EN) | **���� Deutsch** | ���� [Español](README_ES)
4
5---
6
7Das Plugin **visualindex** zeigt einen visuellen Index der Seiten (oder Mediendateien) eines DokuWiki-Namespace.
8
9Es ist kompatibel mit:
10- dem klassischen Editor;
11- ProseMirror.
12
13## Funktionsweise
14
15Das Plugin liest einen Namespace, erstellt eine Liste lesbarer Elemente und zeigt Kacheln mit:
16- einem Bild;
17- einem Titel;
18- einem Link zur Seite oder Mediendatei.
19
20Wenn keine Elemente verfügbar sind, wird eine übersetzte Meldung angezeigt.
21
22## Syntax
23
24Grundsyntax:
25
26```txt
27{{visualindex>namespace}}
28```
29
30Nützliche Beispiele:
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
41Unterstützte Optionen:
42- `filter`: einfacher Filter mit `*` (z. B. `guide*|doc*`);
43- `desc`: absteigende Reihenfolge (`1` / `true`);
44- `medias`: Medien des Namespace anzeigen (`1` / `true`).
45
46Besondere Namespace-Werte:
47- `.`: aktueller Namespace;
48- `~sub:ordner`: Namespace relativ zum aktuellen Namespace.
49
50## Konfigurationsparameter
51
52Im Konfigurationsmanager:
53
54- `icon_size`: Symbolgröße (z. B. `100px`);
55- `text_size`: Textgröße (z. B. `13px`);
56- `text_color`: Textfarbe (hex, rgb/rgba oder CSS-Farbnamen);
57- `skip_file`: regulärer Ausdruck für zu ignorierende Seiten;
58- `show_in_editor_menu`: Visualindex in den Editor-Menüs anzeigen (klassisch und ProseMirror);
59- `use_pagesicon`: den `pagesicon`-Helfer verwenden, wenn verfügbar;
60- `default_image`: Standardbild (Medien-ID, z. B. `wiki:logo.png`); wenn leer, wird das interne Plugin-Bild verwendet.
61
62## Integration mit pagesicon
63
64Wenn das Plugin `pagesicon` vorhanden und über `use_pagesicon` aktiviert ist:
65- Visualindex ruft Seitensymbole über den Helfer ab;
66- Visualindex ruft auch Mediensymbole ab;
67- wenn kein Symbol gefunden wird, wird der Standard-Fallback verwendet.
68
69Fallback-Reihenfolge:
701. Symbol von `pagesicon`;
712. Visualindex `default_image`;
723. internes Plugin-Bild (`images/default_image.png`).
73
74## ProseMirror
75
76Das Plugin stellt eine `Visualindex`-Schaltfläche in ProseMirror bereit (wenn `show_in_editor_menu` aktiviert ist) mit einem Konfigurations-Popup.
77
78Das Popup ermöglicht die Konfiguration von:
79- Namespace;
80- Filter;
81- absteigende Reihenfolge;
82- Medienanzeige.
83