Home / LinuxUser / 2011 / 09 / Dokumentationen mit Mallard schreiben

Newsletter abonnieren

Lies uns auf...

Folge LinuxCommunity auf Twitter

Top-Beiträge

Eingedost
(161 Punkte bei 4 Stimmen)
Aufteiler
(161 Punkte bei 4 Stimmen)

Heftarchiv

LinuxUser Heftarchiv

EasyLinux Heftarchiv

Ubuntu User Heftarchiv

Ubuntu User Heftarchiv

Partner-Links:

Das B2B Portal www.Linx.de informiert über Produkte und Dienstleistungen.

Neue Ente im Teich

Dokumentationen mit Mallard schreiben

Gnome baut um

Noch vor nicht allzu langer Zeit war Docbook bei Gnome das Maß aller Dinge, wenn es um das Schreiben von Handbüchern ging. Doch mit Mallard änderte sich das grundlegend, wobei nicht nur die vereinfachte Syntax den Ausschlag gab. Das Aussehen der Dokumente sollte nicht mehr die Form einer Dissertation haben, sondern ein Wiki-ähnliches Layout, um das Suchen nach den gewünschten Informationen zu erleichtern. Zu den Pionieren gehörte das Chat-Programm Empathy, dessen Handbuch schon in Gnome 2.28 im Herbst 2009 im Mallard-Format vorlag (Abbildung 2).

Abbildung 2

Abbildung 2: Mit dem Empathy-Handbuch betrat Gnome 2.28 neues Terrain in Sachen Mallard.

Hinter der Fassade gab es zudem eine auf den ersten Blick eher unscheinbare Modifikation: Neu zu schreibende Dokumentationen sollen fortan unter einer Creative-Commons-Lizenz stehen statt wie bis dahin unter der GFDL. Das erleichtert das Weiterverbreiten der Texte, da sich beispielsweise auch die Dokumentationsteams von Fedora und Ubuntu für diese Lizenzen entschieden haben. Somit steht und dem Austausch und dem gegenseitigen Einbinden von Dokumenten nichts im Weg.

Das Ändern der Lizenz setzt außerdem voraus, dass alle bisherigen Autoren dieser zustimmen müssen, falls das Projekt bestehende Inhalte weiterverwenden will. In vielen Fällen ist dies mit vertretbarem Aufwand nicht möglich. Aber so stellen die Maintainer eben sicher, dass veraltete Inhalte gar nicht erst einfließen. Ganz nebenbei erzwingen Sie eine themenbasierte Gliederung.

Derzeit liegen allein auf den offiziellen Gnome-Servern bereits 36 Handbücher im neuen Format vor, Tendenz steigend. Externe Projekte wie Déjà Dup [5] und SimpleScan [6] haben Mallard ebenfalls adaptiert. Ab Gnome 3.2 spielt es für das Einbinden externer Hilfeseiten sogar keine Rolle mehr, unter welchem Installationspräfix Hauptprogramm und Plugin installiert sind. Eine in ~/.local installierte Seite gibt der Hilfebrowser dann ebenso korrekt aus wie eine, Die sich in /usr befindet. Das ermöglicht es, ein Plugin ohne die Rechte des Systemverwalters im Home-Verzeichnis zu installieren – komplett mit korrekt integrierter Hilfeseite.

Insgesamt betrachtet, fungiert Gnome durchaus als Motor hinter Mallard, wenngleich Mallard kein reines Gnome-Projekt ist, sondern einen universellen Anspruch hat.

Ausblick

Aufgrund der genannten Einschränkung vermag Mallard auf lange Sicht Docbook nicht zu ersetzen, sondern bestenfalls zu ergänzen. Die Entwickler folgen zwar recht zeitnah den Rufen der Benutzer, wenn es um neue Features geht, aber das Einsatzgebiet beschränkt sich wohl auch weiterhin auf das Darstellen am Bildschirm. Ob es jemals einen brauchbaren LaTeX/PDF-Export gibt, steht in den Sternen. Um technische Dokumente für die Druckausgabe zu schreiben, kommen Sie um Docbook kaum herum – es sei denn, Sie nutzen ohnehin schon LaTeX. Geht es aber um themenbasierte Benutzerhandbücher, die dem Leser zudem noch per Definition ein vertrautes Wiki-Layout bieten, ist Mallard erste Wahl.

Um die Zukunft des Projekts braucht sich zudem niemand Sorgen zu machen. Die Entwickler sind sehr aktiv: Kaum haben Sie ein neues Feature implementiert, nehmen Sie schon das nächste schon in Angriff. Zur Zeit arbeiten sie intensiv an Glossaren [7], also an der Möglichkeit, Begriffe im Text hervorzuheben und automatisch mit einer Begriffserklärung zu verknüpfen. Interessant ist die Tatsache, dass dies auf die Initiative eines kommerziellen Benutzers zurückgeht – das zeugt von der inzwischen recht breiten Akzeptanz des Formats.

Bleibt zu hoffen, dass Mallard in naher Zukunft auch in andere Projekte so einfließt, dass es sich zu mehr entwickelt als als nur einer Machbarkeitsstudie. Das Desktop-Projekt XFCE ist hier bereits auf dem richtigen Weg [8]. Zwar gibt es derzeit nur für die XFCE-Leiste und das Terminal Mallard-Handbücher, und die Dateien werden direkt ohne Umweg über einen Hilfebrowser in HTML bereitgestellt – aber der Grundgedanke der themenbasierten Hilfe bleibt davon unberührt. 

Glossar

WYSIWYG

"What You See Is What You Get". Bezeichnet einen Editor, der genau das anzeigt, was später in der Bildschirm- oder Druckausgabe zu sehen ist.

Infos

[1] Mallard-Projekt: http://projectmallard.org

[2] Deutsches Mallard-Handbuch: http://mariobl.fedorapeople.org/Mallard/

[3] Transformation nach LaTeX: http://gitorious.org/+projectmallard/projectmallard/mal2latex

[4] ITS Tool: http://itstool.org

[5] Déjà Dup: http://launchpad.net/deja-dup/

[6] SimpleScan: http://launchpad.net/simple-scan

[7] Shaun McCance zu Glossaren: http://blogs.gnome.org/shaunm/2011/07/07/mallard-glossaries/

[8] Mallard für XFCE: http://wiki.xfce.org/documentation

Tip a friend    Druckansicht Bookmark and Share
Kommentare

Hits
Wertung: 119 Punkte (7 Stimmen)

Schlecht Gut

Infos zur Publikation

Infos zur Publikation

LinuxUser 05/2014

Aktuelle Ausgabe kaufen:

Heft als PDF kaufen

LinuxUser erscheint monatlich und kostet in der Nomedia-Ausgabe EUR 5,95 und mit DVD EUR 8,50. Weitere Informationen zum Heft finden Sie auf der LinuxUser-Homepage.

Im LinuxUser-Probeabo erhalten Sie drei Ausgaben für 3 Euro. Das Jahresabo (ab EUR 60,60) können Sie im Medialinx-Shop bestellen.

Tipp der Woche

Bilder vergleichen mit diffimg
Bilder vergleichen mit diffimg
Tim Schürmann, 01.04.2014 12:40, 1 Kommentare

Das kleine Werkzeug diffimg kann zwei (scheinbar) identische Bilder miteinander vergleichen und die Unterschiede optisch hervorheben. Damit lassen sich nicht nur Rätsel a la „Orignial und Fäls...

Aktuelle Fragen

programm suche
Hans-Joachim Köpke, 13.04.2014 10:43, 8 Antworten
suche noch programme die zu windows gibt, die auch unter linux laufen bzw sich ähneln sozusagen a...
Funknetz (Web-Stick)
Hans-Joachim Köpke, 04.04.2014 07:31, 2 Antworten
Bei Windows7 brauche ich den Stick nur ins USB-Fach schieben dann erkennt Windows7 Automatisch, a...
Ubuntu 13.10 überschreibt immer Windows 8 Bootmanager
Thomas Weiss, 15.03.2014 19:20, 8 Antworten
Hallo Leute, ich hoffe das ich richtig bin. Ich habe einen Dell Insipron 660 Ich möchte gerne Ub...
USB-PTP-Class Kamera wird nicht erkannt (Windows-only)
Wimpy *, 14.03.2014 13:04, 15 Antworten
ich habe meiner Frau eine Digitalkamera, AGFA Optima 103, gekauft und wir sind sehr zufrieden dam...
Treiber
Michael Kristahn, 12.03.2014 08:28, 5 Antworten
Habe mir ein Scanner gebraucht gekauft von Canon CanoScan LiDE 70 kein Treiber wie bekomme ich de...