Vorlage:TOC Artikel/Doku

Aus ÖsterreichWiki
< Vorlage:TOC Artikel
Version vom 7. März 2017, 10:26 Uhr von Karl Gruber (Diskussion | Beiträge) (Die Seite wurde neu angelegt: „<noinclude>{{Dokumentation/Dokuseite}}</noinclude> Diese Vorlage dient zur Einblendung einer alphabetischen '''Indexliste''' in Artikeln oder Artikelserien mit…“)
(Unterschied) ← Nächstältere Version | Aktuelle Version (Unterschied) | Nächstjüngere Version → (Unterschied)
Zur Navigation springen Zur Suche springen
Dokumentations-Unterseite Diese Seite ist die Dokumentations-Unterseite der Vorlage:TOC Artikel.

Diese Vorlage dient zur Einblendung einer alphabetischen Indexliste in Artikeln oder Artikelserien mit Unterkapiteln, die nach Anfangsbuchstaben- und zeichen gegliedert sind. Sie sollte dann benutzt werden, wenn die Vorlage:TOC, die keine Parameter kennt, nicht ausreichend ist.

Im Gegensatz zur Vorlage {{TOC}} kann diese Vorlage über [[#toc]] von weiter unten im Artikel angesprungen werden. Die Linkadresse wird allerdings nur erzeugt, wenn nicht ein von der MediaWiki-Software generiertes Inhaltsverzeichnis im Artikel aufscheint (Parameter TOC). In diesem Fall ist das Sprungziel an das automatisch generierte Inhaltsverzeichnis gebunden.

Parameter

Beim Aufruf ohne Parameter, entspricht diese Vorlage der Vorlage {{TOC}}. Darüber hinaus können folgende optionalen Parameter angegeben werden:

Parameter Beschreibung
ARTIKEL Gibt den Artikel an, auf den referenziert werden soll. Wird dieser Parameter nicht angegeben, wird innerhalb der Seite referenziert, auf der diese Vorlage angegeben wurde. Der eigentliche Link setzt sich demnach aus diesem Parameter und dem entsprechenden Buchstaben zusammen.
Beispiel: ARTIKEL=Liste der Autoren/ erzeugt als Linkadresse für den Buchstaben „A“ entsprechend Liste der Autoren/A.
TITEL Gibt den Titel des Inhaltsverzeichnisses einschlieVorlage:SSlich Formatauszeichnungen an. Wird dieser Parameter nicht angegeben, erscheint „Inhaltsverzeichnis“.
Beispiel: TITEL='''[[Liste der Autoren]]'''
ZEICHEN Legt die Bereiche fest, die ausgegeben werden. Die Symbole müssen in der angegebenen Reihenfolge kodiert werden. Wird dieser Parameter nicht angegeben, wird das Symbol „A“ (also nur die Ausgabe der GroVorlage:SSbuchstaben) angenommen:
  • „#“: Ziffern 0–9 als Bereich (0–9)
  • „0“: Ziffern 0–9 einzeln (0 1 2 3 4 5 6 7 8 9)
  • „a“: Zeichen a–z
  • „A“: Zeichen A–Z

Hinweis: „0“ und „#“ dürfen nicht gleichzeitig angegeben werden.
Beispiel: ZEICHEN=0a gibt also sowohl die einzelnen Ziffern als auch die Kleinbuchstaben aus.

LANG Dieser Parameter (von englisch Language: Sprache) erweitert die Buchstaben um sprachspezifische Zeichen. Dabei werden folgende Sprachen unterstützt:
  • de (deutsch): Ergänzt die Buchstaben „Ä“, „Ö“ und „Ü“
  • fo (färöisch): Ergänzt die Buchstaben „Á“, „Æ“, „Í“, „Ó“, „Ø“, „Ú“ und „Ý“ (nur GroVorlage:SSbuchstaben)
  • tr (türkisch): Ergänzt die Buchstaben „Ç“, „İ“, „Ö“, „Ş“ und „Ü“; entfernt die Buchstaben „Q“ und „W“ (nur GroVorlage:SSbuchstaben)

Beispiel: LANG=de

S Wird dieser Parameter mit einem beliebigen Wert angegeben, wird der Buchstabe „S“ um die beiden Einträge „Sch“ und „St“ erweitert.
Beispiel: S=erweitert
XYZ Wird dieser Parameter mit einem beliebigen Wert angegeben, werden die Buchstaben „XYZ“ in einem Link zusammengefasst (verlinkt auf „X–Z“).
Beispiel: XYZ=zusammen
TOC Normalerweise unterdrückt diese Vorlage die Anlage eines Inhaltsverzeichnisses in dem Artikel, in dem sie aufgerufen wurde. Um dennoch ein Inhaltsverzeichnis anzulegen, kann dieser Parameter mit einem beliebigen Wert benutzt werden.
Beispiel: TOC=trotzdem

Beispiele

Beispiele für den Aufruf und die Parameter

  • {{TOC Artikel}} ergibt:
Inhaltsverzeichnis A B C D E F G H I J K L M N O P Q R S T U V W X Y Z


  • {{TOC Artikel|LANG=de|S=erweitert}} ergibt:
Inhaltsverzeichnis A Ä B C D E F G H I J K L M N O Ö P Q R S Sch St T U Ü V W X Y Z


  • {{TOC Artikel|LANG=fo}} ergibt:
Inhaltsverzeichnis A Á Æ B C D E F G H I Í J K L M N O Ó Ø P Q R S T U Ú V W X Y Ý Z


  • {{TOC Artikel|LANG=tr}} ergibt:
Inhaltsverzeichnis A B C Ç D E F G H I İ J K L M N O Ö P R S Ş T U Ü V X Y Z


  • {{TOC Artikel|ZEICHEN=0}} ergibt:
Inhaltsverzeichnis 0 1 2 3 4 5 6 7 8 9


  • {{TOC Artikel|ZEICHEN=#A|XYZ=zusammen}} ergibt:
Inhaltsverzeichnis 0–9 A B C D E F G H I J K L M N O P Q R S T U V W X Y Z


  • {{TOC Artikel|ZEICHEN=0Aa|S=erweitert}} ergibt:
Inhaltsverzeichnis 0 1 2 3 4 5 6 7 8 9 A B C D E F G H I J K L M N O P Q R S Sch St T U V W X Y Z a b c d e f g h i j k l m n o p q r s sch st t u v w x y z


  • {{TOC Artikel|TITEL=''[[Buchstabe]]n:''}} ergibt:
Buchstaben: A B C D E F G H I J K L M N O P Q R S T U V W X Y Z


  • {{TOC Artikel|TITEL=}} ergibt:
A B C D E F G H I J K L M N O P Q R S T U V W X Y Z


  • {{TOC Artikel|TITEL='''[[Liste von Autoren]]:'''|ARTIKEL=Liste von Autoren/}} ergibt:


Kopiervorlagen

Kopiervorlage mit gesamtem Alphabet

Siehe bei Vorlage:TOC

Kopiervorlage für Artikelinhaltsverzeichnis ohne das Alphabet

Zu beachten ist, dass dann das Kapitel-Bearbeiten nicht funktioniert, also die ganze Liste bearbeitet werden muss.

Inhaltsverzeichnis A B C D E F G H I J K L M N O P Q R S T U V W X Y Z


mit Überschriftensimulation
hier beispielsweise mit {{Überschriftensimulation 4}}
A
  • Einträge A
B
  • Einträge B

{{TOC Artikel|TOC=trotzdem}}
{{Anker|A}}{{Überschriftensimulation 4|A}}
{{Anker|B}}{{Überschriftensimulation 4|B}}
{{Anker|C}}{{Überschriftensimulation 4|C}}
{{Anker|D}}{{Überschriftensimulation 4|D}}
{{Anker|E}}{{Überschriftensimulation 4|E}}
{{Anker|F}}{{Überschriftensimulation 4|F}}
{{Anker|G}}{{Überschriftensimulation 4|G}}
{{Anker|H}}{{Überschriftensimulation 4|H}}
{{Anker|I}}{{Überschriftensimulation 4|I}}
{{Anker|J}}{{Überschriftensimulation 4|J}}
{{Anker|K}}{{Überschriftensimulation 4|K}}
{{Anker|L}}{{Überschriftensimulation 4|L}}
{{Anker|M}}{{Überschriftensimulation 4|M}}
{{Anker|N}}{{Überschriftensimulation 4|N}}
{{Anker|O}}{{Überschriftensimulation 4|O}}
{{Anker|P}}{{Überschriftensimulation 4|P}}
{{Anker|Q}}{{Überschriftensimulation 4|Q}}
{{Anker|R}}{{Überschriftensimulation 4|R}}
{{Anker|S}}{{Überschriftensimulation 4|S}}
{{Anker|T}}{{Überschriftensimulation 4|T}}
{{Anker|U}}{{Überschriftensimulation 4|U}}
{{Anker|V}}{{Überschriftensimulation 4|V}}
{{Anker|W}}{{Überschriftensimulation 4|W}}
{{Anker|X}}{{Überschriftensimulation 4|X}}
{{Anker|Y}}{{Überschriftensimulation 4|Y}}
{{Anker|Z}}{{Überschriftensimulation 4|Z}}
mit „;“-Syntax

 

A
  • Einträge A
B
  • Einträge B


{{TOC Artikel|TOC=trotzdem}}
;{{Anker|A}}A
;{{Anker|B}}B
;{{Anker|C}}C
;{{Anker|D}}D
;{{Anker|E}}E
;{{Anker|F}}F
;{{Anker|G}}G
;{{Anker|H}}H
;{{Anker|I}}I
;{{Anker|J}}J
;{{Anker|K}}K
;{{Anker|L}}L
;{{Anker|M}}M
;{{Anker|N}}N
;{{Anker|O}}O
;{{Anker|P}}P
;{{Anker|Q}}Q
;{{Anker|R}}R
;{{Anker|S}}S
;{{Anker|T}}T
;{{Anker|U}}U
;{{Anker|V}}V
;{{Anker|W}}W
;{{Anker|X}}X
;{{Anker|Y}}Y
;{{Anker|Z}}Z

In Listen

In Listen, die als Tabellen gesetzt sind, ist das TOC vergleichsweise aufwändig. Beispiele:

Hilfsmittel

nur die Anker:
{{Anker|A}} {{Anker|B}} {{Anker|C}} {{Anker|D}} {{Anker|E}} {{Anker|F}} {{Anker|G}} {{Anker|H}} {{Anker|I}} {{Anker|J}} {{Anker|K}} {{Anker|L}} {{Anker|M}} {{Anker|N}} {{Anker|O}} {{Anker|P}} {{Anker|Q}} {{Anker|R}} {{Anker|S}} {{Anker|T}} {{Anker|U}} {{Anker|V}} {{Anker|W}} {{Anker|X}} {{Anker|Y}} {{Anker|Z}}

mehrere Indexlisten in einem Artikel

Sind Artikel in mehreren Sektionen untergliedert die wiederum aus alphanumerischen Unterkapiteln bestehen, kann nicht einfach ein {{TOC Artikel}} am Anfang jeder Sektion geschrieben werden, das heißt

== Sektion 1 ==
{{TOC Artikel}}
=== A ===
…
=== Z ===

== Sektion 2 ==
{{TOC Artikel}}
=== A ===
…
=== Z ===

Auf Grund der gleichen Unterkapitelnamen würden dabei stets die Unterkapitel der ersten Sektion angesprungen werden. Als Lösung bietet es sich an jedem Unterkapitel einen einzigartigen Namen zu geben, der aus einem Präfix besteht, das für jede Sektion gleich ist und diesen Präfix dann als Sprungziel der Indexliste zu übergeben:

== Sektion 1 ==
{{TOC Artikel|ARTIKEL=#S1-}}
=== {{Anker|S1-A}} A ===
…
=== {{Anker|S1-Z}} Z ===

== Sektion 2 ==
{{TOC Artikel|ARTIKEL=#S2-}}
=== {{Anker|S2-A}} A ===
…
=== {{Anker|S2-A}} Z ===

Siehe auch