Um Fremdleseproben in ein Werk einbinden zu können, müssen die folgenden Konventionen für die Daten-Ablage eingehalten werden:
Auf gleicher Ebene wie die parsX-Datei des aktuellen Werkes befindet sich ein Verzeichnis fremdleseproben
.
Für jedes Werk dessen Leseprobe(n) importiert werden sollen, befindet sich in fremdleseproben
ein Unterverzeichnis mit frei wählbarem Namen.
Innerhalb jedes dieser Verzeichnisse befindet sich die parsX-Datei des jeweiligen Werkes sowie ggfs. ein Verzeichnis abbildungen
mit den Abbildungen des jeweiligen Werkes:
Der Import von Fremdleseproben erfolgt mit dem Element <import>
-Element innerhalb des <nachspann>
-Elementes. Im typ
-Attribut wird der Wert leseprobe
gesetzt. Im quelle
-Attribut wird, ausgehend vom Verzeichnis fremdleseproben
, der relative Pfad zu der parsX-Datei des Werkes notiert, dessen Leseproben importiert werden sollen. Im Nachspann können beliebig viele <import>
-Elemente auf Ebene von <kapitel>
stehen. Die Reihenfolge der <import>
- und <kapitel>
-Elemente kann frei gewählt werden. Für das abgebildete Beispiel:
<import typ="leseprobe" quelle="werk-ordner-1/werk-1.xml"/>
Bei der Produktion des EPUB's aus der XML-Datei {parsx-datei-aktuelles-werk}.xml
werden vor Beginn der EPUB-Transformation zuerst die <import>
-Elemente aufgelöst:
Aus jeder referenzierten und im Ordner fremdleseproben/
gefundenen XML-Datei wird die Leseprobe extrahiert und im parsX-XML-Format temporär zwischengespeichert.
Während der weiteren EPUB-Konvertierung werden die vorprozessierten Leseproben-XML-Daten weiterverarbeitet und dem Konvertierungsworkflow zugespielt.
Das fertige EPUB enthält vor jeder Fremdleseprobe eine generische Titelseite die automatisch aus den Metadaten der Fremdleseprobe erstellt wird.
Für die Leseprobe kann mit dem Attribut @toctitel
ein Eintragstext im TOC eines E-Books angegeben werden. Mit dem Attribut toc="nein"
kann die Aufnahme ins TOC unterdrückt werden.