# Handbok för GTK-Doc

1.12

Användarhandbok för utvecklare med användningsinstruktioner för GTK-Doc.

Chris
Lyttle

                chris@wilddev.net

Dan
Mueth

                d-mueth@uchicago.edu

Stefan
Kost

                ensonic@users.sf.net

GTK-Doc-projektet

    gtk-doc-list@gnome.org

2000, 2005, 2007-2009
Dan Mueth, Chris Lyttle och Stefan Kost
2009
Daniel Nylander (po@danielnylander.se)
2004
Marcus Rejås och Alexander Nordström (info@se.linux.org)

Tillstånd att kopiera, distribuera och/eller modifiera detta dokument ges under villkoren i GNU Free Documentation License, version 1.1 eller senare, utgivet av Free Software Foundation utan standardavsnitt och omslagstexter. En kopia av licensen finns inkluderad.

Flera namn på produkter och tjänster är registrerade varumärken. I de fall dessa namn förekommer i GNOME-dokumentation - och medlemmarna i GNOME-dokumentationsprojektet är medvetna om dessa varumärken - är de skrivna med versaler eller med inledande versal.

1.13
18 December 2009
1.12
18 December 2009
1.11
16 Novemebr 2008
mal
GNOME doc-utils migration

## Introduktion

This chapter introduces GTK-Doc and gives an overview of what it is and how it is used.

### Vad är 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.

### Hur fungerar 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).

### Hämta GTK-Doc

#### Krav

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.

gtk-doc's configure script searches these 3 directories automatically:

`/usr/lib/sgml/stylesheets/nwalsh-modular` (used by RedHat)

`/usr/lib/dsssl/stylesheets/docbook` (used by Debian)

`/usr/share/sgml/docbkdsl` (used by SuSE)

If you have the stylesheets installed somewhere else, you need to configure gtk-doc using the option: `--with-dsssl-dir=<PATH_TO_TOPLEVEL_STYLESHEETS_DIR>`

### Om GTK-Doc

(FIXME)

(History, authors, web pages, license, future plans, comparison with other similar systems.)

### Om denna handbok

(FIXME)

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

## Setting up your project

The next sections describe what steps to perform to integrate GTK-Doc into your project. Theses section assume we work on a project called 'meep'. This project contains a library called 'libmeep' and an end-user app called 'meeper'.

### Setting up a skeleton documentation

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:

#### Example directory structure

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

### Integration with autoconf

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

#### Integration with 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 : path to installed docs

2. --enable-gtk-doc : use gtk-doc to build documentation

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.

#### Förberedelse för gtkdocize

    AC_CONFIG_MACRO_DIR(m4)

### Integration med 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 with 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.

#### Running gtkdocize from 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 with version control systems

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`

## Documenting the code

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

  A list of symbols that are related to this section..

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

### Documenting symbols

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;

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

## Controlling the result

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.

## Frågor och svar

Fråga
Svar
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 förklaring)
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, mars 2000
2000
Free Software Foundation, Inc.

    Free Software Foundation, Inc. 51 Franklin Street, Suite 330, Boston, MA02110-1301USA

. Var och en äger kopiera och sprida ordagranna kopior av detta licensavtal [originalet och denna översättning], men att ändra det är inte tillåtet.

## GNU Free Documentation License

### 0. BAKGRUND

Syftet med denna licens är att göra en handbok, bok, eller annat praktiskt och användbart dokument fritt som i frihet: att försäkra var och en den faktiska friheten att kopiera och sprida det vidare, med eller utan förändringar, antingen kommersiellt eller ideellt. Sekundärt bevarar denna licens ett sätt för författaren och förläggaren att få ära för deras arbete utan att de anses vara ansvariga för förändringar gjorda av andra.

Denna Licens är en sorts copyleft, vilket betyder att derivativa verk av detta dokument själva måste vara fria på samma sätt. Den kompletterar GNU General Public License, som är en copyleft-licens utformad för fri programvara.

Vi har utformat denna licens för att den skall användas för handböcker till fri programvara, eftersom fri programvara behöver fri dokumentation: ett fritt program bör ha en handbok som erbjuder samma friheter som programmet gör. Men denna licens är inte begränsad till programvaruhandböcker; den kan användas för vilket textverk som helst oavsett ämne eller huruvida det är en utgiven, tryckt bok. Vi rekommenderar denna licens huvudsakligen för alla verk vars syfte är instruktion eller referens.

### TILLÄMPNINGSOMRÅDE OCH DEFINITIONER

Denna licens [det engelska originalet] gäller för varje handbok eller annat verk, oavsett uttrycksform, som innehåller ett meddelande där upphovsrättsinnehavaren stadgat att verket kan spridas enligt villkoren i GNU Free Documentation License. Ett sådant meddelande ger en internationell frihet utan krav på ersättning och utan tidsbegränsning att använda verket under villkoren i denna licens [det engelska originalet]. Dokument nedan syftar på godtycklig handbok eller verk. Var och en är licenstagare och benämns som du.

En förändrad version av dokumentet avser varje verk som innehåller dokumentet eller en del av det, antingen ordagranna kopior, eller med ändringar och/eller översatt till ett annat språk.

Ett sekundärt avsnitt är en märkt bilaga eller förord till dokumentet som exklusivt behandlar förhållandet mellan dokumentets förläggare eller författare och dokumentets huvudsakliga ämne (eller till relaterade ämnen) och som inte innehåller något som direkt faller under det huvudsakliga ämnet. (Således, om dokumentet delvis är en lärobok i matematik så får ett sekundärt avsnitt inte förklara någon matematik.) Förhållandet kan vara en historisk koppling till ämnet eller något relaterat, eller en juridisk, kommersiell, filosofisk, etisk eller politisk ställning till det.

De oföränderliga avsnitten är sekundära avsnitt vars titlar är angivna som oföränderliga avsnitt i meddelandet som stadgar att dokumentet är utgivet under denna licens [det engelska originalet].

Omslagstexterna är speciella korta ordföljder som är listade som framsidestexter eller baksidestexter i meddelandet som stadgar att dokumentet är utgivet under denna licens [det engelska originalet].

En transparent kopia av dokumentet är en maskinläsbar kopia, representerad i ett format vars specifikation finns tillgänglig för allmänheten, som lämpar sig för att revidera dokumentet på ett enkelt sätt med generella textredigeringsprogram eller (för pixelbaserade bilder) generella grafikprogram eller (för ritningar) något väl tillgängligt ritprogram, och som är passande som indata till textfomaterare eller för automatisk konvertering till en mängd format som passar som indata till textformaterare. En kopia i ett för övrigt transparent filformat vars markeringar, eller avsaknad av markeringar, har ordnats för att hindra eller motverka att vidare förändring vidtas av läsare är inte transparent. Ett bildformat är inte transparent om det används för någon betydande del text. En kopia som inte är transparent kallas opak.

Exempel på passande format för transparenta kopior innefattar ren ASCII utan markeringar, Texinfo indataformat, LaTeX indataformat, SGML eller XML som använder en publikt tillgänglig DTD, och standardenlig HTML, PostScript eller PDF utformat för mänsklig förändring. Exempel på transparenta bildformat innefattar PNG, XCF och JPG. Opaka format innefattar leverantörsspecifika format som bara kan läsas och editeras med leverantörsspecifika ordbehandlare, SGML eller XML för vilket DTD och/eller verktyg för behandling inte finns allmänt tillgängliga, och den maskingenererade HTML, PostScript eller PDF som produceras av vissa ordbehandlare enbart avsett som utdata.

Titelsidan innebär, för en tryckt bok, titelsidan själv, och sådana därpå följande sidor som krävs för att göra det material som enligt denna licens skall synas på titelsidan läsbart. För verk i sådana format som inte har någon egentlig titelsida, avses med titelsida den text som är närmast den mest framstående förekomsten av verkets titel, föregående den huvudsakliga textmassan.

### 2. ORDAGRANN KOPIERING

Du äger kopiera och sprida dokumentet på valfritt medium, antingen kommersiellt eller ideellt, förutsatt att denna licens [det engelska originalet], upphovsrättsklausul, och meddelandet som stadgar att GNU Free Documentation License gäller för dokumentet finns med på alla kopior, och att du inte lägger till några som helst andra villkor än de som ingår i denna licens. Du äger inte vidta tekniska åtgärder för att begränsa eller kontrollera läsande eller vidare kopiering av de kopior du skapar eller sprider. Dock äger du ta emot kompensation i utbyte mot kopior. Om du sprider tillräckligt många kopior måste du också följa villkoren i paragraf 3.

Du äger också låna ut kopior, under samma villkor som ovan, och du äger visa kopior offentligt.

### 3. OMFATTANDE KOPIERING

Om du publicerar tryckta kopior (eller kopior i medier som normalt har tryckta omslag) av dokumentet, i en upplaga överstigande 100 exemplar, och dokumentets licensmeddelande kräver omslagstexter, så måste du förse kopiorna med omslag som, klart och tydligt, visar alla omslagstexter: framsidestexter på framsidan och baksidestexter på baksidan. Båda omslagen måste klart och tydligt identifiera dig som utgivare av dessa kopior. Framsidan måste presentera dokumentets hela titel, med alla ord i titeln lika framträdande och synliga. Du äger lägga till ytterligare stoff på omslagen. Kopiering med förändringar gjorda bara på omslaget, så länge som de bevarar dokumentets titel och i övrigt uppfyller dessa krav kan anses vara ordagrann kopiering i andra avseenden.

Om de obligatoriska texterna för något omslag är för omfattande för att rymmas i läsbart skick skall du placera de första (så många som får plats) på det egentliga omslaget, och fortsätta med resten på de direkt intilliggande sidorna.

Om du publicerar opaka kopior av dokumentet i upplagor om mer än 100, måste du antingen bifoga en maskinläsbar transparent kopia med varje opak kopia, eller ange i eller med varje opak kopia en nätverksadress som är tillgänglig för den allmänna nätverksanvändande massan där man, med öppet standardiserade protokoll, kan ladda ner en komplett transparent kopia av dokumentet, utan extra material. Om du väljer det senare alternativet, måste du vidta skäliga åtgärder, när du börjar sprida opaka kopior i kvantitet, för att denna transparenta kopia skall förbli tillgänglig på angivna platsen till åtminstone ett år efter den sista gången du spred en opak kopia (direkt eller via ombud eller återförsäljare) av den utgåvan till allmänheten.

Det är önskvärt, men inte ett krav, att du kontaktar författarna till dokumentet i god tid innan du sprider något större antal kopior, för att ge dem en chans att förse dig med en uppdaterad version av dokumentet.

### 4. FÖRÄNDRINGAR

Du äger kopiera och sprida en förändrad version av dokumentet under de villkor som beskrivs i paragraf 2 och 3 av GNU Free Documentation License, förutsatt att du släpper den förändrade versionen under exakt denna licens, och att den förändrade versionen antar dokumentets roll, och således medger spridning och förändring av den förändrade versionen till envar som erhåller en kopia av den. Utöver detta måste du göra följande med den ändrade versionen:

- #### A

  På titelsidan (och omslagen om det finns några) använda en titel skild från den som [original]dokumentet har, och skild från tidigare versioners titel (som skall, om det finns några, finnas listade i historikavsnittet i dokumentet). Du äger använda samma titel som det föregående dokumentet om den ursprungliga utgivaren ger sitt tillstånd.

- #### B

  Lista på titelsidan, som författare, en eller flera personer eller juridiska personer som ansvarat för förändringarna i den förändrade versionen, tillsammans med minst fem av de huvudsakliga författarna av dokumentet (alla dess huvudsakliga författare, om det har mindre än fem).

- #### C

  Ange namnet på utgivaren av den förändrade versionen, som utgivare, på titelsidan.

- #### D

  Bibehålla dokumentets alla upphovsrättsklausuler.

- #### E

  Lägga till en upphovsrättsklausul för dina förändringar angränsande till de andra upphovsrättsklausulerna.

- #### F

  Direkt efter upphovsrättsklausulerna innefatta ett meddelande som ger allmänheten tillstånd att använda den förändrade versionen under villkoren i denna licens [det engelska originalet] i den form som visas i Tillägg nedan.

- #### G

  I meddelandet om licensen bevara den fullständiga listan över oföränderliga avsnitt och obligatoriska omslagstexter som finns i dokumentets meddelande om licensen.

- #### H

  Inkludera en oförändrad kopia av denna licens [Det är den engelska originalversionen som avses].

- #### I

  Bevara avsnittet med titeln historik (History), bevara dess titel och lägg i avsnittet till en post med åtminstone titeln, året, nya författare och utgivaren av den förändrade versionen så som angivet på titelsidan. Om det inte finns något avsnitt med titeln historik (History) i dokumentet så skapa en med titeln, året, författare och utgivaren av dokumentet så som det står på [original]dokumentets titelsida. Lägg sedan till en post som beskriver den förändrade versionen så som beskrivits ovan.

- #### J

  Bevara den nätverksadress, om det finns någon, angiven i dokumentet till den allmänt tillgängliga transparenta kopian av dokumentet, och likaså nätverksadresserna till de föregående versioner som dokumentet baseras på. Dessa får placeras i avsnittet historik (History). Du äger utelämna en nätverksadress för ett verk som är publicerat mer än fyra år före dokumentet självt, eller om den ursprunglige utgivaren vars verk nätverksadressen hänvisar till ger sitt tillstånd.

- #### K

  För alla avsnitt med titlarna tillkännagivanden (Acknowledgements) eller dedikationer (Dedications), bevara titeln på avsnittet, och bevara allt innehåll och prägel på alla tillkännagivanden och/eller dedikationer gjorda av varje bidragare.

- #### L

  Bevara alla oföränderliga avsnitt i dokumentet oförändrade till text och titel. Avsnittsnummer eller motsvarande anses inte tillhöra avsnittets titel.

- #### M

  Radera varje avsnitt med titeln endossering (Endorsements). Ett sådant avsnitt får inte inkluderas i en förändrad version.

- #### N

  Inte byta titel på något existerande avsnitt så att det blir endossering (Endorsements) eller så att titeln kan förväxlas med något oföränderligt avsnitt.

Om den förändrade versionen innehåller nya framsidestexter eller bilagor som är att anses som sekundära avsnitt och inte innehåller något material kopierat från dokumentet, så äger du, om du vill, benämna några eller samtliga av dessa som oföränderliga. För att göra detta, lägg deras titlar till listan över oföränderliga avsnitt i den förändrade versionens licensmeddelande. Dessa titlar måste vara skilda från alla andra avsnitts titlar.

Du äger lägga till ett avsnitt med titeln endossering (Endorsements), förutsatt att det inte innehåller något annat än endosseringar för din förändrade version från olika aktörer -- till exempel, meddelanden om utförd korrekturläsning eller att texten har godkänts av en organisation som en officiell definition av en standard.

Du äger lägga till ett textavsnitt på upp till fem ord som framsidestext, och ett textavsnitt på upp till 25 ord som baksidestext i listan över omslagstexter i den förändrade versionen. Bara ett textavsnitt med framsidestexter och ett med baksidestexter får läggas till av (eller genom försorg av) en enda juridisk person. Om dokumentet redan innehåller en omlagstext för något av omslagen, tidigare tillagd av dig eller genom försorg av samma juridiska person som du företräder, äger du inte lägga till en till, men du äger ändra den gamla med tillstånd från den tidigare utgivaren som lade till den förra.

Författaren (författarna) och utgivaren (utgivarna) av dokumentet ger inte via denna licens sitt tillstånd att använda sina namn för publicitet eller för att lägga till eller antyda endossering av någon förändrad version.

### 5. KOMBINERA DOKUMENT

Du äger kombinera dokumentet med andra dokument som är utgivna under denna licens, under de villkor som definieras i paragraf 4 av GNU Free Documentation License för förändrade versioner, förutsatt att du, i det kombinerade dokumentet, innefattar alla oföränderliga avsnitt från originaldokumenten, omodifierade, och listar dem som oföränderliga avsnitt i ditt kombinerade verk i dess licensklausul, och att du bevarar alla deras garantiavsägelseklausuler.

Det kombinerade verket behöver bara innehålla en enstaka kopia av denna licens [engelska originalversionen], och flera identiska oföränderliga stycken kan ersättas med en kopia. Om det finns flera oföränderliga stycken med samma namn men olika innehåll, se till att titeln på varje sådant avsnitt är unik genom att i slutet på den, inom parentes, lägga till namnet på den ursprunglige författaren eller utgivaren av det avsnittet om dessa är kända, annars ett unikt nummer. Gör samma justeringar av titlarna i listan över oföränderliga avsnitt i licensklausulen i det kombinerade verket.

I det kombinerade verket måste du kombinera alla avsnitt med titlarna historik (History) i de ursprungliga dokumenten, till ett avsnitt med titeln historik (History); på samma sätt skall alla avsnitt med titlarna tillkännagivanden (Acknowledgements), alla avsnitt med titlarna dedikationer (Dedications) kombineras. Du måste ta bort alla avsnitt med titlarna endossering (Endorsements).

### 6. SAMLINGAR AV DOKUMENT

Du äger skapa en samling bestående av dokumentet och andra dokument som är släppta under GNU Free Documentation License, och ersätta individuella kopior i dokumenten av denna licens med en enda kopia [av den engelska originalversionen] som inkluderas i samlingen, förutsatt att du följer villkoren för ordagrann kopiering i denna licens för varje inkluderat dokument i alla andra avseenden.

Du äger lyfta ut ett dokument från en sådan samling, och sprida det enskilt under GNU Free Documentation License, förutsatt att du lägger till en kopia av denna licens [den engelska originalversionen] i det utlyfta dokumentet, och följer villkoren för ordagrann kopiering i denna licens för det utlyfta dokumentet i alla andra avseenden.

### 7. SAMMANSLAGNING MED OBEROENDE VERK

En samling av dokumentet eller av dess derivat med andra separata och oberoende dokument eller verk, på eller i en lagringsvolym eller ett spridningsmedium, kallas för en sammanslagning om den sammanslagna upphovsrätten inte används för att begränsa samlingens användares rättigheter som de enskilda dokumenten medger. När dokumentet ingår i en sådan sammanslagning, gäller inte denna licens de andra verken i samlingen som inte själva är deriverat av dokumentet. Om kravet på omslagstexter enligt paragraf 3 är tillämpligt på dessa kopior av dokumentet, så kan dokumentets omslagstexter, om dokumentet utgör mindre än hälften av hela samlingen, placeras på det omslag som omger dokumentet inuti samlingen, eller den elektroniska motsvarigheten till omslag om dokumentet är i elektronisk form. Annars måste de synas på det omslag som omger hela samlingen.

### 8. ÖVERSÄTTNING

Översättning anses vara en sorts förändring, så du äger sprida översättningar av dokumentet enligt de villkor som sätts i paragraf 4. Oföränderliga avsnitt som ersätts med översättningar kräver tillstånd från deras upphovsrättsinnehavare, men du äger inkludera översättningar av alla eller vissa av dessa oföränderliga avsnitt tillsammans med originalversionerna av dessa oföränderliga avsnitt. Du äger inkludera en översättning av denna licens, och alla licensklausuler i dokumentet, och alla garantiavsägelser, förutsatt att du också innefattar den engelska originalversionen av denna licens och originalversionerna av dessa klausuler. Skulle det finnas skillnader mellan översättningen och originalversionen av denna licens eller någon klausul så gäller originalversionen.

### 9. UPPHÖRANDE

Du äger inte kopiera, förändra, omlicensiera eller sprida dokumentet annat än enligt villkoren i GNU Free Documentation License. Alla övriga försök att kopiera, modifiera, omlicensiera, eller sprida dokumentet är ogiltiga och kommer automatiskt medföra att du förlorar dina rättigheter enligt denna licens. Tredje man som har mottagit kopior eller rättigheter från dig enligt dessa licensvillkor kommer dock inte att förlora sina rättigheter så länge de följer licensvillkoren.

### 10. FRAMTIDA VERSIONER AV DENNA LICENS

Free Software Foundation kan publicera nya, reviderade versioner av GNU Free Documentation License då och då. Sådana nya versioner kommer att vara likadana i andemening som den nuvarande versionen, men kan skilja i detalj för att behandla nya problem eller angelägenheter. Se http://www.gnu.org/copyleft/.

Varje version av licensen ges ett unikt versionsnummer. Om dokumentet stadgar att en specifik numrerad version av denna licens eller valfri senare version gäller för det, så äger du rätten att följa villkoren enligt antingen den angivna versionen eller vilken senare version som helst som publicerats (inte som utkast) av Free Software Foundation. Om dokumentet inte anger en version av denna licens, äger du välja vilken version som helst som publicerats (inte som utkast) av Free Software Foundation.

### TILLÄGG

För att använda GNU Free Documentation License för ett dokument du har skrivit, inkludera en kopia av licensen [det engelska originalet] i dokumentet och placera följande copyrightklausul omedelbart efter titelsidan:

> Copyright (c) ÅRTAL DITT NAMN.

> Permission is granted to copy, distribute and/or modify this document under the terms of the GNU Free Documentation License, Version 1.1 or any later version published by the Free Software Foundation; with the Invariant Sections being LIST THEIR TITLES, with the Front-Cover Texts being LIST, and with the Back-Cover Texts being LIST. A copy of the license is included in the section entitled GNU Free Documentation License.

Om du inte har några oföränderliga avsnitt, skriv utan oföränderliga avsnitt istället för att ange vilka som är oföränderliga. Om du inte har några framsidestexter, skriv utan framsidestexter istället för framsidestexter som LISTAS; såväl som för baksidestexter.

Om ditt dokument innehåller icke-triviala exempel med programkod, så rekommenderar vi att du släpper dessa exempel parallellt under en, av dig vald, fri programvarulicens, som till exempel GNU General Public License, för att möjliggöra deras användning i fri programvara.