Kapitel 2. Verwaltung der Dokumente

Inhaltsverzeichnis

Das Webinterface
Aufbau Webinterface
Freigabe von Dokumenten

Zusammenfassung

zpub stellt eine einfach zu bedienende, grafische, browsergestützte Oberfläche für die im SVN verwalteten Dokumente zur Verfügung. Dabei kann die Historie eines Dokuments verfolgt werden, Änderungen können zeitlich und per Redakteur zugeordnet werden, Dokumente können freigegeben werden, Gruppen von Redakteuren gebildet werden, Ausgabeformate angesehen und heruntergeladen werden und der Status aktueller Ausgabegenerierungsprozesse angezeigt werden.

Das Webinterface von zpub hält je nach den Rechten des angemeldeten Benutzers unterschiedliche Informationen und Funktionen parat. Bisher existieren zwei Benutzerrollen:

  1. Redakteure

    Redakteure sind in der Lage, sämtlich relevanten Informationen und Funktionen zum Verwalten und Einsehen der von Ihnen bearbeiteten Dokumente zu nutzen.

  2. Administratoren

    Administratoren bekommen zusätzlich zu den Informationen und Funktionen der Redakteure weitere Funktionen dargestellt. Diese Funktionen sind in der folgenden Übersicht gekennzeichnet. Die Zuordnung der Rollen geschieht über Max Mustermann, max.mustermann@demo.zpub.de.

Das Webinterface

Die Verwaltung von Dokumenten sowie die automatische Generierung der Ausgabeformate geschieht serverseitig und ist über ein Webinterface zu administrieren.

Anmerkung

URL des Webinterfaces:

https://demo.zpub.de/

Die Seiten des Webinterfaces werden bei jedem Aufruf generiert und beinhalten - sofern gerade aufgerufen oder aktualisiert - immer den aktuellen Stand. Werden relative Zeitangaben gemacht, so gelten diese relativ zum Zeitpunkt des Seitenaufrufs bzw. der letzten Aktualisierung.

Tipp

Das die Verbindung zu zpub läuft über eine verschlüsselte Verbindung. Das selbst-signierte SSL-Zertifikat muß akzeptiert und bestätigt werden.

Das Webinterface bietet Funktionen zu den einzelnen Dokumenten wie auch zur Administration des Systems.

Das Menü ist hierarchisch mit zwei Ebenen aufgebaut, wobei zu jedem Dokument eine Unterebene existiert. Die Menüpunkte sind im Folgenden erläutert (Übersicht):

  • Dokumentübersicht

  • Dokument „Handbuch“

    • Archiv

    • Abonnenten

  • Status

  • Benutzer

Aufbau Webinterface

Dokumentübersicht

In der Dokumentübersicht werden die verwalteten Dokumente aufgeführt. Die verwalteten Dokumente sind ebenfalls in der Navigation vorhanden.

Dokument „Handbuch“

Die Übersicht über ein Dokument enthält Angaben über die letzten Änderungen, den Status der Freigabe sowie die erzeugten Ausgabeformate. Existieren zu einem Dokument Änderungen, die aktueller sind als die letzte freigegebene Version, kann dieses Dokument freigegeben werden.

Archiv

Zu jedem Dokument existiert ein Archiv, welches in tabellarischer Darstellung die Bearbeitungsschritte des Dokuments mit Angaben zum jeweiligen Redakteur, der inhaltlichen Änderung, des Änderungsdatums und des Freigabestatuses enthält. Die Tabelle ist nach den laufenden Revisions-Nummern sortiert, die auch in den Arbeitsversionen der Dokumente eingefügt sind. Weiter können noch nicht freigegebene Revisionen hier freigegeben werden.

Das Archiv beinhaltet alle Revisionen seit der Verwaltung der Dokumente mit zpub. Revisionen werden nicht gelöscht, die gesamte Historie bleibt erhalten und wird lediglich vom Speicherplatz auf dem zpub-Server begrenzt.

Versionierung

Jede via SVN übertragene Änderung stößt auf dem zpub-Server eine Neugenerierung sämtlicher Ausgabeformate an. Die zu einer Version bzw. Revision erstellten Ausgabeformate werden dauerhaft abgespeichert, wobei sie weiterhin verlinkt und abrufbar sind. Die Links beinhalten die Revisionsangaben und sind wie folgt aufgebaut:

https://demo.zpub.de/zpub-Technik/archive/131/handbuch/zpub-Technik.pdf

1

Revisionsangabe

Um immer auf die aktuellste Dokumentrevision zuzugreifen, existiert ein latest-Link zu jedem Ausgabeformat:

https://demo.zpub.de/zpub-Technik/latest/handbuch/zpub-Technik.pdf

Die Revisionsangabe ist durch latest ersetzt. Dieser Link kann, da er sich nicht ändert, z.B. für Bookmarks etc. verwendet werden.

Abonnenten

Dieser Punkt ist nur bei entsprechenden Rechten sichtbar.

Unter "Abonnenten" sind die Email-Adressen der Redakteure einzutragen, die bei neuen Versionen dieses Dokuments per Email benachrichtigt werden sollen. Die Benachrichtigungsemail enthält Angaben zum Redakteur, der die Änderung durchgeführt hat, den Zeitpunkt der Änderung, der Kurzbeschreibung der Änderung sowie Links zu den generierten Ausgabeformaten.

Status

"Status" fasst Systemmeldungen sowie Meldungen der automatischen Ausgabegenerierung zusammen. Die sogenannten "job"-Angaben sind nach "Wartenden Aufträgen", "Aufträge in Bearbeitung" sowie "Fehlgeschlagene Aufträge" eingeordnet. Sollte ein Auftrag fehlgeschlagen sein, so ist hier die Fehlermeldung ("Logdatei") einsehbar und es es werden Optionen zu einem erneuten Versuch und des Löschens des Auftrages angeboten.

Benutzer

Dieser Punkt ist nur bei entsprechenden Rechten sichtbar.

Listet alle Benutzer des Systems auf. Hier eingetragene Benutzerkennungen sind zum einen für die Anmeldung am Webfrontend (die Seiten, die über http://demo.zpub.de erreichbar sind) wie auch für die Nutzung des Versions-Verwaltungssystems gültig.

Freigabe von Dokumenten

Dokumente werden standardmäßig mit einem "Draft"-Wasserzeichen sowie Revisions-, Redakteursangaben und Zeitstempel versehen. Während ein Dokument also von einem Redakteur oder einer Redakteursgruppe "in Bearbeitung" ist, wird dies durch das Wasserzeichen kenntlich gemacht. Diese Dokumente (Revisionen) sind nur für den internen Gebrauch bestimmt. Erreicht ein Dokument einen finalen Stand (Revision), kann diese Revision freigegeben werden. Dies geschieht über die entsprechenden Buttons (auf der Dokumentseite sowie der zugehörigen Archiv-Seite). Dabei generiert freigeben die entsprechende Revision des Dokuments erneut - jedoch ohne das Wasserzeichen und die Revisionsmarkierungen.