# GTK-Doc-Handbuch

1.18

Benutzerhandbuch für Entwickler mit Anweisungen für die Benutzung von GTK-Doc.

Chris Lyttle

                chris@wilddev.net

Dan Mueth

                d-mueth@uchicago.edu

Stefan Kost

                ensonic@users.sf.net

GTK-Doc-Projekt

    gtk-doc-list@gnome.org

2000, 2005 Dan Mueth and Chris Lyttle
2007-2011 Stefan Sauer (Kost)
2009, 2010, 2011 Mario Blättermann (mariobl@freenet.de)

Das vorliegende Dokument kann gemäß den Bedingungen der GNU Free Documentation License (GFDL), Version 1.1 oder jeder späteren, von der Free Software Foundation veröffentlichten Version ohne unveränderbare Abschnitte sowie ohne Texte auf dem vorderen und hinteren Buchdeckel kopiert, verteilt und/oder modifiziert werden. Eine Kopie der GFDL finden Sie unter diesem Link oder in der mit diesem Handbuch gelieferten Datei COPYING-DOCS.

Bei vielen der von Firmen zur Unterscheidung ihrer Produkte und Dienstleistungen verwendeten Namen handelt es sich um Marken. An den Stellen, an denen derartige Namen in einer GNOME-Dokumentation vorkommen und wenn die Mitglieder des GNOME-Dokumentationsprojekts über diese Marken informiert wurden, sind die Namen in Großbuchstaben oder mit großen Anfangsbuchstaben geschrieben.

1.18
14 sep 2011
sk bug fixes, speedups, markdown support
1.17
26. Februar 2011
sk urgent bug fix update
1.16
14. Januar 2011
sk Fehlerkorrekturen und Verbesserung des Layouts
1.15
21. Mai 2010
sk Korrekturen von Fehlern und Einschränkungen
1.14
28. März 2010
sk Fehlerkorrekturen und Leistungssteigerung
1.13
18. Dezember 2009
sk Aktualisierung wegen beschädigtem Tar-Archiv
1.12
18. Dezember 2009
sk Neue Funktionsmerkmale und Fehlerkorrekturen
1.11
16. November 2008
mal Migration auf die gnome-doc-utils

## Einführung

Dieses Kapitel führt in GTK-Doc ein und gibt einen Überblick darüber, worum es sich dabei handelt und wie es benutzt wird.

### Was ist GTK-Doc?

GTL-Doc wird zur Dokumentation von C-Code verwendet. Üblicherweise wird damit die öffentliche API von Bibliotheken dokumentiert, wie die der GTK+- und GNOME-Bibliotheken. Es kann aber auch zur Dokumentation von Anwendungscode verwendet werden.

### Wie funktioniert GTK-Doc?

GTK-Doc verwendet Funktionsdokumentationen, die sich in den Quelldateien innerhalb speziell formatierter Kommentarblöcke befinden, oder Dokumentation, die zu den von GTK-Doc verwendeten Vorlagendateien hinzugefügt wurde. Beachten Sie jedoch, dass GTK-Doc nur Funktionen dokumentieren wird, die in den Header-Dateien deklariert sind. Es erstellt keine Ausgaben für statische Funktionen.

GTK-Doc besteht aus einer Anzahl von Perl-Skripten, wovon jedes einen bestimmten Schritt in dem Prozess ausführt.

Dieser Vorgang umfasst fünf Hauptschritte:

1. Schreiben der Dokumentation. Der Autor ergänzt die Quelldateien um die Dokumentation für jede Funktion, jedes Makro usw. In der Vergangenheit wurden diese Informationen in erstellte Vorlagendateien eingegeben. Dies wird nicht mehr empfohlen.

2. Gathering information about the code. gtkdoc-scan scans the header files of the code looking for declarations of functions, macros, enums, structs, and unions. It creates the file `<module>-decl-list.txt` containg a list of the declarations, placing them into sections according to which header file they are in. On the first run this file is copied to `<module>-sections.txt`. The author can rearrange the sections, and the order of the declarations within them, to produce the final desired order. The second file it generates is `<module>-decl.txt`. This file contains the full declarations found by the scanner. If for some reason one would like some symbols to show up in the docs, where the full declaration cannot be found by the scanner or the declaration should appear differently, one can place enties similar to the ones in `<module>-decl.txt` into `<module>-overrides.txt`. gtkdoc-scanobj can also be used to dynamically query a library about any GtkObject subclasses it exports. It saves information about each object's position in the class hierarchy and about any GTK Args and Signals it provides.

3. Generating the "template" files. gtkdoc-mktmpl creates a number of files in the `tmpl/` subdirectory, using the information gathered in the first step. (Note that this can be run repeatedly. It will try to ensure that no documentation is ever lost.)

   Since GTK-Doc 1.9 the templates can be avoided. We encourage people to keep documentation in the code. gtkdocize supports now a `--flavour no-tmpl` option that chooses a makefile that skips tmpl usage totally. If you have never changed file in tmpl by hand, please remove the dir (e.g. from version control system).

4. Generating the SGML/XML and HTML/PDF. gtkdoc-mkdb turns the template files into SGML or XML files in the `sgml/` or `xml/` subdirectory. If the source code contains documentation on functions, using the special comment blocks, it gets merged in here. If there are no tmpl files used it only reads docs from sources and introspection data. We recommend to use Docbook XML.

   gtkdoc-mkhtml konvertiert die SGML/XML-Dateien in HTML-Dateien im Unterordner `html/`. Ebenso konvertiert gtkdoc-mkpdf die SGML/XML-Dateien in ein PDF-Dokument namens `<package>.pdf`.

   Dateien in `sgml/` oder `xml/` und `html/`-Ordnern werden immer überschrieben. Niemand sollte diese direkt bearbeiten.

5. Fixing up cross-references between documents. After installing the HTML files, gtkdoc-fixxref can be run to fix up any cross-references between separate documents. For example, the GTK+ documentation contains many cross-references to types documented in the GLib manual. When creating the source tarball for distribution, gtkdoc-rebase turns all external links into web-links. When installing distributed (pregenerated) docs the same application will try to turn links back to local links (where those docs are installed).

### GTK-Doc bekommen

#### Erfordernisse

Perl v5 - Die Hauptskripte wurden in Perl geschrieben.

DocBook DTD v3.0 - Die DTD für DocBook SGML. http://www.ora.com/davenport

Jade v1.1 - Dies ist ein DSSSL-Prozessor zur Umwandlung von SGML in verschiedene Formate. http://www.jclark.com/jade

Modulare DocBook-Stilvorlagen Dies ist der DSSSL-Code zur Umwandlung von DocBook in HTML und einige andere Formate. Es wird zusammen mit Jade benutzt. Ich habe den DSSSL-Code in gtk-doc.dsl etwas angepasst, um die Programmcode-Listings und -Deklarationen einzufärben und um globale Cross-Reference-Indizes im erzeugten HTML zu unterstützen. http://nwalsh.com/docbook/dsssl

docbook-to-man - if you want to create man pages from the DocBook. I've customized the 'translation spec' slightly, to capitalise section headings and add the 'GTK Library' title at the top of the pages and the revision date at the bottom. There is a link to this on http://www.ora.com/davenport NOTE: This does not work yet.

#### Installation

Es gibt keinen Standardort, an welchem die Modularen DocBook-Stilvorlagen installiert werden.

Das Configure-Skript von GTK-Doc durchsucht folgende drei Ordner automatisch:

`/usr/lib/sgml/stylesheets/nwalsh-modular` (verwendet von RedHat)

`/usr/lib/dsssl/stylesheets/docbook` (verwendet von Debian)

`/usr/share/sgml/docbkdsl` (verwendet von SuSE)

Falls sie Stilvorlagen an anderen Orten installiert haben, müssen Sie GTK-Doc mit folgender Option konfigurieren: `--with-dsssl-dir=<PFAD_ZUM_BASISORDNER_DER_STILVORLAGEN>`

### Info zu GTK-Doc

(FIXME)

(Geschichte, Autoren, Webseiten, Lizenz, Zukunftspläne, Vergleich mit ähnlichen Systemen)

### Über dieses Handbuch

(FIXME)

(wofür es bestimmt ist, wo Sie es erhalten können, Lizenz)

## Einrichten Ihre Projekts

Die nächsten Abschnitte beschreiben die notwendigen Schritte, um GTK-Doc in Ihr Projekt zu integrieren. Nehmen wir an, wir arbeiten an einem Projekt namens »meep«. Das Projekt enthält eine Bibliothek namens »libmeep« sowie eine Endbenutzer-Anwendung namens »meeper«. Weiterhin gehen wir davon aus, dass wir autoconf und automake verwenden. Zusätzlich beschreibt der Abschnitt Klartext-Makefiles oder andere Erstellungssysteme die Grundlagen für die Arbeit in einer anderen Erstellungsumgebung.

### Einrichten des Grundgerüsts der Dokumentation

Erstellen Sie in dem Ordner der obersten Ebene des Projekts die Unterordner namens docs/reference. Auf diese Weise können Sie auch docs/help für die Endbenutzerdokumentation anlegen. Es ist empfehlenswert, einen weiteren Unterordner mit dem Namen des Dokumentationspakets anzulegen. Für Pakete, die nur eine einzige Bibliothek enthalten, ist dieser Schritt nicht notwendig.

Dies kann dann wie nachstehend angezeigt aussehen:

Beispiel für die Ordnerstruktur

    meep/
      docs/
        reference/
          libmeep/
          meeper/
      src/
        libmeep/
        meeper/

### Integration in autoconf

Sehr einfach! Fügen Sie eine Zeile zu Ihrem `configure.ac`-Skript hinzu.

Integration in autoconf

    # check for gtk-doc
    GTK_DOC_CHECK([1.14],[--flavour no-tmpl])

This will require all developers to have gtk-doc installed. If it is okay for your project to have optional api-doc build setup, you can solve this as below. Keep it as is, as gtkdocize is looking for `GTK_DOC_CHECK` at the start of a line.

Keep gtk-doc optional

    # check for gtk-doc
    m4_ifdef([GTK_DOC_CHECK], [
    GTK_DOC_CHECK([1.14],[--flavour no-tmpl])
    ],[
    AM_CONDITIONAL([ENABLE_GTK_DOC], false)
    ])

Das erste Argument wird zur Überprüfung von gtkdocversion während des configure-Durchlaufs benutzt. Das zweite, optionale Argument wird von gtkdocize verwendet. Das Makro GTK_DOC_CHECK fügt verschiedene Schalter für configure hinzu:

1. --with-html-dir=PATH : Pfad zur installierten Dokumentation

2. --enable-gtk-doc : gtk-doc zur Erstellung der Dokumentation verwenden [Vorgabe=no]

3. --enable-gtk-doc-html : Erstellung der Dokumentation im HTML-Format [Vorgabe=yes]

4. --enable-gtk-doc-pdf : Erstellung der Dokumentation im PDF-Format [Vorgabe=no]

GTK-Doc ist standardmäßig deaktiviert! Denken Sie daran, die Option `'--enable-gtk-doc'` beim nächsten Durchlauf von `configure` zu übergeben. Anderenfalls wird die vorher erstellte Dokumentation installiert. Dies ergibt für Benutzer durchaus Sinn, aber nicht für Entwickler.

Weiterhin ist es empfehlenswert, dass das `configure.ac`-Skript die folgende Zeile enthält. Dies erlaubt gtkdocize das automatische Kopieren der Makrodefinition für `GTK_DOC_CHECK` in Ihr Projekt.

Vorbereitung für gtkdocize

    AC_CONFIG_MACRO_DIR(m4)

### Integration in automake

Kopieren Sie zunächst die Datei `Makefile.am` aus dem Beispiel-Unterordner der gtkdoc-sources in den API-Dokumentationsordner Ihres Projekts ( `./docs/reference/<package>`). Falls Sie mehrere Dokumentationspakete haben, müssen Sie dies für jedes davon wiederholen.

Im nächsten Schritt bearbeiten Sie die Einstellungen in `Makefile.am`. Allen Einstellungen ist ein Kommentar vorangestellt, der den jeweiligen Zweck beschreibt. Die meisten Einstellungen sind zusätzliche Flags, die an verschiedene Werkzeuge übergeben werden. Jedes der Werkzeuge hat eine Variable der Form `<WERKZEUGNAME>_OPTIONEN`. Alle Werkzeuge unterstützen `--help` zur Auflistung der unterstützten Parameter.

Vielleicht möchten Sie auch GTK-Doc für das distcheckmake-Ziel aktivieren. Fügen Sie dazu den im nächsten Beispiel gezeigten Einzeiler zur Datei `Makefile.am` der obersten Ebene hinzu:

GTK-Doc während »make distcheck« aktivieren

    DISTCHECK_CONFIGURE_FLAGS=--enable-gtk-doc

### Integration in autogen

Die meisten Projekte dürften über ein `autogen.sh`-Skript verfügen, welches die Build-Infrastruktur nach dem Auschecken aus einem Versionsverwaltungssystem wie CVS, SVN oder Git erzeugt. GTK-Doc liefert ein Werkzeug namens gtkdocize mit, das in einem solchen Skript verwendet werden kann. Es sollte vor autoheader, automake oder autoconf ausgeführt werden.

Ausführen von gtkdocize durch autogen.sh

    gtkdocize || exit 1

Beim Ausführen von gtkdocize wird `gtk-doc.make` in die Wurzel Ihres Projekts oder in jeden anderen durch die Option `--docdir` festgelegten Ordner kopiert. Außerdem wird das configure-Skript daraufhin überprüft, ob `GTK_DOC_CHECK` enthalten ist. Dieses Makro kann verwendet werden, um weitere Parameter an gtkdocize zu übergeben.

In früherer Zeit erzeugte GTK-Doc die Vorlagendateien dort, wo die Entwickler die Dokumentaion platzierten. Das stellte sich als nicht optimal heraus, beispielsweise um generierte Dateien unter Versionskontrolle zu haben. Seit einigen Versionen kann GTK-Doc auch sämtliche Informationen aus Quellcode-Kommentaren ermitteln. Seit GTK-Doc 1.9 sind diese Vorlagen nicht mehr notwendig. Wir ermutigen die Entwickler, die Dokumentation innerhalb des Codes zu halten. gtkdocize unterstützt nun die Option `--flavour no-tmpl`, wodurch ein Makefile gewählt wird, welches die Verwendung der Vorlagen komplett umgeht. Neben der Möglichkeit, diese Option direkt beim Befehlsaufruf zu übergeben, kann Sie auch zu einer Umgebungsvariable namens GTKDOCIZE_FLAGS hinzugefügt oder als zweiter Parameter im GTK_DOC_CHECK-Makro im Konfigurationsskript aufgeführt werden. Falls Sie niemals Dateien im Vorlagenordner manuell bearbeitet oder aus älteren GTK-Doc-Versionen importiert haben, sollten Sie den Ordner löschen, z.B. in der Versionsverwaltung.

### Erstellung der Dokumentation

Nach den bisher absolvierten Schritten ist es Zeit für den Build-Vorgang. Zunächst muss `autogen.sh` erneut ausgeführt werden. Falls dieses Skript auch den configure-Aufruf enthält, sollten Sie die Option `--enable-gtk-doc` hinzufügen. Anderenfalls führen Sie danach `configure` manuell aus, ebenfalls mit dieser Option.

Der erste Durchlauf von make erstellt verschiedene zusätzliche Dateien in den Dokumentationsordnern. Die bedeutendsten davon sind: `<package>.types`, `<package>-docs.xml` (früher .sgml), `<package>-sections.txt`.

Erstellung der Dokumentation

    ./autogen.sh --enable-gtk-doc
    make

Nun können Sie `docs/reference/<package>/index.html` in Ihrem Browser öffnen. Zugegeben, das Ergebnis ist noch ein wenig enttäuschend. Im nächsten Abschnitt zeigen wir Ihnen, wie Sie die Seiten mit Leben füllen können.

### Integration in Versionsverwaltungssysteme

Als Faustregel gilt, dass alle von Ihnen bearbeiteten Dateien auch unter Versionsverwaltung stehen sollten. In typischen Projekten sind das folgende Dateien: `<package>.types`, `<package>-docs..xml` (früher .sgml), `<package>-sections.txt`, `Makefile.am`.

### Integration in Klartext-Makefiles oder andere Erstellungssysteme

In the case one does not want to use automake and therfore `gtk-doc.mak` one will need to call the gtkdoc tools in the right order in own makefiles (or other build tools).

Schritte zur Erstellung der Dokumentation

    DOC_MODULE=meep
    // sources have changed
    gtkdoc-scan --module=$(DOC_MODULE) --source-dir=...
    gtkdoc-scangobj --module=$(DOC_MODULE)
    gtkdoc-mkdb --module=$(DOC_MODULE) --output-format=xml
    // xml files have changed
    mkdir html
    cd html && gtkdoc-mkhtml $(DOC_MODULE) ../meep-docs.xml
    gtkdoc-fixxref --module=$(DOC_MODULE) --module-dir=html

One will need to look at the `Makefile.am` and `gtk-doc.mak` to pick the extra options needed.

## Dokumentieren des Codes

GTK-Doc benutzt Quellcode-Kommentare mit einer speziellen Syntax für Code-Dokumentation. Weiterhin werden Informationen über Ihre Projektstruktur aus anderen Quellen geholt. Im nächsten Abschnitt finden sie umfassende Informationen über die Syntax der Kommentare.

Platzierung der Dokumentation

In der Vergangenheit wurde die Dokumentation oft in Dateien gespeichert, die im Ordner `tmpl` liegen. Das hat den Nachteil, dass die Informationen oft nicht aktualisiert wurden und die Datei tendenziell Konflikte mit Versionsverwaltungssystemen verursachen kann.

Um die bereits genannten Probleme zu vermeiden, empfehlen wir, die Dokumentation innerhalb der Quellen zu halten. In diesem Handbuch wird ausschließlich dieser Weg des Dokumentierens des Quellcodes beschrieben.

The scanner can handle the majority of c headers fine. In the case of receiving warnings from the scanner that look like a special case, one can hint GTK-Doc to skip over them.

GTK-Doc-Kommentarblock

    #ifndef __GTK_DOC_IGNORE__
    /* unparseable code here */
    #endif

### Kommentare zur Dokumentation

Ein mehrzeiliger Kommentar, der mit einem zusätzlichen »*« beginnt, markiert einen Kommentarblock, der von den Werkzeugen in GTK-Doc verarbeitet wird.

GTK-Doc-Kommentarblock

    /**
     * identifier:
     * documentation ...
     */

Der »identifier« ist eine Zeile mit dem Namen des Objekts, auf das sich der Kommentar bezieht. Die Syntax kann abhängig von der Art des Objekts variieren.

Der Block »documentation« ist ebenfalls für jeden Symboltyp unterschiedlich. Symboltypen mit Parametern wie Funktionen oder Makros haben eine Parameterbeschreibung, auf die eine leere Zeile folgt (keine echte Leerzeile, sondern ein »*«).Danach folgt eine detaillierte Beschreibung. Alle Zeilen (außerhalb von Programmlistings und CDATA-Abschnitten, die nur ein solches »*« enthalten, werden in Absatzumbrüche umgewandelt. Falls Sie keinen Absatzumbruch wünschen, verwenden sie stattdessen ein » * «, d.h. setzen Sie ein Leerzeichen jeweils davor und dahinter.

Beim Dokumentieren von Code beschreiben Sie zwei Aspekte:

- What it is: The name for a class or function can sometimes be misleading for people coming from a different background.

- What it does: Tell about common uses. Put it in releation with the other API.

Ein Vorteil von Hypertext gegenüber Klartext ist die Möglichkeit, Verknüpfungen im Dokument zu verwenden. Das Schreiben eines korrekten Markups für eine solche Verknüpfung kann allerdings langatmig sein, deshalb stellt GTK-Doc eine Reihe von praktischen Abkürzungen bereit.

- Verwenden Sie function(), um einen Bezug zu Funktionen oder Makros herzustellen, die Argumente akzeptieren.

- Verwenden Sie @param, um einen Bezug zu Parametern herzustellen. Verwenden Sie dies auch, wenn es um einen Bezug zu Parametern anderer Funktionen geht, bezogen auf jene, die Sie gerade beschreiben.

- Benutzen Sie %constant, um einen Bezug auf eine Konstante herzustellen, z.B. %G_TRAVERSE_LEAFS.

- Verwenden Sie #symbol, um auf andere Symboltypen zu verweisen, z.B. »structs« und »enums« und Makros, die keine Argumente benötigen.

- Verwenden Sie #Object::signal, um auf ein GObject-Signal zu verweisen

- Verwenden Sie #Object:property, um auf eine GObject-Eigenschaft zu verweisen.

- Verwenden Sie #Struct.field, um auf ein Feld innerhalb einer Struktur zu verweisen.

Falls Sie die Sonderzeichen »<«, »>«, »()«, »@«, »%« oder »#« in Ihrer Dokumentation verwenden wollen, ohne dass GTK-Doc diese ändert, können Sie die XML-Entitäten »&lt;«, »&gt;«, »&lpar;«, »&rpar;«, »&commat;«, »&percnt;« und »&num;« verwenden oder die Zeichen mit einem Backslash »\« maskieren.

DocBook kann mehr als nur verknüpfen. Sie können auch Listen, Tabellen und Beispiele einbauen. Um die Nutzung der DocBook-SGML/XML-Tags innerhalb der Dokumentationskommentare zu aktivieren, übergeben Sie der Variable MKDB_OPTIONS in der Datei `Makefile.am` die Option `--xml-mode` oder `--sgml-mode`.

Since GTK-Doc-1.18 the tool supports a subset or the markdown language. One can use it for sub-headings and simple itemized lists. On older GTK-Doc versions the content will be rendered as it (the list items will appear in one line separated by dashes).

GTK-Doc comment block using markdown

    /**
     * identifier:
     *
     * documentation ...
     *
     * # Sub heading #
     *
     * more documentation:
     * - list item 1
     * - list item 2
     *
     * Even more docs.
     */

Wie an früherer Stelle bereits erwähnt, ist GTK-Doc für das Dokumentieren der öffentlichen API gedacht. Daher kann man keine Dokumentation für statische Symbole schreiben. Nichtsdestotrotz ist es jedoch gut, diese Symbole trotzdem zu dokumentieren. Dies hilft anderen, Ihren Code besser zu verstehen. Deswegen empfehlen wir, hierfür normale Kommentare zu verwenden, ohne das zweite »*« in der ersten Zeile. Falls später die Funktion veröffentlicht werden soll, ist es lediglich nötig, im Kommentarblock ein zweites »*« hinzuzufügen und den Symbolnamen an der richtigen Stelle in die Abschnittsdatei einzubauen.

### Dokumentieren von Abschnitten

Jeder Abschnitt der Dokumentation enthält Informationen über eine Klasse oder ein Modul. Um eine Komponente hinzuzufügen, können Sie einen Abschnittsblock schreiben. Die Kurzbeschreibung wird auch im Inhaltsverzeichnis verwendet. Alle @-Felder sind optional.

Section comment block

    /**
     * SECTION:meepapp
     * @short_description: the application class
     * @title: Meep application
     * @section_id:
     * @see_also: #MeepSettings
     * @stability: Stable
     * @include: meep/app.h
     * @image: application.png
     *
     * The application class handles ...
     */

SECTION:<name>

  Der Name verweist auf die Abschnittsdokumentation des entsprechenden Teils der Datei `<package>-sections.txt`. Der hier angegebene Name sollte der Markierung <FILE> in der Datei `<package>-sections.txt` entsprechen.

@short_description

  Eine einzeilige Beschreibung des Abschnitts, die später hinter den Verweisen im Inhaltsverzeichnis und oben in der Abschnittsseite erscheint.

@title

  Der Abschnittstitel in der SECTION-Deklaration, Vorgabe ist <name>. Er kann im Feld @title überschrieben werden.

@section_id

  Overrides the use of title as a section identifier. For GObjects the <title> is used as a section_id and for other sections it is <MODULE>-<title>.

@see_also

  Eine Liste von Symbolen, welche sich auf diesen Abschnitt beziehen.

@stability

  Eine informelle Beschreibung der Stabilitätsstufe dieser API. Wir empfehlen dafür einen der folgenden Begriffe:

  - Stable - The intention of a Stable interface is to enable arbitrary third parties to develop applications to these interfaces, release them, and have confidence that they will run on all minor releases of the product (after the one in which the interface was introduced, and within the same major release). Even at a major release, incompatible changes are expected to be rare, and to have strong justifications.

  - Unstable - Unstable interfaces are experimental or transitional. They are typically used to give outside developers early access to new or rapidly changing technology, or to provide an interim solution to a problem where a more general solution is anticipated. No claims are made about either source or binary compatibility from one minor release to the next.

  - Private - An interface that can be used within the GNOME stack itself, but that is not documented for end-users. Such functions should only be used in specified and documented ways.

  - Internal - An interface that is internal to a module and does not require end-user documentation. Functions that are undocumented are assumed to be Internal.

@include

  The `#include` files to show in the section synopsis (a comma separated list), overriding the global value from the section file or command line. This item is optional.

@image

  Das Bild, das am Beginn einer Referenzseite für diesen Abschnitt angezeigt wird. Meist wird es eine Art Diagramm für visuelle Erscheinungsbild einer Klasse oder ein Diagramm sein, das die Beziehungen zu anderen Klassen darstellt. Dieses Objekt ist optional.

Um unnötiges Rekompilieren nach Dokumentationsänderungen zu vermeiden, platzieren Sie die Abschnittsdokumentation in die C-Quellen, wo immer es möglich ist.

### Dokumentieren von Symbolen

Jedes Symbol (function, macro, struct, enum, signal und property) wird in einem separaten Block dokumentiert. Der Block wird am besten nahe der Definition der Symbole platziert, so dass es leichter ist, diese synchron zu halten. Die Funktion wird üblicherweise in den C-Quellen definiert, »macro«, »struct« und »enum« dagegen in der Header-Datei.

#### Allgemeine Markierungen

Sie können Versionsinformationen zu allen Dokumentationselementen hinzufügen, um darauf hinzuweisen, wann eine API eingeführt oder wann sie als veraltet markiert wurde.

Versionierungs-Markierungen

Since:

  Beschreibung, seit welcher Version des Codes die API verfügbar ist.

Deprecated:

  Absatz, der darüber informiert, dass diese Funktion nicht mehr genutzt werden sollte. Die Beschreibung sollte einen Verweis auf die neue API enthalten.

(FIXME : Stabilitätsinformation)

Allgemeine Markierungen

    /**
     * foo_get_bar:
     * @foo: some foo
     *
     * Retrieves @foo's bar.
     *
     * Returns: @foo's bar
     *
     * Since: 2.6
     * Deprecated: 2.12: Use foo_baz_get_bar() instead.
     **/
    Bar *
    foo_get_bar(Foo *foo)
    {
    ...

#### Kommentarblock einer Funktion

Bitte denken Sie an:

- Document whether returned objects, lists, strings, etc, should be freed/unrefed/released.

- Dokumentiert, ob Parameter NULL sein können, und was in diesem Fall geschieht.

- Erwähnen Sie interessante Vorbedingungen (und nachfolgende Bedingungen), wo es nützlich erscheint.

GTK-Doc nimmt an, dass alle Symbole (Makros, Funktionen), die mit »_« beginnen, privat sind. Sie werden wie statische Funktionen behandelt.

Werfen Sie auch einen Blick auf die »gobject introspection annotation tags«: http://live.gnome.org/GObjectIntrospection/Annotations

Kommentarblock einer Funktion

    /**
     * function_name:
     * @par1:  description of parameter 1. These can extend over more than
     * one line.
     * @par2:  description of parameter 2
     * @...: a %NULL-terminated list of bars
     *
     * The function description goes here. You can use @par1 to refer to parameters
     * so that they are highlighted in the output. You can also use %constant
     * for constants, function_name2() for functions and #GtkWidget for links to
     * other declarations (which may be documented elsewhere).
     *
     * Returns: an integer.
     *
     * Since: 2.2
     * Deprecated: 2.18: Use other_function() instead.
     */

Funktions-Tags

Returns:

  Abschnitt, der das zurückgegebene Ergebnis beschreibt.

@...:

  In case the function has variadic arguments, you should use this tag (@Varargs: does also work for historic reasons).

#### Property-Kommentarblock

Property-Kommentarblock

    /**
     * SomeWidget:some-property:
     *
     * Here you can document a property.
     */
    g_object_class_install_property (object_class, PROP_SOME_PROPERTY, ...);

#### Signal-Kommentarblock

Bitte denken Sie an:

- Dokumentiert, wann ein Signal ausgegeben wird und ob es vor oder nach anderen Signalen ausgegeben wird.

- Dokumentiert, was eine Anwendung in dem Signal-Handler tun könnte.

Signal-Kommentarblock

    /**
     * FooWidget::foobarized:
     * @widget: the widget that received the signal
     * @foo: some foo
     * @bar: some bar
     *
     * The ::foobarized signal is emitted each time someone tries to foobarize @widget.
     */
    foo_signals[FOOBARIZE] =
      g_signal_new ("foobarize",
                    ...

#### Struct-Kommentarblock

Struct-Kommentarblock

    /**
     * FooWidget:
     * @bar: some #gboolean
     *
     * This is the best widget, ever.
     */
    typedef struct _FooWidget {
      /*< private >*/
      GtkWidget parent;

      /*< public >*/
      gboolean bar;
    } FooWidget;

Verwenden Sie `/*< private >*/` vor den privaten »struct«-Feldern, die Sie verbergen wollen. Um das umgekehrte Verhalten zu erzielen, verwenden Sie `/*< public >*/`.

Struct comment blocks can also be used for GObjects and GObjectClasses. It is usualy a good idea to add a comment blco for a class, if it has vmethods (as this is how they can be documented). For the GObject itself one can use the related section docs, having a separate block for the instance struct would be useful if the instance has public fields. One disadvantage here is that this creates two index entries of the same name (the structure and the section).

#### Enum-Kommentarblock

Enum-Kommentarblock

    /**
     * Something:
     * @SOMETHING_FOO: something foo
     * @SOMETHING_BAR: something bar
     *
     * Enum values used for the thing, to specify the thing.
     *
     **/
    typedef enum {
      SOMETHING_FOO,
      SOMETHING_BAR,
      /*< private >*/
      SOMETHING_COUNT
    } Something;

Verwenden Sie `/*< private >*/` vor den privaten »enum«-Werten, die Sie verbergen wollen. Um das umgekehrte Verhalten zu erzielen, verwenden Sie `/*< public >*/`.

### Nützliche DocBook-Tags

Nachfolgend finden Sie einige DocBook-Tags, die beim Dokumentieren von Code nützlich sein können.

So erstellen Sie eine Verknüpfung zu einem anderen Abschnitt in den GTK-Docs:

    <link linkend="glib-Hash-Tables">Hash Tables</link>

»linkend« ist dabei die SGML-XML-Kennung des obersten Elements der Seite, auf welche die Verknüpfung zielt (»gtk«, »gdk«, »glib«), danach folgt der Seitentitel ("Hash Tables"). Für Widgets ist dies einfach der Klassenname. Leerzeichen und Unterstriche werden SGML/XML-konform in »-« umgewandelt.

Für einen Bezug zu einer externen Funktion, z.B. einer C-Standardfunktion:

    <function>...</function>

So fügen Sie Beispielcode ein:

    <example>
      <title>Using a GHashTable.</title>
      <programlisting>
          ...
      </programlisting>
    </example>

Vielleicht auch so, für sehr kurze Codeschnipsel, die keinen Titel benötigen:

    <informalexample>
      <programlisting>
      ...
      </programlisting>
    </informalexample>

Außerdem unterstützt GTK-Doc auch eine Abkürzung: |[ ... ]|

Für eine Liste mit Aufzählungszeichen:

    <itemizedlist>
      <listitem>
        <para>
          ...
        </para>
      </listitem>
      <listitem>
        <para>
          ...
        </para>
      </listitem>
    </itemizedlist>

Für eine nicht zum eigentlichen Text gehörende Notiz:

    <note>
      <para>
        Make sure you free the data after use.
      </para>
    </note>

Für einen Bezug zu einem Typ:

    <type>unsigned char</type>

Für einen Bezug zu einer externen Struktur (die nicht in den GTK-Docs beschrieben wird:

    <structname>XFontStruct</structname>

Für einen Bezug zu einem Feld einer Struktur:

    <structfield>len</structfield>

To refer to a class name, we could possibly use:

    <classname>GtkWidget</classname>

but you'll probably be using #GtkWidget instead (to automatically create a link to the GtkWidget page - see the abbreviations).

Zum Hervorheben von Text:

    <emphasis>This is important</emphasis>

Für Dateinamen:

    <filename>/home/user/documents</filename>

To refer to keys use:

    <keycombo><keycap>Control</keycap><keycap>L</keycap></keycombo>

## Füllen der zusätzlichen Dateien

Es gibt eine Menge zusätzlicher Dateien, die mit den eingebetteten Quellcode-Kommentaren verwaltet werden müssen: `<package>.types`, `<package>-docs.xml` (früher .sgml), `<package>-sections.txt`.

### Bearbeiten der Typendatei

Falls Ihre Bibliothek oder Anwendung GtkObjects/GObjects beinhaltet, sollten deren Signale, Argumente/Parameter und Positionen in der Hierarchie in der Dokumentation erscheinen. Alles was Sie tun müssen, ist die `xxx_get_type`Funktionen zusammen mit deren Includes in der Datei `<package>.types` aufzulisten.

Example types file snippet

    #include <gtk/gtk.h>

    gtk_accel_label_get_type
    gtk_adjustment_get_type
    gtk_alignment_get_type
    gtk_arrow_get_type

Since GTK-Doc 1.8 gtkdoc-scan can generate this list for you. Just add "--rebuild-types" to SCAN_OPTIONS in `Makefile.am`. If you use this approach you should not dist the types file nor have it under version control.

### Bearbeiten des Master-Dokuments

GTK-Doc erstellt die Dokumentation in DocBook-SGML/XML. Beim Verarbeiten der in den Quellcode eingebetteten Kommentare erzeugt GTK-Doc eine Dokumentationsseite pro Klasse oder Modul als separate Datei. Das Hauptdokument schließt diese ein und setzt sie in die passende Reihenfolge.

While GTK-Doc creates a template master document for you, later run will not touch it again. This means that one can freely structure the documentation. That includes grouping pages and adding extra pages. GTK-Doc has now a test suite, where also the master-document is recreated from scratch. Its a good idea to look at this from time to time to see if there are some new goodies introduced there.

Erstellen Sie keine Schritt-für-Schritt-Anleitungen als zusätzliche Dokumente. Schreiben Sie lediglich zusätzliche Kapitel. Der Vorteil des direkten Einbettens einer Anleitung für Ihre Bibliothek in die API ist die Möglichkeit der einfachen Verknüpfung der Schritt-für-Schritt-Anleitung zur Symboldokumentation. Außerdem sind die Chancen größer, dass die Anleitung die gleichen Aktualisierungen erfährt wie die Bibliothek selbst.

Was sollte nun innerhalb des Master-Dokuments geändert werden? Zunächst recht wenig. Es gibt einige Platzhalter (Text in eckigen Klammern), die Sie beachten sollten.

Kopfzeile des Master-Dokuments

    <bookinfo>
      <title>MODULENAME Reference Manual</title>
      <releaseinfo>
        for MODULENAME [VERSION]
        The latest version of this documentation can be found on-line at
        <ulink role="online-location" url="http://[SERVER]/MODULENAME/index.html">http://[SERVER]/MODULENAME/</ulink>.
      </releaseinfo>
    </bookinfo>

    <chapter>
      <title>[Insert title here]</title>

### Bearbeiten der Abschnittsdatei

The section file is used to organise the documentation output by GTK-Doc. Here one specifies which symbol belongs to which module or class and control the visibility (public or private).

The section file is a plain test file with xml like syntax (using tags). Blank lines are ignored and lines starting with a '#' are treated as comment lines.

The <FILE> ... </FILE> tag is used to specify the file name, without any suffix. For example, using '<FILE>gnome-config</FILE>' will result in the section declarations being output in the template file `tmpl/gnome-config.sgml`, which will be converted into the DocBook SGML/XML file `sgml/gnome-config.sgml` or .DocBook XML file `xml/gnome-config.xml`. (The name of the html file is based on the module name and the section title, or for gobjects it is based on the gobjects class name converted to lower case).

The <TITLE> ... </TITLE> tag is used to specify the title of the section. It is only useful before the templates (if used) are initially created, since the title set in the template file overrides this. Also if one uses SECTION comment in the sources, this is obsolete.

You can group items in the section by using the <SUBSECTION> tag. Currently it outputs a blank line between subsections in the synopsis section. You can also use <SUBSECTION Standard> for standard GObject declarations (e.g. the functions like g_object_get_type and macros like G_OBJECT(), G_IS_OBJECT() etc.). Currently these are left out of the documentation. You can also use <SUBSECTION Private> for private declarations which will not be output (It is a handy way to avoid warning messages about unused declarations.). If your library contains private types which you don't want to appear in the object hierarchy and the list of implemented or required interfaces, add them to a Private subsection. Wheter you would place GObject and GObjectClass like structs in public or Standard section depends if they have public entries (variables, vmethods).

You can also use <INCLUDE> ... </INCLUDE> to specify the #include files which are shown in the synopsis sections. It contains a comma-separate list of #include files, without the angle brackets. If you set it outside of any sections, it acts for all sections until the end of the file. If you set it within a section, it only applies to that section.

## Überprüfung des Ergebnisses

Ein GTK-Doc-Durchlauf erzeugt Protokolldateien im Dokumentationsordner. Die Namen der erzeugten Dateien sind: `<package>-undocumented.txt`, `<package>-undeclared.txt` und `<package>-unused.txt`. Sie liegen alle als Klartext vor und können daher einfach betrachtet und weiterverarbeitet werden.

The `<package>-undocumented.txt` file starts with the documentation coverage summary. Below are two sections divided by blank lines. The first section lists undocumented or incomplete symbols. The second section does the same for section docs. Incomplete entries are those, which have documentation, but where e.g. a new parameter has been added.

The `<package>-undeclared.txt` file lists symbols given in the `<package>-sections.txt` but not found in the sources. Check if they have been removed or if they are misspelled.

The `<package>-unused.txt` file lists symbol names, where the GTK-Doc scanner has found documentation, but does not know where to put it. This means that the symbol has not yet been added to the `<package>-sections.txt` file.

Enable or add the `TESTS=$(GTKDOC_CHECK)` line in Makefile.am. If at least GTK-Doc 1.9 is installed, this will run sanity checks during `make check` run.

One can also look at the files produced by the source code scanner: `<package>-decl-list.txt` and `<package>-decl.txt`. The first one can be compared with the section file if that is manualy maintained. The second lists all declarations fromt he headers If a symbol is missing one could check if this file contains it.

If the project is GObject based, one can also look into the files produced by the object scanner: `<package>.args.txt`, `<package>.hierarchy.txt`, `<package>.interfaces.txt`, `<package>.prerequisites.txt` and `<package>.signals.txt`. If there are missing symbols in any of those, one can ask gtkdoc to keep the intermedia scanner file for further analysis, but running it as `GTK_DOC_KEEP_INTERMEDIATE=1 make`.

## Dokumentieren anderer Schnittstellen

Bis jetzt haben wir GTK-Doc nur dazu verwendet, die API des Codes zu dokumentieren. In den nächsten Abschnitten finden Sie Vorschläge, wie die Werkzeuge zum Dokumentieren anderer Schnittstellen eingesetzt werden können.

### Befehlszeilenoptionen und Handbuchseiten

As one can generate man pages for a docbook refentry as well, it sounds like a good idea to use it for that purpose. This way the interface is part of the reference and one gets the man-page for free.

#### Dokumentieren des Werkzeuges

Create one refentry file per tool. Following our example we would call it `meep/docs/reference/meeper/meep.xml`. For the xml tags that should be used and can look at generated file in the xml subdirectory as well as examples e.g. in glib.

#### Hinzufügen der zusätzlichen Configure-Überprüfungen

Zusätzliche Configure-Überprüfungen

    AC_ARG_ENABLE(man,
                  [AC_HELP_STRING([--enable-man],
                                  [regenerate man pages from Docbook [default=no]])],enable_man=yes,
                  enable_man=no)

    AC_PATH_PROG([XSLTPROC], [xsltproc])
    AM_CONDITIONAL(ENABLE_MAN, test x$enable_man != xno)

#### Hinzufügen der zusätzlichen Makefile-Regeln

Zusätzliche Configure-Überprüfungen

    man_MANS = \
           meeper.1

    if ENABLE_GTK_DOC
    if ENABLE_MAN

    %.1 : %.xml
            @XSLTPROC@ -nonet http://docbook.sourceforge.net/release/xsl/current/manpages/docbook.xsl $<

    endif
    endif

    BUILT_EXTRA_DIST = $(man_MANS)
    EXTRA_DIST += meep.xml

### DBus-Schnittstellen

(FIXME: http://hal.freedesktop.org/docs/DeviceKit/DeviceKit.html, http://cgit.freedesktop.org/DeviceKit/DeviceKit/tree/doc/dbus)

## Häufig gestellte Fragen

Frage Antwort
- Keine Klassenhierarchie. Die `xxx_get_type()`-Funktion des Objekts wurde nicht in die Datei `<package>.types` eingegeben.
- Noch immer keine Klassenhierarchie. Falsche oder fehlende Benennung in der Datei `<package>-sections.txt` (siehe Erklärung).
- Verdammt, ich habe immer noch keine Klassenhierarchie. Is the object name (name of the instance struct, e.g. GtkWidget) part of the normal section (don't put this into Standard or Private subsections).
- Kein Symbolindex. Does the `<package>-docs.{xml,sgml}` contain a index that xi:includes the generated index?
- Symbole werden nicht mit deren Dokumentationsbschnitt verknüpft. Is the doc-comment using the correct markup (added #,% or ())? Check if the gtkdoc-fixxref warns about unresolvable xrefs.
- Eine neue Klasse erscheint nicht in der Dokumentation. Is the new page xi:included from `<package>-docs.{xml,sgml}`.
- Ein neues Symbol erscheint nicht in der Dokumentation. Is the doc-comment properly formatted. Check for spelling mistakes in the begin of the comment. Check if the gtkdoc-fixxref warns about unresolvable xrefs. Check if the symbol is correctly listed in the `<package>-sections.txt` in a public subsection.
- Ein Typ fehlt in der Klassenhierarchie. If the type is listed in `<package>.hierarchy` but not in `xml/tree_index.sgml` then double check that the type is correctly placed in the `<package>-sections.txt`. If the type instance (e.g. GtkWidget) is not listed or incidentialy makred private it will not be shown.
- I get foldoc links for all gobject annotations. Check that `xml/annotation-glossary.xml` is xi:included from `<package>-docs.{xml,sgml}`.
- Parameter wird im Kommentarblock des Quellcodes beschrieben, aber existiert nicht Überprüfen Sie, ob die Parameternamen der Prototypen in der Quelle und im Header unterschiedlich sind
- multiple "IDs" for constraint linkend: XYZ Das Symbol XYZ erscheint zweifach in der Datei `<package>-sections.txt`.
- Element typename in namespace '' encountered in para, but no template matches.

## Werkzeuge mit Bezug zu gtk-doc

GtkDocPlugin - a Trac GTK-Doc integration plugin, that adds api docs to a trac site and integrates with the trac search.

Gtkdoc-depscan - a tool (part of gtk-doc) to check used API against since tags in the api to determine the minimum required version.

Version 1.1, März 2000
2000 Free Software Foundation, Inc.

    Free Software Foundation, Inc. 51 Franklin Street, Fifth Floor, Boston, MA02110-1301USA

. Es ist jedermann erlaubt, wortwörtliche Kopien dieses Lizenzdokuments zu erstellen und zu verbreiten, Änderungen sind jedoch nicht zulässig.

## GNU Freie Dokumentationslizenz

### 0. VORWORT

Der Zweck dieser Lizenz ist es, eine Anleitung, ein Textbuch oder andere geschriebene Dokumente frei im Sinne von Freiheit zu halten: jedem die effektive Freiheit zu sichern, es zu kopieren und weiter zu verteilen, mit oder ohne es zu ändern, entweder kommerziell oder nichtkommerziell. Zweitens sichert diese Lizenz dem Autor und Veröffentlicher einen Weg, Anerkennung für seine Arbeit zu bekommen, ohne dabei für Änderungen anderer verantwortlich zu sein.

Diese Lizenz ist eine Art copyleft, das heißt, dass abgeleitete Arbeiten des Dokumentes selbst wieder im gleichen Sinne frei sein müssen. Es ergänzt die GNU General Public License, die eine Copyleft-Lizenz für freie Software darstellt.

Wir haben diese Lizenz gestaltet, um sie für Anleitungen von freier Software zu benutzen, weil freie Software freie Dokumentation benötigt: Ein freies Programm sollte mit Anleitungen kommen, die dieselbe Freiheit wie die Software bieten. Aber diese Lizenz ist nicht auf Software-Anleitungen beschränkt; sie kann für alle textlichen Arbeiten verwendet werden, unabhängig vom Thema, oder ob es als gedrucktes Buch veröffentlicht wird. Wir empfehlen diese Lizenz prinzipiell für Arbeiten, deren Zweck Anleitungen oder Referenzen sind.

### 1. ANWENDBARKEIT UND DEFINITIONEN

Diese Lizenz betrifft jede Anleitung oder andere Arbeit, die einen Hinweis des Copyright-Halters enthält, welcher besagt, dass sie unter den Bedingungen dieser Lizenz verteilt werden kann. Das Dokument, weiter unten, bezieht sich auf jede dieser Anleitungen oder Arbeiten. Jedes Mitglied der Öffentlichkeit ist ein Lizenznehmer, und wird mit Sie bezeichnet.

Eine Modifizierte Version von dem Dokument bezeichnet jegliche Arbeit, die das Dokument oder einen Teil davon enthält, entweder wortwörtlich kopiert oder mit Modifikationen und/oder in eine andere Sprache übersetzt.

Ein Sekundärer Abschnitt ist ein benannter Anhang oder ein wichtiger Abschnitt des Dokumentes, der exklusiv mit der Beziehung des Veröffentlichers zu dem Gesamtthema des Dokumentes (oder verwandten Themen) handelt und nichts enthält, was direkt unter das Gesamtthema fällt. (Wenn zum Beispiel das Dokument teilweise ein Textbuch der Mathematik ist, erklärt ein Sekundärer Abschnitt keine Mathematik.) Die Beziehung könnte eine Angelegenheit einer historischen Verbindung mit dem Thema oder einer verwandten Sache sein, oder einer gesetzlichen, kommerziellen, philosophischen, ethnischen oder politischen Position ihr gegenüber.

Unveränderliche Abschnitte sind spezielle Sekundäre Abschnitte, deren Titel in dem Hinweis, der besagt, dass das Dokument unter dieser Lizenz veröffentlicht ist, gekennzeichnet sind, Unveränderte Abschnitte zu sein.

Die Covertexte sind spezielle kurze Textpassagen, die, als Vorderseitentexte oder Rückseitentexte, in dem Hinweis aufgeführt sind, der besagt, dass das Dokument unter dieser Lizenz veröffentlicht ist.

Eine Transparente Kopie des Dokumentes meint eine maschinenlesbare Kopie, die in einem der Allgemeinheit zugänglichen Format repräsentiert ist, deren Inhalt direkt und einfach mit gebräuchlichen Texteditoren oder (bei aus Pixeln bestehenden Bildern) gebräuchlichen Zeichenprogrammen oder (bei Bildern) weit verbreiteten Bildverarbeitungsprogramm besehen und verändert werden kann, und das geeignet ist, in Textformatierern eingegeben werden zu können oder automatisch in eine Vielzahl von Formaten übersetzt werden kann, die geeignet sind, in Textformatierern eingegeben werden zu können. Eine Kopie in einem anderen Transparenten Dateiformat, dessen Aufbau gestaltet wurde, eine ständige Veränderung durch den Leser zu vereiteln oder abzuwenden, ist nicht Transparent. Eine Kopie die nicht Transparent ist, nennt man Undurchsichtig.

Beispiele von passenden Formaten für Transparente Kopien enthalten reines ASCII ohne Codierung, das Texinfo-Eingabeformat, das LaTeX-Eingabeformat, SGML oder XML die eine öffentlich zugängliche DTD nutzen, und dem Standard entsprechendes HTML, das für die Veränderung durch Menschen gestaltet wurde. Undurchsichtige Formate enthalten PostScript, PDF, proprietäre Formate die nur von proprietären Textverarbeitungen gelesen und bearbeitet werden, SGML oder XML für die die DTD und/oder die Verarbeitungswerkzeuge nicht allgemein erhältlich sind, und maschinengeneriertes HTML, das von einigen Textverarbeitungen nur zu Ausgabezwecken produziert wurde.

Die Titelseite meint bei einem gedruckten Buch die Titelseite selbst, und die folgenden Seiten, die gebraucht werden, um leserlich das Material zu beinhalten, das die Lizenz benötigt, um auf der Titelseite zu erscheinen. Für Arbeiten, die als solche keine Titelseiten haben, meint Titelseite den Text, der der wirkungsvollsten Erscheinung des Arbeitstitels am nächsten kommt und den Textkörper einleitet.

### 3. WORTWÖRTLICHE KOPIEN

Sie dürfen das Dokument auf jedem Medium kopieren und verteilen, entweder kommerziell oder nichtkommerziell, vorausgesetzt, dass die Lizenz, die Copyrighthinweise und der Lizenzhinweis, der besagt, dass die Lizenz für das Dokument gilt, in allen Kopien reproduziert werden, und dass sie keine wie auch immer lautenden andere Bedingungen als die der Lizenz hinzufügen. Sie dürfen keine technischen Möglichkeiten nutzen, die das Lesen oder Weiterkopieren der Kopien, die Sie machen oder weiterkopieren, kontrollieren oder behindern. Wie auch immer, Sie dürfen im Gegenzug Vergütungen für Kopien akzeptieren. Wenn Sie eine genügend große Anzahl von Kopien verteilen, müssen Sie auch den Bedingungen in Abschnitt 3 zustimmen.

Sie dürfen auch Kopien unter den oben genannten Bedingungen verleihen, und Sie dürfen Kopien öffentlich zeigen.

### 3. KOPIEREN IN MENGEN

Wenn Sie mehr als 100 gedruckte Kopien des Dokumentes veröffentlichen, und die Lizenz des Dokumentes Cover-Texte verlangt, müssen Sie die Kopien in Verpackungen einschließen, die sauber und leserlich all diese Cover-Texte enthalten: Vorderseitentexte auf der Vorderseite, und Rückseitentexte auf der Rückseite. Beide Seiten müssen auch sauber und leserlich Sie als den Veröffentlicher dieser Kopien identifizieren. Die Vorderseite muß den vollen Titel mit allen Wörtern des Titels gleich auffällig und sichtbar darstellen. Sie dürfen andere Materialien zusätzlich der Seite hinzufügen. Kopieren mit Veränderungen der Seiten, solange diese den Titel des Dokumentes absichern und diese Bedingungen erfüllen, können in anderer Hinsicht als wortwörtliche Kopien behandelt werden.

Wenn die geforderten Texte für jede Seite zu groß sind, um leserlich darauf zu passen, sollten Sie die erstgenannten (so viele wie vernünftig darauf passen) auf die aktuelle Seite setzen, und mit dem Rest auf angrenzenden Seiten fortfahren.

Wenn Sie mehr als 100 Undurchsichtige Kopien des Dokumentes veröffentlichen oder verteilen, müssen Sie entweder zusammen mit jeder Undurchsichtigen Kopie eine Transparente Kopie einfügen, oder in oder mit jeder Undurchsichtigen Kopie eine öffentlich zugängliche Computer-Netzwerk-Adresse angeben, die eine komplette Transparente Kopie des Dokumentes enthält, die frei von hinzugefügtem Material ist und die sich die allgemeine netzwerknutzende Öffentlichkeit mit Standard-Netzwerkprotokollen unentgeltlich herunterladen kann. Wenn Sie die letzte Option verwenden, müssen Sie, wenn Sie beginnen, Undurchsichtige Kopien in Mengen zu verteilen, vernünftige umsichtige Schritte unternehmen, die sicherstellen, dass die Transparente Kopie unter der genannten Adresse mindestens ein Jahr, nachdem Sie das letzte Mal eine Undurchsichtige Kopie dieser Edition (direkt oder über Ihre Vermittler oder Händler) an die Öffentlichkeit verteilt haben.

Es wird erbeten, aber nicht verlangt, dass Sie die Autoren des Dokumentes kontaktieren, bevor Sie eine große Anzahl an Kopien weiterverteilen, um ihnen zu ermöglichen, Sie mit einer aktualisierten Version des Dokumentes zu versorgen.

### 4. MODIFIKATIONEN

Sie dürfen eine Modifizierte Version eines Dokumentes unter den in den Abschnitten 2 und 3 oben stehenden Bedingungen kopieren und verteilen, vorausgesetzt, Sie veröffentlichen die Modifizierte Version unter genau dieser Lizenz, so dass die modifizierte Version die Stelle des Dokumentes einnimmt, folglich auch das Lizenzieren der Verteilung und Modifikation der Modifizierten Version an jeden, der eine Kopie davon besitzt. Zuätzlich müssen Sie diese Dinge in der Modifizierten Version tun:

- A

  Auf der Titelseite (und auf den Covern, falls vorhanden) einen Titel verwenden, der sich von dem des Dokumentes unterscheidet, und von denen vorhergehender Versionen (die, falls vorhanden, in dem History-Abschnitt des Dokumentes aufgeführt sein sollten). Sie dürfen denselben Titel wie in einer vorhergehenden Version nutzen, wenn der ursprüngliche Veröffentlicher sein Einverständnis gibt.

- B

  Auf der Titelseite, eine oder mehrere Personen als Autoren benennen, die für das Einbringen von Veränderungen in die Modifizierte Version verantwortlich sind, zusammen mit mindesten fünf eigentlichen Autoren des Dokumentes (allen eigentlichen Autoren, wenn es weniger als fünf sind).

- C

  Auf der Titelseite den Namen des Veröffentlichers der Modifizierten Version als Veröffentlicher kennzeichnen.

- D

  Alle Copyright-Hinweise des Dokumentes beibehalten.

- E

  Einen passenden Copyright-Hinweis für Ihre Modifikationen angrenzend an die anderen Copyright-Hinweise hinzufügen.

- F

  Gleich hinter dem Copyright-Hinweis einen Lizenzhinweis einfügen, der die öffentliche Erlaubnis gibt, die Modifizierte Version unter den Bedingungen dieser Lizenz zu nutzen, in einer Form, die weiter unten im Anhang dargestellt ist.

- G

  In dem Lizenzhinweis die volle Liste der Unveränderlichen Abschnitte und benötigten Cover-Texte, die in dem Lizenzhinweis des Dokumentes gegeben ist, beibehalten.

- H

  Eine unveränderte Kopie dieser Lizenz einfügen.

- I

  Den Abschnitt, der mit History (Geschichte) betitelt ist, und seinen Titel beibehalten und ihn zu einem Punkt hinzufügen, der mindestens Titel, Jahr, neue Autoren, und Veröffentlicher der Modifizierten Version wie auf der Titelseite gegeben, benennt. Wenn es keinen mit History betitelten Abschnitt gibt, erstellen Sie einen, der den Titel, Jahr, Autoren, und Veröffentlicher des Dokumentes wie auf der Titelseite gegeben, benennt, und fügen Sie dann einen Punkt hinzu, der die Modifizierte Version beschreibt wie im vorhergehenden Satz.

- J

  Die Netzwerk-Adresse, falls aufgeführt, beibehalten, die im Dokument aufgeführt ist, um öffentlichen Zugriff zu einer Transparenten Kopie des Dokumentes zu ermöglichen, und genauso die Netzwerk-Adressen, die im Dokument für frühere Versionen, auf denen es basiert, aufgeführt sind. Diese können in den History-Abschnitt gestellt werden. Sie können eine Netzwerk-Adresse für ein Werk auslassen, das mindestens vier Jahre vor dem Dokument selbst veröffentlicht wurde, oder wenn der ursprüngliche Autor, auf den sich die jeweilige Version bezieht, es erlaubt.

- K

  In jeglichem Abschnitt, der mit Acknowledgements (Anerkennungen) oder Dedications (Widmungen) betitelt ist, den Titel des Abschnittes beibehalten, und in dem Abschnitt allen Inhalt und Ton von jeder Anerkennung und/oder Widmung jedes Beitragenden beibehalten, der dort aufgeführt ist.

- L

  Alle Unveränderlichen Abschnitte des Dokumentes beibehalten, unverändert in ihrem Text und ihren Titeln. Abschnittsnummern oder ähnliches werden nicht als Teil von Abschnittstiteln betrachtet.

- M

  Alle Abschnitte, die mit Endorsements (Billigungen) betitelt sind, löschen. Solche Abschnitte dürfen nicht mit in die Modifizierte Version aufgenommen werden.

- N

  Betiteln Sie keine existierenden Abschnitte mit Endorsements oder so, dass sie im Widerspruch zu Titeln von Unveränderlichen Abschnitten stehen.

Wenn die Modifizierte Version neue wichtige Abschnitte enthält oder Anhänge, die Sekundäre Abschnitte darstellen, und kein Material enthalten, das aus dem Dokument kopiert wurde, dürfen Sie nach Ihrer Wahl einige oder alle diese Abschnitte als Unveränderlich bezeichnen. Um dies zu tun, fügen Sie ihre Titel der Liste der Unveränderlichen Abschnitte in dem Lizenzhinweis der Modifizierten Version hinzu. Diese Titel müssen sich von allen anderen Abschnittstiteln unterscheiden.

Sie dürfen einen Abschnitt Endorsements hinzufügen, vorausgesetzt, er enthält nichts außer Bewilligungen Ihrer Modifizierten Version von verschiedenen Seiten -- zum Beispiel Aussagen von Beurteilungen, oder dass der Text von einer Organisation als für die autoritäre Definition eines Standards befunden wurde.

Sie dürfen eine Passage aus bis zu fünf Wörtern als Vorderseitentext hinzufügen, und eine Passage von bis zu 25 Wörtern als Rückseitentext, ans Ende der Liste von Covertexten in der Modifizierten Version. Höchstens eine Passage von Vorderseitentexten und eine von Rückseitentexten darf von (oder durch Abmachungen von) irgendeinem Wesen hinzugefügt werden. Wenn das Dokument für die entsprechende Seite schon einen Covertext hat, der vorher von Ihnen oder durch Abmachungen von demselben Wesen, in dessen Namen Sie handeln, hinzugefügt wurde, dürfen Sie keinen anderen hinzufügen; aber Sie dürfen den alten, wenn es der ursprüngliche Veröffentlicher, der den alten hinzugefügt hat, explizit erlaubt, ersetzen.

Der/die Autor(en) und Veröffentlicher des Dokumentes erteilen durch diese Lizenz nicht die Erlaubnis, ihre Namen für Veröffentlichungen für Bewilligungen irgendeiner Modifizierten Version oder deren Durchsetzungen oder Andeutungen zu nutzen.

### 5. DOKUMENTE KOMBINIEREN

Sie dürfen das Dokument mit anderen Dokumenten, die unter dieser Lizenz veröffentlicht wurden, unter den Bedingungen in Abschnitt 4 für Modifizierte Versionen kombinieren, vorausgesetzt, Sie beinhalten in der Kombination alle Unveränderlichen Abschnitte aller ursprünglichen Dokumente unverändert, und führen Sie alle als Unveränderliche Abschnitte Ihrer kombinierten Arbeit in deren Lizenzhinweis auf.

Die kombinierte Arbeit braucht nur eine Kopie dieser Lizenz zu beinhalten, und mehrfache identische Unveränderliche Abschnitte können durch eine einzige Kopie ersetzt werden. Wenn es mehrere Unveränderliche Abschnitte mit demselben Titel, aber unterschiedlichem Inhalt gibt, machen Sie den Titel jedes Abschnittes durch Hinzufügen (in Klammern) des Namens des ursprünglichen Autors oder Veröffentlichers dieses Abschnittes, falls bekannt, unverwechselbar, oder ansonsten durch eine einzigartige Nummer. Führen Sie dieselben Änderungen in der Liste der Unveränderlichen Abschnitte im Lizenzhinweis der kombinierten Arbeit durch.

In der Kombination müssen Sie alle mit History betitelten Abschnitte aus den verschiedenen ursprünglichen Dokumenten zusammenführen, und daraus einen Abschnitt History bilden; genauso kombinieren Sie jeden mit Acknowledgements betitelten Abschnitt, und jeden mit Dedications betitelten Abschnitt. Sie müssen jeden mit Endorsements betitelten Abschnitt löschen.

### 6. SAMMLUNGEN VON DOKUMENTEN

Sie dürfen eine Sammlung erstellen, die aus dem Dokument und anderen, unter dieser Lizenz veröffentlichten Dokumenten besteht, und die individuellen Kopien der Lizenz in den einzelnen Dokumenten durch eine einzige Kopie ersetzen, die sich in der Sammlung befindet, vorausgesetzt, Sie folgen den Regeln dieser Lizenz für wortwörtliches Kopieren jedes dieser Dokumente in jeglicher Hinsicht.

Sie dürfen ein einzelnes Dokument aus einer solchen Sammlung heraustrennen, und es individuell unter dieser Lizenz verteilen, vorausgesetzt, Sie fügen eine Kopie dieser Lizenz in das herausgetrennte Dokument ein und folgen der Lizenz in jeglicher Hinsicht bezüglich dem wortwörtlichen Kopieren des Dokuments.

### 7. AGGREGATION MIT UNABHÄNGIGEN ARBEITEN

Eine Zusammenstellung dieses Dokumentes oder seinen Ableitungen mit anderen separaten und unabhängigen Dokumenten oder Arbeiten, in oder auf einem Teil eines Speicher- oder Verteilungsmediums, zählt nicht als Ganzes als Modifizierte Version des Dokumentes, vorausgesetzt, kein Gesamt-Copyright wurde für die Zusammenstellung festgelegt. Solch eine Zusammenstellung wird Aggregat (Mischung) genannt, und diese Lizenz gilt nicht für die anderen selbstenthaltenen Arbeiten, die mit dem Dokument zusammengestellt wurden, im Falle, dass sie zusammengestellt wurden, wenn sie nicht selbst abgeleitete Arbeiten des Dokumentes sind. Wenn die Covertext-Bedingung von Abschnitt 3 auf diese Kopien des Dokumentes anwendbar ist, dann können, wenn das Dokument weniger als ein Viertel des gesamten Aggregates ist, die Covertexte des Dokumentes auf Seiten platziert werden, die nur das Dokument innerhalb des Aggregates umgeben. Ansonsten müssen sie auf Seiten erscheinen, die das gesamte Aggregat umgeben.

### 8. ÜBERSETZUNG

Übersetzung wird als eine Art Modifikation angesehen, also dürfen Sie Übersetzungen des Dokumentes unter den Bedingungen von Abschnitt 4 verteilen. Das Ersetzen von Unveränderlichen Abschnitten mit Übersetzungen erfordert spezielle Einwilligung des Copyright-Halters, aber Sie dürfen Übersetzungen von einigen oder allen Unveränderlichen Abschnitten zusätzlich zu den ursprünglichen Versionen dieser Unveränderlichen Abschnitte einfügen. Sie dürfen eine Übersetzung dieser Lizenz hinzufügen, vorausgesetzt Sie beinhalten auch die ursprüngliche englische Version dieser Lizenz. Im Falle einer Nichtübereinstimmung zwischen der Übersetzung und der ursprünglichen englischen Version dieser Lizenz hat die ursprüngliche englische Version Vorrang.

### 9. TERMINATION

Sie dürfen das Dokument nicht kopieren, modifizieren, sublizenzieren oder verteilen, außer wie es diese Lizenz ausdrücklich vorschreibt. Jegliche andere Absicht, das Dokument zu kopieren, modifizieren, sublizenzieren oder verteilen, ist nichtig und beendet automatisch Ihre Rechte unter dieser Lizenz. Wie auch immer, Parteien, die Kopien oder Rechte von Ihnen unter dieser Lizenz bekommen haben, wird nicht die Lizenz beendet, solange diese Parteien in voller Zustimmung verbleiben.

### 10. ZUKÜNFTIGE REVISIONEN DIESER LIZENZ

Die Free Software Foundation kann von Zeit zu Zeit neue, revidierte Versionen der GNU Free Documentation License veröffentlichen. Solche neue Versionen werden vom Grundprinzip her der vorliegenden Version gleichen, können sich aber im Detail unterscheiden, um neue Probleme oder Anliegen anzusprechen. Siehe auch http://www.gnu.org/copyleft/.

Jeder Version dieser Lizenz wird eine unterscheidende Versionsnummer gegeben. Wenn das Dokument angibt, dass eine spezielle Version dieser Lizenz oder eine spätere Version darauf zutrifft, haben Sie die Wahl, den Bestimmungen und Bedingungen von entweder der angegebenen Version oder einer beliebigen späteren Version, die von der Free Software Foundation (nicht als Entwurf) veröffentlicht wurde, zu folgen. Wenn das Dokument keine Versionsnummer angibt, können Sie irgendeine, jemals von der Free Software Foundation (nicht als Entwurf) veröffentlichte Version wählen.

### Anhang

Um diese Lizenz in einem von Ihnen geschriebenen Dokument nutzen zu können, fügen Sie eine Kopie der Lizenz in das Dokument ein und setzen Sie die folgenden Copyright- und Lizenzhinweise gleich hinter die Titelseite:

> Copyright (c) JAHR IHR NAME.

> Es wird die Erlaubnis gegeben, dieses Dokument zu kopieren, verteilen und/oder zu verändern unter den Bedingungen der GNU Free Documentation License, Version 1.1 oder einer späteren, von der Free Software Foundation veröffentlichten Version; mit den Unveränderlichen Abschnitten. DEREN TITEL AUFGEZÄHLT sind, mit den Vorderseitentexten, die AUFGEZÄHLT sind, und mit den Rückseitentexten, die AUFGEZÄHLT sind. Eine Kopie dieser Lizenz ist in dem Abschnitt enthalten, der mit GNU Free Documentation License betitelt ist.

Wenn Sie keine Unveränderlichen Abschnitte haben, schreiben Sie mit keinen Unveränderlichen Abschnitten, anstatt anzugeben, welche unveränderlich sind. Wenn Sie keine Vorderseitentexte haben, schreiben Sie keine Vorderseitentexte anstatt Vorderseitentexte die AUFGEZÄHLT sind; genauso bei den Rückseitentexten.

Wenn Ihr Dokument nicht-triviale Beispiele von Programmcode enthält, empfehlen wir, diese Beispiele parallel unter einer freien Software-Lizenz, wie der GNU General Public License, zu veröffentlichen, um ihren Gebrauch in freier Software zu erlauben.