DITA Editor

Tektur Editor - DITA XML Editor mit einem automatischen Satzsystem.

Wikipedia: Die Darwin Information Typing Architecture (DITA) ist ein Dokumentenformat, ähnlich dem bekannten DocBook. DITA wird von der Firma IBM und der Organisation OASIS als freie Architektur entwickelt und steht als Dokumenttypdefinition (DTD) kostenlos zur Verfügung. DITA basiert auf XML: Im Gegensatz zu DocBook gibt es für DITA keine SGML-basierte DTD.

Nach der offiziellen Definition aus der Architekturspezifikation (nachstehend in deutscher Übersetzung) ist DITA

„… eine Architektur, um themenorientierten, informationstypisierten Inhalt in Form einer einzigen Quelle (single source) zu erstellen, der in vielfältiger Weise wiederbenutzt werden kann. DITA ist auch eine Architektur, um neue Informationstypen zu erstellen sowie neue Informationsdomänen — basierend auf vorhandenen Typen und Domänen — zu beschreiben. Dies ermöglicht es Gruppen von Benutzern, sehr spezifische, zielgerichtete Dokumenttypdefinitionen zu erstellen, indem ein Spezialisierung genannter Prozess verwendet wird, bei dem die gemeinsamen Ausgabetransformationen und Gestaltungsrichtlinien für allgemeinere Typen und Domänen dennoch beibehalten werden.“[1]

Tektur Editor ist ein einfach zu bedienender Editor um DITA Inhalte erstellen, als PDF ausgeben und pflegen zu können.

Das Blog zur Entwicklung gibt es hier: www.tekturcms.de (engl.).

Status: WORK IN PROGRESS / EXPERIMENTAL
Datum: 05.09.2017

 Tektur Logo

Folgendes sollte schon möglich sein (Einige Random Features):

  • Grafiken können für die PDF-Ausgabe seitenbreit, spaltenbreit und in der Marginalie gesetzt werden.
  • Die Breite der Marginalie ist stufenlos einstellbar; die PDF-Ausgabe ist bzgl. der Formatierung weitestgehend konfigurierbar.
  • TOC und mehrstufige Register werden automatisch in der PDF-Ausgabe erzeugt.
  • Die Zellenbreite von CALS Tabellen kann mit der Maus eingestellt werden; Funktionen auf Zellen sind weitestgehend implementiert.
  • Copy 'n Paste funktioniert Element-weise und topic-übergreifend.
  • Verlinkung auf andere Topics funktioniert über Referenzen und ein Linktext wird automatisch aktualisiert, wenn sich der Topic-Titel ändert.
  • Paras, Listitems und Sections können mit den Pfeilbuttons in der Toolbar nach oben und unten verschoben werden.
  • DITA Elemente werden über Tags angezeigt; es gibt einen Brotkrümelpfad über den Elemente selektiert werden können.
  • Die DITA-Map kann u.a. mittels Drag 'n Drop editiert werden; Im Topic Editor gibt es an jeder Stelle ein dynamisches Kontextmenü für weitere Optionen.
  • Valide DITA Strukturen können exportiert und importiert werden.
  • uvm.

Überblick

Tektur Editor ist eine Peer-2-Peer Software, die ohne Server auskommt. Auf der Serverseite ist lediglich ein simples Script erforderlich, welches die IP Adressen der zugeschalteten Peers verwaltet.


Folgend die Hintergründe für die Entscheidung zum Peer-2-Peer System:
 
  1. Ganz banal: Tektur soll in vielen Bereichen ein Novum darstellen. Die Peer-2-Peer Architektur ist zwar schon etwas betagt - hat viele Vorteile und auch Nachteile - gibt es aber in dieser Form im Anwendungsbereich noch nicht.
  2. Die PDF Transformationen sind sehr leistungshungrig und würden eine Serverperformanz erfordern, die wir uns sparen können, wenn die Transformationen auf dem Rechner des Anwenders ausgeführt werden.
  3. Grafiken werden zusammen mit den Topics des Autors auf dessen Rechner verwaltet. Auch diesbzgl. wird der Server entlastet - Es entsteht kein Traffic zu/vom Server.
  4. Falls schützenswerte Inhalte ausgetauscht werden, so sind diese nicht auf dem zentralen Server des Systems im Internet gespeichert, sondern nur auf den Rechnern der angeschlossenen Peers. Über eine geplante End-2-End Verschlüsselung wären die Inhalte maximal geschützt, so dass das System auch in kritischen Anwendungsbereichen zum Einsatz kommen könnte.
Tektur-Editor wird zum Testen als Webapplikation für den Browser CHROME veröffentlicht: http://www.stylesheet-entwicklung.de:8001. Diese Website wird aber nicht mehr weiterentwickelt und dient nur für Demozwecke. Ausserdem ist geplant das Javascript Editor-Control des Contentbereichs abzukapseln - mit sauberen Schnittstellen - um es in anderen Redaktionssystemen einbauen zu können.

Testen der Webapplikation

  1. Herunterladen des aktuellen Testdokuments als DITA Export Paket.
  2. Examinieren des Zip Pakets. Achtung, die Struktur darf nicht verändert werden.
  3. Besuchen der Website der Applikation mit dem Browser Google CHROME: http://www.stylesheet-entwicklung.de:8001

  4. Wählen Sie die Option "create a new project" und füllen Sie das Formular aus:
  5. Sie werden nun zur Topic-Liste weitergeleitet. Auf diesem Weg erscheint noch ein Dummy-Popup, das Sie wegklicken können.
  6. Ihre Topic-Liste ist noch leer. Sie können nun auf eigene Faust Topics anlegen oder das heruntergeladene Testdokument importieren:
  7. Im Importerdialog ziehen Sie das Zip Pakte auf die Upload-Fläche. Bei Klick auf diese Fläche erhalten Sie einen konventionellen Dateiauswahl-Dialog. Das Hochladen des Zips dauert eine Weile. In dieser Zeit bekommen Sie noch keine Ladeanimation angezeigt. Sobald das Zip hochgeladen wird die Liste der zu importierenden Topics angezeigt.
  8. Wenn alle zu importierenden Objekte den Status "ok" haben, so können Sie das gesamte Zip importieren. Die Topic-Liste wird nun schrittweise befüllt (auch das dauert wieder ein bisschen). Zuletzt wird die Map importiert:
  9. Klicken Sie auf den Eintrag mit Typ "map". Das ist das Inhaltsverzeichnis. Einzubindende Kapitel (Topics) werden in der Map referenziert und können auch in anderen Maps wiederverwendet werden. Sie können zum Testen weiter Topics anlegen und diese in der Map einbinden, oder auch eine ganz neue Map erstellen. Probieren Sie einfach ein bisschen herum. Haben Sie die Map schliesslich geöffnet, so klicken Sie auf den Titel:
  10. Sie gelangen zum Popup für das Einstellen der Map-Eigenschaften:
  11. Vergeben Sie hier Werte. Beachten Sie, dass die Textvariablen, die Sie hier definieren, bei der Publikation des Buchs als PDF herangezogen werden. Anschliessend speichern Sie die Map ab:
  12. Nach dem Abspeichern der Map gelangen Sie wieder zur Topic-Liste. Am Eintrag für die Map befindet sich nun ein neues Icon zum Einstellen der Layout-Optionen für das Print-PDF:
  13. Nach Klick auf dieses Icon erscheint das Layouter-Popup. Klicken Sie durch die Reiter und laden Sie z.B. eigene Grafken für das Cover-Image oder ein Logo hoch:
  14. Stellen Sie auch weitere Layoutoptionen ein:
  15. Stellen Sie die Breite der Marginalie auf 50 mm ein, damit das PDF gut aussieht (der Wert 80 ist hier zu hoch):
  16. Erzeugen Sie das PDF und schliessen Sie das Popup. Ihre Einstellungen werden gespeichert:
  17. In der Topic-Liste erscheint nun ein PDF Icon am EIntrag der Map. Wenn Sie auf dieses Icon klicken, können Sie das erzeugte PDF herunterladen bzw. im PDF Viewer betrachten. Das Ergebnis sollte ungefähr wie diese PDF Datei aussehen. Beachten Sie, dass es bzgl. des Stylings noch viel zu tun gibt. Auf dem Server (Linux) sind auch keine Windows Schriften (Arial) installiert. Für eine bessere Demo sprechen Sie mich gerne an.
  18. Einfach mal nach Lust und Laune, sowohl den den Topic-Editor als auch den Map-Editor, ausprobieren. Im Topic-Editor wird bei Rechtsklick ein Kontextmenü für weitere Aktionen an jeder Stelle der Editorfläche angezeigt. Ein Klick auf das Tag des XML Elements zeigt dieses Menü ebenfalls. Die Einträge im Map-Editor können per Drag 'n Drop arangiert werden. Allerdings sollten zuerst einige Topics angelegt werden, bevor man eine Map anlegt, damit man Material zum Einbinden in die Map hat. Ein Hovern über die Icons der Schattflächen zeigt eine Beschreibung zur möglichen Aktion im Tooltip an.

 

Viel Spass beim Ausprobieren!