Automate InDesign with JavaScript

As the following content is primarily directed towards an international audience, it constitutes an English contribution.

Rainer Klute from InDesign-Sprechstunde drew my attention to a small problem with text break shifts caused by the new default shaping engine Harfbuzz in InDesign CC 2024. This affects only text with south east asian scripts. If you face issues with old documents in InDesign you can simple go back to the old shaping engine. To achieve this task, Adobe put a scripting solution online. To streamline the process and eliminate the need for copy-pasting as suggested, I’ve developed a downloadable solution that functions as a unified script capable of seamlessly switching between both states.

Just install this little script switchHarfbuzz.jsx

If you need help with installing scripts, have a look at this installation guide.

After running the script, a little alert appears which informs you about the current shaping engine.

Note: You can also activate Harfbuzz in InDesign CC 2023, where it wasn’t the default engine. But you should know what you’re doing :)

Vor ein paar Tagen erschien das Minor Update InDesign 18.2. Unter Fixed Issues versteckt sich der Hinweis auf die Deaktivierung der Type 1 Schriften:

Einige meiner Kunden sind nun überrascht. Das Thema selber ist klar, die Uralt-Schriften müssen aktualisiert werden. Das kann ggfs. auch via Skript geschehen. Aber zur schnellen Abhilfe könnt ihr via Creative Cloud App euer InDesign auch nochmal downgraden:

Bitte trotzdem zeitnah das Thema angehen, denn auf der Version 18.1 wollt ihr natürlich nicht stehen bleiben.

Bevor es aber losgeht, ein Lesetipp: Marc Autret hat gerade in einem Blogbeitrag auf indiscripts.com die aktuellen Ressourcen zum InDesign-UXP-Scripting zusammengestellt.

Nach den ersten UXP-Schritten möchte ich nun das UXP Developer Tool für das Debugging von Skripten vorstellen. Wer noch das veraltete ExtendScript Toolkit bzw. das nachfolgende Plugin für Visual Studio Code kennt, wünscht sich vermutlich die gleiche Anbindung für die Entwicklung von UXP-Skripten. Visual Studio Code selbst hat bereits einen integrierten JavaScript-Debugger, der für V8-Engine-Kontexte funktioniert. Rein technisch gesehen müsste Visual Studio Code also in der Lage sein, UXP sofort zu debuggen. Das klappt aber (noch?) nicht. Leider habe ich auch keine Informationen, ob diese Anbindung geplant ist.

Stattdessen bietet Adobe das sogenannte UXP Developer Tool (UDT) an. Der Fokus des Tools ist die Verwaltung von Plugins, wie sie bereits für Photoshop oder Adobe XD entwickelt werden können. InDesign unterstützt aktuell aber nur UXP Scripting, d.h. wir benötigen vom UDT auch nur den Bereich zum Debugging von Skripten.

Installation

Das Adobe UXP Developer Tool kann über die Adobe Creative Cloud-Anwendung installiert werden. Die Systemvoraussetzungen sind vermutlich bei den Meisten erfüllt. Eine ausführliche Anleitung findet ihr bei Adobe. In Kürze:

• Creative Cloud Desktop Anwendung starten.
• Alle Applikationen auswählen.
• In der Liste sollte das UDT auftauchen.
  
• Installieren auswählen.

WICHTIG: Das Adobe UXP Developer Tool benötigt Administratorrechte, um korrekt zu funktionieren. Wenn dein Administrator dir keine erweiterten Rechte einräumt, kannst du dieses Tool nicht verwenden.

Und los…

Nacht der Installation startest du InDesign und dann das UXP Developer Tool. Wenn im Bereich Connected Apps kein Eintrag für InDesign zu sehen ist, überprüfe, ob InDesign auch gestartet ist. In meinen Tests hat das UDT sowohl Photoshop als auch InDesign einwandfrei erkannt.

In InDesign 2023 können wir noch keine echten Plugins (mit einem eigenen Bedienfeld) erstellen. Deswegen ist für uns nur der Button Debug Script relevant. Klicke den Button Debug Script und wähle dann das Skript helloWord.idjs aus dem letzten Beitrag oder ein eigenes UXP-Script.

Wähle dann den Button Debug.

Nun startet der eigentliche Debugger in einem neuen Fenster. Die Ansicht ist dem ein oder anderen vielleicht schon aus der Web-Entwicklung als Chrome Developer Tools bekannt. Für uns ist aber erst einmal nur der Tab Sources relevant. Der Debugger hat das von uns gewählte Skript geladen, aber noch nicht ausgeführt.

Das ausgewählte Skript wird automatisch mit einer asynchronen Funktion umschlossen. Dadurch steht die erste Zeile des Skripts etwas unübersichtlich nach dem Funktionsaufruf, hat aber noch die gleiche Zeilennummer.

(async function (exports, require, module, __filename, __dirname) { 
//...
});

Das bedeutet hier zunächst einmal nur, dass InDesign auch während der Debug Session reagiert. Die alten ExtendScript-Skripte waren immer synchron, d.h. während eines Skriptlaufs konnte InDesign nicht angesprochen werden.

Klicke jetzt im rechten Bereich auf den Pfeil Button (oder die Taste F8), um den Debugger zu starten.

Da wir aber keine Breakpoint gesetzt haben und das Skript keinen Fehler enthält, läuft der Code einfach durch und in InDesign sollte das Dokument mit dem Textrahmen erstellt worden sein. Das Developer-Tools-Fenster wird automatisch geschlossen. Das Gleiche passiert sogar, wenn ein Fehler im Skript enthalten ist. Deswegen empfehle ich dringend, die Default-Einstellungen zu verändern:

Nur mit dieser Einstellung wird ein möglicher Fehler angezeigt und die Developer Tools bleiben mit der V8 JavavScript Engine von InDesign verbunden. Verändere im Skript helloWord.idjs in Zeile 3 add() zu axdd() und starte eine neue Debug-Session. Nach der Einstellung von Pause on caught exceptions und dem Start des Skripts sollte es dann so aussehen:

Die Funktion axdd() existiert nicht und wirft, wie zu erwarten, eine Exception. Wir können uns nun auf die Fehlersuche begeben. Als Erstes suchen wir im rechten Bereichs des Fensters unter Scope die möglichen Funktionen der Eigenschaft textFrames:

Hier finden wir alle Eigenschaften und Funktionen und auch die korrekte Schreibweise add(). Leider können wir den Code nicht live korrigieren, sondern müssen zurück in Visual Studio Code (oder einen anderen Texteditor) und die Debug-Session neu starten.

Bevor wir das allerdings erledigen, sollten wir in der Console testen, ob der Befehl funktioniert. Dazu empfehle ich, die Console unterhalb des Sources Tabs einzublenden. Klicke auf das Menü ganz rechts oben und wähle Show console drawer. Alternativ könne ihr auch den Tab Console links neben Sources aktivieren.

Danach erscheint unterhalb des Fensters ein Eingabebereich, in dem man den Befehl page.textFrames.add() ausprobieren kann. Es funktioniert:

Wenn man jetzt das Developer-Tools-Fenster schließt, erscheint die Warnmeldung mit der Exception in InDesign als modaler Dialog. Diesen muss man noch einmal extra wegklicken, sehr nervig.

Weitere Tipps für die Developer Tools

Mit dem Step Over Button bzw. F10 kann man Schritt für Schritt durch den Code schreiten.

Die nächste Zeile, die ausgeführt werden wird, ist grün hinterlegt. Im folgenden Beispiel sind Zeile 1 bis 3 bereits ausgeführt:

In diesem Zustand ist das Dev-Tools-Fenster mit der V8 JavavScript Engine von InDesign verbunden. D.h. wir können in der Console den Zustand der Variablen zur Laufzeit auswerten.

Nach dem Eintrag page. erscheint ein Autocompletion-Feld mit den möglichen Eigenschaften des Objekts. Das gefällt mir super und ist eine tolle Verbesserung. Wenn man ein den Befehl mit Return bestätigt, erscheint in der Console das Ergebnis. Hier ein absichtlich eingetragener Fehler und der zweite, korrekte Versuch:

Beim Experimentieren mit der Console ist mir eine ärgerliche Änderung in UXP aufgefallen. UXP erlaubt die Zuweisung von beliebigen Eigenschaften an ein Objekt. Tippfehler können schnell übersehen werden und Code-Teile werden unerwarteterweise nicht ausgeführt! Schau dir das folgende Beispiel mit der fehlerhaften Eigenschaft geometrixBounds an:

Fehlt eigentlich nur noch ein Breakpoint. Das ist auch ganz einfach: Im Bereich Sources setzen wir diesen vor der Ausführung des Skripts neben die Zeilennummer:

Während das Skript beim Breakpoint zum Halten gekommen ist, kann natürlich wieder der Code inspiziert werden.

Fazit

Alles in allem ist der Prozess noch nicht optimal. Bei jedem neuen Testlauf muss das Skript manuell ausgewählt und gestartet werden! Bei einem Fehler muss das Tool zunächst geschlossen werden und das Skript in einem anderen Editor korrigiert werden. Besser wäre es, wenn man das Skript im Dev Tool korrigieren und direkt neu starten könnte. Wie üblich beim Thema UXP: Wir stehen noch am Anfang!

Mit InDesign CC 2023 bekommen wir das lang ersehnte moderne JavaScript. Mit UXP (Unified Extensibility Platform) ist Adobe der nächste große Wurf für die Automatisierung seiner Applikationen gelungen. Nach XD und Photoshop wurde die Technologie in InDesign implementiert.
Auch wenn es zunächst nur die reine Script-Variante ist, lässt sich schon die vollständige UXP-Unterstützung mit grafischen Benutzeroberflächen und Bedienfeldern im nächsten großen Release voraussehen.

Genug Zeit also, diesen Blog zu reaktivieren und sich mit der Technologie auseinanderzusetzen. Als Einstieg werde ich ohne ExtendScript Ballast ein kleines Skript in UXP erstellen. Später folgen dann Beiträge zum Entwicklungsworkflow, den erweiterten Möglichkeiten wie z.B. den Netzwerkzugriff und den Unterschieden zur abgelösten ExtendScript-Technologie – maßgebend für die Konvertierung von alten Skripten.

Wichtig an dieser Stelle: ExtendScript wird auch in Zukunft unterstützt! Alte Skripte müssen also nicht konvertiert werden. Es empfiehlt sich viel mehr zunächst kleinere neue Projekte mit UXP zu starten!

Los geht’s

Wir brauchen das aktuellste InDesign CC 2023 (v. 18) und einen Texteditor z.B. Visual Studio Code. Nach dem Start von InDesign siehst du im Skripte-Bedienfeld bei den Beispielskripten bereits die UXPScripts. In meinem Screenshot sind auch die beiden Benutzer-Skripte alt.jsx und neu.idjs installiert;

Entscheidend ist die Dateiendung der Skripte: Mit .idjs startet InDesign das Skript in der UXP-Umgebung, mit .jsx wird die ExtendScript-Engine angeworfen.

Wenn du nicht weißt, wie die Skripte dahinkommen, zur Installationsanleitung hier entlang.

Hello, World!

Okay, ich bin über 40: Ich starte meine Reise immer mit einem Hello, World! Skript.

In Visual Studio Code lege ich eine neue Datei helloWord.idjs an. Rechts unten in der Statusleiste empfehle ich den Language Mode JavaScript für eine korrekte Syntaxhervorhebung:

In der ersten Zeile

let doc = app.documents.add();

erstelle ich ein neues Dokument. Leider gibt es noch keine API-Dokumentation, sodass ich aktuell nur auf die ExtendScript-Dokumentation verweisen kann, die aber fast identisch ist. Die Unterschiede werde ich in einem eigenen Beitrag beschreiben.

Für mein Beispielskript möchte ich nun auf der ersten Seite des Dokuments einen Textrahmen erstellen und diesen mit dem Text Hello, World! befüllen.

let dok = app.documents.add();
let page = dok.pages.item(0);
let textFrame = page.textFrames.add();
textFrame.geometricBounds = [15, 15, 100, 100];
textFrame.contents = "Hello, World!";

In der zweiten Zeile wird die erste Seite des Dokuments referenziert (ein InDesign-Dokument hat immer mindestens eine Seite). Auf dieser Seite erstelle ich dann in Zeile 3 einen neuen Textrahmen mit der Methode add(). Der Textrahmen in der Variablen textFrame wird mit der Eigenschaft geometricBounds die Position und Größe zugewiesen. Dazu werden die Koordinaten als Array mit den Werten [y1,x1,y2,x2] übergeben. Schlussendlich wird der Eigenschaft contents der Hallo-Welt-String zugewiesen.

Dieses einfache Programm ist fast identisch mit dem ExtendScript-Pendant. Beachte allerdings die Verwendung von let zur Deklaration der Variablen und die Adressierung der Seite über die Methode ipages.item(0) anstatt über die eckigen Klammern. Auch wenn ich die Abkürzung über die eckigen Klammern immer sehr praktisch fand, waren Sie doch nur ein ExtendScript-Hack der viele Teilnehmer:innen in meinen Schulungen immer auf die falsche Array-Fährte geführt hat.

Nach der Installation im Skripte-Bedienfeld kannst du das Skript wie gewohnt per Doppelklick starten. Das Ergebnis sieht das so aus:

Solltest du dich irgendwo vertippt haben, erscheint ein Warnfenster mit der Zeilennummer und der Fehlermeldung:

Wie man hier auf die Suche geht, zeige ich im nächsten Beitrag zum Entwicklungsworkflow mit dem Adobe UXP Developer Tool.

Wer nicht bis zum nächsten Beitrag warten kann, dem sei die InDesign UXP Scripting Übersicht von Adobe empfohlen. Leider ist diese noch stark verbesserungswürdig!

Info-Webinar

Am 17. März 2021 um 11 Uhr stehen die Durchführenden in einem kostenlosen Webinar Red und Antwort. Hier kannst du dich anmelden >>

Inhalte des Seminars

Die Möglichkeiten der InDesign-Automation sind schier grenzenlos: Scripting, GREP, Plugins, strukturierte Daten und immer wichtiger: Crossmediale Schnittstellen ins Web.
Was steckt dahinter und wie kannst du es in deiner Praxis einsetzen? Das ist der Schwerpunkt dieses Lehrgangs. Du lernst die Möglichkeiten der Automatisierung und Schnittstellen: Am Ende kannst du die Technologien selber einsetzen und Projekte implementieren!

PDF mit Informationen zum Lehrgang >>

Die wichtigsten Themen werden ausführlich vorgestellt und der jeweilige Nutzen anhand von Praxisbeispielen verdeutlicht: Der Einsatz von regulären Ausdrücken mit GREP, InDesign Skripting mit JavaScript, WordPress und Cloud Publishing sowie XML und Anbindung an Datenbanken am Beispiel von EasyCatalog.

Damit die Projekte auch gelingen, gibt es umfassendes Basiswissen zum Projektmanagement noch dazu!

Wie, wann, wo – wie lange

• Geplanter Start: Ende September 2021
• Dauer: Zirka 12 Tage + betreutes Praxisprojekt 4 Tage
• Parallel in Bern und in Stuttgart
• Platz reservieren: E-Mail an René Theiler >>

Zielgruppe

• Du willst technisch anspruchsvolle Publishing-Projekte umsetzen?
• Du hast keine Angst vorm Texteditor?
• Du willst zusammen mit Publishing-Profis deinen Wissensstand auf ein neues Level heben?
• Du bist Mediengestalter/-in, Polygraf/-in, Medieninformatiker/-in, Verlagshersteller/-in (CH Projektmanager/-in Buch), Anwender/-in von Publishingsystemen?
• Aber auch ohne Zertifikat und einschlägiger Berufsausbildung bist du hier richtig!

Geplante Agenda

Themenblock GREP

• Einführung in das Suchen und Ersetzen mit GREP in InDesign
• GREP-Stile, erweiterte GREP-Techniken
• Die besten GREP-Tools
• Mit “ChainGREP” wiederkehrende Suchanfragen zu eigenen Skripten konvertieren

Themenblock Skripting

• Einführung Automatisierung (Abgrenzung GREP, Skripte, Plugins … )
• Was kann Skripting? Skripte finden, installieren und einsetzen
• Einführung JavaScript
• Klassisches JavaScript für InDesign
• Visual Studio Code – die Entwicklungsumgebung für InDesign kennenlernen
• Das InDesign-Objektmodell kennenlernen
• Best Practices
  • Format- und Mustervorlagen
  • Schritte der Scripterstellung

Themenblock Web/WordPress

• Das Web verstehen: HTML- und CSS-Grundlagen
• Content mit WordPress für unterschiedliche Ausgabekanäle verwalten
• WordPress als Multi-Channel-Redaktionssystem

Themenblock strukturierte Daten

• Strukturierte Daten (JSON, REST; Datenbank, CSV; XML)
• Strukturierte Daten über EasyCatalog in InDesign verarbeiten
• Workflows für die Verarbeitung von strukturierten Daten
• XML und InDesign – die Boardmittel kennenlernen
  • XML importieren und exportieren
  • Formate zuweisen, Tabellen einsetzen
• Skripte und XSLT für die Verarbeitung einsetzen
  • Preprocessing: Via XSLT die Daten optimal für InDesign vorbereiten
  • Postprocessing: Mit Skripting alle Layoutkonstrukte herstellen
• Praxisbeispiele XML Automatisierung
• Automatisierte Dokumenterstellung aus JSON-Daten
• InDesign und WordPress verbinden

Themenblock Projektmanagement

• Multi-Channel-Projekte managen
• Agile Projekt-Management-Methoden im Vergleich (Kanban, Scrum, Design Thinking)
• User Story und Story Map
• Multi-Channel-Projekte über die Kanban-Methode agil verwalten

Praxisprojekt nach Wahl

Zum Beispiel

• WordPress nach InDesign
• XML oder JSON nach InDesign
• Datenbank/CSV nach InDesign
• InDesign-Automation über EasyCatalog
• Oder du setzt dein eigenes Praxisprojekt um

Referenten

• Gregor Fellenz, publishingX >>
• Rudi Warttmann, topset >>
• Simea Merki und Haeme Ulrich, morntag >>

Kosten

• 5’900.- CHF/EUR für Mitglieder von publishingNETWORK >> und dmpi >>
• 6’900.- CHF/EUR Normalpreis

Interessiert, melde dich…

Für die Schweiz und Österreich:
René Theiler / Tel. +41 31 351 15 11

Für Deutschland:
Adeline Anders (data2type GmbH, Heidelberg) / Tel. +49 6221 7391260 bei Fragen zum Inhalt des Lehrgangs
Melanie Erlewein (dmpi, Stuttgart) /Tel. +49 711 4 50 44 50 bei Fragen zu der Organisation

InDesign CC 2021 hat einen kleinen fiesen Bug: Wenn ein Dokument aus einer älteren Version geöffnet wird [Umgewandelt], merkt sich InDesign nicht wo die Datei wieder gespeichert werden muss. Beim Speichern öffnet InDesign stattdessen den zuletzt geöffneten Ordner. Das ist natürlich super nervig.

Der Bug wird sicherlich bald behoben, hier kann man abstimmen: https://indesign.uservoice.com/forums/601180-adobe-indesign-bugs/suggestions/41695588-indesign-16-0-saves-converted-files-in-last-used-f

In der Zwischenzeit schafft dieses kleine Skript Abhilfe:

https://raw.githubusercontent.com/grefel/idsHelper/master/saveDocument.jsx

Es speichert umgewandelte Dateien wie gewohnt (sogar ganz ohne Dialog).

Ihr wisst nicht wie das installiert wird? Dann hier entlang: https://www.publishingx.de/skripte-installieren/

Eigentlich ein alter Hut: Web- und Mail-Adressen sollten in InDesign als aktive Hyperlinks ausgezeichnet werden, damit diese im PDF oder eBook anklickbar sind und so vom Nutzer auch tatsächlich verwendet werden können.

Als netter Nebeneffekt werden eure PDFs (und ggfs. auch E-Books) direkt auch barrierefrei.

Gibt’s schon lange von Adobe, nur funktioniert die Funktion mehr schlecht als recht. Deswegen habe ich meine eigene Funktion als kostenloses Skript zur Verfügung gestellt.

Ihr findet das Skript createHyperlinks_v2.jsx auf GitHub. Zur Installationsanleitung direkt hier entlang. Ein schönes Video habe ich auch erstellt!