Schlagwort-Archive: Subversion

Installation von zpub – Ein Werkzeug zur Erstellung technischer Dokumentation (Debian)

Einleitung

Wer größere Handbücher und Dokumentationen erstellen muss, stellt sehr schnell fest, dass gängige Textverarbeitungsprogramme sehr an ihre Grenzen stoßen. Insbesondere bei mehreren Bearbeitern gleicher Dokumente wird die Arbeit schwierig bis unmöglich.

Selbst wenn man das Bearbeiten im Team organisieren kann, erfolgen größere Änderungen am Layout
ist der Aufwand riesig.

Hier kommt zpub (www.zpub.de) ins Spiel. Es setzt zur Dokumentation auf DocBook. Hierbei wird Inhalt und Design klar voneinander getrennt. Die Versionierung erfolgt über Subversion.
Wird ein neues oder geändertes Dokument eingecheckt, werden automatisiert alle definierten Ausgabeformate, z.B. PDF, chm, HTML, etc. erstellt und die fertige Dokumentation steht zeitnah zur
Verfügung.

Installation

Zunächst die benötigten Pakete:

benötigte Pakete

Für Debian gibt es ein Paket, das Repository muss jedoch zunächst aktiviert werden.

Wir erstellen hierzu die Datei /etc/apt/sources.list.d/zpub.list mit folgendem Inhalt:

Die Installation des Pakets wie folgt:

Hierbei werden einige Abhängigkeiten mitinstalliert, dies kann eine Weile dauern.

zpub-Instanz erstellen

Schließlich wird mit Aufruf des nachfolgenden Skripts eine zpub-Instanz erzeugt.

Konfiguration

Benutzer

Zunächst muss ein Benutzer erstellt werden, um auf die Weboberfläche bzw. das SVN-Repository zugreifen
zu können.

Im Anschluss muss das Passwort gesetzt werden.

Zusätzlich noch eine Benutzer für nicht administrative Zugriffe.

Hinweis: Wurde vom Namen zpub abgewichen, ist dies im Pfad entsprechend zu berücksichtigen:

Ausgabeformate

Die Möglichen Ausgabeformate werden hier definiert:

Weitere Konfigurationsmöglichkeiten sind im Handbuch beschrieben.

Bedienung

Mit den vorab erstellten Benutzern kann man das SVN-Repository () nutzen. Nach dem Commit wird automatisch die Dokumentation in den vorher eingestellten Formaten erzeugt.

Details sind im sehr ausführlichen Handbuch bestens beschrieben. In einem späteren Artikel werde ich hierzu näher berichten.

Webgui

Die Webgui ist unter https://<IP oder FQDN des zpub-Servers> zu erreichen. Hier können beispielsweise Versionen betrachtet und freigegeben werden.

Fehlersuche

Sollte der Fehler Error: html_entity error – cannot locate Apache::Util or HTML::Entities at /usr/share/zpub/bin/zpub-cgi.pl beim Aufruf des Archivs auftreten, kann hiermit Abhilfe geschaffen werden:

Das Ergebnis wie folgt:

zpub.pdfzpub.pdf

Subversion und WebSVN – Debian 6

Erforderliche Pakete

Zunächst wird Subversion, WebSVN und das zugehörige Apache Modul libapache2-svn installiert.

Bei der Frage, ob WebSVN konfiguriert wird, bestätigen wir, ebenso die automatische Apache-Konfiguration. Als Pfadangaben wird /var/lib/svn jeweils üernommen.

Repository

Erst wird ein entsprechendes Verzeichnis erstellt.

Darin wird dann ein leeres Subversion-Repository erzeugt.

Im Anschluss werden die Dateiberechtigungen gesetzt, damit Apache auf das Repository zugreifen kann.

Die Datei /var/lib/svn/<repository1>/conf/svnserve.conf wird bearbeitet, hierbei werden die Kommentarzeichen bei folgenden drei Zeilen entfert:

In der Datei /var/lib/svn/<repository1>/conf/passwd werden die Benutzer hinterleget.

WebSVN

Benutzer und Passwort…

Benutzer dürfen lesen und schreiben, jeder andere kann lesend zugreifen. Die Datei /etc/apache2/dav_svn.authz wie folgt erstellen:

Die Konfiguration des Apache-Moduls wird unter /etc/apache2/mods-available/dav_svn.conf angepasst.

Los gehts…

Subversion starten und die Apachekonfiguration neu laden.

Der Zugriff auf WebSVN erfolgt über http://url-oder-ip-des-svn-servers/websvn.

Soll Subversion nach einem Reboot nicht von Hand gestartet werden, kann folgender Cronjob helfen: