Beliebige JavaScript-gesteuerte Korrekturen

Wofür dieser neue Korrekturtyp?

Manchmal benötigt man Berechnungen oder Sie wollen eine Menge Variablen verwenden zur Konfiguration einer oder mehrerer Korrekturen in pdfToolbox. Die "Beliebige JavaScript-gesteuerte Korrekturen" bietet eine mächtige Alternativ zur Verwendung regulärer Korrekturen in diesem Fall.

Diese Korrektur funktioniert über zwei JavaScript Code Bereiche womit eine Konfiguration erzeugt werden kann für eine oder mehre Korrekturen. Die pdfToolbox erzeugt dann die Korrekturen aus den JavaScript-Objekten, die man übergibt und führt diese als Teil des Profiles oder Prozessplans aus. Man sollte dies nicht als einfachen Ersatz von Standard-Fixups sehen, eher als Alternative wenn übliche Korrekturen nur schwer umsetzbar wären, ein gutes Beispiele wäre eine Farbersetzung, bei der im Vorfeld die Anzahl der Farben unklar ist, die ersetzt werden sollen.

Einstellungen der Korrektur

Die Korrektur enthält zwei JavaScript-Bereiche, um es einzurichten:

  1. Der Hauptbereich des JavaScriptes. Hier sollte das Konfigurationsobjekt erstellt werden und über werden an pdfToolbox.
  2. Der Ressourcen-Bereich. Hier müssen alle Ressourcen des JavaScriptes aufgelistet werden. created Fixup requires so they can be properly managed by pdfToolbox

Der Hauptbereich des JavaScriptes

Die pdfToolbox erwartet ein JavaScript-Objekt, was ein oder mehr Korrekturen enthält. Die standardmäßige Form könnte in etwa wie folgt aussehen:

<p>// The object containing all of the Fixup definitions
const configuration = {
	
	// A fixup
	flip_pages: {
		config: {
			// fixup specific setup
		}
		displayName: "The name to be used in the report",
		displayComment: "The comment sometimes also shown in reports"
	},

	// Optionally a second, third... fixup
	
};

// This line makes sure it is passed back to pdfToolbox. Do not use "return" here.
configuration;</p>
Click to copy

Einige Bemerkungen über den oberen Code:

  • "flip_pages" ist die Kennung für die Korrektur, welche wir verwenden wollen.
  • "config" hiermit lassen sich Eigenschaften hinzufügen für die Korrektur. Da jede Korrektur unterschiedlich ist, so muss auch diese Auswahl typischerweise unterschiedlich für jede Korrektur sein.
  • "displayName" und "displayComment" sind optional, aber erlauben Ihnen den Namen und Kommentar festzulegen, die verwenden werden im Preflight-Report wenn diese Korektur ausgeführt wird.

Wie findet man heraus was in den config-Bereich gehört? Klicken Sie auf die blaue "i" Schaltfläche (geziegt unter (3) im Screenshot darüber) und es stehen Ihnen folgende Möglichkeiten zur Auswahl:

  1. Liste aller Korrekturen öffnen
    Dies öffnet die Dokumentation zur korrekten Konfiguration alle Korrekturen.
  2. Korrektur einfügen...
    Dies zeigt eine Liste möglicher Korrekturen und lässt eine auswählen. Die pdfToolbox fügt dann eine leere Korrektur zu dieser Korrektur zum JavaScript Editor um diese weiter anzupassen.
  3. Konfigurierte Korrektur einfügen...
    Dies ist vermutlich die einfachste und mächtigste Art. Stellen Sie zunächst sicher, dass Sie eine Korektur ähnlich bereits konfigurieren, wie Sie es auch über JavaScript ereichen wollen und speichern Sie diese Einstellung (in der selben Bibliothek, wo auch die Korrektur erstellt wird). Verwenden Sie nun diese Option und die vorkonfigurierte Korrektur wird in Liste erscheinen. Wählen Sie die Konfiguration dann aus für die Korrektur, mit all jenen Eigenschaften, die Sie definiert haben, dann wird Sie im JavaScript Editor angezeigt.

Welche Dinge man dabei beachten sollte

Während die Konfiguration der Korrektur relativ einfach ist, gibt es einige Dinge, denen man mit Vorsicht begegnen sollte...

  • pdfToolbox erwartet JavaScript code, kein JSON Objekt. Sie müssen einige JavaScript Statements, die ein "Ergebnis" erzeugen. Dieses Ergebnis sollte dann die Konfiguration die Korrektur enthalten. Sie können Die auf unterschiedlichen Wegen erreichen, die pdfToolbox hat dabei keine bestimmte Erwartung - der Code muss nur eine Ergebnis erzeugen.
  • Sie können zwar mehrere Korrekturen in der JavaScript-Strukture erstellen. Es dürfen jedoch keine zwei Korrekturen des selben Types enthalten sein. Falls eine "flip_pages"-Korrektur Fixup eingefügt wird, kann keine weitere dieses Types in der JavaScript-Strukture angefügt werden. Während es vielicht Wege gibt pdfToolbox zu überlisten beim Einfügen wie dies in Ihr JavaScript, wird es dann dennoch nicht funktionen beim Ausführen der Korrektur.
  • Einige Korrekturen erkauben intern mehrere Konfigurationen (durch die "+" und "-" Schaltflächen in der Bedienoberfläche beim Einstellen einer Korrektur). Solche Korrekturen können ebenenso konfiguriert werden, in diesem Fall wird die "config"-Eigenschaft in Ihrer JavaScript-Strukture dann zu einem Array. Falls Sie sich unklar darüber sind wie dies gemacht wird, erstellen Sie eine Beispiel-Korrektur und verweden Sie dann "Konfigurierte Korrektir einfügen", damit pdfToolbox zeigt wie es geht.

Ressourcen referenzieren

Korrekturen können Ressourcen verwenden, wie etwa ICC-Profile oder - noch viel wichtiger - Prüfungen, die als Filter verwendet werden. Um solche Ressourcen zu benutzen müssen Sie im zweiten Eingabefeld, der Korrektur enthalten sein.

Desktop

Falls Sie die Methode verwenden unter 3. "Konfigurierte Korrektur einfügen" wie oben beschrieben werden alle konfigurierten Ressourcen automatisch angefügt. Selbst dann, wenn Sie noch weitere Ressourcen hinzufügen. Beispielsweise Sie wollen ändern, welche Ressourcen bei der Laufzeit benutzt werden. Oder Sie haben vor das Ziel-ICC-Profil einer Farbkonvertierung, während der Laufzeit über JavaScript zu verändern. Sie könnten dann alle ICC-Profile, die im Bereich "icc_profiles" verwendet werden würden darauf referenzieren innerhalb des JavaScriptes.

Oder Sie wollen die Prüfung im Filter anpassen, der verwendet wird.
Um ein solches Element zur Liste hinzuzufügen, können Sie wieder die blaue Info-Schaltfläche verwenden.

Beispiel

Ein einfaches Beispiel um Seiten horizontal zu spiegeln ist hier angefügt und kann in Ihre Bibliothek importiert werden. Mit der Option "Konfiguriertes Fixup einfügen" können Sie aber auch ganz einfach eigene Beispiele erstellen. Danach braucht man sie nur noch nach eigenem Geschmack anzupassen!