Quelltext der Seite Vorlage:TOC Artikel/Doku

<noinclude>{{Dokumentation/Dokuseite}}</noinclude>
{{VonWP}}
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 {{Vorlage|TOC}} kann diese Vorlage über <code><nowiki>[[#toc]]</nowiki></code> 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.
__TOC__

== Parameter ==

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

{| class="wikitable toptextcells"
|- class="hintergrundfarbe6"
! Parameter
! Beschreibung
|-
| <code>ARTIKEL</code>
| 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.<br />''Beispiel:'' <code>ARTIKEL=Liste der Autoren/</code> erzeugt als Linkadresse für den Buchstaben „A“ entsprechend <code>Liste der Autoren/A</code>.
|-
| <code>TITEL</code>
| Gibt den Titel des Inhaltsverzeichnisses einschlie{{ß}}lich Formatauszeichnungen an. Wird dieser Parameter nicht angegeben, erscheint '''{{„}}Inhaltsverzeichnis{{“}}'''. <br />''Beispiel:'' <code><nowiki>TITEL='''[[Liste der Autoren]]'''</nowiki></code>
|-
| <code>ZEICHEN</code>
| 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 Gro{{ß}}buchstaben) 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.
<br />''Beispiel:'' <code>ZEICHEN=0a</code> gibt also sowohl die einzelnen Ziffern als auch die Kleinbuchstaben aus.
|-
| <code>LANG</code>
| Dieser Parameter (von englisch ''Language:'' Sprache) erweitert die Buchstaben um sprachspezifische Zeichen. Dabei werden folgende Sprachen unterstützt:
* <code>de</code> (deutsch): Ergänzt die Buchstaben {{„}}Ä{{“}}, {{„}}Ö{{“}} und {{„}}Ü{{“}}
* <code>fo</code> (färöisch): Ergänzt die Buchstaben {{„}}Á{{“}}, {{„}}Æ{{“}}, {{„}}Í{{“}}, {{„}}Ó{{“}}, {{„}}Ø{{“}}, {{„}}Ú{{“}} und {{„}}Ý{{“}} (nur Gro{{ß}}buchstaben)
* <code>tr</code> (türkisch): Ergänzt die Buchstaben {{„}}Ç{{“}}, {{„}}İ{{“}}, {{„}}Ö{{“}}, {{„}}Ş{{“}} und {{„}}Ü{{“}}; entfernt die Buchstaben {{„}}Q{{“}} und {{„}}W{{“}} (nur Gro{{ß}}buchstaben)
''Beispiel:'' <code>LANG=de</code>
* griechisch: siehe etwa [[Liste griechischer Wortstämme in deutschen Fremdwörtern#Tabelle|Liste griechischer Wortstämme]]
|-
| <code>S</code>
| Wird dieser Parameter mit einem beliebigen Wert angegeben, wird der Buchstabe „S“ um die beiden Einträge „Sch“ und „St“ erweitert.<br />''Beispiel:'' <code>S=erweitert</code>
|-
| <code>XYZ</code>
| Wird dieser Parameter mit einem beliebigen Wert angegeben, werden die Buchstaben {{„}}XYZ{{“}} in einem Link zusammengefasst (verlinkt auf „X–Z“).<br />''Beispiel:'' <code>XYZ=zusammen</code>
|-
| <code>TOC</code>
| 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.<br />''Beispiel:'' <code>TOC=trotzdem</code>
|}

== Beispiele ==

=== Beispiele für den Aufruf und die Parameter ===
* <code><nowiki>{{TOC Artikel}}</nowiki></code> ergibt:
{{TOC Artikel|TOC=HIER SCHON!}}


* <code><nowiki>{{TOC Artikel|LANG=de|S=erweitert}}</nowiki></code> ergibt:
{{TOC Artikel|LANG=de|S=erweitert|TOC=HIER SCHON!}}


* <code><nowiki>{{TOC Artikel|LANG=fo}}</nowiki></code> ergibt:
{{TOC Artikel|LANG=fo|TOC=HIER SCHON!}}


* <code><nowiki>{{TOC Artikel|LANG=tr}}</nowiki></code> ergibt:
{{TOC Artikel|LANG=tr|TOC=HIER SCHON!}}


* <code><nowiki>{{TOC Artikel|ZEICHEN=0}}</nowiki></code> ergibt:
{{TOC Artikel|ZEICHEN=0|TOC=HIER SCHON!}}


* <code><nowiki>{{TOC Artikel|ZEICHEN=#A|XYZ=zusammen}}</nowiki></code> ergibt:
{{TOC Artikel|ZEICHEN=#A|XYZ=zusammen|TOC=HIER SCHON!}}


* <code><nowiki>{{TOC Artikel|ZEICHEN=0Aa|S=erweitert}}</nowiki></code> ergibt:
{{TOC Artikel|ZEICHEN=0Aa|S=erweitert|TOC=HIER SCHON!}}


* <code><nowiki>{{TOC Artikel|TITEL=''[[Buchstabe]]n:''}}</nowiki></code> ergibt:
{{TOC Artikel|TITEL=''[[Buchstabe]]n:''|TOC=HIER SCHON!}}


* <code><nowiki>{{TOC Artikel|TITEL=}}</nowiki></code> ergibt:
{{TOC Artikel|TITEL=|TOC=HIER SCHON!}}


* <code><nowiki>{{TOC Artikel|TITEL='''[[Liste von Autoren]]:'''|ARTIKEL=Liste von Autoren/}}</nowiki></code> ergibt:
{{TOC Artikel|TITEL='''[[Liste von Autoren]]:'''|ARTIKEL=Liste von Autoren/|TOC=HIER SCHON!}}

<!--
WEITERE BEISPIELE BITTE IMMER MIT |TOC=HIER SCHON! in der Einbindung, damit das TOC hier nicht verschwindet.
-->

== Kopiervorlagen ==

=== Kopiervorlage mit gesamtem Alphabet ===
Siehe bei [[Vorlage:TOC#Kopiervorlage mit gesamtem Alphabet|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.
{{TOC Artikel|TOC=trotzdem}}
<br />
{| width="100%"
|-valign="top"
| width="50%" |
;mit Überschriftensimulation: hier beispielsweise mit {{Vorlage|Überschriftensimulation 4}}

{{Überschriftensimulation 4|A}}
* Einträge A
{{Überschriftensimulation 4|B}}
* Einträge B
…

<pre style="white-space:pre-wrap;">
{{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}}
</pre>
|
;mit {{„}};{{“}}-Syntax
&nbsp;

;A
* Einträge A
;B
* Einträge B
…<br />

<pre style="white-space:pre-wrap;">
{{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
</pre>
|}

=== In Listen ===
In [[Wikipedia:Listen|Listen]], die als Tabellen gesetzt sind, ist das TOC vergleichsweise aufwändig. Beispiele:
* [[Liste griechischer Wortstämme in deutschen Fremdwörtern]], mit je einem TOC für Deutsch und Griechisch, und echten Überschriften in der Kopfzeile
* [[Liste bedeutender Apotheker]]

=== Hilfsmittel ===

'''nur die Anker:'''<br />
<code><nowiki>
{{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}}
</nowiki></code>

=== mehrere Indexlisten in einem Artikel ===
Sind Artikel in mehreren Sektionen untergliedert die wiederum aus alphanumerischen Unterkapiteln bestehen, kann nicht einfach ein <code><nowiki>{{TOC Artikel}}</nowiki></code> am Anfang jeder Sektion geschrieben werden, das heißt
 == Sektion 1 ==
 <nowiki>{{TOC Artikel}}</nowiki>
 === A ===
 …
 === Z ===
 
 == Sektion 2 ==
 <nowiki>{{TOC Artikel}}</nowiki>
 === 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 ==
 <nowiki>{{TOC Artikel|ARTIKEL=#S1-}}</nowiki>
 === <nowiki>{{Anker|S1-A}}</nowiki> A ===
 …
 === <nowiki>{{Anker|S1-Z}}</nowiki> Z ===
 
 == Sektion 2 ==
 <nowiki>{{TOC Artikel|ARTIKEL=#S2-}}</nowiki>
 === <nowiki>{{Anker|S2-A}}</nowiki> A ===
 …
 === <nowiki>{{Anker|S2-A}}</nowiki> Z ===

== Siehe auch ==
* [[Hilfe:Inhaltsverzeichnis]]
* [[:Kategorie:Vorlage:TOC]], zu Varianten der Vorlage:TOC und anderen Methoden
* [[Wikipedia:Formatvorlage Register]]
<includeonly>
[[Kategorie:Vorlage:TOC]]
</includeonly>