Writing GnuCash Documentation

If you are interested in improving the GnuCash documentation, you have come to the right place. This page will provide you with the necessary information to get started.

Just as the GnuCash application has been developed over time by volunteers, so too has the documentation been written by volunteer developers and users to help others learn how GnuCash works. This collaborative effort has resulted in the creation of two major documents, the Help Manual and the Concepts and Tutorial Guide.

The GnuCash community welcomes assistance in maintaining and improving both the program and its documentation. If you are interested in helping write, edit or translate GnuCash's documentation, this page gives guidance on how to get set up to join the effort.

The GnuCash documentation can be viewed and downloaded from the Documentation page.

Einführung

Die GnuCash Dokumentation wird in xml-Dateien gespeichert. Es wird das GNOME2 XML docbook System verwendet. Dieses System ist relativ flexibel, nimmt die xml Dateien als Eingangsmaterial und kann daraus Dokumente in den verschiedensten Ausgabeformaten erzeugen, wie html, pdf etc.

Wenn Sie die GnuCash Dokumentation bearbeiten wollen, sollten Sie xml kennen und ein paar grundsätzliche Kenntnisse des docbook Systems besitzen.

Die folgenden Links führen zu weiteren Websites, welche beim Dokumentieren und Redigieren hilfreich sein können.

DocBook: The Definitive Guide.
DocBook XSL: The Complete Guide.
GNOME Human Interface Guidelines
How_to_translate_the_GnuCash_guide_and/or_help_files: Diese GnuCash wiki-Seite beschreibt das Übersetzen von Dokumentation. Sie enthält eine Menge nützlicher Informationen um mit docbook Dateien zu arbeiten
Documentation_Update_Instructions: Eind detaillierter Leitfaden wie Dokumente bearbeitet werden sollten (update and maintenance).

Wir empfehlen dafür auch die Entwickler-Mailingliste zu abonnieren gnucash-devel.

Die Seite der Gnome Dokumentationsrichtlinien (eng.)

Wie schon gesagt: die neue Dokumentation basiert auf dem GNOME2 XML docbook System. Jeder der mithelfen möchte beachte bitte diese Richtlinien soweit irgend möglich beim Berichtigen und Schreiben von neuen Artikeln.

Wo bekommt man die Quelltexte der Dokumentation?

Zuerst benötigt man eine Kopie der Quelltexte der Dokumentation. Die Quelltexte kann man zum einen von dem GnuCash svn-Server herunterladen oder alternativ den tarball von: current docs tarball laden.

Bitte holen Sie das Dokumentationsmodul aus dem GnuCash SVN-repository "gnucash-docs". Für diejenigen, die nicht mit svn vertraut sind, hat das GnuCash-Wiki eine Anleitung. Um die Dokumentation zu bekommen, muß man der Anleitung folgen und dabei checkout gnucash ersetzen durch checkout gnucash-docs. Man kann aber auch vom aktuellen docs tarball starten.

svn checkout http://code.gnucash.org/repo/gnucash-docs/trunk gnucash-docs

There are two major GnuCash documentation packages to help users: the Help Manual and the Tutorials and Concepts Guide. With the above command, the source code of both will be downloaded.

Autoren

Laden Sie sich eine Kopie der Dokumentationsquellen herunter und pflegen Sie Ihre Änderungen ein. Wenn Sie zufrieden mit Ihren Änderungen sind erzeugen Sie einen Patch duch folgendes Kommande im untersten Verzeichnispfad der Dokumentation (normalerweise gnucash-docs, außer Sie haben diesen Pfad umbenannt):

svn diff > my-patch-name.patch

Next attach your patch to a bug report against the documentation component for the GnuCash project in Gnome's bugzilla database and send an email to gnucash-devel mailing list to inform other developers on your work. See also GnuCash' wiki page on bugzilla for more details about patch submission.

NOTE: Es war gemeinhin ok wenn sie Ihren Patch direkt zur gnucash-devel Liste schicken, wird aber nicht mehr so gerne gesehen da ein Patch leicht in Vergessenheit gerät bzw. übersehen wird zwischen all den anderen Diskussionen auf der Liste. In jedem Fall ist es besser Patches an Bugs anzuhängen (ob nun an existierende oder an einen neuen). Patches bitte immer als Anhang anfügen, nicht Inline im Mailtext senden

Bitte lassen Sie andere Autoren wissen, welchen Abschnitt Sie zu bearbeiten wünschen. Bitte schreiben Sie dies an gnucash-devel, damit andere Mitarbeiter Bescheid sagen könne, ob sie bereits daran arbeiten oder ob diese Aufgabe momentan vakant ist.

Sie werden wohl eine lokale Kopie der alten Dokumentation behalten wollen, um sich darauf zu beziehen, während Sie schreiben. Diese enthalten eine Menge nützlicher Informationen, welche noch nicht in die neue übertragen wurden.

Redakteure/Reviewer

Laden Sie eine Kopie der Dokumentation herunter und fangen an zu schreiben