Schema documentation for component ausgabe

<ausgabe_inhaltsverzeichnis/> gibt an, wo ein generiertes <inhaltsverzeichnis> stehen soll.

Das Element kann als Block-Element zwischen anderen stehen, bei der Produktion wird dann <ausgabe_inhaltsverzeichnis/> durch das generierte <inhaltsverzeichnis> ersetzt.

In das Verzeichnis aufgenommen werden Deckblatt- und Kapitelüberschriften <u> und <u1> bis <u7>, keine <zwischentitel> oder <titel> von Inhaltselementen.

Berücksichtigt werden i.d.R. unabhängig von der Position des Ausgabe-Elements die Überschriften des gesamten Werks (Default: kontext="werk").

Das kontext-Attribut kann abweichend gesetzt werden:

Mit teil-Attributwert: es werden die Überschriften des Werkteils (<vorspann>, <hauptteil> oder <nachspann>) berücksichtigt, in welchem das Ausgabeelement steht.
Mit kapitel-Attributwert: es werden die Überschriften des Kapitels berücksichtigt, das dem, in welchem das Ausgabeelement steht, übergeordnet ist.

Die Auswahl der Überschriften kann weiter eingeschränkt werden:

Wenn ein ebene-Attribut gesetzt wurde, dann werden Überschriften in Hierarchiestufen, die größer als der Attributwert sind, ignoriert.
Überschriften in Kapiteln mit dem @toc-Attributwert nein werden ignoriert.
Zähler und Text aus einem <toctitel> werden bevorzugt verwendet.

Das generierte Verzeichnis entspricht dem Inhaltsmodell von <inhaltsverzeichnis>, für jedes Element wird ein <eintrag> erstellt.

Mit den optionalen ausgabe-zaehler-, ausgabe-text-, ausgabe-nachweis- und ausgabe-referenz-Attributen lässt sich die Übernahme der jeweiligen Strukturen in das generierten Verzeichnis unterdrücken. (Default: "ja")

Mit den optionalen ausgabe-vortitel-, ausgabe-urheber- und ausgabe-untertitel-Attributen lässt sich steuern, ob die jeweiligen Strukturen in das generierte Verzeichnis übernommen werden sollen werden sollen. (Default: "nein")

Die Gestaltung des Verzeichnisses kann über ein typ-Attribut gesteuert werden (@typ mit numerischem Wert). Die vergebenen Typnummern werden in <typisierung> mit Elementname und -typ dokumentiert.

Das Element kann mit einem <nachweis> in einem <meta>-Container, einem <titel> und einer <legende> versehen werden. Diese Elemente werden in das generierte <inhaltsverzeichnis> übernommen.

Die Ausgabe eines Inhaltsverzeichnisses kann mit den Attributen zur Ausgabesteuerung für die Produktion unterdrückt werden.

QName	Type	Default	Use	Annotation
aria-role	restriction of xs:token		optional	Mit dem `role`-Attribut des ARIA-Standards können zur Verbesserung der Barrierefreiheit Auszeichnungen in die Daten eingebracht werden, die von Screenreadern ausgewertet werden. Zur Anwendung des Attributs s. https://www.w3.org/WAI/PF/aria/roles. Aufgenommen wurden auch weitere `role`-Attributwerte aus dem Digital Publishing WAI-ARIA Module 1.0 (W3C Recommendation 14 December 2017, https://www.w3.org/TR/dpub-aria-1.0/#role_definitions)
ausgabe-nachweis	ja-nein	ja	optional	mit `nein` werden Verzeichniseinträge ohne `<nachweis>` erzeugt.
ausgabe-referenz	ja-nein	ja	optional	mit `nein` werden Verzeichniseinträge ohne `<referenz>` (Seitenzahl) erzeugt.
ausgabe-text	ja-nein	ja	optional	mit `nein` werden Verzeichniseinträge ohne `<text>` erzeugt.
ausgabe-untertitel	ja-nein	ja	optional	mit `ja` werden Verzeichniseinträge mit `<untertitel>` ausgegeben.
ausgabe-urheber	ja-nein	nein	optional	mit `ja` werden Verzeichniseinträge mit `<urheber>` ausgegeben.
ausgabe-vortitel	ja-nein	nein	optional	mit `ja` werden Verzeichniseinträge mit `<vortitel>` ausgegeben.
ausgabe-zaehler	ja-nein	ja	optional	mit `nein` werden Verzeichniseinträge ohne `<zaehler>` erzeugt.
auspraegung	xs:IDREFS		optional	Liste mit ID-Referenzen zur Zuordnung von Ausprägungen Die Struktur kann einer oder mehreren Ausprägungen zugeordnet werden. Dazu werden die IDs der jeweiligen Ausprägungen durch Leerzeichen getrennt notiert. Es lassen sich auch die IDs von Ausgaben notieren. In diesem Fall werden der Struktur alle Ausprägungen dieser Ausgabe zugeordnet.
auspraegung-ausschluss	xs:IDREFS		optional	Liste mit ID-Referenzen zum Ausschließen von Ausprägungen Einer oder mehrere Ausprägungen können von der Zuordnung zu der Struktur ausgenommen werden. Dazu werden die IDs der jeweiligen Ausprägungen durch Leerzeichen getrennt notiert. Es lassen sich auch die IDs von Ausgaben notieren. In diesem Fall werden alle Ausprägungen dieser Ausgabe von der Zuordnung zu der Struktur ausgenommen.
ebenen	restriction of xs:integer		optional	gibt an, bis zu welcher Hierarchiestufe Überschriften aufgenommen werden sollen.
ebook	ja-nein	ja	optional	Zum Ausblenden bestimmter Elemente bei der Ausgabe als E-Book (Standardwert ist `ebook="ja"`).
id	xs:ID		optional	Analog zu `<a name="...">` bzw. zum `id`-Attribut innerhalb von HTML für die Angabe von benannten Sprungzielen. Alle Elemente können über das `id`-Attribut referenziert werden (globales Attribut). Die ID heißt bei allen Elementen einheitlich `id`, IDREF-Attribute (z.B. an `<verweis>`, `<abbildung>` etc.) heißen `verweis-intern`. An allen Elementen, an denen ein `id`-Attribut zulässig ist, sind das `sprache`- und `aria-role`-Attribut zulässig. Verlagsspezifisch können weitere globale Attribute definiert werden. Bereits vorgesehen sind als Beispielumsetzung ein `sytem-id`- und `system-referenz`-Attribut, weitere können ergänzt werden.
kontext	restriction of xs:token	werk	optional	gibt an, in welchem Bereich Überschriften berücksichtigt werden
print	ja-nein	ja	optional	Zum Ausblenden bestimmter Elemente im Print (Standardwert ist `print="ja"`)
sprache	xs:string		optional	Das Attribut enthält als Wert einen Sprachcode entsprechend BCP 47. Quelle für die Codes: www.iana.org und https://www.techonthenet.com/js/language_tags.php (Tool zum Auffinden von Sprachcodes) An allen Elementen an denen das `id`-Attribut zulässig ist, kann auch das `sprache`-Attribut angegeben werden und ganze Textbereiche einer Sprache zuweisen. Mit `<fremd>` ist dies auf Inline-Ebene möglich. Umsetzung im EPUB: für Screenreader, anderes Schriftsystem (z.B. Arabisch) für ganze Abschnitte eines Werks. Das `xml:lang`-Attribut - und für EPUB 3 auch das `lang`-Attribut - wird gesetzt. Dabei wirkt sich das `sprache`-Attribut an Hauptteil/Kapitel/etc. auf das `(xml:)lang`-Attribut am entsprechenden `<html>`-Root-Element aus. Umsetzung in InDesign: Ist technisch nicht automatisiert möglich (z.T. manuell möglich), eine automatische Anpassung z.B. der Silbentrennung kann nur dokumentweit oder über das aus dem `<fremd>`-Element generierte Zeichenformat erfolgen.
system-id			optional	Das `system-id`-Attribut kann beim Einsatz eines MAM oder CMS zur eindeutigen Identifikation von Datenbank-Objekten verwendet werden. Im Unterschied zu dem regulären `id`-Attribut müssen nicht die Konventionen des ID-Datentyps von XML eingehalten werden. So können beispielsweise führende Ziffern oder Sonderzeichen verwendet werden, ohne einen Wohlgeformtheits-Fehler zu verursachen.
system-referenz			optional	Das `system-referenz`-Attribut kann beim Einsatz eines MAM oder CMS verwendet werden, um den Bezug zu einem Datenbank-Objekt herzustellen. Dadurch lässt sich zum Beispiel eine Tabelle mit einer Excel-Datei verknüpfen, auf der diese Tabelle basiert. Im Unterschied zum `system-verweis`-Attribut wird durch den Einsatz des `system-referenz`-Attributes kein Link auf eine ID erstellt. Es wird nur eine Beziehung zwischen Inhalt und Datenbank-Objekt gekennzeichnet. Die Implementierung ist systemabhängig. Denkbar wäre zum Beispiel, dass ein System die Bearbeitung einer Tabelle in Excel erlaubt und diese dann beim Export des Assets automatisch wieder in parsX-XML überführt.
typ	typ.nummern		optional

Showing: