Kommentar

Verwendbar für Kommentierungen bestehend aus Normen und Kommentarteil.

Die Dateibenennung entspricht der vergebenen ID.

HINWEIS: Kommentare müssen immer einen Titel erhalten, entweder ist es der Titel der (ersten) kommentierten Vorschrift (Einzelvorschrift oder Gesamtvorschrift) oder der übergreifende Titel (kommentar.teil/titel). Hintergrund: Es gibt in den Printwerken immer wieder Kommentare, die mehrere Vorschriften besprechen. Die fehlenden Titel müssen bei Umstellung in XML-first-Produktion redaktionell nachgepflegt werden (Beschluss 13.02.2018, Aktualisierung: 06.10.2023).

Auszeichnung: <esv.instanz typ="kommentar">

Attribute

@id

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

Aufbau bei Kennzahlstruktur

<esv.instanz typ="[instanztyp]" id="[Werkkürzel]_[Kennzahl]"/>

<esv.instanz typ="[instanztyp]" id="b[ISBN]_[Kennzahl]"/>

Beispiel

<esv.instanz typ="kommentar" id="bdsg_5001_para0005">

<esv.instanz typ="kommentar" id="b9783503176649_para009">

Redaktioneller Stand

@red-stand

Der redaktionelle Stand wird direkt im Wurzelelement angegeben: /esv.instanz/@red-stand. Dieser Bearbeitungsstand ist eine Meta-Information und wird vom Satzdienstleister nur in den Fahnen ausgegeben.

Achtung: Der Wert dieses Attributs muss dem ISO-Datumsformat (YYYY-MM-DD) entsprechen.

Beispiel:

Text im Manuskript: Die Kommentierung berücksichtigt den Rechtsstand bis zum 10.3.2018.

Auszeichnung: <esv.instanz red-stand="2018-03-10">

Ausgabe in der Fahne: 2018-03-10

Kindelemente

Kommentar

<kommentar>

Wrapper für einen Kommentar zu einer gesamten Vorschrift (ggf. mit Auslassungen) oder für die Kommentierung einer Kapitelstruktur oder Anlage.

Achtung: Verwendung NICHT als Wrapper zur Kommentierung einzelner Teile einer Gesamtvorschrift (hierzu mehrere <kommentar.teil> verwenden; für eine einzelne Einzelvorschrift nur <kommentar.teil>).

HINWEIS: <kommentar> darf mehrere Elemente <gesamtvorschrift> oder und/oder <kapitel> beinhalten. Diese Möglichkeit wird aber nur genutzt, wenn es ausdrücklich in die werkspezifischen Konvertierungsanweisungen für den Dienstleister geschrieben wird.

HINWEIS: Es ist möglich, <kommentar> und <kommentar.teil> parallel zu verwenden. Für sehr eng begrenzte kann z.B. eine Gesamtvorschrift und eine Einzelvorschrift einer anderen Gesamtvorschrift gleichzeitig kommentiert werden. Hier ist in jedem Fall immer ein gemeinsamer Titel der Kommentierung erforderlich.

Kommentar.teil

<kommentar.teil>

Tipp:

Werden in einem Kommentar Anlagen kommentiert und haben diese keine Vorschrift(Einzelvorschrift)-Struktur, kann man statt <gesamtvorschrift.text> das <anlagen>-Element verwenden.

Anlagen werden immer als Element <anlage> erfasst, auch wenn es sich um eine Einzelvorschrift handelt. Da durch diese Regel das Attribut @anl beim Element <einzelvorschrift> entfällt, ist es jetzt möglich, in einer Kommentierung zu einer oder mehreren Einzelvorschriften oder eines Kapitels jeweils das Element <anlagen> mit einem oder meheren Kindelementen <anlage> zu verwenden.

Kommentar.text

<kommentar.text>

In diesem Element wird die Kommentierung erfasst.

<kommentar.text> ist ein Kindelement von <kommentar.teil>: kommentar/kommentar.teil/kommentar.text

Kommentar.ebene

<kommentar.ebene>

Die Struktur-Ebene (Untergliederung des Textes) eines Kommentarteils. Eine Ebenenstruktur muss unbedingt eine Überschrift (Titel) haben.

HINWEIS:

Die im Print inline ausgezeichneten aber im Inhaltsverzeichnis erwähnten Ebenen werden in XML als //kommentar.ebene/titel markiert.

Beispiel

Die im Print inline ausgezeichneten aber im Inhaltsverzeichnis nicht erwähnten Ebenen werden in XML als <absatz> markiert.

Auszeichnung: <kommentar.ebene>

Synopse

<synopse>

Ein optionales Element, das in den Instanztypen gesamtvorschrift, gesamtvorschrift.amtlich und kommentar verwendet werden kann. Es kann in einer Vorschrift nur zusätzlich zu den in der Synopse beinhalteten zwei Vorschriften verwendet werden.

/esv.instanz[@typ=(‚gesamtvorschrift‘,‘gesamtvorschrift.amtlich‘)]/synopse
/esv.instanz/(kommentar,kommentar.teil)/synopse

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.