Anleitung zur Bearbeitung von Q-Dokumenten
Überblick
- Q-Dokumente werden per CVS auf dem Server HAPI verwaltet
- PC-seitig kommt TortoiseCVS zum Einsatz
- Es gibt immer zwei Versionen der Dokumente: unveränderlich als PDF und die Quell-Datei im geeigneten Format
- Die PDF-Version wird manuell erstellt und auf \\HAPI\QDocPDF abgelegt
- Der Zugriff ist auf wenige Personen eingeschränkt
im Einzelnen
Wir gehen mal davon aus, dass ein bestehendes Dokument bearbeitet werden muss
- Der aktuelle Stand muss auf dem lokalen PC aktualisiert werden, entweder erstmalig per Rechtklick in ein neues Verzeichnis und Auswahl von "CVS auschecken" oder im bestehenden Verzeichnis per Rechtklick und Auswahl von "CVS Lokal aktualisieren".
- Das Dokument bearbeiten und genau überprüfen: stimmen die Angaben? Ist das Datum korrekt?
- Das PDF erzeugen, überprüfen (Layout, Einrückungen, Version) und unter \\HAPI\QDocPDF ablegen. Die PDF-Konverter arbeiten nicht immer fehlerfrei, und manchmal muss man am Quell-Dokument ändern, damit das PDF ordentlich aussieht. Wird ein Dokument mit Hyperlinks bearbeitet ist es wichtig, dass das PDF mit einem Editor erzeugt wird welcher Links unterstützt.
- per Rechtsklick auf's geänderte Quelldokument und Auswahl von "CVS einchecken" das Dokument auf den Server laden. Unbedingt die Zusammenfassung der vorgenommenen Änderungen und/oder der Änderungsgrund als Kommentar einfügen. Daraus wird F102 gebildet.
Zusatz-Info
Beim erstmaligen Auschecken der Dokumente öffnet sich ein Dialog, der folgendermassen auszufüllen ist:
- Den Server-Namen eingeben
- Den Pfad zur Repository eingeben. Dies ist der Pfad für alle Dokumente. Es gibt auch noch je einen für die Entwicklung electronic und system, /srv/el_cvs resp. /srv/cvs.
- Den Benutzernamen eingeben.
- Liste der Projekte vom Server holen
- Q-Dokumente-Projekt auswählen
- Mit 'OK' bestätigen
Das CVS wird nun eine lokale Arbeitskopie im aktuellen Verzeichnis anlegen. Dieses Verzeichnis muss auf dem Arbeitsplatz liegen. Es darf nicht auf einem Server-Verzeichnis liegen! Es entspricht der Philosophie des CVS, dass man lokal arbeitet und zentral speichert.
Will man dieses lokale Verzeichnis woanders haben, so lässt es sich problemlos im Dateisystem herumschieben. Es verändert sich nichts an der auf dem Server verwalteten Struktur der Daten. Umgekehrt lässt sich eine einmal festgelegte Struktur auch nur schwer umorganisieren.
Es ist eine schlechte Idee, wenn man die lokale Arbeitskopie im 'Eigene Dateien' ablegt. Dadurch bläht man nur das Backupvolumen auf dem Server sinnlos auf.
Will man Änderungen am Dokument sichtbar machen, so wird ein Vergleichs-Programm (diff) benötigt. Ich empfehle dazu CS-Diff, das unter \\hapi\archiv\win32\csdiff zu finden und manuell zu installieren ist. Es kann auch Word- und Excel-Dateien vergleichen.