# GTK-Doc మాన్యుయల్

1.15

GTK-Doc వినియోగపు సూచనలతో అభివృద్దికారుల కొరకు వినియోగదారి మాన్యుయల్.

క్రిస్ లిట్టిల్

                chris@wilddev.net

డాన్ ముయెత్

                d-mueth@uchicago.edu

స్టిఫెన్ కోస్ట్

                ensonic@users.sf.net

GTK-Doc ప్రోజెక్ట్

    gtk-doc-list@gnome.org

2000, 2005, 2007-2009 డాన్ ముయెత్ మరియు క్రిస్ లిట్టిల్ మరియు స్టిఫెన్ కోస్ట్

ఎటువంటి ఫ్రంట్-కవర్ పాఠ్యములు, మరియు బ్యాక్-కవర్ పాఠ్యములు లేకుండా, ఫ్రీ సాఫ్టువేరు ఫౌండేషన్ ద్వారా ప్రచురితమైన వర్షన్ 1.1 లేదా దాని తర్వాత వర్షన్‌ GNU Free Documentation License నియమాలకు లోబడి ఈ పత్రమును నకలు తీయుటకు, పంపిణీ చేయుటకు మరియు/లేదా సవరించుటకు అనుమతి యివ్వబడింది. లైసెన్సు యొక్క నకలు చేర్చబడింది.న్ ద్వారా ప్రచురితమై,

కంపెనీలు వాటి వుత్పత్తులను మరియు సేవలను వర్గీకరించుటకు వుపయోగించు చాలా వరకు నామములు ట్రేడ్‌మార్కులుగా హక్కు కలిగివుంటాయి. అవి GNOME పత్రికీకరణనందు కనిపించునప్పుడు, మరియు GNOME Documentation Project సభ్యలు ఆ ట్రేడ్‌మార్కులను గుర్తించుటకు, ఆనామములు పెద్ద అక్షరములలో లేదా మొదటి అక్షరం పెద్ద అక్షరంగా ముద్రించబడతాయి.

1.17
26 Feb 2011
sk urgent bug fix update
1.16
14 Jan 2011
sk bugfixes, layout improvements
1.15
21 May 2010
sk bug and regression fixes
1.14
28 March 2010
sk bugfixes and performance improvements
1.13
18 డిసెంబర్ 2009
sk బ్రోకెన్ టార్బాల్ నవీకరణ
1.12
18 డిసెంబర్ 2009
sk కొత్త సాధనము సౌలభ్యాలు మరియు బగ్‌పరిష్కారములు
1.11
16 నవంబర్ 2008
mal GNOME doc-utils మైగ్రేషన్

## పరిచయం

ఈ అధ్యాయము GTK-Docను పరిచయం చేస్తుంది మరియు అది యేమిచేస్తుంది దానిని యెలా వుపయోగించాలి అనేదానిపై సంక్షిప్తంగా వివరిస్తుంది.

### GTK-Doc అంటే యేమిటి?

GTK-Doc అనునది C కోడ్‌ను పత్రికీకరణ చేయుటకు వుపయోగించబడింది. ఇది ముఖ్యంగా GTK+ మరియు GNOME వంటి లైబ్రరీల పబ్లిక్ API పత్రికీకరణకు వుపయోగించబడింది. అయితే యిది అనువర్తనము కోడ్‌ను పత్రికీకరణ చేయుటకు కూడా వుపయోగించవచ్చును.

### GTK-Doc యెలా పనిచేయును?

GTK-Doc అనునది మూలపు(సోర్స్) ఫైళ్ళ యొక్క ఫంక్షన్స్ నందు ప్రత్యేకించి-రూపొందించిన కామెంట్ బ్లాక్స్ నందలి పత్రికీకరణను వుపయోగించి పనిచేయును, లేదా GTK-Doc వుపయోగించే మాదిరి(టెంప్లేట్) ఫైళ్ళకు జతచేసిన పత్రికీకరణను వుపయోగించును (GTK-Doc హెడర్ ఫైళ్ళ నందు డిక్లేర్ చేసివున్న ఫంక్షన్లకు మాత్రమే పత్రికీకరణ యిచ్చును; అది స్టాటిక్ ఫంక్షన్ల కొరకు అవుట్పుట్ అందించదు).

GTK-Doc చాలా పెర్ల్ స్క్రిప్టులను కలిగివుంది, ప్రతిది వేరువేరు స్టెప్పును కార్యక్రమమునందు జరుపును.

అక్కడ కార్యక్రమమునందు 5 ముఖ్య స్టెప్పులు వున్నవి:

1. పత్రికీకరణను వ్రాయుట. మూలకర్త(ఆథర్) సోర్స్ ఫైళ్ళనందు ప్రతి ఫంక్షన్‌కు, మాక్రోకు, యూనియన్‌కు పత్రకీకరణను యిస్తాడు. (గతంలో సమాచారమును మాదిరి ఫైళ్ళనందు ప్రవేశపెట్టేవారు, యిది యిప్పడు సమర్ధించబడదు).

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

3. "template" ఫైళ్ళను జనియింపచేస్తోంది. gtkdoc-mktmpl అనునది ఫైళ్ళను `tmpl/` వుపసంచయంనందు సృష్టించును, మొదటి స్టెప్పనందు సేకరించిన సమాచారమును వుపయోగించి. (ఇది పునరావృతంగా నడుపవచ్చునని గమనించండి. ఇది యే పత్రముకూడా యెప్పటికి పోకుండా వుంచుటకు చూస్తుంది.)

   GTK-Doc 1.9 నుండి మాదిరిలు వదిలివేయబడినవి. మేము అందరిని పత్రికీకరణను కోడ్‌నందు వుంచమని కోరుచున్నాము. tmpl వినియోగాన్ని పూర్తిగా వదిలివేసే `--flavour no-tmpl` ఐచ్చికాన్ని యిప్పుడు gtkdocize మద్దతించుచున్నది. tmpl నందలి ఫైలును మీరు మానవీయంగా యెప్పుడూ మార్చివుండకపోతే, దయచేసి డైరెక్టరీను తీసివేయుము(ఉ.దా. వర్షన్ కంట్రోల్ సిస్టమ్ నుండి).

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

   gtkdoc-mkhtml turns the SGML/XML files into HTML files in the `html/` subdirectory. Likewise gtkdoc-mkpdf turns the SGML/XML files into a PDF document called `<package>.pdf`.

   `sgml/` లేదా `xml/` మరియు `html/` డైరెక్టరీల నందలి ఫైళ్ళు యెల్లప్పుడూ దిద్దివ్రాయబడును. ఎవరూ వాటిని యెప్పుడూ నేరుగా సరికూర్చకూడదు.

5. పత్రముల మధ్య క్రాస్-రిఫరెన్సెస్‌ను పరిష్కరించుచున్నది. HTML ఫైళ్ళను సంస్థాపించిన తర్వాత, వేరు వేరు పత్రముల మధ్య క్రాస్-రిఫరెన్సెస్‌ను అమర్చుటకు gtkdoc-fixxref నడుపవచ్చును. ఉదాహరణకు, GTK+ పత్రికీకరణ అనునది GLib మాన్యుయల్ నందు వుంచిన పత్రికీకరణకు చాలా క్రాస్-రిఫరెన్సెస్ కలిగివుంది. పంపిణీ కొరకు మూలపు టార్బాల్‌ను సృష్టించునప్పుడు, gtkdoc-rebase అనునది అన్ని బహిర్గత లింకులను వెబ్-లింకులకు మార్చును. పంపిణీచేసిన (ముందుగాజనియింపచేసిన) పత్రములను సంస్థాపించునప్పుడు అదే అనువర్తనము లింకులను స్థానిక లింకులకు (ఆ పత్రములు యెక్కడ సంస్థాపించబడినవో అక్కడికి) తిరిగివుంచుటకు ప్రయత్నించును.

### GTK-Doc పొందుట

#### అవసరములు

Perl v5 - ముఖ్య స్క్రిప్టులు Perl1 నందు వున్నవి.

DocBook DTD v3.0 - ఇది DocBook SGML DTD. http://www.ora.com/davenport

Jade v1.1 - SGMLను వివిధ ఫార్మాట్ల లోనికి మార్చుటకు యిది DSSSL ప్రోసెసర్. http://www.jclark.com/jade

Modular DocBook Stylesheets DocBookను HTMLకు (యింకా కొన్ని యితర ఫార్మాట్లకు) మార్చుటకు యిది DSSSL కోడ్. ఇది jadeతో కలిపి వుపయోగించబడును. నేను DSSSL కోడ్‌ను కొద్దిగా మలచుకొనినాను, gtk-doc.dsl నందు, ప్రోగ్రామ్ కోడ్ జాబితాలు/డిక్లరేషన్లను రంగులో వుంచుటకు, మరియు జనియింపచేసిన HTML నందు గ్లోబల్ క్రాస్-రిఫరెన్సెస్ యిండిసెస్‌ను మద్దతించుటకు. http://nwalsh.com/docbook/dsssl

docbook-to-man - DocBook నుండి man పేజీలను సృష్టించాలని అనుకొంటే. నేను 'translation spec' ను కొద్దిగా మలచుకొనినాను, విభగాపు హెడ్డింగులను పెద్దఅక్షరములలో వుంచుకొనుటకు మరియు పేజీల యొక్క పైభాగమున 'GTK Library' శీర్షికను జతచేయుటకు మరియు క్రిందన పునఃపరిశీలన తేదీను వుంచుటకు. దీనికి http://www.ora.com/davenport పైన వొక లింకు వుంది. గమనిక: ఇంది యింకా పనిచేయుటలేదు.

#### సంస్థాపన

DocBook మాడ్యులర్ స్టైల్‌షీట్లు యిక్కడ సంస్థాపించాలని వొక ప్రామాణిక స్థలము యేమీలేదు.

GTK-Doc యొక్క ఆకృతీకరణ స్క్రిప్టు ఈ 3 డైరెక్టరీలను స్వయంచాలకంగా శోధిస్తుంది:

`/usr/lib/sgml/stylesheets/nwalsh-modular` (RedHat ద్వారా వుపయోగించబడింది)

`/usr/lib/dsssl/stylesheets/docbook` (Debian ద్వారా వుపయోగించబడింది)

`/usr/share/sgml/docbkdsl` (SuSE ద్వారా వుపయోగించబడింది)

మీరు యెక్కడోవొకచోట స్టైల్‌షీట్లను సంస్థాపించివుంటే, మీరు GTK-Docను ఈ ఐచ్చికము వుపయోగించి ఆకృతీకరించవలసి వుంటుంది: `--with-dsssl-dir=<PATH_TO_TOPLEVEL_STYLESHEETS_DIR>`

### GTK-Doc గురించి

(FIXME)

(చరిత్ర, మూలకర్తలు, వెబ్ పుటలు, లైసెన్స్, భవిష్య ప్రణాళికలు, సమానమైన యితర సిస్టమ్సుతో పోలిక.)

### ఈ మాన్యుయల్ గురించి

(FIXME)

(ఇది యెవరి కొరకు, మీరు దీనిని యెచటనుండి పొందగలరు, లైసెన్స్)

## మీ ప్రోజెక్టును అమర్చుట

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

### స్కెల్టెన్ పత్రికీకరణను అమర్చుచున్నది

మీ పై-స్థాయి ప్రోజెక్టు డైరెక్టరీ క్రింద docs/reference అను ఫోల్డర్లను సృష్టించుము (ఈ విధంగా మీరు docs/helpను అంత్య-వినియోగదారి పత్రికీకరణ కొరకు కలిగివుండవచ్చును). doc-package నామముతో వేరొక వుపసంచయంను సృష్టించుకొనుట సిఫార్సు చేయబడింది. కేవలం వొక లైబ్రరీ మాత్రమే వున్న ప్యాకేజీలకు యిది అవసరములేదు.

This can then look as shown below:

ఉదాహరణ డైరెక్టరీ ఆకృతి

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

### autoconf తో విలీనం

చాలా సులువు! మీ `configure.ac` స్క్రిప్టునకు వొక లైను మాత్రమే జతచేయుము.

autoconf తో విలీనం

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

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

Keep gtk-doc optional

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

ఆకృతీకరణ సమయము వద్ద gtkdocversion కొరకు పరిశీలించుటకు మొదటి ఆర్గుమెంటు వుపయోగించబడింది. 2వది, gtkdocize చేత వుపయోగించబడిన ఐచ్చిక ఆర్గుమెంట్. GTK_DOC_CHECK మాక్రో చాలా ఆకృతీకరణ స్విచ్‌లను జతచేస్తుంది:

1. --with-html-dir=PATH : సంస్థాపించిన పత్రములకు పాత్

2. --enable-gtk-doc : పత్రికీకరణను నిర్మించుటకు gtk-doc వుపయోగించుము [default=no]

3. --enable-gtk-doc-html : పత్రికీకరణను html ఫార్మాట్‌నందు నిర్మించుము [default=yes]

4. --enable-gtk-doc-pdf : పత్రికీకరణను pdf ఫార్మాట్ నందు నిర్మించుము [default=no]

GTK-Doc అప్రమేయంగా అచేతనము చేయబడింది! ఐచ్చికము `'--enable-gtk-doc'`ను తరువాతి `configure`కు నడుపుట మర్చిపోవద్దు. లేకపోతే ముందుగా జనియింపచేసిన పత్రికీకరణ సంస్థాపించబడుతుంది (ఇది వినియోగదారులకు వుపయోగకరం అయితే అభివృద్దికారులకు కాదు).

మీ `configure.ac` స్క్రిప్టునందు ఈ క్రింది వరుసను కలిగివుండుట చాలామంచిది. ఇది మీ ప్రోజెక్టునందు `GTK_DOC_CHECK` కొరకు స్వయంచాలకంగా మాక్రో నిర్వచనాన్ని నకలు తీయుటకు gtkdocizeను అనుమతిస్తుంది.

gtkdocize కొరకు సన్నాహం

    AC_CONFIG_MACRO_DIR(m4)

### automake తో విలీనం

ముందుగా `Makefile.am`ను gtkdoc-sources యొక్క వుదాహరణల వుపసంచయం నుండి మీ ప్రోజెక్టు యొక్క API పత్రికీకరణ డైరెక్టరీనకు నకలుతీయుము (`./docs/reference/<package>`). మీరు బహుళ doc-packages కలిగివుంటే ప్రతిదానికి యిలా చేయండి.

The next step is to edit the settings 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 distcheck make target. Just add the one line shown in the next example to your top-level `Makefile.am`:

distcheck చేయునప్పుడు GTK-Doc చేతనము చేయి

    DISTCHECK_CONFIGURE_FLAGS=--enable-gtk-doc

### autogen తో విలీనం

వర్షన్ కంట్రోల్ సిస్టమ్ (cvs/svn/git వంటి) నుండి చెక్అవుట్ తర్వాత బుల్డ్ నిర్మాణం అమర్చుటకు చాలా ప్రోజెక్టులు `autogen.sh` స్క్రిప్టును కలిగివుంటాయి. GTK-Doc అనునది gtkdocize అనబడు సాధనంతో వస్తుంది దీనిని అటువంటి స్క్రిప్టు నందు వుపయోగించవచ్చును. ఇది autoheader, automake లేదా autoconf ముందు నడుపవలెను.

autogen.sh నుండి gtkdocize నడుపుతోంది

    gtkdocize || exit 1

When running gtkdocize it copies `gtk-doc.make` to your project root (or any directory specified by the `--docdir` option). It also checks you configure script for the `GTK_DOC_CHECK` invocation. This macro can be used to pass extra parameters to gtkdocize.

Historically GTK-Doc was generating template files where developers entered the docs. This turned out to be not so good (e.g. the need for having generated files under version control). Since GTK-Doc 1.9 the tools can get all the information from source comments and thus 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. Besides adding the option directly to the command invocation, they can be added also to an environment variable called GTKDOCIZE_FLAGS or set as a 2nd parameter in GTK_DOC_CHECK macro in the configure script. If you have never changed file in tmpl by hand and migrating from older gtkdoc versions, please remove the dir (e.g. from version control system).

### doc బుల్డును నడుపుట

గతంలో జరిపిన స్టెప్పుల తర్వాత యిప్పుడు బుల్డును నడుపవలెను. ముందుగా మనము `autogen.sh`ను తిరిగి నడుపవలెను. ఈ స్క్రిప్టు మీ కొరకు ఆకృతీకరణను నడిపితే, దానికి `--enable-gtk-doc` ఐచ్చికాన్ని యివ్వుము. లేదా తరువాత ఈ ఐచ్చికముతో మానవీయంగా `configure`ను నడుపుము.

మొదటి make run అనునది doc-dirs నందు చాలా అదనపు ఫైళ్ళను జనియింపచేయును. ముఖ్యమైనవి: `<package>.types`, `<package>-docs.sgml`, `<package>-sections.txt`.

doc బుల్డును నడుపుట

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

ఇప్పుడు మీ బ్రౌజర్‌కు మీరు `docs/reference/<package>/index.html`ను సూచించవచ్చును. అవును, యిప్పటికి యిది కొంత నిరుత్సాహపరుస్తోంది. అయితే ఆగండి, తరువాతి అధ్యాయమునందు పేజీలను యెలా నింపాలో చెబుతాము.

### వర్షన్ కంట్రోల్ సిస్టమ్‌తో విలీనం

thumb యొక్క నియమాన్ని అనుసరించి, యిది మీరు సరికూర్చిన ఫైళ్ళది, అది వర్షన్ కంట్రోల్ క్రిందకు వెళ్ళవలెను. ముఖ్యమైన ప్రోజెక్టులకు ఈ ఫైళ్ళు:`<package>.types``<package>-docs.sgml``<package>-sections.txt` `Makefile.am`

## కోడ్‌ను పత్రికీకరణ చేయుట

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 will find all information about the syntax of the comments.

పత్రికీకరణ స్థానము

గతంలో చాలా వరకు పత్రికీకరణ అనునది `tmpl` డైరెక్టరీ క్రిందని ఫైళ్ళలో నింపవలసివుండేది. సమాచారము సరిగా నవీకరించబడక పోవుట మరియు ఆ ఫైలు వర్షన్ కంట్రోల్ సిస్టమ్సుతో విభేదించుట వంటి లోపాలను యిది కలిగివుంది.

ముందుగా తెలిపిన సమస్యలను తప్పించుటకు మేము పత్రికీకరణను మూలముల లోపలే వుంచమని సూచించుచున్నాము. ఈ మాన్యుయల్ ఈ విధంగా కోడ్ పత్రికీకరణను మాత్రమే వివరించును.

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

GTK-Doc వ్యాఖ్య బ్లాక్

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

### పత్రికీకరణ వ్యాఖ్యలు

బహుళ వరుసలు వుండి అదనపు '*' గుర్తులతో ప్రారంభించబడు వ్యాఖ్య పత్రికీకరణ బ్లాక్‌ను సూచించును అది GTK-Doc సాధనముల ద్వారా నిర్వర్తించబడును.

GTK-Doc వ్యాఖ్య బ్లాక్

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

'identifier' అనునది వ్యాఖ్యకు సంభందించిన అంశము యొక్క నామముతో వుండు వొక వరుస. అంశము పై ఆధారపడి సిన్టాక్సు అనునది కొద్దిగా విభేదించును. (చేయవలసినది identifies చూపు పట్టికను జతచేయి)

ప్రతి చిహ్నపు రకమునకు 'పత్రికీకరణ' బ్లాక్ భిన్నంగా వుంటుంది. ఫంక్షన్లు లేదా స్థూలములు పారామితి వివరణను కలిగివున్నవి ముందుగా ఖాళీ వరుస (a '*') అనుసరించాలి. తరువాత విశదీకృత వివరణను అనుసరించాలి. అన్ని వరుసలు (ప్రోగ్రామ్ బయటవి- జాబితాలు మరియు CDATA విభాగములు) ' *' (ఖాళీ-యాస్ట్రిక్) మాత్రమే కలిగివున్నవి పారాగ్రాఫ్ విరామాలుగా వుంచబడును. మీకు పారాగ్రాఫ్ విరామాలు అక్కరలేకపోతే, దానిని ' * ' (blank-asterisk-blank-blank)కు మార్చుము.

సాదా-పాఠ్యమునందు హైపర్-పాఠ్యమును కలిగివుండువలన వొక సౌకర్యము పత్రమునందు లింకులను కలిగివుండవచ్చును. అయినను లింకు కొరకు సరైన మార్కప్ వ్రాయుట చికాకే. GTK-Doc నందు చాలా వుపయోగకర ఎబ్రివేషన్లు అందించబడుచున్నవి.

- ఆర్గుమెంట్లను తీసుకొనే ఫంక్షన్లను లేదా మాక్రోలను సూచించుటకు function() వుపయోగించుము.

- పారామితులను సూచించుటకు @param వుపయోగించుము. వివరించబడిన పారామితికి సంభందించిన యితర ఫంక్షన్ల పారామితులను సూచించుటకు కూడా దీనిని వుపయోగించుము.

- స్థిరరాశిని సూచించుటకు %constant వుపయోగించుము, ఉ.దా. %G_TRAVERSE_LEAFS.

- ఇతర రకముల చిహ్నమును సూచించుటకు #symbol వుపయోగించుము, ఉ.దా. ఆర్గుమెంట్లు తీసుకొని structs మరియు enums మరియు macros వంటివి.

- GObject సంకేతమును సూచించుటకు #Object::signal వుపయోగించుము

- GObject లక్షణమును సూచించుటకు #Object:property వుపయోగించుము

- స్ట్రక్చర్ నందలి క్షేత్రమును సూచించుటకు #Struct.field వుపయోగించుము.

మీరు ప్రత్యేక ఆక్షరములు '<', '>', '()', '@', '%', or '#'ను మీ పత్రికీకరణనందు GTK-Doc వాటిని మార్చకుండా వుపయోగించాలి అంటే మీరు XML మూలకములు "&lt;", "&gt;", "&lpar;", "&rpar;", "&commat;", "&percnt;" మరియు "&num;" వుపయోగించవచ్చు లేదా వాటిని '\' బాక్‌స్లాష్‌తో ఎస్కేప్ చేయుము.

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 `--xml-mode` or `--sgml-mode` in the variable MKDB_OPTIONS inside `Makefile.am`.

ముందుగా చెప్పినట్లుగా GTK-Doc అనునది పబ్లిక్ API పత్రికీకరణ కొరకు. స్థిర చిహ్నములకు వొక్కరే పత్రికీకరణ వ్రాయలేరు. ఆ చిహ్నములను కూడా వ్యాఖ్యానించుట మంచిది. ఇది యితరులు కూడా మీ కోడ్‌ను అర్ధము చేసుకొనుటకు సహాయపడును. అందుకని వీటిని సాదారణ వ్యాఖ్యలు (మొదటి వరుసనందు 2వ '*' లేకుండా) వుపయోగించి వ్యాఖ్యానించమని సూచించడమైంది. తరువాత ఆ ఫంక్షన్ పబ్లిక్‌గా మార్చవలసివుంటే, చేయవలసినదల్లా వేరొక '*'ను వ్యాఖ్య బ్లాక్ నందు చేర్చి మరియు చిహ్నపు నామాన్నివిభగాముల ఫైలునందు సరైన స్థానములో వుంచడమే.

### పత్రికీకరణ విభాగములు

పత్రికీకరణ యొక్క ప్రతి విభాగము వొక క్లాస్ లేదా మాడ్యూల్ గురించిన సమాచారమును కలిగివుంటుంది. మూలకాన్ని పరిచయం చేయుటకు వొకరు విభాగపు బ్లాక్‌ను వ్రాయవచ్చును. పొట్టి వివరణ అనునది పట్టిక యొక్క సారముల లోపలకూడా వుపయోగించబడును. అన్ని @fields ఐచ్చికమైనవి.

విభాగపు వ్యాఖ్య బ్లాక్

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

SECTION:<name>

  నామము అనునది విభాగపు పత్రికీకరణను `<package>-sections.txt` ఫైలునందలి సంభందిత భాగమునకు లింకుచేయును. ఇక్కడ యిచ్చిన నామము `<package>-sections.txt` ఫైలునందలి <FILE> టాగ్‌తో సరిపోలవలెను.

@short_description

  విభాగము యొక్క వివరణ వొక్క వరుసలో, తరువాత అది TOC నందు లింక్సు తరువాత మరియు విభాగపు పేజీ పైన కనిపించును.

@title

  విభాగపు శీర్షిక అనునది SECTION డిక్లరేషన్ నుండి <name> అప్రమేయం కాబడును. ఇది @title క్షేత్రము ద్వారా దిద్దివ్రాయబడును.

@section_id

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

@see_also

  A list of symbols that are related to this section.

@stability

  ఈ API కలిగివున్న స్థిరత్వపు స్థాయి యొక్క సాధారణ వివరణ. ఈ పదములలో వొక దానిని వుపయోగించుట మేము సిఫార్సు చేయుచున్నాము:

  - స్థిరమైన - స్థిరమైన యింటర్ఫేస్ ముఖ్యోద్దేశం మూడోవ్యక్తి అనువర్తనములను యీ యింటర్ఫేసులకు కొరకు అభివృద్దిపరచుట, విడుదల చేయుట, మరియు ఆ వుత్పాదన యొక్కఅన్ని చిన్న విడుదలలనందు(పెద్ద విడుదల క్రిందన విడుదలగునవి) నడుచునట్లు చూచుకొనుటను చేతన పరచుట. ముఖ్య విడుదలనందు కూడా, సారూప్యతా మార్పులు అనునవి తగ్గించుటకు, ఖచ్చితమైన నిర్ధారణలను కలిగివుండుట.

  - అస్థిరమైన - అస్థిరమైన యింటర్ఫేస్‌లు ప్రయోగాత్మకమైనవి లేదా బదలీకరణ పొందునవి. అవి ముఖ్యంగా బయటి అభివృద్దికారులకు కొత్తవి లేదా వేగంగా మారుతున్న సాంకేతికతపై యాక్సెస్ యిచ్చుటకు వుపయోగించబడును, లేదా వొక సమస్య కొరకు యెక్కువ సహజమైన పరిష్కారము కొరకు యెదురు చూడబడుతోందో అక్కడ మధ్యంతర పరిష్కారము యిచ్చుటకు. ఒక చిన్న విడుదలనుండి తర్వాత దానికి యెటువంటి క్లైమ్స్ సోర్స్ గురించికాని లేదా బైనరీ సారూప్యత గురించికాని చేయబడవు.

  - వ్యక్తిగత - GNOME స్టాక్ లోపలే వుపయోగించగల యింటర్ఫేస్, అయితే అది అంత్య-వినియోగదారుల కొరకు పత్రికీకరణ చేయబడదు. అటువంటి ఫంక్షన్లు తెలుపబడిన మరియు పత్రికీకరణ మార్గములలోనే వుపయోగించాలి.

  - అంతర్గత - మాడ్యూల్‌కు అంతర్గతమైన మాడ్యూల్ మరియు అంత్య-వినియోగదారి పత్రికీకరణ అవసరములేనిది. పత్రికీకరణ చేయని ఫంక్షన్లు అంతర్గతమైనవిగా పరిగణించాలి.

@include

  విభాగపు సారాంశము నందు చూపుటకు `#include` ఫైళ్ళు (కామాతో వేరుచేయబడిన జాబితా), విభాగపు ఫైలు లేదా ఆదేశ వరుసనుండి గ్లోబల్ విలువను దిద్దివ్రాయుట. ఈ అంశము ఐచ్చికము.

@image

  ఈ విభాగము కొరకు సూచనపేజీ పైన ప్రదర్శించుటకు ప్రతిబింబము. ఇది తరుచుగా వొక క్లాస్ యొక్క విజువల్ అప్పియరెన్స్ వివరించుటకు డయాగ్రమ్ వంటిది లేదా యితర క్లాసులతో దాని సంభందాన్ని తెలిపే డయాగ్రమ్. ఈ అంశము ఐచ్చికము.

అనవసరపు రికంపైలేషన్‌ను విసర్జించుటకు doc-changes తర్వాత విభాగపు పత్రములను c-source నందు వీలైనచోట వుంచుము.

### చిహ్నముల పత్రికీకరణ

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 functions are usually documented in the c-source and macros, structs and enums in the header file.

#### సాధారణ టాగ్లు

మీరు వర్షనింగ్ సమాచారమును అన్ని పత్రికీకరణ మూలకాలకు జతచేయవచ్చును, api యెప్పుడు పరిచయం చేయబడిందో చెప్పుటకు, లేదా యెప్పుడు తీసివేయబడిందో చెప్పుటకు.

వర్షనింగ్ టాగ్స్

అప్పటినుంచి:

  కోడ్ యొక్క యే వర్షన్ నుండి API అందుబాటులోవుందో వివరణ.

తీసివేసిన:

  ఈ ఫంక్షన్ యికపై వుపయోగించుటలేదని పారాగ్రాఫ్ చెబుచున్నది. వివరణ చదువరిని కొత్త APIకు సూచించాలి.

(FIXME : స్థిరత్వ సమాచారము)

సాధారణ టాగ్లు

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

#### ఫంక్షన్ వ్యాఖ్యానపు బ్లాక్

దయచేసి దీనికి గుర్తువుంచండి:

- తిరిగివచ్చిన objects, lists, strings, మొదలగునవి, freed/unrefed/released చేయాలా వద్దా అనేదానిపై పత్రము.

- పారామితులు NULL కావచ్చా, వొకవేళ అయితే యేమి జరుగును అనేదానిపై పత్రము.

- తగుచోట్ల ఆసక్తికరమైన ప్రి-కండీషన్లు మరియు పోస్ట్-కండీషన్లను తెలుపుము.

Gtk-doc అన్ని చిహ్నములు (macros, functions) '_'తో ప్రారంభమగునవి వ్యక్తిగతమైనవని పరిగణించును. అవి స్టాటిక్ ఫంక్షన్సు వలె పరిగణించబడును.

gobject యింట్రోస్పెక్షన్ యెన్నోయేషన్ టాగ్స్ వద్ద కూడా చూడండి: http://live.gnome.org/GObjectIntrospection/Annotations

ఫంక్షన్ వ్యాఖ్యానపు బ్లాక్

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

ఫంక్షన్ టాగ్లు

తిరిగివచ్చినవి:

  పారాగ్రాఫ్ తిరిగివచ్చిన ఫలితాన్ని వివరిస్తుంది.

@...:

  ఒకవేళ ఫంక్షన్ వేరియాడిక్ ఆర్గుమెంట్లను కలిగివుంటే, మీరు ఈ టాగ్‌ను వుపయోగించాలి (@Varargs: చారిత్రక కారణాలకు కూడా పనిచేయును).

#### లక్షణము వ్యాఖ్యాము బ్లాక్

లక్షణము వ్యాఖ్యాము బ్లాక్

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

#### సంకేతపు వ్యాఖ్యానము బ్లాక్

దయచేసి దీనికి గుర్తువుంచండి:

- సంకేతము యెప్పుడు వెలువడింది మరియు అది సంకేతముల ముందు వెలువడిందా లేదా తర్వాత అనేది పత్రికీకరణ చేయును.

- సంకేత సంభాలిక నందు వొక అనువర్తనము యేమి చేయవచ్చును అనే పత్రము.

సంకేతపు వ్యాఖ్యానము బ్లాక్

    /**
     * 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 వ్యాఖ్యానము బ్లాక్

Struct వ్యాఖ్యానము బ్లాక్

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

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

Use `/*< private >*/` before the private struct fields you want to hide. Use `/*< public >*/` for the reverse behaviour.

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

#### Enum వ్యాఖ్యానము బ్లాక్

Enum వ్యాఖ్యానము బ్లాక్

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

Use `/*< private >*/` before the private enum values you want to hide. Use `/*< public >*/` for the reverse behaviour.

### ఉపయోగకర DocBook టాగ్స్

కోడ్‌ను పత్రికీకరణ చేయునప్పుడు యెక్కువ వుపయోగకరంగా వుండే మరికొన్ని DocBook టాగ్స్ యిక్కడ వున్నాయి.

GTK docs నందు వేరొక విభాగమునకు లింకు చేయుటకు:

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

మీరు లింకు యేర్పరచాలని కొరుకొనుచున్న పేజీ యొక్క పై అంశముపై SGML/XML idయే linkend. చాలా పేజీలకు ప్రస్తుతం యిదే పార్ట్ ("gtk", "gdk", "glib") మరియు పేజీ శీర్షిక ("Hash Tables"). విడ్జట్లకు యిది క్లాస్ నామము మాత్రమే. SGML/XML నిర్ధారించుటకు ఖాళీలు మరియు అండర్‌స్కోర్లు '-'గా మార్చబడినవి.

బాహ్య ఫంక్షన్‌ను సూచించుటకు, ఉ.దా. ప్రామాణిక C ఫంక్షన్:

    <function>...</function>

ఉదాహరణ కోడ్‌ను చేర్చుటకు:

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

లేదా, శీర్షిక అవసరములేని చాలా చిన్న కోడ్ ముక్కల కొరకు:

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

తరువాతి GTK-Doc కూడా అబ్రివేషన్‌ను మద్దతించును: |[ ... ]|

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>

To refer to keys use:

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

## 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 an 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/XML file `sgml/gnome-config.sgml` or .DocBook XML file `xml/gnome-config.xml`. (The name of the html file is based on the module name and the section title, or for gobjects it is based on the gobjects class name converted to lower case).

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

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

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

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

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

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

## Documenting other interfaces

So far we have been using GTK-Doc to document the API of code. The next sections contain suggestions how the tools can be used to document other interfaces too.

### Commandline options and man pages

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

#### Document the tool

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

#### Adding the extra configure check

Extra configure checks

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

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

#### Adding the extra makefile rules

Extra configure checks

    man_MANS = \
           meeper.1

    if ENABLE_GTK_DOC
    if ENABLE_MAN

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

    endif
    endif

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

### DBus interfaces

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

## Frequently asked questions

Question Answer
- No class hierarchy. The objects `xxx_get_type()` function has not been entered into the `<package>.types` file.
- Still no class hierarchy. Missing or wrong naming in `<package>-sections.txt` file (see explanation).
- Damn, I have still no class hierarchy. Is the object name (name of the instance struct, e.g. GtkWidget) part of the normal section (don't put this into Standard or Private subsections).
- No symbol index. Does the `<package>-docs.{xml,sgml}` contain a index that xi:includes the generated index?
- Symbols are not linked to their doc-section. Is the doc-comment using the correct markup (added #,% or ())? Check if the gtkdoc-fixxref warns about unresolvable xrefs.
- A new class does not appear in the docs. Is the new page xi:included from `<package>-docs.{xml,sgml}`.
- A new symbol does not appear in the docs. Is the doc-comment properly formatted. Check for spelling mistakes in the begin of the comment. Check if the gtkdoc-fixxref warns about unresolvable xrefs. Check if the symbol is correctly listed in the `<package>-sections.txt` in a public subsection.
- A type is missing from the class hierarchy. If the type is listed in `<package>.hierarchy` but not in `xml/tree_index.sgml` then double check that the type is correctly placed in the `<package>-sections.txt`. If the type instance (e.g. GtkWidget) is not listed or incidentialy makred private it will not be shown.
- I get foldoc links for all gobject annotations. Check that `xml/annotation-glossary.xml` is xi:included from `<package>-docs.{xml,sgml}`.
- Parameter 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 `<package>-sections.txt` file.
- Element typename in namespace '' encountered in para, but no template matches.

## Tools related to gtk-doc

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

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

Version 1.1, March 2000
2000 Free Software Foundation, Inc.

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

Everyone is permitted to copy and distribute verbatim copies of this license document, but changing it is not allowed.

## GNU Free Documentation License

### 0. PREAMBLE

The purpose of this License is to make a manual, textbook, or other written document free in the sense of freedom: to assure everyone the effective freedom to copy and redistribute it, with or without modifying it, either commercially or noncommercially. Secondarily, this License preserves for the author and publisher a way to get credit for their work, while not being considered responsible for modifications made by others.

This License is a kind of copyleft, which means that derivative works of the document must themselves be free in the same sense. It complements the GNU General Public License, which is a copyleft license designed for free software.

We have designed this License in order to use it for manuals for free software, because free software needs free documentation: a free program should come with manuals providing the same freedoms that the software does. But this License is not limited to software manuals; it can be used for any textual work, regardless of subject matter or whether it is published as a printed book. We recommend this License principally for works whose purpose is instruction or reference.

### 1. APPLICABILITY AND DEFINITIONS

This License applies to any manual or other work that contains a notice placed by the copyright holder saying it can be distributed under the terms of this License. The Document, below, refers to any such manual or work. Any member of the public is a licensee, and is addressed as you.

A Modified Version of the Document means any work containing the Document or a portion of it, either copied verbatim, or with modifications and/or translated into another language.

A Secondary Section is a named appendix or a front-matter section of the Document that deals exclusively with the relationship of the publishers or authors of the Document to the Document's overall subject (or to related matters) and contains nothing that could fall directly within that overall subject. (For example, if the Document is in part a textbook of mathematics, a Secondary Section may not explain any mathematics.) The relationship could be a matter of historical connection with the subject or with related matters, or of legal, commercial, philosophical, ethical or political position regarding them.

The Invariant Sections are certain Secondary Sections whose titles are designated, as being those of Invariant Sections, in the notice that says that the Document is released under this License.

The Cover Texts are certain short passages of text that are listed, as Front-Cover Texts or Back-Cover Texts, in the notice that says that the Document is released under this License.

A Transparent copy of the Document means a machine-readable copy, represented in a format whose specification is available to the general public, whose contents can be viewed and edited directly and straightforwardly with generic text editors or (for images composed of pixels) generic paint programs or (for drawings) some widely available drawing editor, and that is suitable for input to text formatters or for automatic translation to a variety of formats suitable for input to text formatters. A copy made in an otherwise Transparent file format whose markup has been designed to thwart or discourage subsequent modification by readers is not Transparent. A copy that is not Transparent is called Opaque.

Examples of suitable formats for Transparent copies include plain ASCII without markup, Texinfo input format, LaTeX input format, SGML or XML using a publicly available DTD, and standard-conforming simple HTML designed for human modification. Opaque formats include PostScript, PDF, proprietary formats that can be read and edited only by proprietary word processors, SGML or XML for which the DTD and/or processing tools are not generally available, and the machine-generated HTML produced by some word processors for output purposes only.

The Title Page means, for a printed book, the title page itself, plus such following pages as are needed to hold, legibly, the material this License requires to appear in the title page. For works in formats which do not have any title page as such, Title Page means the text near the most prominent appearance of the work's title, preceding the beginning of the body of the text.

### 2. VERBATIM COPYING

You may copy and distribute the Document in any medium, either commercially or noncommercially, provided that this License, the copyright notices, and the license notice saying this License applies to the Document are reproduced in all copies, and that you add no other conditions whatsoever to those of this License. You may not use technical measures to obstruct or control the reading or further copying of the copies you make or distribute. However, you may accept compensation in exchange for copies. If you distribute a large enough number of copies you must also follow the conditions in section 3.

You may also lend copies, under the same conditions stated above, and you may publicly display copies.

### 3. COPYING IN QUANTITY

If you publish printed copies of the Document numbering more than 100, and the Document's license notice requires Cover Texts, you must enclose the copies in covers that carry, clearly and legibly, all these Cover Texts: Front-Cover Texts on the front cover, and Back-Cover Texts on the back cover. Both covers must also clearly and legibly identify you as the publisher of these copies. The front cover must present the full title with all words of the title equally prominent and visible. You may add other material on the covers in addition. Copying with changes limited to the covers, as long as they preserve the title of the Document and satisfy these conditions, can be treated as verbatim copying in other respects.

If the required texts for either cover are too voluminous to fit legibly, you should put the first ones listed (as many as fit reasonably) on the actual cover, and continue the rest onto adjacent pages.

If you publish or distribute Opaque copies of the Document numbering more than 100, you must either include a machine-readable Transparent copy along with each Opaque copy, or state in or with each Opaque copy a publicly-accessible computer-network location containing a complete Transparent copy of the Document, free of added material, which the general network-using public has access to download anonymously at no charge using public-standard network protocols. If you use the latter option, you must take reasonably prudent steps, when you begin distribution of Opaque copies in quantity, to ensure that this Transparent copy will remain thus accessible at the stated location until at least one year after the last time you distribute an Opaque copy (directly or through your agents or retailers) of that edition to the public.

It is requested, but not required, that you contact the authors of the Document well before redistributing any large number of copies, to give them a chance to provide you with an updated version of the Document.

### 4. MODIFICATIONS

You may copy and distribute a Modified Version of the Document under the conditions of sections 2 and 3 above, provided that you release the Modified Version under precisely this License, with the Modified Version filling the role of the Document, thus licensing distribution and modification of the Modified Version to whoever possesses a copy of it. In addition, you must do these things in the Modified Version:

- A

  Use in the Title Page (and on the covers, if any) a title distinct from that of the Document, and from those of previous versions (which should, if there were any, be listed in the History section of the Document). You may use the same title as a previous version if the original publisher of that version gives permission.

- B

  List on the Title Page, as authors, one or more persons or entities responsible for authorship of the modifications in the Modified Version, together with at least five of the principal authors of the Document (all of its principal authors, if it has less than five).

- C

  State on the Title Page the name of the publisher of the Modified Version, as the publisher.

- D

  Preserve all the copyright notices of the Document.

- E

  Add an appropriate copyright notice for your modifications adjacent to the other copyright notices.

- F

  Include, immediately after the copyright notices, a license notice giving the public permission to use the Modified Version under the terms of this License, in the form shown in the Addendum below.

- G

  Preserve in that license notice the full lists of Invariant Sections and required Cover Texts given in the Document's license notice.

- H

  Include an unaltered copy of this License.

- I

  Preserve the section entitled History, and its title, and add to it an item stating at least the title, year, new authors, and publisher of the Modified Version as given on the Title Page. If there is no section entitled History in the Document, create one stating the title, year, authors, and publisher of the Document as given on its Title Page, then add an item describing the Modified Version as stated in the previous sentence.

- J

  Preserve the network location, if any, given in the Document for public access to a Transparent copy of the Document, and likewise the network locations given in the Document for previous versions it was based on. These may be placed in the History section. You may omit a network location for a work that was published at least four years before the Document itself, or if the original publisher of the version it refers to gives permission.

- K

  In any section entitled Acknowledgements or Dedications, preserve the section's title, and preserve in the section all the substance and tone of each of the contributor acknowledgements and/or dedications given therein.

- L

  Preserve all the Invariant Sections of the Document, unaltered in their text and in their titles. Section numbers or the equivalent are not considered part of the section titles.

- M

  Delete any section entitled Endorsements. Such a section may not be included in the Modified Version.

- N

  Do not retitle any existing section as Endorsements or to conflict in title with any Invariant Section.

If the Modified Version includes new front-matter sections or appendices that qualify as Secondary Sections and contain no material copied from the Document, you may at your option designate some or all of these sections as invariant. To do this, add their titles to the list of Invariant Sections in the Modified Version's license notice. These titles must be distinct from any other section titles.

You may add a section entitled Endorsements, provided it contains nothing but endorsements of your Modified Version by various parties--for example, statements of peer review or that the text has been approved by an organization as the authoritative definition of a standard.

You may add a passage of up to five words as a Front-Cover Text, and a passage of up to 25 words as a Back-Cover Text, to the end of the list of Cover Texts in the Modified Version. Only one passage of Front-Cover Text and one of Back-Cover Text may be added by (or through arrangements made by) any one entity. If the Document already includes a cover text for the same cover, previously added by you or by arrangement made by the same entity you are acting on behalf of, you may not add another; but you may replace the old one, on explicit permission from the previous publisher that added the old one.

The author(s) and publisher(s) of the Document do not by this License give permission to use their names for publicity for or to assert or imply endorsement of any Modified Version .

### 5. COMBINING DOCUMENTS

You may combine the Document with other documents released under this License, under the terms defined in section 4 above for modified versions, provided that you include in the combination all of the Invariant Sections of all of the original documents, unmodified, and list them all as Invariant Sections of your combined work in its license notice.

The combined work need only contain one copy of this License, and multiple identical Invariant Sections may be replaced with a single copy. If there are multiple Invariant Sections with the same name but different contents, make the title of each such section unique by adding at the end of it, in parentheses, the name of the original author or publisher of that section if known, or else a unique number. Make the same adjustment to the section titles in the list of Invariant Sections in the license notice of the combined work.

In the combination, you must combine any sections entitled History in the various original documents, forming one section entitled History; likewise combine any sections entitled Acknowledgements, and any sections entitled Dedications. You must delete all sections entitled Endorsements.

### 6. COLLECTIONS OF DOCUMENTS

You may make a collection consisting of the Document and other documents released under this License, and replace the individual copies of this License in the various documents with a single copy that is included in the collection, provided that you follow the rules of this License for verbatim copying of each of the documents in all other respects.

You may extract a single document from such a collection, and dispbibute it individually under this License, provided you insert a copy of this License into the extracted document, and follow this License in all other respects regarding verbatim copying of that document.

### 7. AGGREGATION WITH INDEPENDENT WORKS

A compilation of the Document or its derivatives with other separate and independent documents or works, in or on a volume of a storage or distribution medium, does not as a whole count as a Modified Version of the Document, provided no compilation copyright is claimed for the compilation. Such a compilation is called an aggregate, and this License does not apply to the other self-contained works thus compiled with the Document , on account of their being thus compiled, if they are not themselves derivative works of the Document. If the Cover Text requirement of section 3 is applicable to these copies of the Document, then if the Document is less than one quarter of the entire aggregate, the Document's Cover Texts may be placed on covers that surround only the Document within the aggregate. Otherwise they must appear on covers around the whole aggregate.

### 8. TRANSLATION

Translation is considered a kind of modification, so you may distribute translations of the Document under the terms of section 4. Replacing Invariant Sections with translations requires special permission from their copyright holders, but you may include translations of some or all Invariant Sections in addition to the original versions of these Invariant Sections. You may include a translation of this License provided that you also include the original English version of this License. In case of a disagreement between the translation and the original English version of this License, the original English version will prevail.

### 9. TERMINATION

You may not copy, modify, sublicense, or distribute the Document except as expressly provided for under this License. Any other attempt to copy, modify, sublicense or distribute the Document is void, and will automatically terminate your rights under this License. However, parties who have received copies, or rights, from you under this License will not have their licenses terminated so long as such parties remain in full compliance.

### 10. FUTURE REVISIONS OF THIS LICENSE

The Free Software Foundation may publish new, revised versions of the GNU Free Documentation License from time to time. Such new versions will be similar in spirit to the present version, but may differ in detail to address new problems or concerns. See http://www.gnu.org/copyleft/.

Each version of the License is given a distinguishing version number. If the Document specifies that a particular numbered version of this License or any later version applies to it, you have the option of following the terms and conditions either of that specified version or of any later version that has been published (not as a draft) by the Free Software Foundation. If the Document does not specify a version number of this License, you may choose any version ever published (not as a draft) by the Free Software Foundation.

### Addendum

To use this License in a document you have written, include a copy of the License in the document and put the following copyright and license notices just after the title page:

> Copyright YEAR YOUR NAME.

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

If you have no Invariant Sections, write with no Invariant Sections instead of saying which ones are invariant. If you have no Front-Cover Texts, write no Front-Cover Texts instead of Front-Cover Texts being LIST; likewise for Back-Cover Texts.

If your document contains nontrivial examples of program code, we recommend releasing these examples in parallel under your choice of free software license, such as the GNU General Public License, to permit their use in free software.