Stichwortverzeichnis

Zur Erstellung von Stichwortverzeichnissen.

Achtung: In diesem Element werden keine Stichworte plaziert.

HINWEIS: Stichworte müssen in die Daten eingearbeitet werden.

Auszeichnung: <register>

Attribute

@id

IDs benennen Instanzen und Elemente eindeutig. Sie sind zwingend erforderlich.

<register id="[Werkkürzel]_[Kennzahl]_stichwortverzeichnis"/>

Beispiel

<register id="twa_0805_stichwortverzeichnis">

Gesamtverzeichnis

@gesamtverzeichnis

Kennzeichnung, dass sich ein Verzeichnis auf das gesamte Werk bezieht (also nicht nur auf einen Abschnitt).

HINWEIS: Falls am Anfang einer Instanz (z.B. zu Beginn einer Kennzahl) ein Inhaltsverzeichnis generiert werden soll, wird das Element <seitenbeginn> erst nach Generierung der Daten platziert.

Achtung:

gesamtverzeichnis="true" darf je Verzeichnisart nur einmal vorkommen, bspw. nur ein Gesamtinhaltsverzeichnis, nur ein Gesamtstichwortverzeichnis.
Sofern in einem Werk sowohl ein Gesamtinhaltsverzeichnis als auch eine Gesamtinhaltsübersicht vorhanden sein sollte, erhält nur das Inhaltsverzeichnis den Attributwert gesamtverzeichnis="true"

true - Das Attribut dient dabei der Erkennung der Hauptverzeichnisse des Werks.

Typ

@typ

Default-Wert @typ='sach'. Muss nur verwendet werden, wenn von Default-Wert 'sach' abweicht (also z.B. für ein Personenregister, dieses bekommt dann den @typ='person‘).

Kindelemente

Verzeichnis.einleitung

<verzeichnis.einleitung>

Einleitender Text am Anfang eines Stichwortverzeichnisses.

Beispiel:

<register auto="nein">
    <titel>
       <titel.standard>
          <text>Sachregister</text>
       </titel.standard>
    </titel>
    <verzeichnis.einleitung>
       <absatz>(Die Zahlen geben die Seitenzahl an)</absatz>
    </verzeichnis.einleitung>

Register.eintrag

<register.eintrag>

Ein Eintrag im Stichwortverzeichnis.

Achtung: In diesem Element werden keine Stichworte plaziert.

Text

<text>

Der Begriff eines Registereintrages.

Fundstellen

<fundstellen>

Wrapper für die Fundstellen eines Stichwortes. Enthält mindestens einen Verweis auf die Fundstellen.

Achtung: Eine Fundstelle kann höchstens eine <verweis.seite> oder ein <verweis.objekt typ=“kennzahl"> enthalten, aber mehrere <verweis.objekt>. Bei solchen Gruppierungen müssen mindestens zwei unterschiedliche Typen vorkommen. Bsp.: verweis.objekt[@typ='kennzahl'] + verweis.objekt[@typ='randziffer'] + verweis.objekt[@typ='randziffer']. Die Elemente <verweis.seite> und <verweis.objekt> können zusammen vorkommen.

Siehe

<siehe>

Es wird von einem Begriff auf ein Stichwort mit der bevorzugten Benennung (meist Synonym) oder zum übergeordneten Begriff verwiesen. Einträgen wie "s.", "siehe", "s.a.", "vgl." werden darunter vereinheitlicht erfasst.

Achtung: Bei „siehe dort“ wird kein Querverweis gesetzt.

HINWEIS: <siehe>siehe dort</siehe>-Einträge sollen so gelassen werden und in die Berichte_Stichwort.xml aufgenommen werden.

Attribut @xml:lang

Wird verwendet, um die Sprache eines Textes/Elementinhalts zu definieren, bspw. 'en' für Englisch. Das Attribut ist an jedem Element verwendbar. Mögliche Werte können hier nicht hinterlegt werden; eingetragen wird der Sprachencode nach ISO 639-1.

HINWEIS: Es wird nur genutzt, wenn es ausdrücklich in die werkspezifischen Konvertierungsanweisungen für den Dienstleister geschrieben wird. Die genaue Verwendung wird dann von der werkverantwortlichen Person angefordert.

Auszeichnungsbeispiele für Fundstellen

<register.eintrag>
   <text>Abgeltung eines besonderen Opfers</text>
   <fundstellen>
      <verweis.objekt typ="kennzahl">5</verweis.objekt>
      <verweis.objekt typ="randziffer">30 ff.</verweis.objekt>
   </fundstellen>
</register.eintrag>

<register.eintrag>
   <text>Zulässigkeitsrüge</text>
   <fundstellen>
      <verweis.objekt typ="kennzahl">§ 9</verweis.objekt>
      <verweis.objekt typ="randziffer">28</verweis.objekt>
      <verweis.objekt typ="randziffer">29</verweis.objekt>
   </fundstellen>
   <fundstellen>
      <verweis.objekt typ="kennzahl">§ 10</verweis.objekt>
      <verweis.objekt typ="randziffer">49</verweis.objekt>
   </fundstellen>
   <register.eintrag>
      <text>verspätete Rüge</text>
      <fundstellen>
         <verweis.objekt typ="kennzahl">§ 9</verweis.objekt>
         <verweis.objekt typ="randziffer">32</verweis.objekt>
   </register.eintrag>
</register.eintrag>

<register.eintrag>
   <text>Belehrungen</text>
   <fundstellen>
      <verweis.seite seitennr="32">32</verweis.objekt>
   </fundstellen>
   <fundstellen>
      <verweis.seite seitennr="35">35</verweis.objekt>
   </fundstellen>
</register.eintrag>

Fallgruppen mit Auszeichnungsbeispielen

Fall 1: Hauptstichwort + Fundstellen


Im Register	`Hauptstichwort A → Fundstelle 1, Fundstelle 2`
Register-XML	`<register.eintrag> <text>Hauptstichwort A</text> <fundstellen><verweis.seite refid="f1" seitennr="98"/></fundstellen> <fundstellen><verweis.seite refid="f2" seitennr="103"/></fundstellen> </register.eintrag>`
Text	`<stichwort register="sach"> <level1 eintrag="Hauptstichwort A"/> </stichwort>`
Beispiel	`<stichwort register="sach"> <level1 eintrag="kooperative Behandlung"/> </stichwort>`

Fall 2: Hauptstichwort1 + Fundstellen; Hauptstichwort2 nur mit Verweis


Im Register	`Hauptstichwort B → Fundstelle 3 Hauptstichwort M → siehe Hauptstichwort B`
Register-XML	`<register.eintrag> <text>Hauptstichwort B</text> <fundstellen><verweis.seite refid="f3" seitennr="17"/></fundstellen> </register.eintrag> <register.eintrag> <text>Hauptstichwort M</text> <siehe>Hauptstichwort B</siehe> </register.eintrag>`
Text	`F2: <stichwort register="sach"> <level1 eintrag="Hauptstichwort B"/> </stichwort> F3: <stichwort register="sach"> <level1 eintrag="Hauptstichwort M"/> <querverweis level1="Hauptstichwort B"/> </stichwort>`
Beispiel	`<stichwort register="sach"> <level1 eintrag="Polikliniken"/> <querverweis level1="Hochschulambulanzen"/> </stichwort>` Tipp: Platzierung: An der ersten Fundstelle des Verweis-Ziels (hier: Hochschulambulanzen) Achtung: Ein Stichwort mit querverweis erzeugt keine Fundstelle im Register. Soll zusätzlich eine Fundstelle abgebildet werden (siehe-auch Verweis), muss ein zusätzliches Stichwort-Element an der entsprechenden Position angelegt werden.

Fall 3: Hauptstichwort1 + Fundstellen; Hauptstichwort2 mit Verweis und Fundstellen

Im Register

Im Register	`Hauptstichwort B → Fundstelle 3 Hauptstichwort M → Fundstelle 2; siehe auch Hauptstichwort B`
Register-XML	`<register.eintrag> <text>Hauptstichwort B</text> <fundstellen><verweis.seite refid="f3" seitennr="17"/></fundstellen> </register.eintrag> <register.eintrag> <text>Hauptstichwort M</text> <fundstellen><verweis.seite refid="f2" seitennr="17"/></fundstellen> <siehe>Hauptstichwort B</siehe> </register.eintrag>`
Text	`F2: <stichwort register="sach"> <level1 eintrag="Hauptstichwort B"/> </stichwort> F3: <stichwort register="sach"> <level1 eintrag="Hauptstichwort M"/> <querverweis level1="Hauptstichwort B"/> </stichwort>`

Hauptstichwort B   →   Fundstelle 3
Hauptstichwort M   →   Fundstelle 2; siehe auch Hauptstichwort B

<register.eintrag>
	<text>Hauptstichwort B</text>
	<fundstellen><verweis.seite refid="f3" seitennr="17"/></fundstellen>
</register.eintrag>
<register.eintrag>
	<text>Hauptstichwort M</text>
	<fundstellen><verweis.seite refid="f2" seitennr="17"/></fundstellen>
	<siehe>Hauptstichwort B</siehe>
</register.eintrag>

Text

F2: <stichwort register="sach">
	<level1 eintrag="Hauptstichwort B"/>
</stichwort>
F3: <stichwort register="sach">
	<level1 eintrag="Hauptstichwort M"/>
	<querverweis level1="Hauptstichwort B"/>
</stichwort>

Fall 4: Hauptstichwort1 + Fundstellen; Hauptstichwort2 mit Verweis im Unterstichwort


Im Register	`Hauptstichwort B - Unterstichwort X → Fundstelle 3 Hauptstichwort C → Fundstelle 4 Hauptstichwort M → siehe Hauptstichwort B, Unterstichwort X; Hauptstichwort C`
Register-XML	`<register.eintrag> <text>Hauptstichwort B</text> <register.eintrag> <text>Unterstichwort X</text> <fundstellen><verweis.seite refid="f3" seitennr="17"/></fundstellen> </register.eintrag> </register.eintrag> <register.eintrag> <text>Hauptstichwort C</text> <fundstellen><verweis.seite refid="f4" seitennr="17"/></fundstellen> </register.eintrag> <register.eintrag> <text>Hauptstichwort M</text> <siehe>Hauptstichwort B, Unterstichwort X</siehe> <siehe>Hauptstichwort C</siehe> </register.eintrag>`
Text	`F3: <stichwort register="sach"> <level1 eintrag="Hauptstichwort B"> <level2 eintrag="Unterstichwort X"> </level1> </stichwort> F4: <stichwort register="sach"> <level1 eintrag="Hauptstichwort C"/> </stichwort> <stichwort register="sach"> <level1 eintrag="Hauptstichwort M"/> <querverweis level1="Hauptstichwort B" level2=“Unterstichwort X“/> </stichwort> <stichwort register="sach"> <level1 eintrag="Hauptstichwort M"/> <querverweis level1="Hauptstichwort C"/> </stichwort>`
Beispiel	`<stichwort register="sach"> <level1 eintrag="Prozesskostenhilfe"/> <querverweis level1="Rechtsanwalt" level2="Beiordnung"/> </stichwort>`

Fall 5: Hauptstichwort1 + Fundstellen; Hauptstichwort2 mit Verweis und Fundstellen im Unterstichwort

Im Register

Im Register	`Hauptstichwort B - Unterstichwort X → Fundstelle 3 Hauptstichwort C → Fundstelle 4 Hauptstichwort M → Fundstelle 2; siehe auch Hauptstichwort B, Unterstichwort X; Hauptstichwort C`
Register-XML	<register.eintrag> <text>Hauptstichwort B</text> <register.eintrag> <text>Unterstichwort X</text> <fundstellen><verweis.seite refid="f3" seitennr="17"/></fundstellen> </register.eintrag> </register.eintrag> <register.eintrag> <text>Hauptstichwort C</text> <fundstellen><verweis.seite refid="f4" seitennr="17"/></fundstellen> </register.eintrag> <register.eintrag> <text>Hauptstichwort M</text> <fundstellen><verweis.seite refid="f2" seitennr="17"/></fundstellen> <siehe>Hauptstichwort B, Unterstichwort X</siehe> <siehe>Hauptstichwort C</siehe> </register.eintrag>
Text	F3: <stichwort register="sach"> <level1 eintrag="Hauptstichwort B"> <level2 eintrag="Unterstichwort X"> </level1> </stichwort> F4: <stichwort register="sach"> <level1 eintrag="Hauptstichwort C"/> </stichwort> F2: <stichwort register="sach"> <level1 eintrag="Hauptstichwort M"/> </stichwort> <stichwort register="sach"> <level1 eintrag="Hauptstichwort M"/> <querverweis level1="Hauptstichwort B" level2=“Unterstichwort X“/> </stichwort> <stichwort register="sach"> <level1 eintrag="Hauptstichwort M"/> <querverweis level1="Hauptstichwort C"/> </stichwort>

Hauptstichwort B
   - Unterstichwort X   →   Fundstelle 3
Hauptstichwort C   →   Fundstelle 4
Hauptstichwort M   →   Fundstelle 2; siehe auch Hauptstichwort B, Unterstichwort X; Hauptstichwort C

<register.eintrag>
	<text>Hauptstichwort B</text>
	<register.eintrag>
		<text>Unterstichwort X</text>
		<fundstellen><verweis.seite refid="f3" seitennr="17"/></fundstellen>
	</register.eintrag>
</register.eintrag>
<register.eintrag>
	<text>Hauptstichwort C</text>
	<fundstellen><verweis.seite refid="f4" seitennr="17"/></fundstellen>
</register.eintrag>
<register.eintrag>
	<text>Hauptstichwort M</text>
	<fundstellen><verweis.seite refid="f2" seitennr="17"/></fundstellen>
	<siehe>Hauptstichwort B, Unterstichwort X</siehe>
	<siehe>Hauptstichwort C</siehe>
</register.eintrag>

Text

F3: <stichwort register="sach">
	<level1 eintrag="Hauptstichwort B">
		<level2 eintrag="Unterstichwort X">
	</level1>
</stichwort>
F4: <stichwort register="sach">
	<level1 eintrag="Hauptstichwort C"/>
</stichwort>
F2: <stichwort register="sach">
	<level1 eintrag="Hauptstichwort M"/>
</stichwort>
<stichwort register="sach">
	<level1 eintrag="Hauptstichwort M"/>
	<querverweis level1="Hauptstichwort B" level2=“Unterstichwort X“/>
</stichwort>
<stichwort register="sach">
	<level1 eintrag="Hauptstichwort M"/>
	<querverweis level1="Hauptstichwort C"/>
</stichwort>

Ausgabe

Titel des Verzeichnisses

Der Titel lautet einheitlich „Stichwortverzeichnis“.
Zusätze wie der Werkname, z.B. „SGB V“ oder „EU-Sozialrecht“, entfallen oder werden im Untertitel aufgeführt.

Bearbeiter:innen des Verzeichnisses

Register haben Bearbeiter:innen, keine Autor:innen. Bearbeiter:innen werden in esv.instanz/meta/autorengruppe/@typ="bearbeiter" aufgeführt.
Der Name der Bearbeiter:innen kann optional unter dem Titel aufgeführt werden, mit dem generierten Zusatz „Bearbeiter:“ davor. Eine Bearbeiter:innen-Nennung in der Fußzeile ist nicht vorgesehen.

Stand

Der Stand des Stichwortverzeichnisses geht aus der Blattnorm hervor und wird nicht zusätzlich explizit genannt (in den Daten steht eine PI mit dem Zeitpunkt der Generierung).

Einleitender Text

Ein einleitender, erklärender Text kann grundsätzlich vorkommen, sollte aber redaktionell einheitlich und vor allem verständlich gefasst werden.

Layout

2-spaltig, Abstand zwischen den Spalten 5 oder 6 mm je nach Satzspiegel, keine Trennlinie zwischen den Spalten, vertikaler Blocksatz
Satzspiegel, Schriften und Abstände werden über werkspezifische Parameter gesteuert
Linksbündige Zwischenüberschrift mit Anfangsbuchstaben A, B, C, … bei Wechsel desselben
Der Hauptstichworteintrag mit seinen Fundstellen oder „Siehe“-Verweisen hat einen hängenden Einzug von 85% des Schriftgrades
Die Kennzahl der Fundstelle wird fett formatiert
Ein Unterstichwort erhält einen Einzug links (in Breite 85% des Schriftgrades) und einen Halbgeviertstrich (EN DASH, U+2013) als Anstrich
Vor einem Hauptstichwort erfolgt ein Abstand von 25% des Schriftgrades
Zusammengehalten werden folgende Elemente (d.h. hier erfolgt kein Spaltenwechsel zwischen den Elementen):
- Zwischenüberschrift und die beiden folgenden Stichwörter (Ebene egal)
- Stichwort und das erste Unterstichwort
- Unterstichwort und das erste Unterunterstichwort
- letztes und vorletztes Stichwort in den Ebenen 2 und 3
Vor „siehe auch“ steht ein Zeilenumbruch, ein Spaltenwechsel ist aber nicht erlaubt
Haupt- und Unterstichwort werden kommasepariert zusammengezogen, wenn das Hauptstichwort keine eigene Fundstelle und nur ein Unterstichwort hat
Auf die Generierung von Text in der Fundstelle, wie z.B. "Kza.", "Rn." oder "S.", wird verzichtet
Im Fahnenmodus werden die Einträge der unterschiedlichen Ebenen in unterschiedlichen Farben ausgegeben

Querverweise (siehe/siehe auch)

Im XML existiert nur das Element siehe. Der Satzprozess entscheidet, ob es sich um ein siehe (= Stichwort ohne Fundstellen und Untereinträge) oder ein siehe-auch (Stichwort mit Fundstellen und/oder Untereinträgen) handelt.
Ein generierter siehe auch-Verweis folgt immer nach der Fundstelle und/oder Untereinträgen (Reihenfolge im XML kann abweichen).

Für die Elemente register//register.eintrag/siehe und rn.block//register.eintrag/siehe gilt:

wenn preceding-sibling::fundstellen: siehe auch generieren
wenn nicht preceding-sibling::fundstellen: siehe generieren

Zusätzliche Erkenntnisse

Der String „Kennzahl“ wird in den XML-Daten (Rahmendatei dokument/@kennzahl) so erfasst, dass die 'normale' Darstellung innerhalb von Texten funktioniert. Die Manipulation für eine andere Anzeige der Kennzahl in der Kopfzeile erfolgt anhand eines Parameters (RegEx) im Satzsystem.