ePaper Import/Export XML (Version 1)

Einleitung

Bei der Nutzung der Import/Exportfunktion im ePaper CMS wird eine .mepa Datei generiert, die Sie sich auf Ihren PC herunterladen. Bei dieser Datei, z.B. mit dem Namen in der Form „export-Mein_erstes_ePaper-20120502_120806.mepa“, handelt es sich um ein Zip – Archiv. Um dieses Archiv zu entpacken, ersetzen Sie die Dateiendung .mepa einfach durch .zip. Manche Software ermöglicht aber auch das direkte Entpacken ohne Umbenennung.

 

Nach dem Entpacken sehen Sie im Rootordner die in der Abbildung dargestellte Struktur. Der Ordner media enthält dabei die Dateien für die für die ePaper Media Items verwendet werden, z.B. wenn eigene Bilder für Links verwendet werden, oder die Bilder einer Bildergalerie. Im Ordner source befinden sich Dateien die dem Player in den ePaper Einstellungen übergeben werden, also z.B. das Logo oder verwendete Hintergrundgrafiken im ePaper.

Alle Einstellungen werden in der epaper.xml festgehalten und konfiguriert. Die Rootebene wird durch das Tag <epaper version=„1“> gekennzeichnet. Das Attribut version gibt die Version an, welche für den Import später mögliche Abwärtskompatibiläten Die XML ist in drei logische Bereiche gegliedert:

  • <settings> innerhalb dieses Tags, werden die ePaper Einstellungen ausgezeichnet,
  • <pages> innerhalb dieses Tags, werden die einzelnen Seiten des ePaper und deren Elemete beschrieben,
  • <galleries> innerhalb dieses Tags, werden die Daten zu Bildergalerien festgehalten

Die Daten die Sie in dieser XML übermitteln überschreiben die im ePaper hinterlegten Daten. Nicht angegebene Elemente werden beim Import ausgelassen und die bereits vorhandenen Daten im System bleiben bestehen. Ungültige Werte werden im allgemeinen ignoriert, in Einzelfällen kann es jedoch zu ungewünschten Anzeigefehlern im ePaper führen, deshalb sollten Änderungen an der XML nur mit Bedacht ausgeführt werden.

ID-Attribute werden für Verweise von z.B. Media Items zu Gallerien, sowie für die Zuordnung zu Bild-Dateien verwendet. Diese müssen innerhalb der XML und der gleichen Tags eindeutig sein.

Settings

Alle Tags wurden, so gut wie möglich, selbsterklärend benannt. User, die mit den Funktionen im CMS vertraut sind, können somit am Namen herleiten, welche Daten im entsprechenden Tag hinterlegt werden. Die Attribute type und default dienen lediglich zur besseren Lesebarkeit und haben auf den Import keine Auswirkungen. Der Einstellungswert wird als <![CDATA[]]> Feld angegeben. Wichtig: Der Type boolean zeigt an, dass im CDATA 0 für false oder 1 für true verwendet werden muss.

Weitere Informationen zu den Parametern und Werten sind im Kapitel ePaper Settings zu finden.

Pages

Innerhalb des <pages> Tags werden die einzelnen Seiten eines ePaper gekapselt. Dabei erhält jede Seite ein eigenes Tag in der Form <page page=„1“ id=„1“ is_index=„1“ index_indent=„0“ is_hidden=„0“ download_pdf=„1“>. Die Attribute die dem Tag dabei übergeben werden haben dabei die folgende Bedeutung:

Attribut Typ Bedeutung
page Integer Seitennummer im ePaper
id Integer Interne Seiten ID für die Zuordnung z.B. von Bildergalerien
is_index Boolean legt fest, ob die Seite im Inhaltsverzeichnis angezeigt wird
index_indent Enum bestimmt das Level der Einrückung im Inhaltsverzeichnis (min=“0“: Level 1, max=“3“: Level 4)
is_hidden Boolean legt fest ob die Seite im ePaper ausgeblendet wird
download_pdf Boolean bestimmt ob der Einzelseitendownload für die entsprechende Seite aktiviert ist

Innerhalb eines <page> Tags werden die einzelnen Elemente, die zu der entsprechenden Seite gehören, ausgezeichnet.

<title>

legt den Seitentitel einer Seite für das Inhaltsverzeichnis fest

<author>

übergibt den Namen des Autors einer entsprechenden Seite

<description>

übergibt die Beschreibung der Seite die beim Mouse Over in der ePaper in der Übersicht angezeigt wird

<annotation>

übergibt den Vermerk/Kommentar zu einer entsprechenden Seite

Die einer Seite zugehörigen Media Items werden innerhalb des Tags <linked_media> deklariert. Dabei erhält jedes Item einen eigenen Tag in der Form <media id=„1“ media_type=„linkintern“ icon=„linkintern.png“ width=““ height=““ preview_image=„0“ frame_only=„0“ geo_rel=“-0.0043,0.1639,0.9964,0.2432“ geo_x1=“-3.11“ geo_x2=„721.39“ geo_y1=„167.83“ geo_y2=„249.04“>. Die einzelnen Attribute haben dabei die folgende Relevanz:

Attribut Typ Bedeutung
id Integer ID des Media Items innerhalb der entsprechenden Seite
media_type Enum Legt den Typ eines Elementes fest. Gültige Werte siehe Wertetabelle
icon Enum legt fest, welches ePaper interne Icon verwendet werden soll. Gültige Werte siehe Wertetabelle
width Integer bestimmt die Breite eines Videos
height Integer bestimmt die Höhe eines Videos
preview_image Boolean legt fest, ob ein eigenes Bild für das Media Item verwendet werden soll. Die Bilder liegen dabei im Ordner media im png Format (andere Formate werden nicht unterstützt). Die Erkennung der Bilder erfolgt anhand des Namens in der Form preview_PAGEID_MEDIAID.png. Wichtig: Kleinschreibung im Dateinamen verwenden
frame_only Boolean legt fest, ob nur Rahmen im ePaper verwendet werden sollen
geo_rel String relative Koordinaten eines Rahmens mit den Punkten oben links und unten rechts zur Seite in der Form x1,y1,x2,y2. Die Werte werden als Float-Wert angegeben, welche zwischen 0 und 1 liegen sollten und Pzentwerten entsprechen. Beispiel: 0.2,0.2,0.666,0.666

Wertetabelle:

media_type Element
'link' externer Link
'linkintern' Link zu einer Seite im ePaper
'video' Video Link
'galery' Galerie
icon Element
'none' kein Icon
'blank.png' transparentes Icon (dient als Platzhalter zur Einrückung der Schrift)
'email.png' E-Mail Icon
'galery.png' Galerie Icon
'image.png' Bild Icon
'link.png' Link Icon
'linkintern.png' Icon für internen Link
'pdf.png' PDF Icon
'readme.png' Readme Icon
'video.png' Video Icon
'zip.png' Zip Icon

Zusätzlich können innerhalb der einzelnen Media Item Elemente die folgenden Angaben festgelegt werden:

<title_short>

übergibt die Kurzbezeichnung (Titel),

<title_long>

übergibt den Beschreibungstext der beim Mouse Over angezeigt wird

<url>

übergibt die Aktion des Elementes. Für externe Links und Videos ist die vollständige URL, für interne Links die entsprechende ID der Seite, für Bildergalerien ist die ID der entsprechenden Galerie anzugeben.

<target>

legt für Externe- und Video Links fest, wie ein Element im Browser angezeigt werden soll. Gültige Angaben sind:

Wert Anzeige
'_blank' neuer Tab / neues Fenster
'_self' selber Tab / selbes Fenster
'_top' übergeordneter Frame
<page_setup>

übergibt die erweiterten Seiteneinstellungen in Form eines Strings (siehe Handbuch)

Für Media Items media_type=„link“ können innerhalb eines weiteren Elements <settings> die Angaben zur Shaddowbox festgelegt werden.

<shadowbox_use>

bestimmt ob die Shaddowbox verwendet werden soll (Boolean)

<shadowbox_width>

bestimmt die Breite der Shaddowbox in Pixel (Integer)

<shadowbox_height>

bestimmt die Höhe der Shaddowbox in Pixel (Integer)

galleries

Innerhalb dieser Auszeichnung werden die Angaben zu den Bildergalerien festgehalten. Die Bilder liegen im Ordner media. Die Erkennung der Bilder erfolgt anhand des Namens in der Form gallery_GALLERYID_IMAGEID.EXTENSION. Erlaubte Bild-Typen sind jpg, png und gif Dateien.

<gallery id="1649">

öffnendes Tag für eine Galerie innerhalb von <galleries>.

<name>

legt den Namen der Galerie fest

<images>

innerhalb dieses Tags werden die einer Galerie zugehörigen Bilder ausgewiesen

<image id="1" extension="jpg">

kennzeichnet ein einzelnes Bild der Galerie. Dem Attribut id ist die ID des Bildes, dem Attribut extension die Dateiendung zu übergeben

<titel>

für jedes Bild kann ein Name als String angegeben werden

War dieser Beitrag hilfreich?
0 von 0 fanden dies hilfreich
Haben Sie Fragen? Anfrage einreichen

Kommentare