GTK Doc - en to en_GB translation catalogue (124 entries)

en: User manual for developers with instructions of GTK-Doc usage.
en_GB: User manual for developers with instructions on GTK-Doc usage.

en: Dan Mueth and Chris Lyttle and Stefan Kost
en_GB: Dan Mueth, Chris Lyttle and Stefan Kost

en: Permission is granted to copy, distribute and/or modify this document under the terms of the <citetitle>GNU Free Documentation License</citetitle>, Version 1.1 or any later version published by the Free Software Foundation with no Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts. A copy of the license is <link linkend="fdl">included</link>.
en_GB: Permission is granted to copy, distribute and/or modify this document under the terms of the <citetitle>GNU Free Documentation Licence</citetitle>, Version 1.1 or any later version published by the Free Software Foundation with no Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts. A copy of the licence is <link linkend="fdl">included</link>.

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

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

en: <guilabel>Writing the documentation.</guilabel> The author fills in the source files with the documentation for each function, macro, union etc. (In the past information was entered in generated template files, which is not recommended anymore).
en_GB: <guilabel>Writing the documentation.</guilabel> The author fills in the source files with the documentation for each function, macro, union etc. (In the past information was entered in generated template files, which is not recommended any more).

en: <guilabel>Gathering information about the code.</guilabel><application>gtkdoc-scan</application> scans the header files of the code looking for declarations of functions, macros, enums, structs, and unions. It creates the file <filename>&lt;module&gt;-decl-list.txt</filename> 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 <filename>&lt;module&gt;-sections.txt</filename> 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 <filename>&lt;module&gt;-decl.txt</filename>. This file contains the full declarations found by the scanner. If for some reason one would like some sybols to show up in the docs, where the full declaration cannot be found by th scanner or the declaration should appear differently, one can place enties similar to the ones in <filename>&lt;module&gt;-decl.txt</filename> into <filename>&lt;module&gt;-overrides.txt</filename>. <application>gtkdoc-scanobj</application> 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.
en_GB: <guilabel>Gathering information about the code.</guilabel><application>gtkdoc-scan</application> scans the header files of the code looking for declarations of functions, macros, enums, structs, and unions. It creates the file <filename><replaceable>module</replaceable>-decl-list.txt</filename> 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 <filename><replaceable>module</replaceable>-sections.txt</filename> 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 <filename><replaceable>module</replaceable>-decl.txt</filename>. 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 <filename><replaceable>module</replaceable>-decl.txt</filename> into <filename><replaceable>module</replaceable>-overrides.txt</filename>. <application>gtkdoc-scanobj</application> 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.

en: <guilabel>Generating the "template" files.</guilabel><application>gtkdoc-mktmpl</application> creates a number of files in the <filename class="directory">tmpl/</filename> subdirectory, using the information gathered in the first step. (Note that this can be run repeatedly. It will try to ensure that no documentation is ever lost.)
en_GB: <guilabel>Generating the "template" files.</guilabel> <application>gtkdoc-mktmpl</application> creates a number of files in the <filename class="directory">tmpl/</filename> subdirectory, using the information gathered in the first step. (Note that this can be run repeatedly. It will try to ensure that no documentation is ever lost.)

en: Since gtk-doc 1.9 the templates can be avoided. We encourage people to keep documentation in the code. <application>gtkdocize</application> supports now a <command>--flavour no-tmpl</command> option that chooses a makefile that skips tmpl usage totally. If you have never changed file in tmpl by hand, please remove the dir once.
en_GB: Since GTK-Doc 1.9 the templates can be avoided. We encourage people to keep documentation in the code. <application>gtkdocize</application> supports now a <command>--flavour no-tmpl</command> option that chooses a makefile that skips <filename class="directory">tmpl</filename> usage totally. If you have never changed file in <filename class="directory">tmpl</filename> by hand, please remove the directory at once.

en: <guilabel>Generating the SGML/XML and HTML.</guilabel><application>gtkdoc-mkdb</application> turns the template files into SGML or XML files in the <filename class="directory">sgml/</filename> or <filename class="directory">xml/</filename> subdirectory. If the source code contains documentation on functions, using the special comment blocks, it gets merged in here. If there are no tmpl files used it only reads takes docs from sources and introspection data. <application>gtkdoc-mkhtml</application> turns the SGML files into HTML files in the <filename class="directory">html/</filename> subdirectory. Files in <filename class="directory">sgml/</filename> or <filename class="directory">xml/</filename> and <filename class="directory">html/</filename> directories are always overwritten. One should never edit them directly.
en_GB: <guilabel>Generating the SGML/XML and HTML.</guilabel> <application>gtkdoc-mkdb</application> turns the template files into SGML or XML files in the <filename class="directory">sgml/</filename> or <filename class="directory">xml/</filename> subdirectory. If the source code contains documentation on functions, using the special comment blocks, it gets merged in here. If there are no <filename class="directory">tmpl</filename> files used it only reads takes docs from sources and introspection data. <application>gtkdoc-mkhtml</application> turns the SGML files into HTML files in the <filename class="directory">html/</filename> subdirectory. Files in <filename class="directory">sgml/</filename> or <filename class="directory">xml/</filename> and <filename class="directory">html/</filename> directories are always overwritten. One should never edit them directly.

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

en: <guilabel>Perl v5</guilabel> - the main scripts are in Perl.
en_GB: <guilabel>Perl v5</guilabel> — the main scripts are in Perl.

en: <guilabel>DocBook DTD v3.0</guilabel> - This is the DocBook SGML DTD. <ulink url="http://www.ora.com/davenport" type="http">http://www.ora.com/davenport</ulink>
en_GB: <guilabel>DocBook DTD v3.0</guilabel> — This is the DocBook SGML DTD. <ulink url="http://www.ora.com/davenport" type="http">http://www.ora.com/davenport</ulink>

en: <guilabel>Jade v1.1</guilabel> - This is a DSSSL processor for converting SGML to various formats. <ulink url="http://www.jclark.com/jade" type="http">http://www.jclark.com/jade</ulink>
en_GB: <guilabel>Jade v1.1</guilabel> — This is a DSSSL processor for converting SGML to various formats. <ulink url="http://www.jclark.com/jade" type="http">http://www.jclark.com/jade</ulink>

en: <guilabel>Modular DocBook Stylesheets</guilabel> 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. <ulink url="http://nwalsh.com/docbook/dsssl" type="http">http://nwalsh.com/docbook/dsssl</ulink>
en_GB: <guilabel>Modular DocBook Stylesheets</guilabel> This is the DSSSL code to convert DocBook to HTML (and a few other formats). It's used together with jade. The DSSSL code has been customised slightly, in gtk-doc.dsl, to colour the program code listings/declarations, and to support global cross-reference indices in the generated HTML. <ulink url="http://nwalsh.com/docbook/dsssl" type="http">http://nwalsh.com/docbook/dsssl</ulink>

en: <guilabel>docbook-to-man</guilabel> - if you want to create man pages from the DocBook. I've customized the 'translation spec' slightly, to capitalise section headings and add the 'GTK Library' title at the top of the pages and the revision date at the bottom. There is a link to this on <ulink url="http://www.ora.com/davenport" type="http">http://www.ora.com/davenport</ulink> NOTE: This does not work yet.
en_GB: <guilabel>docbook-to-man</guilabel> — if you want to create man pages from the DocBook. The 'translation spec' has been customised slightly, to capitalise section headings and add the 'GTK Library' title at the top of the pages and the revision date at the bottom. There is a link to this on <ulink url="http://www.ora.com/davenport" type="http">http://www.ora.com/davenport</ulink> NOTE: This does not work yet.

en: gtk-doc's configure script searches these 3 directories automatically:
en_GB: GTK-Doc's configure script searches these 3 directories automatically:

en: <filename> /usr/lib/sgml/stylesheets/nwalsh-modular </filename> (used by RedHat)
en_GB: <filename>/usr/lib/sgml/stylesheets/nwalsh-modular</filename> (used by Red Hat)

en: <filename> /usr/lib/dsssl/stylesheets/docbook </filename> (used by Debian)
en_GB: <filename>/usr/lib/dsssl/stylesheets/docbook</filename> (used by Debian)

en: <filename> /usr/share/sgml/docbkdsl </filename> (used by SuSE)
en_GB: <filename>/usr/share/sgml/docbkdsl</filename> (used by SuSE)

en: If you have the stylesheets installed somewhere else, you need to configure gtk-doc using the option: <command> --with-dsssl-dir=&lt;PATH_TO_TOPLEVEL_STYLESHEETS_DIR&gt; </command>
en_GB: If you have the stylesheets installed somewhere else, you need to configure GTK-Doc using the option: <command> --with-dsssl-dir=&lt;PATH_TO_TOPLEVEL_STYLESHEETS_DIR&gt; </command>

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

en: (who it is meant for, where you can get it, license)
en_GB: (who it is meant for, where you can get it, licence)

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

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

en: Gtk-Doc is disabled by default! Remember to pass the option <option>'--enable-gtk-doc'</option> to the next <filename>configure</filename> run. Otherwise pregenerated documentation is installed (which makes sense for users but not for developers).
en_GB: GTK-Doc is disabled by default! Remember to pass the option <option>--enable-gtk-doc</option> to the next <filename>configure</filename> run. Otherwise pre-generated documentation is installed (which makes sense for users but not for developers).

en: Furthermore it is recommended that you have the following line inside you <filename>configure.ac</filename> script. This allows <filename>gtkdocize</filename> to automatically copy the macro definition for <function>GTK_DOC_CHECK</function> to your project.
en_GB: Furthermore it is recommended that you have the following line inside your <filename>configure.ac</filename> script. This allows <filename>gtkdocize</filename> to automatically copy the macro definition for <function>GTK_DOC_CHECK</function> to your project.

en: First copy the <filename>Makefile.am</filename> from the examples subdirectory of the gtkdoc-sources to your project's API documentation directory ( <filename class="directory">./docs/reference/&lt;package&gt;</filename>). If you have multiple doc-packages repeat this for each one.
en_GB: First copy the <filename>Makefile.am</filename> from the <filename class="directory">examples</filename> subdirectory of the GTK-Doc sources to your project's API documentation directory (<filename class="directory">./docs/reference/<replaceable>package</replaceable></filename>). If you have multiple doc-packages, repeat this for each one.

en: The next step is to edit the setting inside the <filename>Makefile.am</filename>. 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 <option>&lt;TOOLNAME&gt;_OPTIONS</option>. All the tools support <option>--help</option> to list the supported parameters.
en_GB: The next step is to edit the settings inside the <filename>Makefile.am</filename>. 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 <option><replaceable>TOOLNAME</replaceable>_OPTIONS</option>. All the tools support <option>--help</option> to list the supported parameters.

note: FIXME: explain options ?
en: You may also want to enable gtk-doc for the distcheckmake target. Just add then one-liner show in the next example to you top-level <filename>Makefile.am</filename>:
en_GB: You may also want to enable GTK-Doc for the <literal>distcheckmake</literal> target. Just add the line shown in the next example to your top-level <filename>Makefile.am</filename>:

en: Enable gtk-doc during make distcheck
en_GB: Enable GTK-Doc during make distcheck

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

en: When running <filename>gtkdocize</filename> it copies <filename>gtk-doc.make</filename> to you project root (or any directory specified by the --docdir option). If also check you configure script for the <function>GTK_DOC_CHECK</function> invocation.
en_GB: When running <filename>gtkdocize</filename> it copies <filename>gtk-doc.make</filename> to your project root (or any directory specified by the <option>--docdir</option> option). It also checks your configure script for the <function>GTK_DOC_CHECK</function> invocation.

en: Historically gtk-doc was gerating template files where developers entered the docs. this turned out to be not so good. Since a few version gtk-doc could also get all the information from source comments. Since gtk-doc 1.9 the templates can be avoided. We encourage people to keep documentation in the code. <application>gtkdocize</application> supports now a --flavour=no-tmpl option that chooses a makefile that skips tmpl usage totally. If you have never changed file in tmpl by hand, please remove the dir once.
en_GB: Historically GTK-Doc was generating template files where developers entered the docs. this turned out to be not so good. Since a few versions ago, GTK-Doc can also get all the information from source comments. Since GTK-Doc 1.9 the templates can be avoided. We encourage people to keep documentation in the code. <application>gtkdocize</application> now supports a <option>--flavour=no-tmpl</option> option that chooses a makefile that skips <filename class="directory">tmpl</filename> usage totally. If you have never changed a file in <filename class="directory">tmpl</filename> by hand, please remove the directory at once.

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

en: The first make run generates several additional files in the doc-dirs. The important ones are: <filename>&lt;package&gt;.types</filename>, <filename>&lt;package&gt;-docs.sgml</filename>, <filename>&lt;package&gt;-sections.txt</filename>.
en_GB: The first make run generates several additional files in the doc-dirs. The important ones are: <filename><replaceable>package</replaceable>.types</filename>, <filename><replaceable>package</replaceable>-docs.sgml</filename> and <filename><replaceable>package</replaceable>-sections.txt</filename>.

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

en: As a rule of the thumb, it's those files you edit, that should go under version control. For typical projects it's these files: <filename>&lt;package&gt;.types</filename><filename>&lt;package&gt;-docs.sgml</filename><filename>&lt;package&gt;-sections.txt</filename><filename>Makefile.am</filename>
en_GB: As a rule of thumb, it is the files you edit that should go under version control. For typical projects it's these files: <filename><replaceable>package</replaceable>.types</filename>, <filename><replaceable>package</replaceable>-docs.sgml</filename>, <filename><replaceable>package</replaceable>-sections.txt</filename> and <filename>Makefile.am</filename>.

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

en: In the past most documentation had to be filled into files residing inside the <filename>tmpl</filename> directory. This has the disadvantages that the information is often not updated and also that the file tend to cause conflicts with version control systems.
en_GB: In the past most documentation had to be filled into files residing inside the <filename class="directory">tmpl</filename> directory. This has the disadvantages that the information is often not updated and also that the file tend to cause conflicts with version control systems.

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

en: Gtk-Doc comment block
en_GB: GTK-Doc comment block

en: A multiline comment that starts with an additional '*' marks a documentation block that will be processed by the Gtk-Doc tools. <placeholder-1/>
en_GB: A multiline comment that starts with an additional <literal>*</literal> marks a documentation block that will be processed by the GTK-Doc tools. <placeholder-1/>

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

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

en: Use function() to refer to functions or macros which take arguments.
en_GB: Use <literal>function()</literal> to refer to functions or macros which take arguments.

en: Use @param to refer to parameters. Also use this when referring to parameters of other functions, related to the one being described.
en_GB: Use <literal>@param</literal> to refer to parameters. Also use this when referring to parameters of other functions, related to the one being described.

en: Use %constant to refer to a constant, e.g. %G_TRAVERSE_LEAFS.
en_GB: Use <literal>%constant</literal> to refer to a constant, e.g. <literal>%G_TRAVERSE_LEAFS</literal>.

en: Use #symbol to refer to other types of symbol, e.g. structs and enums and macros which don't take arguments.
en_GB: Use <literal>#symbol</literal> to refer to other types of symbol, e.g. structs and enums and macros which don't take arguments.

en: Use #Object::signal to refer to a GObject signal
en_GB: Use <literal>#Object::signal</literal> to refer to a GObject signal

en: Use #Object:property to refer to a GObject property
en_GB: Use <literal>#Object:property</literal> to refer to a GObject property

en: Use #Struct.field to refer to a field inside a structure.
en_GB: Use <literal>#Struct.field</literal> to refer to a field inside a structure.

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

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

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

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

en: A list of symbols that are related to this section..
en_GB: A list of symbols that are related to this section.

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

en: 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.
en_GB: 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.

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

en: 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.
en_GB: 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.

en: The <literal>#include</literal> files to show in the section synopsis (a comma separated list), overriding the global value from the <link linkend="metafiles_sections">section file</link> or command line. This item is optional.
en_GB: The <literal>#include</literal> files to show in the section synopsis (a comma-separated list), overriding the global value from the <link linkend="metafiles_sections">section file</link> or command line. This item is optional.

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

en: Each symbol (function, macro, struct, enum, signal and property) is documented in a separate block. The block is best placed close to the definition of the symbols so that it is easy to keep them in sync. Thus function are usually documented in the c-source and macros, struct and enum in the header file.
en_GB: 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 synchronisation. Thus functions are usually documented in the C source and macros, structs and enums in the header files.

en: Paragraph denoting that this function should no be used anymore. The description should point the reader to the new API.
en_GB: Paragraph denoting that this function should no be used any more. The description should point the reader to the new API.

en: Gtk-doc assumes all symbols (macros, functions) starting with '_' are private. They are treated like static functions.
en_GB: GTK-Doc assumes all symbols (macros, functions) starting with <literal>_</literal> are private. They are treated like static functions.

en: To link to another section in the GTK docs: <placeholder-1/> The linkend is the SGML id on the top item of the page you want to link to. For most pages this is currently the part ("gtk", "gdk", glib") and then the page title ("Hash Tables"). For widgets it is just the class name. Spaces and underscores are converted to '-' to conform to SGML.
en_GB: To link to another section in the GTK docs: <placeholder-1/> The linkend is the SGML ID on the top item of the page to which you want to link. 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 <literal>-</literal> to conform to SGML.

en: To include example code: <placeholder-1/> or possibly this, for very short code fragments which don't need a title: <placeholder-2/> For the latter gtk-doc also supports an abbreviation: <![CDATA[
    |[
      ...
    ]|
    ]]>
en_GB: To include example code: <placeholder-1/> or possibly this, for very short code fragments which don't need a title: <placeholder-2/> For the latter, GTK-Doc also supports an abbreviation: <![CDATA[
    |[
      ...
    ]|
    ]]>

en: To refer to a class name, we could possibly use: <placeholder-1/> but you'll probably be using #GtkWidget instead (to automatically create a link to the GtkWidget page - see <link linkend="documenting_syntax">the abbreviations</link>).
en_GB: To refer to a class name, we could possibly use: <placeholder-1/> but you'll probably be using <literal>#GtkWidget</literal> instead (to automatically create a link to the GtkWidget page — see <link linkend="documenting_syntax">the abbreviations</link>).

en: To emphasize text: <placeholder-1/>
en_GB: To emphasise text: <placeholder-1/>

en: There are a couple of extra file, that need to be maintained along with the inline source code comments: <filename>&lt;package&gt;.types</filename>, <filename>&lt;package&gt;-docs.sgml</filename>, <filename>&lt;package&gt;-sections.txt</filename>.
en_GB: There are a couple of extra files that need to be maintained along with the inline source code comments: <filename><replaceable>package</replaceable>.types</filename>, <filename><replaceable>package</replaceable>-docs.sgml</filename> and <filename><replaceable>package</replaceable>-sections.txt</filename>.

en: 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 <function>xxx_get_type</function> functions together with their include inside the <filename>&lt;package&gt;.types</filename> file.
en_GB: 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 <function>xxx_get_type</function> functions together with their include inside the <filename><replaceable>package</replaceable>.types</filename> file.

en: Since gtk-doc 1.8 <application>gtkdoc-scan</application> can generate this list for you. Just add "--rebuild-types" to SCAN_OPTIONS in <filename>Makefile.am</filename>. If you use this approach you should not dist the types file nor have it under version control.
en_GB: Since GTK-Doc 1.8 <application>gtkdoc-scan</application> can generate this list for you. Just add <option>--rebuild-types</option> to <symbol>SCAN_OPTIONS</symbol> in <filename>Makefile.am</filename>. If you use this approach you should not distribute the types file, nor have it under version control.

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

en: 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.
en_GB: While GTK-Doc creates a template master document for you, later runs 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 the master-document is also recreated from scratch. It is a good idea to look at this from time to time to see if there are some new goodies introduced there.

en: 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.
en_GB: 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. Also, chances are higher that the tutorial gets updates along with the library.

en: 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.
en_GB: So what are the things to change inside the master document? There are some placeholders (text in square brackets) there which you should take care of.

en: 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).
en_GB: 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).

en: 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.
en_GB: The section file is a plain test file with XML-like syntax (using tags). Blank lines are ignored and lines starting with a <literal>#</literal> are treated as comment lines.

en: The &lt;FILE&gt; ... &lt;/FILE&gt; tag is used to specify the file name, without any suffix. For example, using '&lt;FILE&gt;gnome-config&lt;/FILE&gt;' will result in the section declarations being output in the template file <filename>tmpl/gnome-config.sgml</filename>, which will be converted into the DocBook SGML file <filename>sgml/gnome-config.sgml</filename> or .DocBook XML file <filename>xml/gnome-config.xml</filename>. (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).
en_GB: The &lt;FILE&gt; ... &lt;/FILE&gt; tag is used to specify the filename, without any suffix. For example, using '&lt;FILE&gt;gnome-config&lt;/FILE&gt;' will result in the section declarations being output in the template file <filename>tmpl/gnome-config.sgml</filename>, which will be converted into the DocBook SGML file <filename>sgml/gnome-config.sgml</filename> or DocBook XML file <filename>xml/gnome-config.xml</filename>. (The name of the HTML file is based on the module name and the section title, or for GObjects it is based on the GObject's class name converted to lowercase).

en: You can group items in the section by using the &lt;SUBSECTION&gt; tag. Currently it outputs a blank line between subsections in the synopsis section. You can also use &lt;SUBSECTION Standard&gt; 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 &lt;SUBSECTION Private&gt; 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.
en_GB: You can group items in the section by using the &lt;SUBSECTION&gt; tag. Currently it outputs a blank line between subsections in the synopsis section. You can also use &lt;SUBSECTION Standard&gt; for standard GObject declarations (e.g. the functions like <function>g_object_get_type</function> and macros like <symbol>G_OBJECT()</symbol>, <symbol>G_IS_OBJECT()</symbol> etc.). Currently these are left out of the documentation. You can also use &lt;SUBSECTION Private&gt; 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.

en: You can also use &lt;INCLUDE&gt; ... &lt;/INCLUDE&gt; 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.
en_GB: You can also use &lt;INCLUDE&gt; ... &lt;/INCLUDE&gt; to specify the <literal>#include</literal> files which are shown in the synopsis sections. It contains a comma-separated list of <literal>#include</literal> 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.

en: A Gtk-Doc run generates report files inside the documentation directory. The generated files are named: <filename>&lt;package&gt;-undocumented.txt</filename>, <filename>&lt;package&gt;-undeclared.txt</filename> and <filename>&lt;package&gt;-unused.txt</filename>. All those are plain text files that can be viewed and postprocessed easily.
en_GB: A GTK-Doc run generates report files inside the documentation directory. The generated files are named: <filename><replaceable>package</replaceable>-undocumented.txt</filename>, <filename><replaceable>package</replaceable>-undeclared.txt</filename> and <filename><replaceable>package</replaceable>-unused.txt</filename>. All those are plain text files that can be viewed and postprocessed easily.

en: The <filename>&lt;package&gt;-undocumented.txt</filename> 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.
en_GB: The <filename><replaceable>package</replaceable>-undocumented.txt</filename> 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.

en: The <filename>&lt;package&gt;-undeclared.txt</filename> file lists symbols given in the <filename>&lt;package&gt;-section.txt</filename> but not found in the sources. Check if they have been removed or if they are misspelled.
en_GB: The <filename><replaceable>package</replaceable>-undeclared.txt</filename> file lists symbols given in the <filename><replaceable>package</replaceable>-section.txt</filename> but not found in the sources. Check if they have been removed or if they are misspelled.

en: The <filename>&lt;package&gt;-unused.txt</filename> 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 <filename>&lt;package&gt;-section.txt</filename> file.
en_GB: The <filename><replaceable>package</replaceable>-unused.txt</filename> 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 <filename><replaceable>package</replaceable>-section.txt</filename> file.

en: Enable or add the <option>TESTS=($GTKDOC_CHECK)</option> line in Makefile.am. If at least gtk-doc 1.9 is installed, this will run sanity checks during make check run.
en_GB: Enable or add the <option>TESTS=($GTKDOC_CHECK)</option> line in Makefile.am. If at least GTK-Doc 1.9 is installed, this will run sanity checks during <command>make check</command> run.

en: Frequently asked question
en_GB: Frequently asked questions

en: The objects _get_type() function has not been entered into the <placeholder-1/> file.
en_GB: The object's <function>_get_type()</function> function has not been entered into the <placeholder-1/> file.

en: Damn, I have still no class hierarchy.
en_GB: Damn, I still have no class hierarchy.

en: Is the object name (name of the instance struct) part of the normal section (don't put this into Standard or Private).
en_GB: Is the object name (name of the instance struct) part of the normal section (don't put this into Standard or Private)?

en: Check if the prototype in the header has different parameter names as in the source.
en_GB: Check if the prototype in the header has different parameter names to the source.

en: Symbol XYZ appears twice in -section.txt file.
en_GB: Symbol XYZ appears twice in the -section.txt file.

en: <address>Free Software Foundation, Inc. <street>51 Franklin Street, Suite 330</street>, <city>Boston</city>, <state>MA</state><postcode>02110-1301</postcode><country>USA</country></address> Everyone is permitted to copy and distribute verbatim copies of this license document, but changing it is not allowed.
en_GB: <address>Free Software Foundation, Inc. <street>51 Franklin Street, Suite 330</street>, <city>Boston</city>, <state>MA</state><postcode>02110-1301</postcode><country>USA</country></address> Everyone is permitted to copy and distribute verbatim copies of this licence document, but changing it is not allowed.

en: GNU Free Documentation License
en_GB: GNU Free Documentation Licence

en: The purpose of this License is to make a manual, textbook, or other written document <quote>free</quote> 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.
en_GB: The purpose of this Licence is to make a manual, textbook, or other written document <quote>free</quote> 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 Licence preserves for the author and publisher a way to get credit for their work, while not being considered responsible for modifications made by others.

en: This License is a kind of <quote>copyleft</quote>, 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.
en_GB: This Licence is a kind of <quote>copyleft</quote>, which means that derivative works of the document must themselves be free in the same sense. It complements the GNU General Public Licence, which is a copyleft licence designed for free software.

en: 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.
en_GB: We have designed this Licence 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 Licence 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 Licence principally for works whose purpose is instruction or reference.

en: 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 <quote>Document</quote>, below, refers to any such manual or work. Any member of the public is a licensee, and is addressed as <quote>you</quote>.
en_GB: This Licence 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 Licence. The <quote>Document</quote>, below, refers to any such manual or work. Any member of the public is a licencee, and is addressed as <quote>you</quote>.

en: The <quote>Invariant Sections</quote> are certain <link linkend="fdl-secondary"> Secondary Sections</link> whose titles are designated, as being those of Invariant Sections, in the notice that says that the <link linkend="fdl-document">Document</link> is released under this License.
en_GB: The <quote>Invariant Sections</quote> are certain <link linkend="fdl-secondary"> Secondary Sections</link> whose titles are designated, as being those of Invariant Sections, in the notice that says that the <link linkend="fdl-document">Document</link> is released under this Licence.

en: The <quote>Cover Texts</quote> are certain short passages of text that are listed, as Front-Cover Texts or Back-Cover Texts, in the notice that says that the <link linkend="fdl-document">Document</link> is released under this License.
en_GB: The <quote>Cover Texts</quote> are certain short passages of text that are listed, as Front-Cover Texts or Back-Cover Texts, in the notice that says that the <link linkend="fdl-document">Document</link> is released under this Licence.

en: The <quote>Title Page</quote> 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, <quote>Title Page</quote> means the text near the most prominent appearance of the work's title, preceding the beginning of the body of the text.
en_GB: The <quote>Title Page</quote> means, for a printed book, the title page itself, plus such following pages as are needed to hold, legibly, the material this Licence requires to appear in the title page. For works in formats which do not have any title page as such, <quote>Title Page</quote> means the text near the most prominent appearance of the work's title, preceding the beginning of the body of the text.

en: You may copy and distribute the <link linkend="fdl-document">Document</link> 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 <link linkend="fdl-section3">section 3</link>.
en_GB: You may copy and distribute the <link linkend="fdl-document">Document</link> in any medium, either commercially or noncommercially, provided that this Licence, the copyright notices, and the licence notice saying this Licence applies to the Document are reproduced in all copies, and that you add no other conditions whatsoever to those of this Licence. 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 <link linkend="fdl-section3">section 3</link>.

en: If you publish printed copies of the <link linkend="fdl-document">Document</link> numbering more than 100, and the Document's license notice requires <link linkend="fdl-cover-texts">Cover Texts</link>, 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 <link linkend="fdl-document">Document</link> and satisfy these conditions, can be treated as verbatim copying in other respects.
en_GB: If you publish printed copies of the <link linkend="fdl-document">Document</link> numbering more than 100, and the Document's licence notice requires <link linkend="fdl-cover-texts">Cover Texts</link>, 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 <link linkend="fdl-document">Document</link> and satisfy these conditions, can be treated as verbatim copying in other respects.

en: You may copy and distribute a <link linkend="fdl-modified">Modified Version</link> of the <link linkend="fdl-document">Document</link> under the conditions of sections <link linkend="fdl-section2">2</link> and <link linkend="fdl-section3">3</link> 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:
en_GB: You may copy and distribute a <link linkend="fdl-modified">Modified Version</link> of the <link linkend="fdl-document">Document</link> under the conditions of sections <link linkend="fdl-section2">2</link> and <link linkend="fdl-section3">3</link> above, provided that you release the Modified Version under precisely this Licence, 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:

en: Include, immediately after the copyright notices, a license notice giving the public permission to use the <link linkend="fdl-modified">Modified Version</link> under the terms of this License, in the form shown in the Addendum below.
en_GB: Include, immediately after the copyright notices, a licence notice giving the public permission to use the <link linkend="fdl-modified">Modified Version</link> under the terms of this Licence, in the form shown in the Addendum below.

en: Preserve in that license notice the full lists of <link linkend="fdl-invariant"> Invariant Sections</link> and required <link linkend="fdl-cover-texts">Cover Texts</link> given in the <link linkend="fdl-document">Document's</link> license notice.
en_GB: Preserve in that licence notice the full lists of <link linkend="fdl-invariant"> Invariant Sections</link> and required <link linkend="fdl-cover-texts">Cover Texts</link> given in the <link linkend="fdl-document">Document's</link> licence notice.

en: Include an unaltered copy of this License.
en_GB: Include an unaltered copy of this Licence.

en: If the <link linkend="fdl-modified">Modified Version</link> includes new front-matter sections or appendices that qualify as <link linkend="fdl-secondary">Secondary Sections</link> 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 <link linkend="fdl-invariant">Invariant Sections</link> in the Modified Version's license notice. These titles must be distinct from any other section titles.
en_GB: If the <link linkend="fdl-modified">Modified Version</link> includes new front-matter sections or appendices that qualify as <link linkend="fdl-secondary">Secondary Sections</link> 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 <link linkend="fdl-invariant">Invariant Sections</link> in the Modified Version's licence notice. These titles must be distinct from any other section titles.

en: You may add a section entitled <quote>Endorsements</quote>, provided it contains nothing but endorsements of your <link linkend="fdl-modified">Modified Version</link> 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.
en_GB: You may add a section entitled <quote>Endorsements</quote>, provided it contains nothing but endorsements of your <link linkend="fdl-modified">Modified Version</link> by various parties--for example, statements of peer review or that the text has been approved by an organisation as the authoritative definition of a standard.

en: The author(s) and publisher(s) of the <link linkend="fdl-document">Document</link> do not by this License give permission to use their names for publicity for or to assert or imply endorsement of any <link linkend="fdl-modified">Modified Version </link>.
en_GB: The author(s) and publisher(s) of the <link linkend="fdl-document">Document</link> do not by this Licence give permission to use their names for publicity for or to assert or imply endorsement of any <link linkend="fdl-modified">Modified Version </link>.

en: You may combine the <link linkend="fdl-document">Document</link> with other documents released under this License, under the terms defined in <link linkend="fdl-section4">section 4</link> above for modified versions, provided that you include in the combination all of the <link linkend="fdl-invariant">Invariant Sections</link> of all of the original documents, unmodified, and list them all as Invariant Sections of your combined work in its license notice.
en_GB: You may combine the <link linkend="fdl-document">Document</link> with other documents released under this Licence, under the terms defined in <link linkend="fdl-section4">section 4</link> above for modified versions, provided that you include in the combination all of the <link linkend="fdl-invariant">Invariant Sections</link> of all of the original documents, unmodified, and list them all as Invariant Sections of your combined work in its licence notice.

en: The combined work need only contain one copy of this License, and multiple identical <link linkend="fdl-invariant">Invariant Sections</link> 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.
en_GB: The combined work need only contain one copy of this Licence, and multiple identical <link linkend="fdl-invariant">Invariant Sections</link> 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 licence notice of the combined work.

en: You may make a collection consisting of the <link linkend="fdl-document">Document</link> 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.
en_GB: You may make a collection consisting of the <link linkend="fdl-document">Document</link> and other documents released under this Licence, and replace the individual copies of this Licence in the various documents with a single copy that is included in the collection, provided that you follow the rules of this Licence for verbatim copying of each of the documents in all other respects.

en: 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.
en_GB: You may extract a single document from such a collection, and distribute it individually under this Licence, provided you insert a copy of this Licence into the extracted document, and follow this Licence in all other respects regarding verbatim copying of that document.

en: A compilation of the <link linkend="fdl-document">Document</link> 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 <link linkend="fdl-modified">Modified Version</link> of the Document, provided no compilation copyright is claimed for the compilation. Such a compilation is called an <quote>aggregate</quote>, 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 <link linkend="fdl-cover-texts">Cover Text</link> requirement of <link linkend="fdl-section3">section 3</link> 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.
en_GB: A compilation of the <link linkend="fdl-document">Document</link> 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 <link linkend="fdl-modified">Modified Version</link> of the Document, provided no compilation copyright is claimed for the compilation. Such a compilation is called an <quote>aggregate</quote>, and this Licence 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 <link linkend="fdl-cover-texts">Cover Text</link> requirement of <link linkend="fdl-section3">section 3</link> 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.

en: Translation is considered a kind of modification, so you may distribute translations of the <link linkend="fdl-document">Document</link> under the terms of <link linkend="fdl-section4">section 4</link>. Replacing <link linkend="fdl-invariant"> Invariant Sections</link> 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.
en_GB: Translation is considered a kind of modification, so you may distribute translations of the <link linkend="fdl-document">Document</link> under the terms of <link linkend="fdl-section4">section 4</link>. Replacing <link linkend="fdl-invariant"> Invariant Sections</link> 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 Licence provided that you also include the original English version of this Licence. In case of a disagreement between the translation and the original English version of this Licence, the original English version will prevail.

en: You may not copy, modify, sublicense, or distribute the <link linkend="fdl-document">Document</link> 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.
en_GB: You may not copy, modify, sublicence, or distribute the <link linkend="fdl-document">Document</link> except as expressly provided for under this Licence. Any other attempt to copy, modify, sublicence or distribute the Document is void, and will automatically terminate your rights under this Licence. However, parties who have received copies, or rights, from you under this Licence will not have their licences terminated so long as such parties remain in full compliance.

en: 10. FUTURE REVISIONS OF THIS LICENSE
en_GB: 10. FUTURE REVISIONS OF THIS LICENCE

en: The <ulink type="http" url="http://www.gnu.org/fsf/fsf.html">Free Software Foundation</ulink> 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 <ulink type="http" url="http://www.gnu.org/copyleft">http://www.gnu.org/copyleft/</ulink>.
en_GB: The <ulink type="http" url="http://www.gnu.org/fsf/fsf.html">Free Software Foundation</ulink> may publish new, revised versions of the GNU Free Documentation Licence 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 <ulink type="http" url="http://www.gnu.org/copyleft">http://www.gnu.org/copyleft/</ulink>.

en: Each version of the License is given a distinguishing version number. If the <link linkend="fdl-document">Document</link> specifies that a particular numbered version of this License <quote>or any later version</quote> 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.
en_GB: Each version of the Licence is given a distinguishing version number. If the <link linkend="fdl-document">Document</link> specifies that a particular numbered version of this Licence <quote>or any later version</quote> 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 Licence, you may choose any version ever published (not as a draft) by the Free Software Foundation.

en: 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:
en_GB: To use this Licence in a document you have written, include a copy of the Licence in the document and put the following copyright and licence notices just after the title page:

en: 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 <link linkend="fdl-invariant">Invariant Sections</link> being LIST THEIR TITLES, with the <link linkend="fdl-cover-texts">Front-Cover Texts</link> being LIST, and with the <link linkend="fdl-cover-texts">Back-Cover Texts</link> being LIST. A copy of the license is included in the section entitled <quote>GNU Free Documentation License</quote>.
en_GB: Permission is granted to copy, distribute and/or modify this document under the terms of the GNU Free Documentation Licence, Version 1.1 or any later version published by the Free Software Foundation; with the <link linkend="fdl-invariant">Invariant Sections</link> being LIST THEIR TITLES, with the <link linkend="fdl-cover-texts">Front-Cover Texts</link> being LIST, and with the <link linkend="fdl-cover-texts">Back-Cover Texts</link> being LIST. A copy of the licence is included in the section entitled <quote>GNU Free Documentation Licence</quote>.

en: 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 <ulink type="http" url="http://www.gnu.org/copyleft/gpl.html"> GNU General Public License</ulink>, to permit their use in free software.
en_GB: If your document contains nontrivial examples of program code, we recommend releasing these examples in parallel under your choice of free software licence, such as the <ulink type="http" url="http://www.gnu.org/copyleft/gpl.html"> GNU General Public Licence</ulink>, to permit their use in free software.
