Mit weniger Klicks mehr erreichen: Mit unserer Blogreihe „COSIMA Scripting“ zeigen wir anhand verschiedener Kundenbeispiele mögliche Optimierungen in COSIMA. Mit Hilfe von Scripting können COSIMA-Anwender*innen mit ein wenig Programmiererfahrung selbst neue und sehr spezifische Funktionalitäten erstellen. In dem heutigen Blog-Artikel werden wir uns ein Beispiel für eine Interaktion mit unseren integrierten XML-Editor XMAX genauer ansehen.
Aus der Softwareentwicklung wissen wir, wie hilfreich es ist, wenn Bezüge leicht nachvollziehbar sind. Wir arbeiten mit dem Ticketsystem Jira von Atlassian und (nahezu) jede Code-Änderung in unseren Produkten nimmt Bezug auf ein Ticket in Jira. So kann für jede einzelne Zeile Code (und allein COSIMA besteht aus mehreren Millionen Zeilen Code) rekonstruiert werden, wann und mit welchem Ticket diese Codezeile hinzugekommen ist. Bestenfalls lässt sich auch das „Warum“ ableiten, um bei späteren Änderungen an genau dieser Stelle verstehen zu können, warum der Entwickler oder die Entwicklerin sich damals für die aktuelle Umsetzung entschieden hat.
Solche Bezüge sind nicht nur bei der Softwareentwicklung sinnvoll. Auch im redaktionellen Alltag kommt es regelmäßig vor, dass die ursprüngliche Quelle für die Informationen festgehalten werden soll. Wir erstellen unsere Release Notes bei DOCUFY wenig überraschend mit COSIMA. Die eigentliche Datenquelle ist aber das oben bereits erwähnte Ticketsystem Jira, in dem es zu jedem Ticket ein Metadatum „Release Notes“ gibt. Über ein COSIMA Script (das wir in einem späteren Blog-Artikel noch vorstellen werden) führen wir eine Suchabfrage auf Jira mit den passenden Tickets durch, extrahieren die Informationen aus den Release Notes und konvertieren diese in die passende COSIMA-Struktur mit Blöcken, Absätzen und Listen um. Neben den rein textuellen Inhalten geben wir auch die Information des ursprünglichen Tickets mit. Wir schreiben diese direkt in den Blocktitel. In anderen Fällen ist es auch denkbar, einen XML-Kommentar mit dem Verweis auf die ursprüngliche Quelle zu generieren.
All das ist bereits mit Standardmitteln von COSIMA möglich. Wir haben von unseren Kunden aber auch Anfragen zu mehr Komfort in der Handhabung erhalten. Ein Beispiel dafür kann ein XML-Kommentar mit einer Ticketnummer in der Form „ABC-1234“ sein. Der Wunsch ist, per Doppelklick direkt das entsprechende Ticket im Browser zu öffnen. Ein anderes Beispiel ist das in COSIMA go! standardmäßig vorhandene Elemente <url>, bei dem sich per Doppelklick der Browser mit der im Attribut @address hinterlegten URL öffnen soll.
Dafür notwendig ist die Interaktion mit dem XML-Editor XMAX. Auch hier können COSIMA Scripte das Verhalten individuell beeinflussen. Dabei bleibt es dem Script-Ersteller überlassen, wie genau er die Umsetzung realisieren will. Wir haben uns für diesen Beispiel-Use-Case auf folgende Fälle beschränkt:
- XML-Kommentare, die genau eine Nummer eines Tickets aufweisen, geprüft anhand eines regulären Ausdrucks
- URL-Elemente, deren @address Attribut mit „http“ beginnt
Ist einer der beiden Fälle gegeben, führt als neue Funktion ein Doppelklick direkt zum Öffnen der entsprechenden URL im Browser. Im Fall des Tickets wird die dafür nötige URL vorab noch zusammengesetzt.
Das folgende Video zeigt exemplarisch das Ergebnis:
Zu sehen sind vier Optionen:
- Eine URL mit einem @address Attribut, das mit „http“ beginnt => der Doppelklick öffnet die angegebene URL, im Video ist dies die DOCUFY-Website
- Eine URL mit einem @address Attribut, das nicht mit „http“ beginnt => der Doppelklick hat kein Effekt
- Ein XML-Kommentar mit einer Ticketnummer => der Doppelklick öffnet das Ticket im Ticketsystem
- Ein XML-Kommentar mit anderen Angaben => der Doppelklick hat kein Effekt
Wie bereits erwähnt, soll dieser Use Case nur grob veranschaulichen, wie vielseitig eine Interaktion mit dem XML-Editor per COSIMA Script sein kann. Es sind noch viele weitere Use Cases denkbar. Wir freuen uns über Ihre Rückmeldung mit eigenen Realisierungen oder weiteren Beispielen als Wünsche, auf die wir in einem noch folgenden Blog-Artikel eingehen sollen.
Interesse geweckt?
Diese Artikelreihe beschäftigt sich mit den mächtigen Funktionen von COSIMA Scripting und stellt verschiedene Anwendungsfälle in einzelnen Artikeln vor. Wir freuen uns sehr, Rückmeldung von Ihren Beispielen oder Vorschläge für zukünftige Artikel dieser Reihe zu erhalten. Unsere Kunden bekommen die in den Artikeln vorgestellte COSIMA Scripte mit einer kurzen Anleitung auf Nachfrage selbstverständlich kostenfrei. Dafür einfach eine kurze Mail an support@docufy.de mit dem Titel „COSIMA Scripting: Externe Inhalte direkt aus dem XML-Editor öffnen“ schreiben.
Für weitere Unterstützung oder eine Initial-Umsetzung melden Sie sich gerne zu einem unserer Trainings oder zu einem individuellen Workshop an. Zusätzlich bieten wir Ihnen auch Scripting-Support als Dienstleistung an, falls Sie bei selbst erstellten Scripten Unterstützung in Form eines direkten Austauschs mit unseren Entwicklern brauchen, oder Sie sprechen einen unserer Partner an, der Ihnen ebenfalls Unterstützung im Bereich COSIMA Scripting bieten kann.
