Wir freuen uns über das bevorstehende Release der IDMLlib® 1.1

Die IDMLlib® ist eine Java Library, mit der das Verarbeiten von InDesign® IDML Dokumenten einfacher ist als jemals zuvor.

Mit einer einfachen aber leistungsstarken Schnittstelle zu allen Informationen innerhalb eines IDML Dokuments ist es Softwareentwicklern möglich, Inhalte zu extrahieren, zu modifizieren und neue Inhalte zu erstellen, ohne die komplette IDML Spezifikation zu lesen. Dabei bleibt die Kompatibilität zu InDesign vollständig erhalten.

Entwickler sind mit der IDMLlib in der Lage, aus vorhandenen Inhalten neue IDML Dokumente zu erstellen oder zu entwerfen – und das nur mit Hilfe von Java Befehlen und ohne direkt in die XML Dateien eingreifen zu müssen.

Egal, ob Sie InDesign kompatible Snippets aus Ihrem Content Management System exportieren, ein auf IDML basierendes Marketing Portal erstellen oder einen webbasierten Übersetzungsworkflow entwickeln möchten – mit der IDML Technologie reduzieren Sie Ihre Ausgaben und verkürzen die Zeit bis zur Markteinführung Ihrer Lösung.

Weitere Informationen über die IDMLlib erhalten Sie unter den folgenden Links:

• IDMLlib Webseite (englisch) : http://idmllib.com
• IDMLlib Blog (englisch): http://blog.idmllib.com
• FHCon Webseite: http://www.fhcon.de
• FHCon Blog: http://www.fhcon.de/blog/

Die IDMLlib 1.1 ist ab dem 25. Juni 2010 verfügbar.

Wenn Sie bereits Kunde der IDMLlib 1.0 sind, werden wir Sie rechtzeitig darüber informieren, wo Sie das neue Release herunterladen können. Weiterhin haben Sie als Interessent die Möglichkeit, die IDMLlib 30 Tage lang kostenlos zu testen. Fordern Sie dazu einfach Ihre Testversion über unser Kontaktformular an.

Neue Funktionen der Version 1.1

Laden, Modifizieren und Speichern von IDML Dokumenten

Die IDMLlib 1.1 unterstützt das Modifizieren und Schreiben von IDML Dokumenten. Das folgende einfache Beispiel läd ein Dokument mit vier Seiten (1, 2/3, 4), erstellt zwei Kopien der Seiten 2/3, die nach der Seite 2/3 im Dokument angehangen werden, und sichert ein neues Dokument mit acht Seiten (1, 2/3, 4/5, 6/7, 8).

// Create an 8-pager from a 4-pager
Idml idml = new Idml("4pager.idml");
Spread spread = DocumentUtil.getSpread(idml.getAbstractDocument(), 1);
for(int i=0;i<2;i++) {
  DocumentUtil.addSpread(idml.getAbstractDocument().getAsDocument(),spread,2);
}
idml.saveAs("8pager.idml");

Unterstützung von IDML Snippets

Die IDMLlib 1.1 unterstützt die Verarbeitung von IDML Snippet Dateien. Snippets können auf dem gleichen Weg geladen werden wie ein IDML Container. Es ist möglich, Teile aus dem IDML Dokument oder den ganzen Spread mit allen PageItems von einem Snippet in ein Container Dokument zu kopieren:

Idml idml = new Idml("Catalog.idml");
Idml idms = new Idml("ProductSnippet.idms");
SpreadIterator spreadIterator = DocumentUtil.getSpreadIterator(idms);
Spread firstSpread = spreadIterator.next();
DocumentUtil.addSpread(idml.getAbstractDocument().getAsDocument(),firstSpread);
idml.saveAs("NewCatalog.idml");

Es ist sogar möglich, neue Snippets von Grund auf zu erzeugen:

Idml idml = new Idml("Catalog.idml");
Spread spread = DocumentUtil.getSpreadIterator(idml).next();
Idml snippet = Idml.createEmptySnippet("FirstPage.idms", DocumentPreset.CS4_605_PAGEITEM);
snippet.getAbstractDocument().getAsSnippetDocument().setSpreadList(ListUtil.getAsGenericList(spread));
snippet.save();

Der schnellste Weg, ein Snippet in den ersten Spread zu importieren (index 0):

Idml idml = new Idml("DemoDocuments/EmptyA4.idml");
Idml idms = new Idml("DemoDocuments/ProductSnippet.idms");
DocumentUtil.importSnippet(idml, idms, 0);

Erstellen von neuen IDML Objekten von Grund auf

Mit der IDMLlib 1.1 ist es möglich, alle IDML Objekte von Grund auf zu erzeugen, zum Beispiel eine Ebene (Layer):

Layer layer = new Layer();
layer.setSelf("ILJ11");
layer.setName("My new Layer");
layer.setLayerColor(new InDesignUIColorType(UIColors.Red));
layer.setExpendable(true);
layer.setIgnoreWrap(false);
layer.setLockGuides(false);
layer.setPrintable(true);
layer.setLocked(false);
layer.setShowGuides(true);
layer.setUI(true);

Oder vielleicht ein mehr alltäglicher Fall wie die Erstellung von PageItems, wie zum Beispiel ein Rechteck (Rectangle):

Rectangle rectangle = new Rectangle();
rectangle.setSelf("ILJ1");
rectangle.setFillColor("Color/Magenta");
rectangle.setStrokeWeight(0d);
rectangle.setItemTransform(TransformationMatrixType.getIdentityMatrix());
 
List geometryPathTypeList = PageItemUtil.createPathGeometryList(idml,
    new PathPointType(0, 0), //upperleft point
    new PathPointType(0, 40), //lowerleft point
    new PathPointType(40, 40), //lowerright point
    new PathPointType(40, 0) //upperright point
);
rectangle.setPathGeometryList(geometryPathTypeList);

Der Utility Framework

Der IDMLlib Utility Framework ist aus dem Wunsch unserer Kunden heraus entstanden, die Komplexität aus wiederkehrenden Tätigkeiten wie dem Hinzufügen, Anhängen und Bewegen von PageItems, dem Klonen von Spreads oder dem Importieren von Snippets in Dokumente herauszunehmen. Das Resultat dieses Ansatzes ist im de.fhcon.idmllib.api.util Paket zu finden, welches zur Zeit folgende Utility Klassen enthält:

• DocumentUtil
• GraphicUtil
• GroupUtil
• IdmlLibUtil
• LabelUtil
• ListUtil
• PageItemUtil
• SpreadUtil
• StoryUtil
• TransformationMatrixUtil
• UnitConverterUtil

Der IDMLlib Utility Framework ist ein “work in progress” und wird mit neuen Anforderungen weiter wachsen.

Hier ein paar kleine Beispiele dafür, wie diese Klassen dabei helfen können, den Javacode deutlich zu verkürzen:

Den ersten Spread aus einem Dokument holen

Idml idml = new Idml("DemoDocuments/RectanglesAndTextFrames.idml");
Spread spread = DocumentUtil.getSpreadIterator(idml).next();

Das erste PageItem holen

AbstractIdmlPageItem pageItem = SpreadUtil.getPageItemIterator(spread).next();

Ein Label überprüfen und setzen

if(PageItemUtil.hasLabel(pageItem, "Marked")){
   KeyValuePair label = PageItemUtil.getLabel(pageItem, "Marked");
}

Ein PageItem verschieben und das UnitConverterUtil nutzen, um Millimeter Werte in Points zu konvertieren

PageItemUtil.movePageItem(pageItem,100,100);
double pointValue = UnitConverterUtil.mmToPoint(100);
PageItemUtil.movePageItem(pageItem,pointValue,pointValue);

Alle PageItems einer Gruppe in einen Spread einfügen und alle eingefügten PageItems um 200 Points nach rechts unten verschieben.
Diese Methode erstellt automatisch neue Story Dateien, wenn ein Textrahmen eingefügt wird.

if(pageItem.isGroup()){
   PageItemIterator pageItemIterator = GroupUtil.getPageItemIterator(pageItem.getAsGroup());
   SpreadUtil.appendPageItems(spread,pageItemIterator,200,200);
}

Den kompletten Inhalt eines Dokumentes per Durchlauf über alle ParagraphStyleRanges/CharacterStyleRanges/Content in allen Stories extrahieren.

Idml idml = new Idml("DocWithContent.idml");
StoryIterator storyIterator = DocumentUtil.getStoryIterator(idml);
while (storyIterator.hasNext()) {
   String content = StoryUtil.getContent(storyIterator.next());
   System.out.println(content);
}

Durchlaufen und Filtern von PageItems

Einfaches Durchlaufen aller Top Level PageItems

Idml idml = new Idml("DocWithPageItems.idml");
Spread spread = DocumentUtil.getSpreadIterator(idml).next();
PageItemIterator pageItemIterator = SpreadUtil.getPageItemIterator(spread);
while(pageItemIterator.hasNext()){
  AbstractIdmlPageItem pageItem = pageItemIterator.next();
  //do something with the pageitem
}

Durchlaufen mit einem LabelFilter

Idml idml = new Idml("DocWithPageItems.idml");
Spread spread = DocumentUtil.getSpreadIterator(idml).next();
 
LabelFilter labelFilter = new LabelFilter("Marked","true");
 
PageItemIterator pageItemIterator = SpreadUtil.getPageItemIterator(spread,labelFilter);
//the iterator only contains PageItems with a Label of: Key "Marked" with value "true"
while(pageItemIterator.hasNext()){
  AbstractIdmlPageItem pageItem = pageItemIterator.next();
  //do something with the pageitem
}

Durchlaufen mit Hilfe eines eigenen Filters, der als innere Klasse implemetiert wurde und nur Textrahmen zulässt

Idml idml = new Idml("DocWithPageItems.idml");
Spread spread = DocumentUtil.getSpreadIterator(idml).next();    
 
PageItemIterator pageItemIterator = SpreadUtil.getPageItemIterator(spread,new IPageItemFilter(){
  public boolean accept(AbstractIdmlPageItem pageItem) {
    return pageItem.isTextFrame();
  }
});
 
//the iterator only contains TextFrames
while(pageItemIterator.hasNext()){
  AbstractIdmlPageItem pageItem = pageItemIterator.next();
  assert(pageItem.isTextFrame());
}

Arbeiten mit verschiedenen PageItem Typen

switch (pageItem.getPageItemType()) {
 
  case Button:
    Button button = pageItem.getAsButton();
  break;
 
  case EPSText:
    EPSText epsText = pageItem.getAsEPSText();
  break;
 
  case FormField:
    FormField formField = pageItem.getAsFormField();
  break;
 
  case GraphicLine:
    GraphicLine graphicLine = pageItem.getAsGraphicLine();
  break;
 
  case Group:
    Group group = pageItem.getAsGroup();
  break;
 
  case Oval:
    Oval oval = pageItem.getAsOval();
  break;
 
  case Polygon:
    Polygon polygon = pageItem.getAsPolygon();
  break;
 
  case Rectangle:
    Rectangle rectangle = pageItem.getAsRectangle();
  break;
 
  case TextFrame:
    TextFrame textFrame = pageItem.getAsTextFrame();
  break;
}

Ein austauschbarer IdGenerator zur Erstellung eigener Self ids

Es ist sehr wichtig zu wissen, dass die Self Attribute von IDML Objekten wie z.B. PageItems eindeutig bleiben müssen, damit sie identifiziert werden können. Weil ein großer Teil der Utility Klassen neue PageItems oder andere IDML Objekte mit Self Attributen erzeugt, müssen beim Hinzufügen zu einem Dokument eindeutige Self Zeichenketten erstellt werden.

Da wir wissen, dass unser Ansatz, diese Self ids zu erzeugen, von dem anderer Entwickler abweichen wird, haben wir den IdGenerator austauschbar gemacht.

Sie können also den DefaultIdGenerator nutzen, müssen es aber nicht. Dazu haben wir ein IdGenerator Interface definiert, welches Sie implementieren können, um einen eigenen ID Generator zu erstellen.

public class MyCustomIdGenerator implements IdGenerator {
  public String getSequence(String existingId) {
    //implement your code here
   }
}

Wie Sie sehen können, bekommt die IdGenerator#getSequence() Methode immer die Self reference des gerade verarbeiteten PageItems als Parameter zurück. Unsere Klassen geben immer die Self reference zurück, so lange sie existiert. So können die alten IDs in anderer Form genutzt werden.

Damit unsere Klassen Ihren eigenen IdGenerator nutzen, müssen Sie die Implementierung verfügbar machen:

Idml idml = new Idml("MyDoc.idml");
idml.setIdGenerator(new MyCustomIdGenerator());

Wenn Sie selber Self ids erstellen müssen, können Sie den gerade aktiven IdGenerator der Idml Instanz, mit der Sie gerade arbeiten, beziehen:

Idml idml = new Idml("MyDoc.idml");
IdGenerator generator = idml.getIdGenerator();

15 dokumentierte Beispiele

Wir haben 15 dokumentierte Beispiele erstellt die Ihnen zeigen, wie Sie die IDMLlib erfolgreich nutzen können. Fast alle Beispiele sind aus Kundenanfragen heraus entstanden oder zeigen alltägliche Fallbeispiele für die IDMLlib. Diese Beispiel-Bibliothek ist ein “work in progress” und wird mit neuen Anforderungen und Fragen weiter wachsen.

Liste von Beispielen, die Teil des 1.1 Releases sind:

• CopyTextFramesAndManipulatePSR
• CreateNewStory
• CreateRectangles
• CreateRectangleWithImage
• CreateSimpleTable
• CreateSpreadsFromScratch
• CreateTextFrameCopiesOnNewLayers
• GetStoryContent
• IdmlLoader
• ImportSnippet
• InsertSpread
• LoadModifySaveIdml
• PageItemExamples
• PutPageItemOnDifferentLayers
• SimpleDatabasePublishing

Alle Beispiele wurden getestet und werden mit vorbereiteten IDML Dokumenten geliefert, mit denen das Beispiel veranschaulicht wird.

Dieser Beitrag hat nicht viel zu tun mit der IDMLlib oder unserer sonstigen täglichen Arbeit, aber einige von Ihnen könnten irgendwann einmal vor dem gleichen Problem stehen: dem Wechsel der Sprache in einer lokalisierten Flash Builder 4 Installation. Wenn Sie eine lokalisierte Version der Creative Suite 5 besitzen ist es (meiner Meinung nach) unumgänglich, dass der Flash Builder 4 ebenfalls in einer lokalisierten Version auf Ihrem System vorliegt.

Da es – soweit ich weiss – keinen Weg gibt, die Sprache in irgendeiner Voreinstellung zu ändern, habe ich angefangen, mir die ini-Dateien genauer anzusehen. Zu meiner Entschuldigung muss ich gestehen, dass ich zu der Minderheit der Softwareentwickler gehöre, die nicht die Eclipse IDE für die Java-Entwicklung nutzen. Wenn dies also zur Allgemeinbildung gehört, ignorieren Sie diesen Blogartikel und gehen Sie über zum nächsten.

Wenn Sie also die Flash Builder 4 GUI auf eine andere Sprache umstellen möchten, navigieren Sie zum Flash Builder Programmpaket und wählen Sie im Kontext-Menü (rechte Maustaste bzw. CRTL-Klick) “Paketinhalt zeigen”, um das Programmverzeichnis zu öffnen.

Öffnen Sie im Programmverzeichnis die ini-Datei unter Contents/MacOS/Adobe Flash Builder 4.ini in einem Editor Ihrer Wahl, ich benutze dazu TextWrangler. Die Datei sollte so ähnlich aussehen wie meine:

-nl
de_DE
-startup
../../../plugins/org.eclipse.equinox.launcher_1.0.201.R35x_v20090715.jar
--launcher.library
../../../plugins/org.eclipse.equinox.launcher.carbon.macosx_1.0.200.v20090520-1835
-vmargs
-Xms256m
-Xmx512m
-XX:MaxPermSize=256m
-XX:PermSize=64m
-Xdock:name=Flash Builder
-Xdock:icon=../Resources/fb_app.icns
-XstartOnFirstThread
-Dorg.eclipse.swt.internal.carbon.noFocusRing
-Dorg.eclipse.swt.internal.carbon.smallFonts

In Zeile 2 können Sie sehen, dass die aktuelle Sprache auf “de_DE” gesetzt ist, was die Java locale für deutsch ist. Um die Sprache auf englisch umzustellen, ändern Sie diese Zeile in “en_US” um.

Die ini-Datei enthält ebenso Speichereinstellungen für Ihre Flash Builder Installation. Verändern Sie die Zeilen 8 bis 11 nach Ihren Belangen, um zusätzlichen Speicherplatz zuzuweisen. Als Beispiel sehen Sie hier meine komplette ini-Datei mit englisch als Sprachvorgabe und 1024mb zugewiesenem Speicher für die Eclipse Instanz – was ratsam ist, wenn Sie weitere Plugins wie beispielsweise den Extension Builder installiert haben:

-nl
en_US
-startup
../../../plugins/org.eclipse.equinox.launcher_1.0.201.R35x_v20090715.jar
--launcher.library
../../../plugins/org.eclipse.equinox.launcher.carbon.macosx_1.0.200.v20090520-1835
-vmargs
-Xms512m
-Xmx1024m
-XX:MaxPermSize=256m
-XX:PermSize=64m
-Xdock:name=Flash Builder
-Xdock:icon=../Resources/fb_app.icns
-XstartOnFirstThread
-Dorg.eclipse.swt.internal.carbon.noFocusRing
-Dorg.eclipse.swt.internal.carbon.smallFonts

Alle Dokumentationen bleiben so, wie sie installiert worden sind, und auch die Beispiele und Startbildschirme bleiben in der gleichen Sprache wie auch die Creative Suite Installation. Wenn es einen einfacheren Weg gibt, die UI-Sprache zu ändern, teilen Sie uns das bitte über die Kommentarfunktion mit.

Viele Benutzer scheinen sehr überrascht gewesen zu sein, dass Adobe die INX Unterstützung für InDesign 7.0 entfernt hat, was an folgenden oder ähnlich lautenden Twitter Mitteilungen zu erkennen war:

“Ich habe es endlich geschafft, ein CS5 InDesignDokument in CS4 zu öffnen!” oder
“Wie exportiere ich ohne INX Export Option ein CS5 Dokument zu CS3?”

Dieser Artikel ist für alle Benutzer, die sich die gleichen Fragen stellen, bisher aber noch keine Antwort darauf gefunden haben.

Der IDML Export wurde mit InDesign CS4 eingeführt, ist aber selten zum Dokumentenaustasch genutzt worden, weil CS4 die erste Version überhaupt war, die es unterstützt hat – und der INX Export war ja weiterhin verfügbar. Deshalb hat es bisher keinen Sinn gemacht, ein InDesign Dokument für den Datenaustausch als IDML zu exportieren.

Mit dem Erscheinen der CreativeSuite 5 und InDesign 7.0 hat sich das geändert. Der INX Export ist aus den Export Optionen verschwunden, und IDML wurde zum primären Austauschformat für InDesign. Für Anwender, die der Einführung von IDML (englisch) gefolgt sind, war dies keine große Überraschung.

Was hat sich jetzt also geändert? Grundsätzlich gibt es für den Anwender keine großen Umstellungen bei der Benutzung von IDML im Gegensatz zu INX – der Arbeitsablauf ist genau der gleiche, wie er es mit INX war:

* Exportiere ein IDML aus CS5 über Datei/Export
* Lade das IDML in CS4 über Datei/Öffnen (wie eine normale InDesign .indd Datei)

Es gelten die gleichen Regeln wie auch für den INX Austausch in früheren Versionen: Solange keine neuen Funktionalitäten verwendet werden, ist alles in Ordnung. Aber wir raten trotzdem zu einer Überprüfung der Dokumente, um auf der sicheren Seite zu stehen.

Wenn das Dokument für CS3 exportiert werden soll, wird einfach das in CS4 geladene IDML als INX exportiert und dann in CS3 geöffnet. Das wird für einfach aufgebaute Dokumente  gut funktionieren, aber jedes Dokument, welches von CS5 nach CS3 runterkonvertiert wurde, sollte sehr genau auf Konvertierungsfehler hin überprüft werden.

IDML ist viel mehr, als INX jemals war – wenn wir Sie also neugierig auf IDML gemacht haben, schauen Sie sich in diesem Blog nach anderen IDML Fallbeispielen um.

Eine der am häufigsten gestellten Fragen unserer Kunden ist diese: “Ist die IDMLlib in der Lage, Snippets (.idms) in ein IDML Dokument zu importieren?”. Glücklicherweise können darauf wir seit dem ersten Milestone der IDMLlib 1.1 mit ja antworten, allerdings war dies bis jetzt eine sehr Sourcecode intensive Aufgabe. Wir werden Ihnen später zeigen, wie einfach die Lösung mit unserem neuen IDMLlib Utility Framework ist. Aber zuerst ein paar Erklärungen, was die Idee hinter Snippets ist und was Sie brauchen, um ein Snippet zu importieren.

Das Arbeiten mit Snippets ist ein geeigneter Weg, InDesign Seiten zu modularisieren. Die Idee dahinter ist, ein oder mehrere PageItems in eine externe Datenstruktur zu exportieren, um sie auf verschiedenen Seiten und Dokumenten wiederzuverwenden. PageItems können exportiert werden, indem im InDesign Dokument ein oder mehrere Elemente mit dem Auswahlwerkzeug angewählt und über Datei/Exportieren exportiert werden. Wählen Sie das Format InDesign-Snippet (nur möglich, wenn das Auswahlwerkzeug benutzt wurde) und exportieren Sie die PageItems als .idml Datei.

Das exportierte Snippet ist nichts anderes als eine XML-Datei, die auf dem Schema der InDesignMarkupLanguage beruht, und alle Informationen über die exportierten PageItems enthält. Im Grunde genommen ist ein IDML-Snippet eine XML Datei, die das ganze IDML Schema abbilden kann. Das Snippet kann über den Menübefehl Datei/Platzieren in das gleiche oder in ein anderes Dokument importiert werden.

Was hat das Arbeiten mit Snippets also für Vorteile? So wie ein IDML Dokument enthält das Snippet nur Referenzen zu allen enthaltenen Werten wie Schriften oder Bilder, und ist dadurch sehr klein (Dateigröße) und einfach weiterzuverwenden. Es ist ein mächtiges Konzept in InDesign, aber es wird noch leistungsfähiger in einem IDML Workflow. Stellen Sie sich zum Beispiel eine Anzeigenkampagne mit verschiedenen Werbeaussagen und/oder Bildern vor, die außerhalb von InDesign zusammengestellt und später in einem InDesign Server verarbeitet und fertiggestellt wird. Eine mögliche Realisierung wäre über einen Anzeigen-Baukasten, der über eine Webapplikation zur Verfügung gestellt wird und so keiner Standortbeschränkung unterliegt.

Einen weiteren Vorteil, den Sie durch die Verwendung von IDML und Snippets außerhalb von InDesign haben, ist die Möglichkeit, Snippets nach Ihren Wünschen zu modifizieren: ändern Sie im Snippet verwendete Bilder oder Texte oder fügen Sie weitere PageItems hinzu.

Was müssen wir also tun, um ein Snippet außerhalb von InDesign in ein IDML Dokument einzufügen und so den Datei/Platzieren Befehl zu simulieren?

Die folgenden Schritte sind nötig, um das Snippet zu importieren. Dies kann entweder programmatisch geschehen oder mit einem Werkzeug wie Oxygen XML, welches die Verarbeitung von IDML Dokumenten vereinfacht, indem es IDML Container Dateien unterstützt:

• Das IDML Dokument entpacken
• Den Spread lokalisieren, an den die Snippet-PageItems angehangen werden sollen
• Das IDMS Snippet laden und die zu importierenden PageItems lokalisieren
• Die PageItems an de gewählten Spread anfügen
• Neue Stories/Story_xxx.xml Dateien für jedes importierte TextFrame PageItem erstellen
• Jede Story vom Snippet zum korrespondierenden Stories/Story_xxx.xml kopieren
• Self-ID Kollisionen für jedes importierte Objekt überprüfen, neue IDs für kollidierte PageItems erstellen und Self-IDs der PageItems aktualisieren
• Einen neuen IDML Container (.idml) erstellen

Wir haben dies hier vereinfacht dargestellt, indem das Snippet in das Dokument importiert wird, aus dem es exportiert worden ist. Daher brauchen keine Stile, Farben und Ähnliches importiert werden.

Sogar mit Hilfe der IDMLlib wären es 20-30 Zeilen Code gewesen. Aber mit der aktuellen Version der IDMLlib sind wir in der Lage, die Länge des Codes enorm zu verkürzen, ohne dabei die Flexibilität zu verlieren.

Idml idml = new Idml("docs/4pager.idml");
Idml idms = new Idml("docs/product.idms");
DocumentUtil.importSnippet(idml,idms,1);
idml.saveAs("processes/merged.idml");
idml.close();
idms.close();

Der eigentliche Import ist nur eine einzige Zeile Code, welcher alle oben gelisteten Schritte beinhaltet – der Rest ist das Laden, Speichern und Schließen des IDML Dokuments:

DocumentUtil.importSnippet(idml,idms,1);

Die importSnippet() Methode nimmt 3 oder 5 Parameter an:

• targetIdml
• sourceIdms
• targetSpreadIndex
• xOffset (optional)
• yOffset (optional)

Mit dem x- und y-Offset sind Sie in der Lage, importierte PageItems von ihrer ursprünglichen Position an eine andere Position auf dem Spread zu verschieben.

Aber was ist, wenn man importierte PageItems vorab bearbeiten muss, z.B. Text- und Bildänderungen oder zusätzliche Ebenen? Und woher weiss man, welche PageItems importiert worden sind? Nichts einfacher als das: die DocumentUtil.importSnippet() Methode gibt einen PageItemIterator zurück, mit welchem es ganz einfach möglich ist, über alle importierten PageItems zu iterieren und alle PageItems so zu modifizieren, wie es gewünscht ist.

Ein Beispiel, wie man alle PageItems auf die Ebene u3b stellt:

PageItemIterator pageItemIterator = DocumentUtil.importSnippet(idml, idms, 1);
while(pageItemIterator.hasNext()) {
  AbstractIdmlPageItem pageItem = pageItemIterator.next();
  pageItem.setItemLayer("u3b");
}

Dies war der erste Blogbeitrag über unseren neuen IDMLlib-Utility-Framework innerhalb der IDMLlib, welcher das Arbeiten mit IDML einfacher macht als jemals zuvor. In den nächsten Tagen und Wochen werden wir an dieser Stelle weitere Teile dieses Frameworks vostellen.

Wir hoffen, dass Ihnen dieser Beitrag über IDML Snippets gefallen hat und Sie bemerkt haben, wir einfach es ist, mit Hilfe der IDMLlib mit Snippets zu arbeiten. Ihr Feedback nehmen wir gerne an, und auch die Kommentarfunktion steht zur Verfügung.

Da wir zur Zeit einige Anfragen von PHP-Entwicklern bezüglich der Arbeit mit IDML, der IDMLib und PHP bekommen, haben wir einen Blick auf das PHP/Java Bridge Projekt bei Sourceforge geworfen, und es scheint zu funktionieren. Wir werden mit ein paar komplexeren Beispielen testen, wie stabil alles läuft.

Hier ist mein Vorschlag, die IDMLlib für Java mit Apache 2, Tomcat 6, Java 6 und PHP 5 zum Laufen zu bringen.

Um die IDMLlib für Java mit PHP nutzen zu können, benötigen Sie folgende Komponenten:

• Die IDMLlib für Java, die Sie über http://idmllib.com beziehen können
• Ein laufendes Apache 2 und PHP 5 Setup mit einer Tomcat 6 Installation
• Und natürlich die PHP/Java Bridge

Für diese Anleitung werde ich ein Debian 5 Lenny Setup nutzen. Aber Sie können ebenso die Konfigurationshinweise für beispielsweise Windows, Mac OS X, Redhat Linux, Suse Linux oder wo auch immer Java, Apache 2, Tomcat 6 und PHP laufen, nutzen.

1 Installation Debian Linux

Installieren Sie eine einfache debian Lenny Distribution.

Stellen Sie sicher, dass Sie ‘non-free‘ in Ihren apt.sources Liste stehen haben.

deb http://debian.uni-essen.de/debian/ lenny main non-free
deb-src http://debian.uni-essen.de/debian/ lenny main non-free

deb http://security.debian.org/ lenny/updates main contrib non-free
deb-src http://security.debian.org/ lenny/updates main contrib non-free

2 Installation Apache 2 and PHP 5

3 Installation Tomcat 6

Da es kein Tomcat 6 debian Packet gibt, installieren wir Tomcat 6 von Hand.

Nach ‘wget’ die URL zur letzten Tomcat Version einfügen!

Jakarta Commons Daemon installieren.

Ein Initscript erstellen, um Tomcat 6 zu starten und zu stoppen.

/etc/init.d/tomcat6

#!/bin/sh
#
# /etc/init.d/tomcat6 -- startup script for the Tomcat 5 servlet engine
#
# Written by Miquel van Smoorenburg <miquels@cistron.nl>.
# Modified for Debian GNU/Linux by Ian Murdock <imurdock@gnu.ai.mit.edu>.
# Modified for Tomcat by Stefan Gybas <sgybas@debian.org>.
# Modified for Tomcat 6 by ohaeuser - 16.02.2009
### BEGIN INIT INFO
# Provides:          tomcat
# Required-Start:    $local_fs $remote_fs $network
# Required-Stop:     $local_fs $remote_fs $network
# Should-Start:      $named
# Should-Stop:       $named
# Default-Start:     2 3 4 5
# Default-Stop:      0 1 6
# Short-Description: Start Tomcat.
# Description:       Start the Tomcat servlet engine.
### END INIT INFO

set -e

PATH=/bin:/usr/bin:/sbin:/usr/sbin
NAME=tomcat6
DESC="Tomcat servlet engine"
DAEMON=/usr/bin/jsvc
CATALINA_HOME=/opt/$NAME
DEFAULT=/etc/default/$NAME

if [ `id -u` -ne 0 ]; then
        echo "You need root privileges to run this script"
        exit 1
fi

# Make sure tomcat is started with system locale
if [ -r /etc/default/locale ]; then
        . /etc/default/locale
        export LANG
fi

. /lib/lsb/init-functions
. /etc/default/rcS

# The following variables can be overwritten in $DEFAULT

# Run Tomcat 5 as this user ID
TOMCAT6_USER=tomcat6

# The first existing directory is used for JAVA_HOME (if JAVA_HOME is not
# defined in $DEFAULT)
JDK_DIRS="/usr/lib/jvm/java-6-sun /usr/lib/jvm/java-1.5.0-sun /usr/lib/j2sdk1.5-sun /usr/lib/j2sdk1.5-ibm /usr/lib/j2sdk1.4-sun /usr/lib/j2sdk1.4-blackdown
/usr/lib/j2se/1.4 /usr/lib/j2sdk1.4-ibm /usr/lib/j2sdk1.3-sun /usr/lib/j2sdk1.3-blackdown /usr/lib/jvm/java-gcj /usr/lib/kaffe"

# Look for the right JVM to use
for jdir in $JDK_DIRS; do
    if [ -r "$jdir/bin/java" -a -z "${JAVA_HOME}" ]; then
        JAVA_HOME_TMP="$jdir"
        # checks for a real JDK like environment, needed to check if
        # really the java-gcj-compat-dev package is installed
        if [ -r "$jdir/bin/jdb" ]; then
            JAVA_HOME="$JAVA_HOME_TMP"
        fi
    fi
done
export JAVA_HOME

# Directory for per-instance configuration files and webapps
CATALINA_BASE=/opt/$NAME

# Use the Java security manager? (yes/no)
TOMCAT6_SECURITY=yes

# Timeout in seconds for the shutdown of all webapps
TOMCAT6_SHUTDOWN=30

# End of variables that can be overwritten in $DEFAULT

# overwrite settings from default file
if [ -f "$DEFAULT" ]; then
        . "$DEFAULT"
fi

test -f $DAEMON || exit 0

[ -z "$TOMCAT6_USER" ] && TOMCAT6_USER=tomcat6

# Check if we use gij
gij=no
"$JAVA_HOME/bin/java" -version 2>&1 | grep -q "^gij (GNU libgcj)" && gij=yes

# gij doesn't support a security manager yet (see bug #399595)
if [ "$gij" = "yes" ]; then
    printf "The java-gcj-compat-dev environment currently doesn't\nsupport a security manager. See README.Debian." | logger -p daemon.warning -t $NAME
fi

# Set java.awt.headless=true if JAVA_OPTS is not set so the
# Xalan XSL transformer can work without X11 display on JDK 1.4+
# It also looks like the default heap size of 64M is not enough for most cases
# se the maximum heap size is set to 128M
if [ -z "$JAVA_OPTS" ]; then
        JAVA_OPTS="-Djava.awt.headless=true -Xmx128M"
fi

JAVA_OPTS="$JAVA_OPTS -Djava.endorsed.dirs=$CATALINA_HOME/common/endorsed -Dcatalina.base=$CATALINA_BASE -Dcatalina.home=$CATALINA_HOME
-Djava.io.tmpdir=$CATALINA_BASE/temp"

# Set the JSP compiler if set in the tomcat6.default file
if [ -n "$JSP_COMPILER" ]; then
        JAVA_OPTS="$JAVA_OPTS -Dbuild.compiler=$JSP_COMPILER"
fi

if [ "$TOMCAT6_SECURITY" = "yes" ]; then
        JAVA_OPTS="$JAVA_OPTS -Djava.security.manager -Djava.security.policy=$CATALINA_BASE/conf/catalina.policy"
fi

# juli LogManager disabled if running under gij (see bug #395167)
if [ "$gij" != "yes" ]; then
        JAVA_OPTS="$JAVA_OPTS -Djava.util.logging.manager=org.apache.juli.ClassLoaderLogManager
                   -Djava.util.logging.config.file=$CATALINA_BASE/conf/logging.properties"
fi

# Define other required variables
CATALINA_PID="/var/run/$NAME.pid"
BOOTSTRAP_CLASS=org.apache.catalina.startup.Bootstrap
JSVC_CLASSPATH="/usr/share/java/commons-daemon.jar:$CATALINA_HOME/bin/bootstrap.jar"

# Look for Java Secure Sockets Extension (JSSE) JARs
if [ -z "${JSSE_HOME}" -a -r "${JAVA_HOME}/jre/lib/jsse.jar" ]; then
    JSSE_HOME="${JAVA_HOME}/jre/"
fi
export JSSE_HOME

echo $JSSE_HOME

case "$1" in
  start)
        if [ -z "$JAVA_HOME" ]; then
                log_failure_msg "no JDK found - please set JAVA_HOME"
                exit 1
        fi

        if [ ! -d "$CATALINA_BASE/conf" ]; then
                log_failure_msg "invalid CATALINA_BASE specified"
                exit 1
        fi

 log_daemon_msg "Starting $DESC" "$NAME"
        if start-stop-daemon --test --start --pidfile "$CATALINA_PID" \
                --user $TOMCAT6_USER --startas "$JAVA_HOME/bin/java" \
                >/dev/null; then

                # Create catalina.policy (for the security manager)
                rm -f "$CATALINA_BASE/conf/catalina.policy"
                umask 022
                echo "// AUTO-GENERATED FILE -- DO NOT EDIT!" \
                        > "$CATALINA_BASE/conf/catalina.policy"
                echo "// Edit the files in /opt/tomcat6/conf/policy.d/ instead" \
                        >> "$CATALINA_BASE/conf/catalina.policy"
                echo ""  >> "$CATALINA_BASE/conf/catalina.policy"
                cat /opt/tomcat6/conf/policy.d/*.policy \
                        >> "$CATALINA_BASE/conf/catalina.policy"

                # Clean up and set permissions on required files
                find "$CATALINA_BASE"/temp/ -mindepth 1 -exec rm -fr {} +
                REQUIRED_FILES='"$CATALINA_BASE/conf"
                        "$CATALINA_BASE/logs" "$CATALINA_BASE/temp"
                        "$CATALINA_BASE/webapps" "$CATALINA_BASE/work"'
                if [ -e "$CATALINA_BASE/conf/tomcat-users.xml" ]; then
                        REQUIRED_FILES=$REQUIRED_FILES'
                                "$CATALINA_BASE/conf/tomcat-users.xml"'
                fi
                eval chown --dereference "$TOMCAT6_USER" $REQUIRED_FILES \
                        || true

                cd "$CATALINA_BASE/temp"

                $DAEMON -user "$TOMCAT6_USER" -cp "$JSVC_CLASSPATH" \
                    -outfile SYSLOG -errfile SYSLOG \
                    -pidfile "$CATALINA_PID" $JAVA_OPTS "$BOOTSTRAP_CLASS"

else
                log_progress_msg "(already running)"
        fi
        log_end_msg 0
        ;;
  stop)
        log_daemon_msg "Stopping $DESC" "$NAME"
        if start-stop-daemon --test --start --pidfile "$CATALINA_PID" \
                --user "$TOMCAT6_USER" --startas "$JAVA_HOME/bin/java" \
                >/dev/null; then
                log_progress_msg "(not running)"
        else
                $DAEMON -cp "$JSVC_CLASSPATH" -pidfile "$CATALINA_PID" \
                     -stop "$BOOTSTRAP_CLASS"
        fi
        log_end_msg 0
        ;;
   status)
        if start-stop-daemon --test --start --pidfile "$CATALINA_PID" \
                --user $TOMCAT6_USER --startas "$JAVA_HOME/bin/java" \
                >/dev/null; then

                if [ -f "$CATALINA_PID" ]; then
                    log_success_msg "$DESC is not running, but pid file exists."
                else
                    log_success_msg "$DESC is not running."
                fi
        else
                log_success_msg "$DESC is running with pid `cat $CATALINA_PID`"
        fi
        ;;

restart|force-reload)
        if start-stop-daemon --test --stop --pidfile "$CATALINA_PID" \
                --user $TOMCAT6_USER --startas "$JAVA_HOME/bin/java" \
                >/dev/null; then
                $0 stop
                sleep 1
        fi
        $0 start
        ;;
  try-restart)
        if start-stop-daemon --test --start --pidfile "$CATALINA_PID" \
                --user $TOMCAT6_USER --startas "$JAVA_HOME/bin/java" \
                >/dev/null; then
                $0 start
        fi
        ;;
  *)
        log_success_msg "Usage: $0 {start|stop|restart|try-restart|force-reload|status}"
        exit 1
        ;;
esac

exit 0

Grundlegende Einstellungen unter /etc/defaults/tomcat6:

# Modified for tomcat6 16.02.2009 - ohaeuser
# Run Tomcat as this user ID. Not setting this or leaving it blank will use the
# default of tomcat6.
#TOMCAT6_USER=tomcat6

# The home directory of the Java development kit (JDK). You need at least
# JDK version 1.4. If JAVA_HOME is not set, some common directories for
# the Sun JDK, various J2SE 1.4 versions, and the free runtimes
# java-gcj-compat-dev and kaffe are tried.
JAVA_HOME=/usr/lib/jvm/java-6-sun

# Directory for per-instance configuration files and webapps. It contain the
# directories conf, logs, webapps, work and temp. See RUNNING.txt for details.
# Default: /var/lib/tomcat5.5
CATALINA_BASE=/opt/tomcat6

# Arguments to pass to the Java virtual machine (JVM).
#JAVA_OPTS="-Djava.awt.headless=true -Xmx128M"
JAVA_OPTS="-Djava.awt.headless=true -Xms256m -Xmx512m -XX:MaxPermSize=256m -Dlog.home=$CATALINA_BASE -Dsolr.solr.home=/home/solr -Dcom.idmllib.license=ILJD10-xxxx-xxxx-xxxx-xxxx"

# Java compiler to use for translating JavaServer Pages (JSPs). You can use all
# compilers that are accepted by Ant's build.compiler property.
#JSP_COMPILER=jikes

# Use the Java security manager? (yes/no, default: yes)
# WARNING: Do not disable the security manager unless you understand
# the consequences!
# NOTE: java-gcj-compat-dev currently doesn't support a security
# manager.
TOMCAT6_SECURITY=no
#Export for AWT
#export LD_LIBRARY_PATH=$JAVA_HOME/jre/lib/amd64/

Die wichtigste Zeile dabei ist folgende:

JAVA_OPTS=”-Djava.awt.headless=true -Xms256m -Xmx512m -XX:MaxPermSize=256m -Dlog.home=$CATALINA_BASE -Dsolr.solr.home=/home/solr -Dcom.idmllib.license=ILJD10-xxxx-xxxx-xxxx-xxxx”

Mit dieser werden Speichereinstellungen festgelegt, außerdem setzt sie den IDMLlib Lizenzcode.

-Dcom.idmllib.license=ILJD10-xxxx-xxxx-xxxx-xxxx

Sie benötigen einen gültigen Lizenzkey, den Sie unter http://idmllib.com bekommen können.

4 Überprüfen, ob das grundlegende Setup läuft

Erstellen Sie eine info.php Datei in Ihrem Apache 2 web root…

… und testen Sie, ob Apache 2 und PHP laufen: http://server_ip/index.php

Wenn Sie die PHP Informationsseite sehen, sollte alles funktionieren!

Nun testen Sie, ob der Tomcat 6 installiert ist: http://server_ip:8080/

Wenn Sie die Standard Tomcat Statusseite sehen, können wir damit anfangen, die PHP/Java Bridge aufzusetzen.

5 PHP/Java Bridge Templatedatei erstellen

Dies ist die Hauptseite des PHP/Java Bridge Projektes: http://php-java-bridge.sourceforge.net/

Sie benötigen eine JavaBridgeTemplate.war Datei: http://sourceforge.net/projects/php-java-bridge/files/Binary%20package/php-java-bridge_6.1.2.1/JavaBridgeTemplate6121.war/download

Benennen Sie diese Datei um in IDML.war und kopieren die diese in Ihren Webapps Ordner. Tomcat sollte es so automatisch nutzen können.

Kopieren Sie die idmllib.jar Datei nach /opt/tomcat6/webapps/IDML/WEB-INF/lib

6 Konfiguration Apache und PHP

URL_FOPEN auf ‘On’ stellen.

Sie können Ihr Setup mit suhosin schützen, so dass URL_FOPEN auf eine spezifische Adresse beschränkt ist:

suhosin.executor.include.whitelist=http://localhost:8080

Besuchen Sie http://www.hardened-php.net/suhosin/configuration.html für weitere interessanten Einstellungen.

7 Testen Sie die IDMLlib

Wenn Sie alle vorhergehenden Schritte ausgeführt haben, starten Sie Adobe InDesign, nehmen Sie irgendein InDesign Dokument und exportieren Sie es über Datei/Export als IDML Datei. Sie können auch ein neues InDesign Dokument erstellen, allerdings benötigen Sie zumindest eine Textbox mit Inhalt.

Laden Sie die IDML Datei in ihren Webordner und steuern Sie es mit einem kleinen PHP Script an:

Achtung: Sie müssen einen Pfad für die IDML Datei zur Verfügung stellen. Außerdem fragen wir nicht alle Stories ab, sondern “schummeln” ein wenig und stellen nur die korrekte Story ID aus der IDML Datei zur Verfügung. Entpacken Sie die IDML Datei und navigieren Sie zum Stories Ordner. Natürlich gibt es auch  einige nützliche Funktionen in der IDMLlib, um die Story IDs aus den Spreads zu bekommen und über sie zu iterieren.

Demnächst werden wir Ihnen zeigen, wie Sie Story Inhalte modifizieren und in eine IDML Datei zurückschreiben können.

Wenn es vor ein paar Jahren noch ausreichte zu wissen, ob ein Server an ist oder nicht, sind die heutigen Anforderungen immens gestiegen.

Nehmen wir das Beispiel einer typischen Mediendatenbank: Hier müsste man eigentlich zu jeder Zeit wissen, ob der eigentliche Server läuft und natürlich über das Netzwerk erreichbar ist. Nur, was heißt “laufen”? Meistens reicht dies nicht aus. Sobald die Applikation z.B. zu langsam wird, weil bestimmte Ressourcen nicht zur Verfügung stehen oder ausgebaut werden müssten, häufen sich Beschwerden von Benutzern. Diese Anfragen laufen bei der IT auf und müssen bearbeitet werden. Das heißt, der Admnistrator wird auf der einen Seite mit Fragen bombardiert und auf der anderen Seite soll er das Problem lösen.

Anforderungen:

• Plattformunabhängig
• Viele Dienste, Applikationen automatisch erkennen
• Einfache Konfiguration
• Komplexe IT Strukturen überwachen und kontrollieren
• Auswertung, Reporting & Berichtswesen

Besser wäre es natürlich, der Administrator wird proaktiv gewarnt oder aber ein Dienst reagiert auf bestimmte Sachen selbsttätig und informiert den Admin lediglich. Aber auch hier ist die Tücke im Detail. Insbesondere, wenn die Mediendatenbank z.B. unter einer Applikationsserver läuft, der wiederum mit einer SQL Datenbank kommunizieren muss. Die binären Daten liegen zudem auf einem separaten Fileserver. So gesehen muss ein Überwachungsdienst in der Lage sein zu erkennen, welche dieser Komponenten ausgefallen ist und was getan werden muss.

Fällt z.B. der Applikationsserver der Mediendatenbank aus, genügt es, diesen neu zu starten. Ist die Verbindung zum SQL Server unterbrochen, muss in jedem Fall der SQL Server neu gestartet werden. Vorab wäre es jedoch ratsam, den Mediendatenbankserver herunter zu fahren und erst dann neu zu starten, wenn der SQL Server wieder funktioniert.

Wird der Speicher des Fileserver zu knapp, hilft kein Neustart – hier muss der Admin dann eine Benachrichtigung erhalten, damit er eine Erweiterung der Speicherkapazitäten einplanen kann.

Als Schwierigkeit dazu kann es sehr gut sein, dass die Mediendatenbank unter Mac oder Windows läuft, der SQL Server unter Linux und der Fileserver unter Solaris.

Ein modernes Überwachungswerkzeug muss also plattformunabhängig sein, dem Admin genaue Kennzahlen geben, z.B. wie viel Speicherplatz für Daten pro Woche zusätzlich hinzukommt, und eine Warnung auswerfen, falls ein Dateisystem zu 85% ausgelastet ist.

Für eine plattforumübergreifende Überwachung setzen wir Hyperic ein. Über einen zentralen Hyperic HQ Server werden Server und Dienste über ein Agentenmodell überwacht. Auf dem Zielsystem sammelt ein Java-Agent Daten und leitet diese zum Hyperic Server weiter. Server und Agenten verfügen über eine Vielzahl von mitgelieferten Modulen und Templates, um bestimmte Dienste wie z.B. MySQL, Oracle, Apache Webserver, Tomcat 6 etc. zu überwachen und Informationen zu sammeln. Vorgefertigte Installer für Linux, Windows, Mac OS X und Solaris, wo eine Java 1.5 JRE mitgeliefert wird, sind verfügbar. Man kann jedoch auch ein plattformunabhängiges Paket ohne mitgelieferte Java Version herunter laden.

Das Setup ist hierbei äußerst einfach. Sobald der Server einmal installiert ist, kann man anfangen, die Agenten auf den zu überwachenden Server zu installieren. Sobald ein Agent sich mit dem Server verbunden hat, erkennt er automatisch die meisten laufenden Standarddienste und Applikationen. Tomcat und MySQL Dienste werden normalerweise sofort erkannt. In den Konfigurationstabs im Server erhält man nun Tipps und Informationen, wie man z.B. bei einer Tomcat Instanz JMX zur Überwachung aktiviert.

Man kann jedoch auch jederzeit manuell Dienste hinzufügen und über eigene Skripte so ziemlich alles überwachen, was man benötigt.

Wenn einmal die Server und Dienste erkannt wurden, kann man nun festlegen, wann was für Aktionen ausgeführt werden sollen, z.B. kann man eine Benachrichtigung konfigurieren, wenn der Tomcat nicht mehr verfügbar ist (Availability < 100%) oder Fehler in den Logdateien auftauchen.

Somit kann man relativ einfach seine Applikationen und Server zentral überwachen.

In der Opensource Variante werden hier nur Benachrichtigungen ausgelöst und Dienste können dann manuell über den Hyperic HQ Server neu gestartet werden.

In der Enterprise Variante erhält man die Möglichkeit, auch Aktionen – wie z.B. ein Restart des Tomcat Dienstes – als Reaktionen zu Warnungen zu definieren. Zudem erhält man Zugriff zu einem umfangreichne Reporting Tool, womit man detaillierte Listen und Charts mit einer genauen Auswertungen über Auslastungen und Nutzung auf Knopfdruck erstellen kann.

Und das ganze zum kleinen Preis. Es wird nach Anzahl der Agenten abgerechnet – also Servern – und der Preis richtet sich nach dem gewünschten Support Level.

So würde die Überwachung unseres Beispiels mit 3 Servern unter 1.000 Euro Lizenzsumme pro Jahr kosten.

Weitere Informationen finden Sie unter www.hyperic.com

[Mit PicLens anzeigen]