MegaZine3 Video Tutorial 2-2-0-11

Video Tutorial 2-2-0-11
mz3Tool3
MegaZine3
Bookmarks
mz3Viewer
Bookmarks: Introduction
In diesem Tutorial werden Bookmarks, das sind die Reiter an den
Buchrändern, beschrieben. In der WIKI findet man ebenfalls einige
Informationen zu Bookmarks.
Bookmarks können vorab, wie im Beispiel rechts, in der megazine.mz3
definiert, aber auch vom Betrachter interaktiv zur Laufzeit gesetzt werden.
Vordefinierte Bookmarks
In der megazine.mz3 fügt man Bookmarks über das <bookmarks> tag ein.
Die <bookmark> Elemente definieren dann die einzelnen Reiter, welche in
der Reihenfolge der Definition am Buchrand angeordnet werden.
Jedes Element definiert jeweils Titel, Seite, Farbe und Beschreibung.
Bookmarks können mehrsprachig sein, d.h. mehrere Sprachen unterstützen.
Individuelle Bookmarks
Diese Bookmarks werden entsprechend dem MZ3 Titel und verwendeten
Browser im Flash-Speicher abgelegt und beim nächsten Start wieder
geladen. Interaktive Bookmarks werden automatisch gefärbt.
Bookmarks (2-2-0-11 DE)
2
7/8/2014
Predefined Bookmarks
Hintergrundinformation
Die folgenden Details sind vor allem für jene gedacht, die aus Neugier oder weil sie manuell Änderungen
vornehmen wollen, eine megazine.mz3 Datei im Editor aufrufen. Aber obwohl mz3Tool3 die Bookmark
tags an der richtigen Stele einfügt, sind einige Details nützlich, da die eigentlichen Daten vom Anwender in
eine XML Datei eingegeben werden müssen.
Das Bookmark Element muss wie die anderen Kind-Knoten (child nodes) dem <book> Start-Tag folgen.
Buch-Elemente: chapter, foreground, background, pagebackground, bookmarks und sidebar
Die generelle Struktur eines Bookmark Tags sieht folgendermaßen aus:
<bookmarks>
<bookmark title=“text1” page=“10” color=“0xeeeeee” description=“this explains the details” />
<bookmark title=“Inhalt” page=“anchor:toc” color=“0xeeeeee” description=“goto TOC” />
</bookmarks>
Bookmarks (2-2-0-11 DE)
3
7/8/2014
Bookmarks-Unterstützung durch mz3Tool3
mz3Tool3 fügt die Inhalte für das Bookmark-Tag in der megazine.mz3 Datei ein.
Es wird nur ein Ordner “add2book”, der sich entsprechend dem gewünschten “Wirkungskreis” in einem
Unterordner des _myConfigs-Ordners befindet, benötigt. In einem solchen Ordner muss die XML Datei
abgelegt werden.
Liegt der add2book Ordner im Ordner _myConfigs, werden dieselben Bookmarks in allen MZ3 Titeln
genutzt; es sei denn ein add2book Ordner befindet sich auch noch in einem Unterordner im Pfad des MZ3
Titels. Die Datei muss bookmarks.xml heißen, und sich in einem add2book Ordner befinden .
Der Inhalt muss entsprechend der Vorgaben in der Wiki aufgebaut sein, also:
In der ersten Zeile muss der Tagname stehen: <bookmarks>
In den folgenden Zeilen werden alle Bookmarks als Attribute des Elements <bookmark> definiert.
Die Attribute title und page (Zielseite) sind notwendig, color und description (Tooltipp) sind optional.
Eine Beispieldatei bookmarks.xml befindet sich im Ordner Examples\add2book
Bookmarks (2-2-0-11 DE)
4
7/8/2014
Bookmarks: Mehrsprachigkeit
Bookmarks können “lokalisiert”, also mehrsprachig definiert werden. Die Variable “$1” im Namen der
Sprachdateien wird auf die Sprache des jeweils aktuell angezeigten MZ3 Titels gesetzt.
Die Texte der Reiter (Inhalte der Bookmarks) und deren Beschreibung (die Tooltipps) werden je Sprache in
XML Dateien mit dem jeweiligen Sprachcode im Dateinamen und als „ID“ innerhalb der Datei definiert.
Es wird empfohlen, im Dateinamen auch den Buch- und Versionsnamen anzugeben, um die Datei eindeutig
zu benennen:
bm_(bookname)_(versionname)_lc.xml
mit lc als Sprachcode; z.B.“en”, “de”, “fr”
Beispiel: Dateinamen für den sprachspezifischen Inhalt in Deutsch und Englisch für den MZ3 Titel
getting_started:
bm_getting_started_de.xml und bm_getting_started_en.xml
Dabei ist “getting” der Buchname, “started” der Versionsname, und “en” und “de” sind Sprachcodes.
Die bookmarks.xml Datei einer mehrsprachigen Version verknüpft die Sprachdateien über das Attribut
langfiles im <bookmarks> Tag. Die Texte im Reiter und Tooltipp werden über Bezeichner (identifiers, “IDs”)
referenziert. Das Beispiel auf der nächsten Seite zeigt die generelle Logik und die Beziehungen.
Bookmarks (2-2-0-11 DE)
5
7/8/2014
Bookmarks: Beziehungen
Bookmarks (2-2-0-11 DE)
7
7/8/2014