Rahmendatei

Die Rahmendatei verbindet alle im Werk vorkommenden XML-Dateien und zeigt, in welcher Reihenfolge und Struktur sie erscheinen. Neben einer reinen Auflistung der XML-Dokument-Verweise (<dokument>) können in Form von Abschnitten (<abschnitt>, s. unten) analog zu „Ebenen“ Hierarchien abgebildet werden. Daher müssen übergeordnete Ebenenüberschriften, z. B. Fächer oder Teilabschnitte, in der Rahmendatei (und nicht in einzelnen XML-Instanzen) angegeben werden.

Im Wurzelelement dieser Rahmendatei muss die ProduktID/das Werkskürzel, der Produkttyp sowie die ID der Rahmendatei angegeben werden. Die Rahmendatei muss immer auf ESV.xsd verweisen.

HINWEIS: Die Rahmendatei muss immer auf "ESV.xsd" verweisen. Die Dateibenennung entspricht der vergebenen ID.

Tipp: Für XML-first-Bücher kann die Rahmendatei automatisch über ein Transformations-Szenario generiert werden. Mehr dazu im Wiki: Rahmendatei-Generator

LBW: Bei Rücklieferung von Loseblatt-ELs soll das Element <stand-lieferung> (produkt.meta/stand-lieferung) innerhalb der Rahmendatei gesetzt werden. Die Attribute @lfg und @datum sind analog wie in <seitenbeginn> zu befüllen.

Auszeichnung: <esv.produkt>

Attribute

@produktid

Tabelle 1. Produktid-Struktur
Werktyp	`@produktid`-Beschreibung	`@produktid`-Beispiel
LBW	normiertes ESV-Werkkürzel	"`sbg09`" "`kwg`" "`gkoed01`"
Buch	"`b`" + normierte ISBN	"`b9783503154241`"
Zeitschrift	[Werkkürzel]_[Jahr]_[Nummer Zeitschriftenheft]	"`ksi_2017_05`" "`sis_2022_07_08`"

@id/@refid

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

Die @id der Rahmendatei setzt sich zusammen aus der @produktid und dem Suffix „_0000“.

<esv.produkt id="[Werkkürzel]_0000"/>
<esv.produkt id="b[ISBN]_0000"/>
<esv.produkt id="[Werkkürzel]_[Jahr]_[Nummer Zeitschriftenheft]_0000">

Beispiel

<esv.produkt id="in_0000">
<esv.produkt id="b9783503154241_0000">
<esv.produkt id="ksi_2017_05_0000">

@typ

Legt die Werkart ("Buch", "LBW", "Zeitschrift" oder "Datenbank") fest.

HINWEIS: Der @typ=‘Datenbank‘ muss von der werkverantwortlichen Person angefordert werden.

@produktkuerzel

Produktkürzel

HINWEIS:

Für alle @typ="zeitschrift" muss ein @produktkuerzel vergeben werden:


Zeitschrift	`@produktkuerzel`
AbfallR	AbfallR
altlasten spektrum	AltS
Archiv	Archiv
Berliner Anwaltsblatt	BAB
Betriebliche Prävention	BePr
Bodenschutz	ZBos
Deutsch als Fremdsprache	DaF
Deutsche Sprache	DS
ER EnergieRecht	ZER
Forschung & Lehre	FuL
Fremdsprache Deutsch	FD
Gemeindewirtschaft	GW
Ideen- und Innovationsmanagement	IDIM
Immissionsschutz	ImS
Journal der Wirtschaftsstrafrechtlichen Vereinigung e. V	WiJ
Kranken- und Pflegeversicherung	KrV
KRS Krankenhaus-Rechtsprechung	KRS
Krisen-, Sanierungs- und Insolvenzberatung	KSI
MÜLL und ABFALL	MA
Privacy in Germany	PinG
Die Personalvertretung	PV
Die Rentenversicherung	rv
Die Sozialgerichtsbarkeit	SGb-Z
sicher ist sicher	sis
Steuer- und RechtsBrief Touristik	SRTour
Die steuerliche Betriebsprüfung	StBp
Stiftung&Sponsoring	SuS
Versorgungswirtschaft	VW
Wege zur Sozialversicherung	WzS
Zeitschrift für Corporate Governance	ZCG
ZESAR	ZESAR
Zeitschrift für Compliance	ZfC
Zeitschrift für deutsche Philologie	ZfdPh
Zeitschrift für Risikomanagement	ZfRM
Zeitschrift Interne Revision	ZIR
Risk, Fraud & Compliance	ZRFC

Kindelemente

Produkt.meta

<produkt.meta>

Enthält die Metadaten eines Werkes: Die Informationen aus Titelei und Impressum eines Werks in standardisierter Form. Mehr unter <produkt.meta>

Abschnitt

<abschnitt>

Zusammengehörige Dokumente (z. B. gleiche Kennzahl mit durchgängiger Seitennummerierung, aber einzelne Richtlinien, Dokumente, etc.) werden in dem Element <abschnitt> mit dem Attribut @rahmen=“true“ zusammengehalten. In diesem Fall wird im Inhaltsverzeichnis nur der Abschnittstitel angezeigt.

Vorwort, Frontispiz usw. werden ebenfalls in separaten XML-Dateien erfassen (Modul: Vorspann). Diese Dokumente werden dann in der Rahmendatei referenziert unter <abschnitt typ="vorspann">.

Analog werden Verzeichnisse am Ende des Werks mit <abschnitt typ="nachspann"> gekennzeichnet.

Einschübe, die gesondert im Inhaltsverzeichnis dargestellt werden sollen, werden mit <abschnitt typ="einschub"> gekennzeichnet.

Achtung: Wenn @rahmen=“true“, muss das <titel>-Element ausgefüllt werden. Wenn es sich um eine Kennzahl handelt, muss das <kennzahl>-Element ausgefüllt sein.

<abschnitt rahmen="true" id="sgbV_0000_e0006_e0003_e0001">
    <abschnitt.meta>
        <titel sichtbar="false">
            <titel.standard>
                <text>Beschlußempfehlung des Ausschusses für Arbeit und Sozialordnung (11. Ausschuß)</text>
            </titel.standard>
        </titel>
        <meta>
            <kennzahl>M 040</kennzahl>
        </meta>
    </abschnitt.meta>
    <dokument href="sgbV_m040_01.xml" refid="sgbV_m040_01" kennzahl="M 040"/>
    <dokument href="sgbV_m040_02.xml" refid="sgbV_m040_02" kennzahl="M 040"/>
</abschnitt>

Achtung: Sonderfall: Folgen nach übergeordneten Überschriften direkt Absätze oder Randnummern sowie Einzeldokumente, so ist der Abschnitt in der Rahmendatei mit dem Attribut rahmen="true" zu kennzeichnen.

Zur Darstellung kompletter Zeitschriftenjahrgänge in der Rahmendatei gibt es die folgenden optionale Elemente:

abschnitt.meta/meta/jahrgang
abschnitt.meta/meta/nummer
abschnitt.meta/meta/heft-startseite
abschnitt.meta/meta/heft-endseite
abschnitt.meta/meta/volldatum

HINWEIS: Es müssen von dieser Gruppe entweder alle oder keins vorhanden sein. Die Elemente dienen ausschließlich der internen Verwendung in Produktionsdaten.

Dokument

<dokument>

Attribute von <dokument>

@href

Wird verwendet, um Dateien mit dem XML-Dokument zu verknüpfen.

@refid

RefIDs werden verwendet, um auf bereits vorhandene IDs zu verweisen, @refid-Werte müssen also immer schon verwendete @id-Werte sein. Bei Verweisen mit dem Element verweis.objekt sind sie zwingend erforderlich.

@kennzahl

Beinhaltet die Kennzahl des Dokumentes.

Auszeichnungsbeispiel

element_abschnitt_sonderfall_bsp_978-5-13097-9_S25

<abschnitt rahmen="true">
                <abschnitt.meta>
                <titel>
                <titel.standard>
                <kennung><seitenbeginn nr="25"/>A.</kennung>
                <text>Grundsätze für die Berechnung des … Unterhalts</text>
                </titel.standard>
                </titel>
                </abschnitt.meta>
                <dokument id="b9783503130979_A" href="b9783503130979_A.xml"/>
                <dokument id="b9783503130979_A_1" href="b9783503130979_A_1.xml"/>
                <dokument id="b9783503130979_A_2" href="b9783503130979_A_2.xml"/>
                <dokument id="b9783503130979_A_3" href="b9783503130979_A_3.xml"/>
                </abschnitt>
                …

Wobei b9783503130979_A.xml eine Instanz ohne Titel darstellt:


                <esv.instanz xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 
                xsi:noNamespaceSchemaLocation="http://documents.esv.info/schema/esv/1.0/ESV.xsd" typ="kapitel" id="b9783503130979_A">
                <meta>
                <titel.kol typ="recto">Berechnungsstufen</titel.kol>
                </meta>
                <kapitel>
                <rn.block id="b9783503130979_A_rn0001">
                <kennung>
                <kursiv>1</kursiv>
                </kennung>
                <absatz id="b9783503130979_A_rn0001_a0001">Die Berechnung des Unterhaltsanspruchs 
                eines unterhaltsberechtigten Ehegatten vollzieht sich über mehrere Berechnungsstufen bzw. Berechnungsebenen...</absatz>...	
                </rn.block>
                </kapitel>
                </esv.instanz>