Git und Subversion protokollieren Änderungen an Dateien und ermöglichen den Zugriff auf frühere Bearbeitungsstände. Help+Manual unterstützt beide Systeme direkt, weitere Systeme können über angepasste Befehlsskripte angebunden werden. In dieser Arbeit wird Git vorgestellt.
Git hält Änderungen an den Projektquellen nachvollziehbar fest. Gespeicherte Bearbeitungsstände lassen sich vergleichen und bei Bedarf wiederherstellen. Das unkomprimierte Projektformat von Help+Manual eignet sich dafür, weil die Topicinhalte als einzelne XML-Dateien vorliegen.
Die Versionsverwaltung kann vollständig über GitHub Desktop, einer grafischen Benutzeroberfläche für Git, erfolgen. Auf diese Weise lassen sich mehrere Help+Manual-Projekte in einem übergeordneten Git-Repository zusammenfassen. Sämtliche Git-Befehle werden dabei über GitHub Desktop ausgeführt. Help+Manual erkennt die einzelnen Projektordner in dieser Anordnung nicht als Git-Repositories und bietet deshalb keine Git-Funktionen im Menüband des Help+Manual-Editors an.
Um Git-Befehle direkt aus Help+Manual aufzurufen, muss für jeden Projektordner ein eigenes Repository angelegt werden. Dazu wird das Help+Manual-Projekt geschlossen und in GitHub Desktop folgendermassen vorgegangen:
1.File > Add local repository wählen.
2.Über Choose… den Ordner auswählen, der die Projektdatei (.hmxp) enthält, und mit Add repository bestätigen.
3.Falls noch kein Repository vorhanden ist, dem angebotenen Link create a repository folgen. Den Pfad kontrollieren und mit Create repository das Repository direkt im Projektordner erstellen.
Dabei entsteht der versteckte Unterordner .git, der die lokale Git-Verwaltung und Versionshistorie enthält.
Anschliessend wird in Help+Manual unter Ansicht > Programmoptionen > Versionskontrolle die Git-Unterstützung aktiviert und der Pfad zur installierten git.exe angegeben. Nach dem Öffnen des Projekts steht das Symbol für die Versionskontrolle im Menüband zur Verfügung.
Der folgende Explainer zeigt die Git-Initialisierung mittels GitHub Desktop Schritt-für-Schritt.
Explainer: Git initialisieren
Eine ausführliche Einführung in die Versionsverwaltung würde den Rahmen dieses Topics sprengen. Der praktische Versuch zeigt jedoch, dass sich Git auf diese Weise direkt aus Help+Manual nutzen lässt. |
Weitere Informationen sowie die zugehörige Website finden sich bei [Web:SCM].
Hinweis: Das Repository mit den MAS-Projekten steht im GitHub-Repository https://github.com/esciotools zur Verfügung.
