Redaktionssysteme - modular und offen

Transkript

1 Redaktionssysteme - modular und offen by Ferdinand Soethe Open-Source-Software richtig verstanden, ist ein Baukasten aus vielfältig rekombinierbaren Elementen. Der direkte Vergleich einer kommerziellen Software-Lösung mit einer einzigen Open-Source-Software ist daher wenig sinnvoll und lässt Open Source Lösungen oftmals schlechter abschneiden. Dass es auch anders geht, zeigen wir am Beispiel einer kleinen Technischen Redaktion, für die aus verschiedenen Open-Source- Komponenten ein #exibles und leistungsfähiges Open-Source- Redaktionssystem entsteht Table of contents 1 Einleitung Zu meiner Person Unterlagen im Internet Situationsanalyse Einstieg in Single Source Publishing Auswahl Apache Forrest Forrest Installation Vorbereitung Projektvorbereitung Installationsvorbereitungen Installation Forrest installieren Erste Schritte mit Forrest Projekt anlegen... 6

2 4.2 Arbeiten im dynamischen Modus Arbeitsumgebung erweitern Wahl der Arbeitsumgebung JEdit installieren Versionierung Tortoise installieren Grundsätzlich: Repository-Struktur Repository erstellen Repository füllen Handbuch auschecken Arbeitsabläufe Nicht alles ist wichtig Die erste Seite anpassen Änderungen im Explorer Änderungen in Tortoise Änderungsmarkierung Änderungen einchecken Dokumentierte Commits Vorlagen verwenden Neue Dateien in Tortoise Seiten im Navigator Navigatorstruktur site.xml Site für eigene Struktur Seite 2: Über das Programm Neue Seiten im Navigaor Neue Seite im Browser Subversion Transaktionen Transaktionsverarbeitung Page 2

3 6.19 Transaktionen im Log Medien im System Multimedia Erweiterungen Customizing Anpassungen der Look and Feel Feinsteuerung der Navigation SSP nutzen Konsolidierte Print-Version Teamwork Teamstart Locking Subversion Hosting Qualitätssicherung / Freigabe Standardformate Standards wo immer das geht Andere Formate, DITA? Tools XML Tools Mehrsprachigkeit Mehrsprachigkeit mit Tabs Page 3

4 1 Einleitung 1.1 Zu meiner Person... Ferdinand Soethe Softwarearchitekt, Autor Trainer und Berater Arbeitsschwerpunkt: Open Source SSP-Systeme Vorträge und Artikel im In- und Ausland 1.2 Unterlagen im Internet Die Unterlagen zu diesem Vortrag finden Sie im Internet unter 2 Situationsanalyse 2.1 Einstieg in Single Source Publishing Rufus Redakteur eröffnet sein neues Redaktionsbüro und braucht schnell eine brauchbare Single-Source-Publishing-Lösung. In Vorgesprächen mit Kollegen (und seiner Bank) hat er folgende Rahmenbedingungen identifiziert. Mehr Zeit als Geld => free und open source software XML-Technologie Unterstützung für pdf und html Einzelplatzinstallation Page 4

5 2.2 Auswahl Apache Forrest Nach gründlicher Recherche wählt Rufus Apache Forrest als erstes Werkzeug für seinen Einstieg in SSP. Wichtige Aspekte seiner Entscheidung waren Die Möglichkeit schnell zu Ergebnissen zu kommen (Der erste Kunde drängt). Die Plattformunabhängigkeit des Systems. Die schnelle Beantwortung seiner Fragen in einer lebendigen Online Community. Die gute Darstellung von ihm benötigter Elemente in Druckvorlagen (PDF) und HTML. 3 Forrest Installation 3.1 Vorbereitung Zur Vorbereitung nutzt Rufus die vielen Informationsangebote zu Forrest. Er liest die Dokumentation auf dem Forrest Website besucht einen Vortrag zu Forrest bei seiner Tekom-Regionalgruppe lädt sich die erweiterten Unterlagen herunter und vollzieht die Beispiele nach. Kurzum, er macht sich vor seinem ersten Auftrag anhand einer Testinstallation mit der Funktionsweise und den Grenzen des Systems vertraut. 3.2 Projektvorbereitung Gut vorbereitet,akquiriert Rufus seinen ersten Auftrag, die Dokumentation eines kleinen Softwareprojekts. Auf den guten Rat erfahrener Kollegen hin bespricht er mit dem Kunden genau, welches System er für die Dokumentation wählt und was es leisten kann und wählt einen entspannten Zeitplan für dieses erste eigene Projekt. 3.3 Installationsvorbereitungen Seinen neuen "Arbeitsrechner" installiert er bewußt von Grund auf neu. Als Grundlage braucht und installiert er also Java Acrobat Reader Page 5

6 3.4 Installation Rufus entscheidet sich dafür, zunächst die aktuelle Version 0.8 von Forrest für sein Projekt zu benutzen und lädt die Windows-Version auf seinen Rechner herunter. Dann installiert er Forrest im Verzeichnis C:\Programme. 3.5 Forrest installieren Die Installation von Forrest ist ziemlich einfach und unter docs_0_80/your-project.html#installing ausführlich dokumentiert: 1. Inhalte des ZIP-Archivs in ein beliebiges Verzeichnis entpacken 2. Zwei Umgebungsvariablen richtig setzen. Fertig! Damit ist Forrest installiert und einsatzbereit. 4 Erste Schritte mit Forrest 4.1 Projekt anlegen Forrest organisiert jedes Projekt in einem beliebigen Verzeichnis irgendwo auf einer Festplatte. Rufus legt das neues Verzeichnis handbuch für sein Projekt auf dem Desktop an und initialisiert von der Befehlszeile aus das neue Projekt. 1. Befehlszeilenfenster öffnen 2. In ein neues, leeres Unterverzeichnis des Projektes wechseln 3. Forrest seed-basic aufrufen Forrest legt nun das Grundgerüst eines neuen Projektes für Sie an. 4.2 Arbeiten im dynamischen Modus Für die weitere Arbeit startet Rufus Forrest im dynamischen Modus, so dass er die ersten Ergebnisse seiner Arbeit sofort überprüfen kann. Im dynamischen Modus (forrest run) läuft Forrest als Webserver (Application-Server) auf dem eigenen PC. Wie einen Webserver sprechen wir ihn mit unserem Browser und einem bestimmten URL an... und bekommen als Antwort eine dynamisch, d.h. in diesem Moment generierte Seite, unseres Projekts. Page 6

7 5 Arbeitsumgebung erweitern 5.1 Wahl der Arbeitsumgebung Zur Bearbeitung seiner Forrest-Projekte wählt Rufus mit JEdit einen kostenlosen OpenSource-Editor mit Unterstützung für verschiedene Programmiersprachen aus. Den kann er später dann problemlos durch einen professionellen XML-Editor ersetzen, wenn er aus der Praxis weiss worauf es ihm ankommt. 5.2 JEdit installieren 1. Windows-Installer von jedit herunterladen ( 2. Programm installieren 3. Im Plugin-Manager zusätzlich das XML-Plugin installieren. 5.3 Versionierung Aus vielen Gesprächen weiss Rufus, wie wichtig die Versionierung von Projekten in der Praxis ist. Er will sein Projekt daher gleich unter Versionskontrolle stellen. Aufgrund seiner überragenden Leistungsmerkmale wählt er ein Subversion-basiertes System ( aus. Als Windows-Anwender ist der komfortable Subversion-Client Tortoise ( tortoisesvn.tigris.org/) die erste Wahl. 5.4 Tortoise installieren Tortoise allein genügt für den Anfang völlig. 1. Tortoise herunterladen 2. Installationsprogramm ausführen. 5.5 Grundsätzlich: Repository-Struktur Zur Versionierung von Projekten müssen diese zunächst in einer Urfassung in ein Repository eingestellt werden. Dabei ist es sinnvoll, je Projekt ein eigenes Repository (Verzeichnis mit speziellen Strukturen) anzulegen und diese gemeinsam unter einem Repository-Hauptverzeichnis zu speichern. 1. Repository Hauptverzeichnis anlegen 2. Darin ein neues Verzeichnis handbuch_repos anlegen Page 7

8 5.6 Repository erstellen Im Repository-Verzeichnis muss nun eine Datenbank-Struktur eingerichtet werden Tortoise erledigt diese Schritte besonders einfach und komfortabel: 1. Verzeichnis auswählen 2. Darin Rechtsklick, TortoiseSVN-Create repository here auswählen. Im Verzeichnis erscheint die Grundstruktur des neuen Verzeichnisses. Page 8

9 5.7 Repository füllen Für die Erstbefüllung des Repositories verwenden wir die Ausgangsdaten des Forrest- Projekts. 1. Jetty-Server beenden (Strg+C, Ja) 2. Handbuch-Verzeichnis auswählen 3. build-verzeichnis löschen 4. Handbuch-Verzeichnis erneut auswählen 5. Rechtsklick, Tortoise-Import 6. Repository-Verzeichnis auswählen 7. Verzeichnispfad um trunk erweitern 8. Import starten 9. Mit Repository-Browser den Erfolg überprüfen. 5.8 Handbuch auschecken 1. Alle Dateien im Handbuchverzeichnis löschen. 2. Rechtklick SVN Checkout 3. Repository auswählen 4. Checkout starten 5. Forrest run wieder starten 6 Arbeitsabläufe 6.1 Nicht alles ist wichtig Da Änderungen in diesem Verzeichnis für uns unwichtig sind, lassen wir das build- Verzeichnis künftig ignorieren. Page 9

10 6.2 Die erste Seite anpassen Auf der ersten Seite seines Projekts beschreibt Rufus kurz den Sinn und Zweck dieses Handbuchs. Dazu braucht er lediglich den Inhalt der bereits eingestellten Startseite (index.xml) zu verändern. Page 10

11 6.3 Änderungen im Explorer Im dynamischen Modus genügt ein Aktualisieren der Seite im Browser, um die Änderungen zu sehen: 6.4 Änderungen in Tortoise Die Änderung macht Tortoise im Explorer sofort sichtbar. Page 11

12 6.5 Änderungsmarkierung Um genau zu wissen, was geändert wurde, läßt Rufus sich mit Rechtklick auf die Datei Tortoise SVN-Diff die Veränderungen an der Datei aufzeigen: Page 12

13 6.6 Änderungen einchecken Mit dem Rechtklick SVN Commit werden die Änderungen an das Repository übergeben (eingecheckt). Das kann eine Datei oder ein ganzes Projekt sein. Page 13

14 6.7 Dokumentierte Commits Vor dem Commit zeigt Tortoise noch mal eine Liste aller Änderungen und erwartet die Eingabe einer Beschreibung der Änderung Page 14

15 6.8 Vorlagen verwenden Als nächstes will Rufus die beschriebene Software kurz vorstellen. Um schnell neue Seiten anlegen zu können, speichert er die Index-Seite als Vorlage ohne Inhalte in vorlage.xml ab. Da Forrest Dateien nicht automatisch ins Projekt einbindet, kann er beliebig viele frei benannte Vorlagen direkt im Projekt ablegen, ohne dass diese sichtbar werden. 6.9 Neue Dateien in Tortoise Beim Versuch die Änderung einzuchecken wird eine Besonderheit deutlich: Page 15

16 Neu zugefügte Dateien müssen explizit unter Versionskontrolle gestellt werden Seiten im Navigator Neue Seiten werden von Forrest erst berücksichtigt, wenn innerhalb des Projektes auf sie verwiesen wird. Page 16

17 Sinnvoll ist es für neue Seiten einen Eintrag im Navigator anzulegen, der ihre Position im Website wie auch in der PDF-Datei festlegt Navigatorstruktur site.xml Jede Seite braucht ein Element site.xml, dass ihm einen Platz im Navigator/PDF zuweist. Eindeutigen Namen (keine prüfbare Grammatik). Schachtelung der Elemente spiegelt Schachtelung des Menüs wider. Im Abschnitt external-refs können externe Links zentral verwaltet werden Site für eigene Struktur Durch Anpassung der Label in site.xml wird der Navigator nun projektspezifisch eingedeutscht Im Browser wird auch diese Anpassung sofort sichtbar: Page 17

18 6.14 Seite 2: Über das Programm Auf einer zweiten Seite will Rufus nun das Programm vorstellen. Er legt sie als Kopie der Vorlage im xdocs-verzeichnis an und fügt mit jedit den Text ein. Page 18

19 6.15 Neue Seiten im Navigaor Dann fügt er im Navigator einen Verweis auf die neue Seite ein: Page 19

20 6.16 Neue Seite im Browser 6.17 Subversion Transaktionen Oft müssen in einem Projekt verschiedene Dateien geändert werden um ein gesetztes Ziel zu erreichen. Durch gemeinsames Einchecken trägt man dieser Tatsache Rechnung: Page 20

21 6.18 Transaktionsverarbeitung Subversion bearbeitet den Vorgang auch transaktionsorientiert: Es wird nur alles oder nichts erfolgreich eingecheckt. Alle Änderungen bilden zusammen eine neue Version Transaktionen im Log Klare Transaktionsorientierung macht auch die Subverion Protokolle leichter verständlich Page 21

22 Page 22

23 7 Medien im System 7.1 Multimedia Erweiterungen Von Hause aus unterstützt Forrest auch Vektorgrafiken im SVG-Standard. Rufus nutzt dies von Anfang an um viele Skalierungs und Auflösungsprobleme zu vermeiden. 1. SVG-Datei einfach in den resources/images-zweig des Projekts stellen. 2. In der Datei mit der gewünschten Zielformatierung (.png) referenzieren. <img src="/images/apache-forrest-original.png" alt="forrest Logo"/> 8 Customizing 8.1 Anpassungen der Look and Feel Für die bevorstehende Veröffentlichung einer ersten Version muss Rufus das Handbuch nun präsentationsfein machen. Texte der Benutzeroberfläche eindeutschen. Passende Beschriftungen und Logo einfügen. Copyright Vermerke setzen. Er nutzt dazu die Anpassungsmöglichkeiten in skinconfig.xml. 8.2 Feinsteuerung der Navigation In skinconfig.xml kann er auch die Einblendung von Subnavigation bei nur einem Unterkapitel unterdrücken Page 23

24 9 SSP nutzen 9.1 Konsolidierte Print-Version Natürlich soll das Handbuch zu OneSourceDocs auch in einer Print-Version veröffentlicht werden. Dank gründlicher Recherche kennt Rufus das Zauberwort, mit dem sich auf Knopfdruck ein konsolidiertes PDF aus Forrest erzeugen läßt. 1. Mit dem URL erzeugt Forrest aus allen Seiten eine hierarchisch gestaffeltes PDF. 10 Teamwork 10.1 Teamstart Mittlerweile sind die Handbücher von Rufus so erfolgreich, dass er einen Mitarbeiter einstellt. Das wirft gleich mehrere Fragen bei der Zusammenarbeit bei Projekten auf: Page 24

25 10.2 Locking Wie verhindern die Beiden Probleme durch gleichzeitiges bearbeiten von Dokumenten? 1. Absprechen 2. Editor der Dokumente sperrt 3. Subversion Konfliktmanagment Rufus wählt den dritten Weg weil er entscheidend besser skaliert Subversion Hosting Bisher hatte Rufus sein Subversion lokal gehostet. Zur größeren Flexibiltät mietet er einen Subversion-Account (100MB für <10 im Monat) auf das alle Mitarbeiter von überall her sicher zugreifen können. Damit schafft er zugleich auch eine zusätzliche Datensicherungsebene Qualitätssicherung / Freigabe Wie behält Rufus die Übersicht? Wie kann er die Arbeit seines neuen Mitarbeiters gezielt prüfen und freigeben? 1. Absprachen 2. Überprüfung des Subversion-Protokolle 3. Auslagerung von Ständen in einen Zweig Da Absprachen absehbar nicht funktionieren, kombiniert Rufus die Varianten 2 und 3. Er überprüft laufend die Commit-Protkolle seines Mitarbeiters und friert regelmäßig Versionsstände in Branches ein, die dann qualitätsgesichert und ggf. nachgebessert werden können. Korrekturen in einem Branch können bei Bedarf auch wieder in den Hauptast (trunk) migiriert werden. 11 Standardformate 11.1 Standards wo immer das geht Nach den ersten Schritten realisiert Rufus, dass das Forrest-eigene Format proprietär und damit auch nicht sonderlich zukunftsträchtig ist. Daher erstellt Rufus neue Seiten nur noch in XHTML. Page 25

26 11.2 Andere Formate, DITA? Nebenbei sammelt Rufus auch Erfahrungen mit anderen Formaten. Für viele bietet Forrest mittlerweile Plugins (sie die man nur noch installieren muss. Für andere Formate (z.b. DITA) experimentiert Refus mit selbstgeschriebenen Transformationen. Da diese nur zum recht einfachen Document V2-Format transformieren müssen, stellt sich das als leichter heraus als gedacht. 12 Tools 12.1 XML Tools Inzwischen schreibt Rufus sehr viel in seinem Single Source Publishing System und erkennt die Notwendigkeit für einen brauchbaren XML-Editor. Aus verschiedenen Vorträgen weiss er, wie wichtig ein visueller Modus für die Arbeit mit großen Texten ist und, weil er keine leistungsfähigen Open Source Produkte findet, investiert in Oxygen,ein kommerzielles Produkt. 13 Mehrsprachigkeit 13.1 Das Handbuch ist inzwischen so erfolgreich, dass Rufus auch eine englische Version erstellen soll. Dafür bietet Forrest viele Möglichkeiten: 1. i18n Unterstützung ( 2. Verwendung mehrerer Tabs 13.2 Mehrsprachigkeit mit Tabs Rufus wählt die zweite Möglichkeit, weil diese seinen Anforderungen besser gerecht wird. Tab "Home" in "DE" umbenennen (tabs.xml) Tab "EN" anlegen (tabs.xml) Seiten übersetzen Übersetzung in site.xml eintragen Page 26