# ஜிடிகே டாக் கையேடு

1.15

உருவாக்குவோருக்கான ஜிடிகே டாக்(GTK-Doc) பயன்பாட்டு பயனர் கையேடு

க்ரிஸ் லைட்டில்

                chris@wilddev.net

டேன் மீயத்

                d-mueth@uchicago.edu

ஸ்டீபன் கோஸ்ட்

                ensonic@users.sf.net

ஜிடிகே-டாக் திட்டம்

    gtk-doc-list@gnome.org

2000, 2005, 2007-2009 டேன் மீயத் க்ரிஸ் லைட்டில் மற்றும் ஸ்டீபன் கோஸ்ட்

நீங்கள் இலவச மென் பொருள் அமைப்பினால் வெளியிடப்பட்ட ஜிஎன்யு பொது ஆவண அனுமதிக்கான இந்த 1.1 ம் பதிப்பு அல்லது அடுத்த பதிப்புகள் விதிகளின் படி நீங்கள் (விருப்பப்படி) மாற்றமில்லா தொகுதிகள், முன் அட்டை உரைகள், பின் அட்டை உரைகள் ஆக்கியன நீங்கலாக இதை பிரதி எடுக்கலாம், வினியோகிக்கலாம், மாற்றலாம். அனுமதியின் பிரதி இங்குள்ளது:included

நிறுவனங்களால் அவர்களது பொருட்கள், சேவைகளை குறிப்பிட பயனாகும் பல பெயர்களை அவர்களது வியாபார குறியாக சொல்கிறார்கள். அத்தகைய பெயர்கள் க்னோம் ஆவணங்களில் காணப்படுமானால், அவை க்னோம் ஆவண திட்ட உறுப்பினருக்கு தெரிவிக்கப்பட்டால், அவை தலை எழுத்துக்களாக அலல்து முதல் எழுத்து தலை எழுத்தாக காட்டப்படும்.

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
மால் க்னோம் டாக்-யுடில்ஸ் இட மாற்றம்

## அறிமுகம்

இந்த அத்தியாயம் ஜிடிகே-டாக் குறித்த அறிமுகம் தருகிறது. மேலும் அது என்ன எப்படி பயன்படுத்துவது என மேலோட்டமாக சொல்லுகிறது.

### ஜிடிகே டாக் என்பதென்ன?

ஜிடிகே டாக் சி குறியாக்கத்தை ஆவணப்படுத்துகிறது. இது எடுத்துக்காட்டாக ஜிடிகே+ மற்றும் க்னோம் நூலகங்கள் போன்ற நூலகங்களின் பொது ஏபிஐ களை ஆவணப்படுத்த பயன்படுகிறது. ஆனாலும் இது நிரல்களின் குறியாக்கத்தை ஆவணப்படுத்தக்கூட பயன்படுத்தலாம்.

### ஜிடிகே டாக் எப்படி வேலை செய்கிறது?

ஜிடிகே டாக் வேலை செய்வதெப்படி எனில் சிறப்பு ஒழுங்கில் விமர்சன தொகுதிகளாக செயல்களின் ஆவணங்கள் மூல கோப்புகளில் வைக்கப்படும். அல்லது ஜிடிகே டாக் பயன்படுத்தும் டெம்ப் கோப்புகளுக்கு சேர்க்கபடும். (ஆயினும் ஜிடிகே டாக் தலைப்பு கோப்புகளில் அறுதியிட்ட பங்ஷன்களை மட்டுமே ஆவணப்படுத்தும். நிலையான பங்க்ஷன்களுக்கு வெளியீடு தராது)

ஜிடிகே டாக் இல் பல பெர்ல் குறுநிரல்கள் உள்ளன.

இந்த நடப்பில் ஐந்து படிகள் உள்ளன

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. "வார்ப்புரு" கோப்புகள் உருவாக்கம் .gtkdoc-mktmpl இந்த துணை அடைவில் முதல் சுற்றில் சேகரித்த தகவல்களைக் கொண்டு பல கோப்புகளை உருவாக்குகிறது: `tmpl/` (இதை மீண்டும் மீண்டும் இயக்கலாம். எந்த கோப்பும் தொலைந்து போகாமல் இது பார்த்துக்கொள்ளும்.)

   ஜிடிகே டாக் 1.9 முதல் வார்ப்புருக்களை தவிர்க்கலாம். மக்கள் ஆவணத்தை குறீயாக்கத்தில் வைத்து இருப்பதையே நாங்கள் விரும்புகிறோம். gtkdocize இப்போது இந்த `--flavour no-tmpl` தேர்வை ஆதரிக்கிறது. இது (tmpl) வார்ப்புரு பயன்பாட்டை முற்றூம் தவிர்க்கும் ஒரு மேக் பைலை தேர்வுசெய்கிறது. நீங்கள் கைமுறையாக எந்த ஒரு 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 ஆவணங்கள் இடையில் குறுக்கு தொடுப்புகளை சரி செய்யலாம். உதாரணமாக ஜிடிகே+ ஆவணத்தில் ஜிலிப் கையேட்டில் ஆவணப்படுத்திய பல வகைகளுக்கு குறுக்கு தொடுப்புகள் இருக்கும். வினியோகிக்க டார் பால் செய்யும் போது gtkdoc-rebase எல்லா வெளி தொடுப்புக்களையும் வலை தொடுப்பாக மாற்றிவிடும். இதே நிரல் ஆவணங்கள் நிறுவப்படும்போது அவற்றை உள்ளமை தொடுப்புக்களாக மாற்றியமைக்கும். (மற்ற ஆவணங்கள் நிறுவப்பட்டு இருக்கும் பட்சத்தில்.)

### ஜிடிகே டாக் ஐ பெறுதல்

#### முன் தேவைகள்

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

நீங்கள் டாக்புக் இலிருந்து மேன் பக்கங்களை தயாரிக்க விரும்பினால் ..மொழிபெயர்ப்பு குறிப்புக்களை சற்றே நான் மாற்றியுள்ளேன். தொகுப்பு தலைப்புகள் மேலெழுத்தில் காட்டப்படும். ஜிடிகே நூலகம் என்னும் தலைப்பு ('GTK Library') பக்கங்களின் மேலே காட்டப்படும். திருத்திய தேதி கீழே காட்டப்படும். இதற்கு இங்கு ஒரு தொடுப்பு உள்ளது: http://www.ora.com/davenport குறிப்பு: இது இன்னும் செயலில் இல்லை..

#### நிறுவல்

மாடுலர் டாக் புக் ஸ்டைய்ல்ஷீட்ஸ் நிறுவப்பட செந்தரமான இடமில்லை.

ஜிடிகே டாக் இன் வடிவமைக்கும் குறுநிரல் மூன்று அடைவுகளை தானியங்கியாக பார்க்கும்.

`/usr/lib/sgml/stylesheets/nwalsh-modular` (ரெட் ஹாட் ஆல் பயன்படுத்தப்படுவது)

`/usr/lib/dsssl/stylesheets/docbook` (டெபியன் ஆல் பயன்படுத்தப்படுவது)

`/usr/share/sgml/docbkdsl` (சூசே ஆல் பயன்படுத்தப்படுவது)

ஸ்டைய்ல் ஷீட் கள் வேறெங்கும் நிறுவி இருப்பின் கை முறையாக ஜிடிகே டாக் ஐ வடிவமைக்க வேண்டும். கட்டளை தேர்ர்வு: `--with-dsssl-dir=<PATH_TO_TOPLEVEL_STYLESHEETS_DIR>`

### ஜிடிகே டாக் பற்றி

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

### ஆட்டோ கான்ஃப் உடன் ஒருங்கிணைப்பு

ரொம்ப சுலபம். `configure.ac` குறுநிரலுக்கு ஒரே ஒரு வரி மட்டும் சேருங்கள்.

ஆட்டோ கான்ஃப் உடன் ஒருங்கிணைப்பு

    # 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)
    ])

முதல் தரு மதிப்பு வடிவமைப்பு நேரத்தில் ஜிடிகே டாக் இன் பதிப்பை சோதிக்கிறது. இரண்டாவது தெர்வு தருமதிப்பு. இது இந்த நிரலால் பயன்படுத்தப்படுகிறது. gtkdocize. GTK_DOC_CHECK மேக்ரோ பல மாற்றிகளை வடிவமைத்து சேர்க்கிறது:

1. --with-html-dir=PATH : நிறுவிய ஆவணங்களுக்கான பாதை

2. ""--enable-gtk-doc :ஆவணமாக்கத்துக்கு ஜிடிகே டாக் ஐ பயன்படுத்துக. [முன்னிருப்பு=இல்லை]

3. --enable-gtk-doc-html : html ஒழுங்கில் ஆவணத்தை உருவாக்குக[முன்னிருப்பு=ஆம்]

4. --enable-gtk-doc-pdf : pdf ஒழுங்கில் ஆவணத்தை உருவாக்குக [முன்னிருப்பு=இல்லை]

ஜிடிகே டாக் GTK-Doc முன்னிருப்பாக செயலிழந்து இருக்கும்! ஆகவே அடுத்த `configure` இயக்கத்துக்கு இந்த தேர்வை செய்க: `'--enable-gtk-doc'` . இல்லையானால் முன் உருவாக்கிய ஆவணங்கள் நிறூவப்படும்.( இது பயனர்களுக்கு புரியும், நல்லது. ஆனால் உருவாக்குவோருக்கு அல்ல).

மேலும் பின் வரும் வரியை உங்கள் `configure.ac` குறுநிரலில் அமைத்துக்கொள்க. இது gtkdocize நிரலை தானியங்கியாக `GTK_DOC_CHECK` இன் மேக்ரோ அறிதியீட்டை உங்கள் திட்டத்துக்கு பிரதி எடுக்கிறது.

gtkdocize க்கு முன்னேற்பாடு

    AC_CONFIG_MACRO_DIR(m4)

### ஆட்டோமேக் உடன் ஒருங்கிணைப்பு

முதலில் gtkdoc-sources அடைவிலிருந்து உங்கள் திட்டத்தின் ஏபிஐ ஆவண அடைவு ( `./docs/reference/<package>`) க்கு `Makefile.am` ஐ பிரதி எடுக்கவும். உங்களுக்கு பல டாக் பொதிகள் இருப்பின் இதை ஒவ்வொன்றுக்கும் செய்யவும்.

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 போது ஜிடிகே- டாக் ஐ செயலாக்குக

    DISTCHECK_CONFIGURE_FLAGS=--enable-gtk-doc

### ஆட்டொஜென் உடன் ஒருங்கிணைத்தல்

முக்கால்வாசி திட்டங்களில் (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 build) இயக்குதல்

இப்போது கட்டுமானத்திற்கு ஆயத்தமாகிவிட்டோம். முதலில் நாம் மீன்டும் `autogen.sh` ஐ இயக்கவேண்டும். இது உங்களுக்கு கட்டமைப்பை இயக்கினால் அதற்கு `--enable-gtk-doc` தேர்வை தரவும். இல்லையானால் கைமுறையாக இதே தேர்வுடன் `configure` ஐ பிரிதொரு முறை இயக்கவும்.

ஆவண அடைவுகளில் (doc-dirs) பல கூடுதல் கோப்புகளை முதல் மேக் இயக்கம் உருவாக்கும்.அவற்றில்ய் முக்கியமானவை: `<package>.types`, `<package>-docs.sgml`, `<package>-sections.txt`.

டாக் உருவாக்கியை (doc build) இயக்குதல்

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

இப்போது உங்கள் உலாவியை `docs/reference/<package>/index.html` க்கு சுட்டிக்காட்டலாம். ஆமாம், இது கொஞ்சம் ஏமாற்றமாகத்தான் இருக்கிறது. கவலை வேண்டாம். அடுத்த அத்தியாயத்தில் எப்படி இவற்றை உயிருக்கு கொண்டு வருவது என பார்க்கலாம்.

### வெர்ஷன் கன்ட்ரோல் அமைப்புகளுடன் ஒருங்கிணைத்தல்

குத்து மதிப்பாக சொல்லப்போனால் , நீங்கள் திருத்தும் கோப்புகள்தான் வெர்ஷன் கட்டுப்படுக்கு போக வேண்டும். வழக்கமாக இவைதான் அந்த கோப்புகள்: `<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.

ஜிடிகே டாக் விமரிசன தொகுப்பு

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

### ஆவணமாக்க விமரிசனங்கள்

'*' இல் துவங்கும் பல்வரி விமர்சனம் ஜிடிகே டாக் கருவிகளால் ஒரு ஆவணமாக்கல் தொகுதியாக கையாளப்படும்.

ஜிடிகே டாக் விமரிசன தொகுப்பு

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

'identifier' எனப்படும் இனம் காட்டி விமர்சனம் பொருந்தும் உருப்படியின் பெயருடன் கூடிய ஒரு வரி. உருப்படியை பொருத்து இலக்கணம் சற்று மாறலாம்.

ஆவண ( 'documentation') தொகுதி ஒவ்வொரு அடையாளத்துக்கும் கூட தனித் தனியாகும் .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).

ஜிடிகே டாக்

சிறப்பு குறிகளான '<', '>', '()', '@', '%', அல்லது '#' ஐ ஜிடிகே டாக் மாற்றாமல் அப்படியே ஆவணத்தில் பயன்படுத்த அவற்றுக்கான ஹெச்எம்எல் ஐ பயன்படுத்துக: "&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`.

ஜிடிகே டாக்

### ஆவணப்படுத்தும் தொகுதிகள்

ஆவணத்தில் ஒவ்வொரு பிரிவும் ஒரு வகுப்பு அல்லது கூறு குறித்து தகவலைப்பெற்றிருக்கும். ஒரு பாகத்தை அறிமுகம் செய்ய ஒரு தொகுதியை எழுதலாம். குறுகிய விவரணம் உள்ளடக்க பட்டியலில் கூட பயன்படுத்தப்படும். எல்லா @ புலங்களூம் தேர்வுக்குரியன.

பிரிவு விமரிசன தொகுதி

    /**
     * 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:<பெயர்>

  பகுதி ஆவணத்தை பெயர் `<package>-sections.txt`கோப்புக்கு இணைக்கிறது. கொடுக்கப்பட்ட பெயர் `<package>-sections.txt` கோப்பில் <FILE> குறிப்புடன் பொருந்த வேண்டும்.

@short_description

  பகுதி பக்கத்தின் மேலே உள்ளடக்க பட்டியலுக்கான தொடுப்புகளுக்குப்பின் காணும் ஒரு வரி விவரம்.

@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

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

  - Stable - நிலையான- எனில் இடைமுகம் நிலையானது. மூன்றாம் நபர்கள் இவற்றை ஒட்டி நிரல்களை எழுதி வெளியிடலாம்; எந்த பெரிய வெளியீட்டுக்குள் அவை வெளியிடப்பட்டதோ அதன் சிறிய வெளியீட்டுகளுக்குள் அவை சரியாக வேலை செய்யும் என நம்பலாம். பெரிய வெளியீடில் கூட இசைவு இல்லாமல் போவது துர்லபம்.

  - 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 - தனிப்பயன் எனில் க்னோம் இல் மட்டும் பயன்படும் இடைமுகம். ஆயின் இறுதி பயனருக்கு ஆவணப்படுத்தவில்லை. அப்படிப்பட்ட செயல்கள் குறீப்பிட்ட ஆவணப்படுத்தப்பட்ட வழியில் மட்டுமே பயன்படுத்தப்பட வேண்டும்.

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

@include

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

@image

  The image to display at the top of the reference page for this section. This will often be some sort of a diagram to illustrate the visual appearance of a class or a diagram of its relationship to other classes. This item is optional.

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

### சிம்பல்களை ஆவணப் படுத்தல்

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.

#### பொது டேக் ஒட்டுகள்

You can add versioning information to all documentation elements to tell when an api was introduced, or when it was deprecated.

டேக் களை பதிப்பாக்கல்

இதிலிருந்து:

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

கைவிடப்பட்டது.

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

FIXME : Stability information)

பொது டேக் ஒட்டுகள்

    /**
     * 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)
    {
    ...

#### பங்ஷன் விமரிசன தொகுதி

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

- Document whether parameters can be NULL, and what happens if they are.

- Mention interesting pre-conditions and post-conditions where appropriate.

க்கு நினைவிருத்துக

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

Also, take a look at gobject introspection annotation tags: 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.
     */

பங்ஷன் டேக் ஒட்டுகள்

திருப்பிகிடைப்பவை:

  Paragraph describing the returned result.

@...:

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

#### பண்புகள் விமரிசன தொகுதி

பண்புகள் விமரிசன தொகுதி

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

#### சமிக்ஞை விமரிசன தொகுதி

- சமிக்ஞை எப்போது வெளியிடப்படும் மற்றும் மற்ற சமிக்ஞைகளுக்கு முன்னா பின்னா வெளியிடப்படும் என ஆவணப்படுத்தல்.

- Document what an application might do in the signal handler.

க்கு நினைவிருத்துக

சமிக்ஞை விமரிசன தொகுதி

    /**
     * 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",
                    ...

#### அமைப்பு விமரிசன தொகுதி

அமைப்பு விமரிசன தொகுதி

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

#### ஈநம் விமரிசன தொகுதி

ஈநம் விமரிசன தொகுதி

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

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

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

    <function>...</function>

ஜிடிகே டாக்

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>

## கூடுதல் கோப்புகளை நிரப்புதல்

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

### கோப்பு வகையை திருத்துதல்

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

ஜிடிகே டாக்

### முதன்மை ஆவணத்தை திருத்துதல்

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.

ஜிடிகே டாக்

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.

முதன்மை ஆவணத்தின் தலைப்பு

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

### தொகுதி கோப்பை திருத்துதல்

ஜிடிகே டாக்

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.

## விடையை கட்டுப்படுத்தல்

ஜிடிகே டாக்

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.

ஜிடிகே டாக்

ஜிடிகே டாக்

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

கேள்வி பதில்
- வகுப்பு கட்டுமுறை இல்லை `""xxx_get_type()` பொருட்கள் பங்ஷன் இன்னும் `<package>.வகைகள்` கோப்பில் உள்ளிடப்படவில்லை
- இன்னும் வகுப்பு கட்டுமுறை இல்லை `<package>-sections.txt` கோப்பில் தவறான பெயரிடுதல் அல்லது காணவில்லை (பார்க்க: விளக்கம்)
- அடடா, இன்னும் வகுப்பு கட்டுமுறை இல்லை Is the object name (name of the instance struct, e.g. ஜிடிகேவிட்செட்) part of the normal section (don't put this into Standard or Private subsections).
- சிம்பல் குறி அட்டவணை இல்லை 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. ஜிடிகேவிட்செட்) 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.
- குறி XYZ இல் இரு முறை காண்கிறது.

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

பதிப்பு 1.1, மார்ச் 2000
2000 Free Software Foundation, Inc.

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

இந்த லைசென்ஸ் ஆவணத்தை அனவரும் பிரதி எடுத்து வினியோகிக்கலாம் ஆனால் மாற்றக்கூடாது.

## க்னூ இலவச ஆவண லைசென்ஸ்

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

நீங்கள் ஒரு Document ஆவணத்தின் மாற்றப்பட்ட பதிப்பு(Modified Version) ஐ கீழ் கண்ட தொகுதிகளின் விதிகளூக்கு இணங்க வினியோகிக்கலாம்: 2 and 3 கட்டுப்பாடு எது எனில் யாரிடம் எந்த பதிப்பு இருக்கிறதோ அதே லைசன்ஸ் கீழ் வெளியிட வேண்டும். மாற்றிய பதிப்பு ஆவணத்தின் பங்கை செய்ய வேண்டும். மேலும் பின் வருவனவற்றை மாற்றிய பதிப்பில் செய்ய வேண்டும்.:

- A

  முந்தைய பதிப்புகளின் வரலாற்றை ஆவணத்தின் வரலாற்றில் எழுதுக. இப்பதிப்புகளின்

- B

  Title Page, இல் ஆசிரியர்களாக பட்டியலிடப்பட்டதில் ஒருவரோ மேலுமோ யார் மாற்றங்களை செய்தனரோ அவரது பெயர்களையும் Modified Version இல் சேர்க்கவும். Document இன் ஆசிரியர்கள் ஐந்துக்கு குறைவாக இருப்பின் அனைத்து பெயர்களூம் அதிகமாக இருப்பின் குறைந்தது ஐந்து முக்கிய ஆசிரியர்கள் பெயர்களும் சேர்க்கப்பட வேண்டும்.

- C

  Title Page இல் வெளியிடுவோர் பெயராக Modified Version ஐ வெளியிடுவோர் பெயரை குறிப்பிடுக.

- D

  Document இன் காப்புரிமையை பாதுகாக்கவும்.

- E

  காப்புரிமை அறிவிப்புக்கு அருகில் உங்கள் மாற்றங்களுக்கான காப்புரிமையை வெளியிடுக.

- F

  உங்கள் காப்புரிமை அறிவிப்புக்கு பின்னாலேயே Modified Version ஐ பொது ஜனம் பயன்படுத்த பின் வரும் படிவத்தில் இந்த லைசென்ஸ் மூலம் அனுமதி வழங்குக.

- G

  link linkend="fdl-invariant"> Invariant Sections

- H

  இந்த லைசென்ஸின் மாற்றப்படாத வடிவத்தையும் ஒரு பிரதி வைத்திருங்கள்.

- I

  History எனக்குறித்த தொகுதி, அதன் தலைப்பு இவற்றை பாதுகாக்கவும். இதனுடன் Title Page. இல் தரப்பட்ட Modified Version இன் தலைப்பு, வருடம், புதிய ஆசிரியர்கள், வெளியிடுவோர் , ஆகியவற்றை சேர்க்கவும். Document இல் அப்படி History எனக்குறித்த தொகுதி இல்லாவிடில் வருடம், புதிய ஆசிரியர்கள், வெளியிடுவோர் , ஆகியவற்றை தலைப்பு பக்கத்தில் உள்ளபடி உருவாக்கி பின் புதிதாக முன் சொன்னவாறு மாற்றியதை சேர்க்கவும்..

- J

  ஆவணத்தின் பிரதிக்கு பொதுஜன அணுகலுக்கு தரப்பட்ட Document இல் காணும் Transparent தொடுப்பை பாதுகாக்கவும்.அதேபோல முதைய பதிப்புகளில் உள்ள தொடுப்புகளையும் பாதுகாக்கவும். இவற்றை History பகுதியில் வைக்கலாம். ஆவணத்துக்கு நான்கு வருடங்கள் முன் வெளியிட்டவற்றையும் ஆசிரியர் நீக்கலாம் என அனுமதி தந்தவற்றையும் நீக்கலாம்.

- K

  Acknowledgements அல்லது Dedications எனக்குறித்த எந்த தொகுதியிலும் தொகுதியின் தலைப்பையும் அதில் உள்ளவற்றில் ஒவ்வொரு பங்கீடு அளித்தோரின் நன்றி அறிதல் /அர்ப்பணம் ஆகியவற்றின் சாரத்தையும் பாதுகாக்கவும் ,

- L

  Document, இன் Invariant Sections of the Document களை உரை தலைப்புகளை மாற்றாமல் பாதுகாக்கவும். தொகுதி எண்களும் அல்லது அதன் சமானமானவையும் இதில் சேராது.

- M

  Endorsements இல் உள்ளதை நீக்கவும். அப்படிப்பட்ட எந்த தொகுதியும் Modified Version இல் இருத்தலாகாது..

- N

  இருப்பிலுள்ள எந்த தொகுதியையும் Endorsements என் மறு பெயரிடவோ அல்லது Invariant Section உடன் மோதும் எதையும் செய்யலாகாது

Modified Versionஇல் புதிய விஷயம் இருந்தாலோ அல்லது Secondary Sections என அனுபந்தம் இருந்து அதில் ஆவணத்திலிருந்து பிரதி எடுத்த ஏதும் இல்லாமல் இருந்தாலோ நீங்கள் தேர்ந்தெடுத்து அவற்றை முழுதுமோ பகுடியோ மாறாதவை என குறிப்பிடலாம். இதை செய்ய அவற்றின் தலைப்புகளை மாற்றிய பதிப்பு நோட்டீசில் Invariant Sections பட்டியலில் சேர்க்கவும். இந்த தலைப்புகள் மற்ற தலைப்புகளீன் பெயரிலிருந்து மாறுபட்டு இருத்தல் வேண்டும்.

சகாக்கள் எழுதிய விமர்சனங்கள், மதிப்புரைகள் அல்லது ஒரு நிறுவனம் உங்கள் Modified Version ஐ திறனாய்வு செய்து தகுதி சான்று கொடுத்து இருப்பின் அவை மட்டும் இருக்கும் பட்சத்தில் நீங்கள் Endorsements என தலைப்பிட்ட தொகுதி ஒன்றை சேர்க்கலாம்.

link linkend="fdl-cover-texts">Front-Cover Text

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 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 2010, I. Felix.

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

உங்கள் ஆவணத்தில் முக்கியமல்லாத நிரல் குறியீட்டு உதாரணங்கள் இருப்பின் , எங்கள் பரிந்துரை: இவற்றின் இலவச பயனுக்கு இந்த உதாரணங்களை இணையாக மென்பொருள் அனுமதிக்கான உங்கள் தேர்வில் வெளியிடுங்கள்.மாதிரிக்கு: GNU General Public License,