Das Handbuch bei GitHub

Das Handbuch können Andere besser schreiben, als wir vom Kernteam von museum-digital. Ein gutes Handbuch für Benutzer kommt schließlich am Besten von anderen Benutzern. Deshalb ist das (deutschsprachige) Handbuch ab jetzt allgemein über GitHub bearbeitbar.

Mit der Umstellung der technischen Basis des Handbuchs auf mdbook Anfang des Jahres liegen alle Texte als Markdown-Dateien – also quasi als nur leicht formatierte Textdateien – vor, die problemlos mit einem Versionskontrollsystem verwaltet und verteilt bearbeitet werden können. Da GitHub mittlerweile wahrscheinlich die zentrale Stelle für die kollaborative Arbeit an vergleichbaren, versionierten Inhalten (von Handbüchern bis zum Hauptzweck, Programmen) ist, und die Meisten, die sich mit Versionierung auseinandergesetzt haben, wahrscheinlich schon ein GitHub-Konto haben, ist das Handbuch nun also zentral dort zu finden und wird dort gemeinsam mit allen, die mitmachen wollen, weitergeschrieben.

Auf jeder Seite des Handbuchs findet sich nun oben rechts ein Link zur äquivalenten Seite zur Bearbeitung, falls es Anmerkungen oder Ergänzungen gibt.

Seitenspezifische Hilfelinks in musdb

In der Navigation von musdb gibt es seit langer Zeit Links zum einigen Seiten des Handbuch. Bisher waren die hier verlinkten Seiten aber immer dieselben – egal, von welcher Seite aus man den Menüpunkt aufgeklappt hat.

Ab dieser Woche werden hier – soweit in der jeweiligen Sprache der Benutzer vorhanden – jeweils Links zu den passenden Seiten aus dem Handbuch zu finden sein. So finden sich die Antworten auf die Fragen, die während der Arbeit aufkommen, schneller – und musdb profitiert direkt von einem sich füllenden Handbuch.

Das neue Feld „Danksagung“

Zu guter Letzt soll hier noch eine Neuerung Erwähnung finden, die ausnahmsweise nichts mit dem Handbuch zu tun hat: Auf dem Reiter „Zusatz“ kann jetzt im neuen Feld „Danksagung“ der Dank an Mitwirkende und Fördermittelgeber ausgedrückt werden.

Besonders wichtig ist das Feld für die gerade laufenden Projekte im Rahmen der Förderlinie Neustart Kultur. Damit die Angabe des Fördergebers nach den Vorgaben der Deutschen Digitalen Bibliothek im richtigen Feld weitergegeben werden kann (in unserem Fall lido:creditLine), muss die Angabe der Förderer in das Feld Danksagung eingetragen werden. Damit das, wo nicht eh schon geschehen, einfach umgesetzt werden kann, ist das Feld für die Stapelverarbeitung mit der Funktion „Globales Ändern“ freigeschaltet.

This content is licensed under a Creative Commons Attribution 4.0 International license.

Eine neue Suchfunktion in musdb bietet endlich die Möglichkeit, nach Ereignissen zu suchen (nicht nur ihren Bestandteilen), negative Suchen durchzuführen (z.B. „Objekte, die nicht aus Hamburg kommen“), „oder“-Suchen zu machen, und – mir persönlich seit langem ein Anliegen – Objekte mit Maßangaben größer oder kleiner als ein gegebener Wert zu suchen. Damit spiegelt die Objekt-Suchfunktion in musdb die Logik der hier noch nicht besprochenen, aber schon länger verfügbaren neuen Suchfunktion der Ausgabe von museum-digital.

Weil es sich aber um so eine einschneidende Überarbeitung handelt, war es umso dringlicher, die entsprechende Seite im Handbuch zu überarbeiten. Einmal dabei, haben wir die Gelegenheit genutzt, das Handbuch technisch auf ganz neue Beine zu stellen.

Die Handbuchseite zur neuen Suchfunktion in musdb kann hier gefunden werden.

Neues Handbuch

Warum also ein neues Handbuch? Der grundlegendste Grund ist die zugrundeliegende Software: Das alte Handbuch basierte auf einer selbst geschriebenen Software, die einerseits dem Anspruch eines Handbuchs nicht in allen Belangen entsprach, und andererseits in Ermangelung von Zeit schlicht nicht oft genug upgedatet wurde.

Das neue Handbuch wird mit der Software mdbook generiert, die etwa auch für die Benutzer-Dokumentation der Programmiersprache Rust zum Einsatz kommt. Damit kommen nützliche, vorher nicht vorhandene Features wie etwa eine Druckfunktion für das gesamte Handbuch und eine besser navigierbare Navigation.

Für die Bearbeitung des Handbuchs bedeutet der Wechsel der Software, dass das Handbuch jetzt in simplen Plain-Text-Dateien geschieht, statt wie bisher direkt auf dem Server mit einem Login und eigenen Editor. Dadurch, dass diese Plain-Text-Dateien auch auf dem lokalen Rechner bearbeitet werden, kann in Zukunft theoretisch jeder zum Handbuch beitragen.

Die neue Software hilft aber natürlich noch nicht, das bisher sehr unvollständige Handbuch auch tatsächlich zu schreiben, auch wenn die Arbeit jetzt auch mehr Schultern verteilt werden kann.

Beitragsbild: Zuccarelli, Francesco: Cicero entdeckt das Grabmal des Archimede / CC BY-NC-SA @ Stiftung Preußische Schlösser und Gärten Berlin-Brandenburg & Murza, Gerhard (1994)

This content is licensed under a Creative Commons Attribution 4.0 International license.