# GTK-Doc-Handbuch

1.12

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, 2007-2009
Dan Mueth, Chris Lyttle und Stefan Kost
2009
Mario Blättermann (mariobl@gnome.org)

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.13
18 December 2009
1.12
18 December 2009
1.11
16 Novemebr 2008
mal
GNOME doc-utils migration

## 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?

GTK-Doc is used to document C code. It is typically used to document the public API of libraries, such as the GTK+ and GNOME libraries. But it can also be used to document application code.

### Wie funktioniert GTK-Doc?

GTK-Doc works by using documentation of functions placed inside the source files in specially-formatted comment blocks, or documentation added to the template files which GTK-Doc uses (though note that GTK-Doc will only document functions that are declared in header files; it won't produce output for static functions).

GTK-Doc consists of a number of perl scripts, each performing a different step in the process.

There are 5 main steps in the process:

1. Writing the documentation.

   The author fills in the source files with the documentation for each function, macro, union etc. (In the past information was entered in generated template files, which is not recommended anymore).

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 sybols to show up in the docs, where the full declaration cannot be found by th 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 once.

4. Generating the SGML/XML and HTML.

   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 takes docs from sources and introspection data.

   gtkdoc-mkhtml turns the SGML files into HTML files in the `html/` subdirectory.

   Files in `sgml/` or `xml/` and `html/` directories are always overwritten. One should never edit them directly.

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 - the main scripts are in Perl.

DocBook DTD v3.0 - This is the DocBook SGML DTD. http://www.ora.com/davenport

Jade v1.1 - This is a DSSSL processor for converting SGML to various formats. http://www.jclark.com/jade

Modular DocBook Stylesheets This is the DSSSL code to convert DocBook to HTML (and a few other formats). It's used together with jade. I've customized the DSSSL code slightly, in gtk-doc.dsl, to colour the program code listings/declarations, and to support global cross-reference indices in the generated HTML. 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

There is no standard place where the DocBook Modular Stylesheets are installed.

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)

(who it is meant for, where you can get it, license)

## 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 Bilbliothek namens »libmeep« sowie eine Endbenutzer-Anwendung namens »meeper«.

### Einrichten des Grundgerüsts der Dokumentation

Under your top-level project directory create folders called docs/reference (this way you can also have docs/help for end-user documentation). It is recommended to create another subdirectory with the name of the doc-package. For packages with just one library this step is not necessary.

This can then look as show below:

#### Beispiel für die Ordnerstruktur

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

### Integration in autoconf

Very easy! Just add one line to your `configure.ac` script.

#### Integration in autoconf

    # check for gtk-doc
    GTK_DOC_CHECK(1.9)

Besides checking for the required Gtk-Doc version, this adds two configure switches:

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

2. --enable-gtk-doc : Zur Erstellung der Dokumentation wird gtk-doc verwendet.

Gtk-Doc is disabled by default! Remember to pass the option `'--enable-gtk-doc'` to the next `configure` run. Otherwise pregenerated documentation is installed (which makes sense for users but not for developers).

Furthermore it is recommended that you have the following line inside you `configure.ac` script. This allows `gtkdocize` to automatically copy the macro definition for `GTK_DOC_CHECK` to your project.

#### Vorbereitung für gtkdocize

    AC_CONFIG_MACRO_DIR(m4)

### Integration in automake

First copy the `Makefile.am` from the examples subdirectory of the gtkdoc-sources to your project's API documentation directory ( `./docs/reference/<package>`). If you have multiple doc-packages repeat this for each one.

The next step is to edit the setting inside the `Makefile.am`. All the settings have a comment above that describes their purpose. Most settings are extra flags passed to the respective tools. Every tool has a variable of the form `<TOOLNAME>_OPTIONS`. All the tools support `--help` to list the supported parameters.

You may also want to enable gtk-doc for the distcheckmake target. Just add then one-liner show in the next example to you top-level `Makefile.am`:

#### Enable gtk-doc during make distcheck

    DISTCHECK_CONFIGURE_FLAGS=--enable-gtk-doc

### Integration in autogen

Most projects will have an `autogen.sh` script to setup the build infrastructure after a checkout from version control system (such as cvs). Gtk-Doc comes with a tool called `gtkdocize` which can be used in such a script. It should be run before autoheader, automake or autoconf.

#### Ausführen von gtkdocize durch autogen.sh

    gtkdocize || exit 1

When running `gtkdocize` it copies `gtk-doc.make` to you project root (or any directory specified by the --docdir option). If also check you configure script for the `GTK_DOC_CHECK` invocation.

Historically gtk-doc was gerating template files where developers entered the docs. this turned out to be not so good. Since a few version gtk-doc could also get all the information from source comments. 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 once.

### Running the doc build

After the previous steps it's time to run the build. First we need to rerun `autogen.sh`. If this script runs configure for you, then give it the `--enable-gtk-doc` option. Otherwise manually run `configure` with this option afterwards.

The first make run generates several additional files in the doc-dirs. The important ones are: `<package>.types`, `<package>-docs.sgml`, `<package>-sections.txt`.

#### Running the doc build

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

Now you can point your browser to `docs/reference/<package>/index.html`. Yes, it's a bit disappointing still. But hang-on, during the next chapter we tell you how to fill the pages with life.

### Integration in Versionsverwaltungssysteme

As a rule of the thumb, it's those files you edit, that should go under version control. For typical projects it's these files: `<package>.types` `<package>-docs.sgml` `<package>-sections.txt` `Makefile.am`

## Dokumentieren des Codes

GTK-Doc uses source code comment with a special syntax for code documentation. Further it retrieves information about your project structure from other sources. During the next section you find all information about the syntax of the comments.

### Documentation placement

In the past most documentation had to be filled into files residing inside the `tmpl` directory. This has the disadvantages that the information is often not updated and also that the file tend to cause conflicts with version control systems.

The avoid the aforementioned problems we suggest putting the documentation inside the sources. This manual will only describe this way of documenting code.

### Documentation comments

A multiline comment that starts with an additional '*' marks a documentation block that will be processed by the Gtk-Doc tools.

#### Gtk-Doc comment block

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

The 'identifier' is one line with the name of the item the comment is related to. The syntax differs a little depending on the item. (TODO add table showing identifiers)

The 'documentation' block is also different for each symbol type. Symbol types that get parameters such as functions or macros have the parameter description first followed by a blank line (just a '*'). Afterwards follows the detailed description. All lines (outside program- listings and CDATA sections) just containing a ' *' (blank-asterisk) are converted to paragraph breaks. If you don't want a paragraph break, change that into ' * ' (blank-asterisk-blank-blank).

One advantage of hyper-text over plain-text is the ability to have links in the document. Writing the correct markup for a link can be tedious though. Gtk-Doc comes to help by providing several useful abbreviations.

- Use function() to refer to functions or macros which take arguments.

- Use @param to refer to parameters. Also use this when referring to parameters of other functions, related to the one being described.

- Use %constant to refer to a constant, e.g. %G_TRAVERSE_LEAFS.

- Use #symbol to refer to other types of symbol, e.g. structs and enums and macros which don't take arguments.

- Use #Object::signal to refer to a GObject signal

- Use #Object:property to refer to a GObject property

- Use #Struct.field to refer to a field inside a structure.

If you need to use the special characters '()', '@', '%', or '#' in your documentation without gtk-doc changing them you can use the XML entities "&lpar;", "&rpar;", "&commat;", "&percnt;" and "&num;" respectively or escape them with a backslash '\'.

DocBook can do more that just links. One can also have lists, tables and examples. To enable the usage of SGML/XML tags inside doc-comments you need to have `--sgml-mode` in the variable MKDB_OPTIONS inside `Makefile.am`.

As already mentioned earlier Gtk-Doc is for documenting public API. Thus one cannot write documentation for static symbols. Nevertheless it is good to comment those symbols too. This helps other to understand you code. Therefore we recommend to comment these using normal comments (without the 2nd '*' in the first line). If later the function needs to be made public, all one needs to do is to add another '*' in the comment block and insert the symbol name at the right place inside the sections file.

### Documenting sections

Each section of the documentation contains information about one class or module. To introduce the component one can write a section block. The short description is also used inside the table of contents.

#### Section comment block

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

SECTION:<name>

  The name links the section documentation to the respective part in the `<package>-sections.txt` file. The name give here should match the <FILE> tag in the `<package>-sections.txt` file.

@short_description

  A one line description of the section, that later will appear after the links in the TOC and at the top of the section page.

@see_also

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

@stability

  A informal description of the stability level this API has. We recommend the use of one of these terms:

  - 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.

FIXME having @title here, would put this title into a newly generated section file, but later would be obsolete (right?)

To avoid unnecessary recompilation after doc-changes put the section docs into the c-source where possible.

### Dokumentieren von Symbolen

Each symbol (function, macro, struct, enum, signal and property) is documented in a separate block. The block is best placed close to the definition of the symbols so that it is easy to keep them in sync. Thus function are usually documented in the c-source and macros, struct and enum in the header file.

#### Function comment block

    /**
     * function_name:
     * @par1:  description of parameter 1. These can extend over more than
     * one line.
     * @par2:  description of parameter 2
     *
     * 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.
     */

Returns:

  Paragraph describing the returned result.

Deprecated:

  Paragraph denoting that this function should no be used anymore. The description should point the reader to the new API.

Since:

  Description since which version of the code the API is available.

Gtk-doc assumes all symbols (macros, functions) starting with '_' are private. They are treated like static functions.

(FIXME) (stability) (glib-enums, ...)

#### Property comment block

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

#### Signal comment block

    /**
     * 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 comment block

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

### Nützliche DocBook-Tags

Here are some DocBook tags which are most useful when documenting the code.

To link to another section in the GTK docs:

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

The linkend is the SGML id on the top item of the page you want to link to. For most pages this is currently the part ("gtk", "gdk", glib") and then the page title ("Hash Tables"). For widgets it is just the class name. Spaces and underscores are converted to '-' to conform to SGML.

To refer to an external function, e.g. a standard C function:

    <function>...</function>

To include example code:

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

or possibly this, for very short code fragments which don't need a title:

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

For the latter gtk-doc also supports an abbreviation: |[ ... ]|

To include bulleted lists:

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

To include a note which stands out from the text:

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

To refer to a type:

    <type>unsigned char</type>

To refer to an external structure (not one described in the GTK docs):

    <structname>XFontStruct</structname>

To refer to a field of a structure:

    <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).

To emphasize text:

    <emphasis>This is important</emphasis>

For filenames use:

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

## Filling the extra files

There are a couple of extra files, that need to be maintained along with the inline source code comments: `<package>.types`, `<package>-docs.sgml`, `<package>-sections.txt`.

### Editing the types file

If your library or application includes GtkObjects/GObjects, you want their signals, arguments/parameters and position in the hierarchy to be shown in the documentation. All you need to do, is to list the `xxx_get_type` functions together with their include inside the `<package>.types` file.

#### 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.

### Editing the master document

Gtk-Doc produces documentation in DocBook SGML/XML. When processing the inline source comments, the Gtk-Doc tools generate one documentation page per class or module as a separate file. The master document includes them and place them in a order.

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.

Do not create tutorials as extra documents. Just write extra chapters. The benefit of directly embedding the tutorial for your library into the API documentation is that it is easy to link for the tutorial to symbol documentation. Apart chances are higher that the tutorial gets updates along with the library.

So what are the things to change inside the master document? For a start is only a little. There are some placeholders (text in square brackets) there which you should take care of.

#### Master document header

    <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>

### Editing the section file

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 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 are initially created, since the title set in the template file overrides this.

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.

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

A Gtk-Doc run generates report files inside the documentation directory. The generated files are named: `<package>-undocumented.txt`, `<package>-undeclared.txt` and `<package>-unused.txt`. All those are plain text files that can be viewed and postprocessed easily.

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.

## Häufig gestellte Fragen

Frage
Antwort
No class hierarchy.
The objects _get_type() function has not been entered into the `.types` file.
Still no class hierarchy.
Wrong naming in section file (see Erklärung)
Damn, I have still no class hierarchy.
Is the object name (name of the instance struct) part of the normal section (don't put this into Standard or Private).
No symbol index.
FIXME (<index> tag in main sgml file)
Symbols are not linked to their doc-section.
FIXME (added #,% or () ?)
A new class does not appear in the docs.
FIXME (section file, types file, main-sgml file)
A new symbol does not appear in the docs.
FIXME (section file, proper doc comment)
Parameter described in source code comment block but does not exist
Check if the prototype in the header has different parameter names as in the source.
multiple "IDs" for constraint linkend: XYZ
Symbol XYZ appears twice in -sections.txt file.
Element typename in namespace '' encountered in para, but no template matches.
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.