gtk-doc master - en to cs translation catalogue (313 entries)

note: (itstool) path: bookinfo/title
en: GTK-Doc Manual
cs: Příručka ke GTK-Doc

note: (itstool) path: abstract/para
en: User manual for developers with instructions of GTK-Doc usage.
cs: Uživatelská příručka pro vývojáře s instrukcemi k používání GTK-Doc.

note: (itstool) path: authorgroup/author
en: <firstname>Chris</firstname> <surname>Lyttle</surname> <affiliation> <address> <email>chris@wilddev.net</email> </address> </affiliation>
cs: <firstname>Chris</firstname> <surname>Lyttle</surname> <affiliation><address><email>chris@wilddev.net</email></address></affiliation>

note: (itstool) path: authorgroup/author
en: <firstname>Dan</firstname> <surname>Mueth</surname> <affiliation> <address> <email>d-mueth@uchicago.edu</email> </address> </affiliation>
cs: <firstname>Dan</firstname> <surname>Mueth</surname> <affiliation><address><email>d-mueth@uchicago.edu</email></address></affiliation>

note: (itstool) path: authorgroup/author
en: <firstname>Stefan</firstname> <surname>Sauer (Kost)</surname> <affiliation> <address> <email>ensonic@users.sf.net</email> </address> </affiliation>
cs: <firstname>Stefan</firstname> <surname>Sauer (Kost)</surname> <affiliation><address><email>ensonic@users.sf.net</email></address></affiliation>

note: (itstool) path: publisher/publishername
en: GTK-Doc project
cs: Projekt GTK-Doc

note: (itstool) path: legalnotice/para
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>.
cs: Je povoleno kopírovat, šířit a/nebo upravovat tento dokument za podmínek <citetitle>GNU Free Documentation License</citetitle> ve verzi 1.1 nebo v jakékoli další verzi vydané nadací Free Software Foundation, s neměnnými oddíly, bez textů předních desek a bez textů zadních desek. Kopie licence je <link linkend="fdl">součástí</link>.

note: (itstool) path: legalnotice/para
en: Many of the names used by companies to distinguish their products and services are claimed as trademarks. Where those names appear in any GNOME documentation, and those trademarks are made aware to the members of the GNOME Documentation Project, the names have been printed in caps or initial caps.
cs: Mnoho názvů použitých firmami k zviditelnění produktů nebo služeb jsou ochranné známky. Na místech, kde jsou tyto názvy v dokumentaci použity a členové Dokumentačního projektu GNOME jsou si vědomi skutečnosti, že se jedná o ochrannou známku, je takovýto název psán velkými písmeny celý nebo s velkým písmenem na začátku.

note: (itstool) path: revhistory/revision
en: <revnumber>1.26.1</revnumber> <date>11 Aug 2017</date> <authorinitials>ss</authorinitials> <revremark>development</revremark>
cs: <revnumber>1.26.1</revnumber> <date>11. srpna 2017</date> <authorinitials>ss</authorinitials> <revremark>vývoj</revremark>

note: (itstool) path: revhistory/revision
en: <revnumber>1.26</revnumber> <date>11 Aug 2017</date> <authorinitials>ss</authorinitials> <revremark>port all tools from perl/bash to python</revremark>
cs: <revnumber>1.26</revnumber> <date>11. srpen 2017</date> <authorinitials>ss</authorinitials> <revremark>přenesení všech nástrojů z jazyků Perl/Bash do jazyka Python</revremark>

note: (itstool) path: revhistory/revision
en: <revnumber>1.25</revnumber> <date>21 March 2016</date> <authorinitials>ss</authorinitials> <revremark>bug fixes, test cleanups</revremark>
cs: <revnumber>1.25</revnumber> <date>21. březen 2016</date> <authorinitials>ss</authorinitials> <revremark>opravy chyb, pročištění testů</revremark>

note: (itstool) path: revhistory/revision
en: <revnumber>1.24</revnumber> <date>29 May 2015</date> <authorinitials>ss</authorinitials> <revremark>bug fix</revremark>
cs: <revnumber>1.24</revnumber> <date>29. května 2015</date> <authorinitials>ss</authorinitials> <revremark>oprava chyby</revremark>

note: (itstool) path: revhistory/revision
en: <revnumber>1.23</revnumber> <date>17 May 2015</date> <authorinitials>ss</authorinitials> <revremark>bug fix</revremark>
cs: <revnumber>1.23</revnumber> <date>17. květen 2015</date> <authorinitials>ss</authorinitials> <revremark>oprava chyby</revremark>

note: (itstool) path: revhistory/revision
en: <revnumber>1.22</revnumber> <date>07 May 2015</date> <authorinitials>ss</authorinitials> <revremark>bug fixes, dropping deprecated features</revremark>
cs: <revnumber>1.22</revnumber> <date>07. květen 2015</date> <authorinitials>ss</authorinitials> <revremark>oprava chyb, odstranění zastaralých věcí</revremark>

note: (itstool) path: revhistory/revision
en: <revnumber>1.21</revnumber> <date>17 Jul 2014</date> <authorinitials>ss</authorinitials> <revremark>bug fixes, dropping deprecated features</revremark>
cs: <revnumber>1.21</revnumber> <date>17. červenec 2014</date> <authorinitials>ss</authorinitials> <revremark>oprava chyb, odstranění zastaralých věcí</revremark>

note: (itstool) path: revhistory/revision
en: <revnumber>1.20</revnumber> <date>16 Feb 2014</date> <authorinitials>ss</authorinitials> <revremark>bug fixes, markdown support, style improvements</revremark>
cs: <revnumber>1.20</revnumber> <date>16. únor 2014</date> <authorinitials>ss</authorinitials> <revremark>opravy chyb, podpora značkovacího jazyka, vylepšení stylů</revremark>

note: (itstool) path: revhistory/revision
en: <revnumber>1.19</revnumber> <date>05 Jun 2013</date> <authorinitials>ss</authorinitials> <revremark>bug fixes</revremark>
cs: <revnumber>1.19</revnumber> <date>05. červen 2013</date> <authorinitials>ss</authorinitials> <revremark>opravy chyb</revremark>

note: (itstool) path: revhistory/revision
en: <revnumber>1.18</revnumber> <date>14 Sep 2011</date> <authorinitials>ss</authorinitials> <revremark>bug fixes, speedups, markdown support</revremark>
cs: <revnumber>1.18</revnumber> <date>14. září 2011</date> <authorinitials>ss</authorinitials> <revremark>opravy chyb, zrychlení, podpora značkovacího jazyka</revremark>

note: (itstool) path: revhistory/revision
en: <revnumber>1.17</revnumber> <date>26 Feb 2011</date> <authorinitials>sk</authorinitials> <revremark>urgent bug fix update</revremark>
cs: <revnumber>1.17</revnumber> <date>26. únor 2011</date> <authorinitials>sk</authorinitials> <revremark>aktualizace kvůli neodkladné opravě chyby</revremark>

note: (itstool) path: revhistory/revision
en: <revnumber>1.16</revnumber> <date>14 Jan 2011</date> <authorinitials>sk</authorinitials> <revremark>bugfixes, layout improvements</revremark>
cs: <revnumber>1.16</revnumber> <date>14. leden 2011</date> <authorinitials>sk</authorinitials> <revremark>opravy chyb, vylepšení vzhledu</revremark>

note: (itstool) path: revhistory/revision
en: <revnumber>1.15</revnumber> <date>21 May 2010</date> <authorinitials>sk</authorinitials> <revremark>bug and regression fixes</revremark>
cs: <revnumber>1.15</revnumber> <date>21. květen 2010</date> <authorinitials>sk</authorinitials> <revremark>opravy chyb a regresí</revremark>

note: (itstool) path: revhistory/revision
en: <revnumber>1.14</revnumber> <date>28 March 2010</date> <authorinitials>sk</authorinitials> <revremark>bugfixes and performance improvements</revremark>
cs: <revnumber>1.14</revnumber> <date>28. březen 2010</date> <authorinitials>sk</authorinitials> <revremark>opravy chyb a vylepšení výkonu</revremark>

note: (itstool) path: revhistory/revision
en: <revnumber>1.13</revnumber> <date>18 December 2009</date> <authorinitials>sk</authorinitials> <revremark>broken tarball update</revremark>
cs: <revnumber>1.13</revnumber> <date>18. prosinec 2009</date> <authorinitials>sk</authorinitials> <revremark>aktualizace poškozeného balíčku</revremark>

note: (itstool) path: revhistory/revision
en: <revnumber>1.12</revnumber> <date>18 December 2009</date> <authorinitials>sk</authorinitials> <revremark>new tool features and bugfixes</revremark>
cs: <revnumber>1.12</revnumber> <date>18. prosinec 2009</date> <authorinitials>sk</authorinitials> <revremark>nové funkce nástroje a opravy chyb</revremark>

note: (itstool) path: revhistory/revision
en: <revnumber>1.11</revnumber> <date>16 November 2008</date> <authorinitials>mal</authorinitials> <revremark>GNOME doc-utils migration</revremark>
cs: <revnumber>1.11</revnumber> <date>16. listopad 2008</date> <authorinitials>mal</authorinitials> <revremark>přechod na doc-utils z GNOME</revremark>

note: (itstool) path: chapter/title
en: Introduction
cs: Úvod

note: (itstool) path: chapter/para
en: This chapter introduces GTK-Doc and gives an overview of what it is and how it is used.
cs: Tato kapitola je úvodem do GTK-Doc a podává přehled o tom, co to je a jak to použít.

note: (itstool) path: sect1/title
en: What is GTK-Doc?
cs: Co je to GTK-Doc?

note: (itstool) path: sect1/para
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.
cs: GTK-Doc se používá k dokumentaci kódu jazyka C. Typické použití je pro dokumentaci veřejného API knihoven, jako jsou knihovny GTK+ a GNOME. Lze jej ale použít i k dokumentaci aplikačního kódu.

note: (itstool) path: sect1/title
en: How Does GTK-Doc Work?
cs: Jak GTK-Doc pracuje?

note: (itstool) path: sect1/para
en: GTK-Doc works by using documentation of functions placed inside the source files in specially-formatted comment blocks, or documentation added to the template files which GTK-Doc uses (though note that GTK-Doc will only document functions that are declared in header files; it won't produce output for static functions).
cs: GTK-Doc pracuje na základě dokumentace funkcí umístěné přímo v souborech se zdrojovým kódem ve speciálně formátovaných komentářových blocích, nebo dokumentace přidané do souborů šablon, které GTK-Doc používá (ačkoliv je nutno poznamenat, že GTK-Doc dokumentuje pouze funkce, které jsou deklarované v hlavičkových souborech; pro statické funkce žádný výstup nevytváří).

note: (itstool) path: sect1/para
en: GTK-Doc consists of a number of python scripts, each performing a different step in the process.
cs: GTK-Doc sestává z řady skriptů v jazyce Python, z nichž každý provádí jinou část procesu.

note: (itstool) path: sect1/para
en: There are 5 main steps in the process:
cs: Celý proces se skládá z pěti hlavních kroků:

note: (itstool) path: listitem/para
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).
cs: <guilabel>Psaní dokumentace.</guilabel> Autor doplní soubory se zdrojovým kódem dokumentací pro každou funkci, makro, strukturu atd. (Dříve se informace vkládaly do souborů s vygenerovanými šablonami, což se již nedoporučuje).

note: (itstool) path: listitem/para
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> containing 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 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 entities similar to the ones in <filename>&lt;module&gt;-decl.txt</filename> into <filename>&lt;module&gt;-overrides.txt</filename>.
cs: <guilabel>Shromáždění informací o kódu.</guilabel> <application>gtkdoc-scan</application> projde hlavičkové soubory kódu a vyhledá při tom deklarace funkcí, maker, výčtů, struktur a sjednocení. Tím se vytvoří soubor <filename>&lt;module&gt;-decl-list.txt</filename> obsahující seznam deklarací, které jsou rozdělené do oddílů podle hlavičkového souboru, ze kterého pochází. Při prvním spuštění se tento soubor zkopíruje do <filename>&lt;module&gt;-sections.txt</filename>. Autor může změnit uspořádání oddílů a jejich pořadí v rámci deklarací tak, jak to požaduje ve výsledku. Druhý soubor, který se vytvoří, je <filename>&lt;module&gt;-decl.txt</filename>. Tento soubor obsahuje úplné deklarace nalezené při procházení. Pokud byste z nějakého důvodu chtěli v dokumentaci zahrnout symbol, který při procházení nebyl nalezen, nebo jeho deklarace vypadá jinak, můžete jej umístit podobně jako v <filename>&lt;module&gt;-decl.txt</filename> do <filename>&lt;module&gt;-overrides.txt</filename>.

note: (itstool) path: listitem/para
en: <application>gtkdoc-scangobj</application> can also be used to dynamically query a library about any GObject subclasses it exports. It saves information about each object's position in the class hierarchy and about any GObject properties and signals it provides.
cs: Dá se také použít <application>gtkdoc-scanobj</application> k dynamickým dotazům do knihoven na podtřídy objektu GObject, které exportují. Tím se uloží informace o pozici každého objektu v hierarchii tříd a o argumentech a signálech objektu GObject, které poskytují.

note: (itstool) path: listitem/para
en: <application>gtkdoc-scanobj</application> should not be used anymore. It was needed in the past when GObject was still GtkObject inside gtk+.
cs: <application>gtkdoc-scanobj</application> by se ale již používat nemělo. Bylo zapotřebí v minulosti, kdy byl GObject ještě GtkObject v rámci gtk+.

note: (itstool) path: listitem/para
en: <guilabel>Generating the XML and HTML/PDF.</guilabel> <application>gtkdoc-mkdb</application> turns the template files into XML files in the <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 docs from sources and introspection data.
cs: <guilabel>Generování XML a HTML/PDF.</guilabel> <application>gtkdoc-mkdb</application> přemění soubory šablon na soubory XML v podsložce <filename class="directory">xml/</filename>. Pokud zdrojový kód obsahuje dokumentaci funkcí za použití speciálních komentářových bloků, tak zde se sloučí. V případě, že není použitý žádný soubor šablon, načte se dokumentace pouze ze zdrojového kódu a introspektivních dat.

note: (itstool) path: listitem/para
en: <application>gtkdoc-mkhtml</application> turns the XML files into HTML files in the <filename class="directory">html/</filename> subdirectory. Likewise <application>gtkdoc-mkpdf</application> turns the XML files into a PDF document called <filename>&lt;package&gt;.pdf</filename>.
cs: <application>gtkdoc-mkhtml</application> převádí soubory XML na soubory HTML v podsložce <filename class="directory">html/</filename>. Obdobně <application>gtkdoc-mkpdf</application> převádí soubory XML na dokument PDF nazvaný <filename>&lt;balíček&gt;.pdf</filename>.

note: (itstool) path: listitem/para
en: Files in <filename class="directory">xml/</filename> and <filename class="directory">html/</filename> directories are always overwritten. One should never edit them directly.
cs: Soubory ve složkách <filename class="directory">xml/</filename> a <filename class="directory">html/</filename> jsou vždy přepsány. Nikdy by neměly být upravovány přímo.

note: (itstool) path: listitem/para
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).
cs: <guilabel>Opravy křížových odkazů mezi dokumenty.</guilabel> Po nainstalování souborů HTML můžete spustit <application>gtkdoc-fixxref</application>, aby se opravily křížové odkazy mezi samostanými dokumenty. Například dokumentace GTK+ obsahuje křížové odkazy na typy zdokumentované v příručce GLib. Když vytváříte zdrojový balíček pro distribuci, <application>gtkdoc-rebase</application> předělá všechny externí odkazy na webové odkazy. Když se distribuovaná (předgenerovaná) dokumentace instaluje, pokusí se tatáž aplikace předělat odkazy zpátky na místní odkazy (na dokumenty, které jsou nainstalované).

note: (itstool) path: sect1/title
en: Getting GTK-Doc
cs: Jak získat GTK-Doc?

note: (itstool) path: sect2/title
en: Requirements
cs: Požadavky

note: (itstool) path: sect2/para
en: <guilabel>python 2/3</guilabel> - the main scripts are written in python.
cs: <guilabel>Python 2/3</guilabel> – hlavní skripty jsou v jazyce Python.

note: (itstool) path: sect2/para
en: <guilabel>xsltproc</guilabel> - the xslt processor from libxslt <ulink url="http://xmlsoft.org/XSLT/" type="http">xmlsoft.org/XSLT/</ulink>
cs: <guilabel>xsltproc</guilabel> – procesor xslt z knihovny libxslt <ulink url="http://xmlsoft.org/XSLT/" type="http">xmlsoft.org/XSLT/</ulink>

note: (itstool) path: sect2/para
en: <guilabel>docbook-xsl</guilabel> - the docbook xsl stylesheets <ulink url="http://sourceforge.net/projects/docbook/files/docbook-xsl/" type="http">sourceforge.net/projects/docbook/files/docbook-xsl</ulink>
cs: <guilabel>docbook-xsl</guilabel> – stylopisy XSL pro docbook <ulink url="http://sourceforge.net/projects/docbook/files/docbook-xsl/" type="http">sourceforge.net/projects/docbook/files/docbook-xsl</ulink>

note: (itstool) path: sect2/para
en: One of <guilabel>source-highlight</guilabel>, <guilabel>highlight</guilabel> or <guilabel>vim</guilabel> - optional - used for syntax highlighting of examples
cs: Něco z <guilabel>source-highlight</guilabel>, <guilabel>highlight</guilabel> nebo <guilabel>vim</guilabel> – (volitelné) používá se pro zvýraznění syntaxe u příkladů

note: (itstool) path: sect1/title
en: About GTK-Doc
cs: O aplikaci GTK-Doc

note: (itstool) path: sect1/para
en: (FIXME)
cs: (DOPLNIT)

note: (itstool) path: sect1/para
en: (History, authors, web pages, mailing list, license, future plans, comparison with other similar systems.)
cs: (Historie, autoři, webové stránky, poštovní konference, licence, plány do budoucna, srovnání s ostatními podobnými systémy.)

note: (itstool) path: sect1/title
en: About this Manual
cs: O této příručce

note: (itstool) path: sect1/para
en: (who it is meant for, where you can get it, license)
cs: (k čemu je určená, kde ji můžete získat, licence)

note: (itstool) path: chapter/title
en: Setting up your project
cs: Nastavení vašeho projektu

note: (itstool) path: chapter/para
en: 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'. We also assume you will be using autoconf and automake. In addition section <link linkend="plain_makefiles">plain makefiles or other build systems</link> will describe the basics needed to work in a different build setup.
cs: Následující oddíl popisuje kroky, které musíte provést, abyste integrovali GTK-Doc do svého projektu. Tento oddíl předpokládá, že pracujeme na projektu nazvaném „meep“. Tento projekt obsahuje knihovnu nazvanou „libmeep“ a aplikaci pro koncového uživatele nazvanou „meeper“. Rovněž předpokládá, že používáte autoconf a automake. V oddílu <link linkend="plain_makefiles">prosté soubory Makefile nebo jiné sestavovací systémy</link> budou popsány základní požadavky pro fungování s jinými postupy sestavování.

note: (itstool) path: sect1/title
en: Setting up a skeleton documentation
cs: Nastavení kostry dokumentace

note: (itstool) path: sect1/para
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.
cs: Pod nejvyšší složkou projektu vytvořte složky nazvané docs/reference (takto můžete mít i docs/help s dokumentací pro koncového uživatele). Je doporučeno vytvořit další podsložku s názvem balíčku s dokumentací. Pro balíčky s jedinou knihovnou není tento krok nutný.

note: (itstool) path: example/title
en: Example directory structure
cs: Příklad struktury složek

note: (itstool) path: sect1/para
en: This can then look as shown below: <_:example-1/>
cs: Ve výsledku to může vypadat nějak takto: <_:example-1/>

note: (itstool) path: sect1/title (itstool) path: example/title
en: Integration with autoconf
cs: Integrace s autoconf

note: (itstool) path: sect1/para
en: Very easy! Just add one line to your <filename>configure.ac</filename> script.
cs: Velmi snadné! Stačí jen přidat jeden řádek do vašeho skriptu <filename>configure.ac</filename>.

note: (itstool) path: example/title
en: Keep gtk-doc optional
cs: Ponechání gtk-doc jako volitelného

note: (itstool) path: sect1/para
en: 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 <function>GTK_DOC_CHECK</function> at the start of a line. <_:example-1/>
cs: Vyžaduje to, aby všichni vývojáři měli gtk-doc nainstalované. Jestli u vašeho projektu stačí mít sestavení dokumentaci k API jen volitelné, můžete to vyřešit podle vzoru níže. Použijte to přesně tak, jak je uvedeno, protože gtkdocize hledá <function>GTK_DOC_CHECK</function> na začátku řádku. <_:example-1/>

note: (itstool) path: sect1/para
en: The first argument is used to check for the gtkdocversion at configure time. The 2nd, optional argument is used by <application>gtkdocize</application>. The <symbol>GTK_DOC_CHECK</symbol> macro also adds several configure switches:
cs: První argument se používá ke kontrole gtkdocversion v průběhu konfigurace. Druhý, volitelný argument používá nástroj <application>gtkdocize</application>. Makro <symbol>GTK_DOC_CHECK</symbol> také přidává několik přepínačů pro configure:

note: (itstool) path: listitem/para
en: --with-html-dir=PATH : path to installed docs
cs: --with-html-dir=CESTA: cesta, kam se má dokumentace nainstalovat

note: (itstool) path: listitem/para
en: --enable-gtk-doc : use gtk-doc to build documentation [default=no]
cs: --enable-gtk-doc: použít k sestavení dokumentace gtk-doc [výchozí je ne]

note: (itstool) path: listitem/para
en: --enable-gtk-doc-html : build documentation in html format [default=yes]
cs: --enable-gtk-doc-html: sestavit dokumentaci ve formátu HTML [výchozí je ano]

note: (itstool) path: listitem/para
en: --enable-gtk-doc-pdf : build documentation in pdf format [default=no]
cs: --enable-gtk-doc-pdf: sestavit dokumentaci ve formátu PDF [výchozí je ne]

note: (itstool) path: important/para
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).
cs: GTK-Doc je standardně vypnuté! Nezapomeňte zadat přepínač „<option>--enable-gtk-doc</option>“ při dalším spuštění <filename>configure</filename>. Jinak se nainstaluje předgenerovaná dokumentace (která může mít význam pro uživatele, ale ne pro vývojáře).

note: (itstool) path: sect1/para
en: Furthermore it is recommended that you have the following line inside your <filename>configure.ac</filename> script. This allows <application>gtkdocize</application> to automatically copy the macro definition for <function>GTK_DOC_CHECK</function> to your project.
cs: Mimo to je ještě doporučeno, abyste měli ve skriptu <filename>configure.ac</filename> následující řádek. Umožní to <application>gtkdocize</application> automaticky nakopírovat definice maker pro <function>GTK_DOC_CHECK</function> do vašeho projektu.

note: (itstool) path: example/title
en: Preparation for gtkdocize
cs: Příprava pro gtkdocize

note: (itstool) path: sect1/para
en: After all changes to <filename>configure.ac</filename> are made, update the <filename>configure</filename> file. This can be done by re-running <code>autoreconf -i</code> or <code>autogen.sh</code>.
cs: Po provedení změn v <filename>configure.ac</filename> aktualizujte soubor <filename>configure</filename>. To se dá udělat opětovným spuštěním <code>autoreconf -i</code> nebo <code>autogen.sh</code>.

note: (itstool) path: sect1/title
en: Integration with automake
cs: Integrace s automake

note: (itstool) path: sect1/para
en: First copy the <filename>Makefile.am</filename> from the <filename class="directory">examples</filename> sub directory of the <ulink url="https://git.gnome.org/browse/gtk-doc/tree/examples/Makefile.am">gtkdoc-sources</ulink> to your project's API documentation directory ( <filename class="directory">./docs/reference/&lt;package&gt;</filename>). A local copy should be available under e.g. <filename>/usr/share/doc/gtk-doc-tools/examples/Makefile.am</filename>. If you have multiple doc-packages repeat this for each one.
cs: Jako první nakopírujte <filename>Makefile.am</filename> z podsložky <filename class="directory">examples</filename> ve složce <ulink url="https://git.gnome.org/browse/gtk-doc/tree/examples/Makefile.am">gtkdoc-sources</ulink> do složky s dokumentací API svého projektu (<filename class="directory">./docs/reference/&lt;package&gt;</filename>). Místní kopie by měla být k dispozici např. pod <filename>/usr/share/doc/gtk-doc-tools/examples/Makefile.am</filename>. Pokud máte více balíčků s dokumentací, opakujte tento krok pro každý z nich.

note: (itstool) path: sect1/para
en: 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>&lt;TOOLNAME&gt;_OPTIONS</option>. All the tools support <option>--help</option> to list the supported parameters.
cs: Dalším krokem je úprava nastavení v <filename>Makefile.am</filename>. Všechna nastavení mají komentáře s popisem jejich účelu. Většina nastavení má doplňující příznaky předávané do dotyčných nástrojů. Každý nástroj má proměnnou ve formátu <option>&lt;NÁZEVNÁSTROJE&gt;_OPTIONS</option>. Všechny nástroje podporují <option>--help</option> pro vypsání podporovaných přepínačů.

note: (itstool) path: sect1/title
en: Integration with autogen
cs: Integrace s autogen

note: (itstool) path: sect1/para
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/svn/git). GTK-Doc comes with a tool called <application>gtkdocize</application> which can be used in such a script. It should be run before autoheader, automake or autoconf.
cs: Většina projektů má skript <filename>autogen.sh</filename>, který po stažení ze systému pro správu verzí (jako je CVS, SVN nebo Git), nastaví infrastrukturu pro sestavení. GTK-Doc se dodává s nástrojem nazvaným <application>gtkdocize</application>, který lze v takovémto skriptu využít. Měl by být spuštěný před autoheader, automake nebo autoconf.

note: (itstool) path: example/title
en: Running gtkdocize from autogen.sh
cs: Spuštění gtkdocize z autogen.sh

note: (itstool) path: sect1/para
en: When running <application>gtkdocize</application> it copies <filename>gtk-doc.make</filename> to your project root (or any directory specified by the <option>--docdir</option> option). It also checks you configure script for the <function>GTK_DOC_CHECK</function> invocation. This macro can be used to pass extra parameters to <application>gtkdocize</application>.
cs: Když spustíte <filename>gtkdocize</filename>, tak nakopíruje do kořenové složky vašeho projektu (nebo složky určené přepínačem <option>--docdir</option>) soubor <filename>gtk-doc.make</filename>. Navíc zkontroluje váš skript configure, jestli volá <function>GTK_DOC_CHECK</function>. Toto makro můžete použít k předání dalších parametrů do <application>gtkdocize</application>.

note: (itstool) path: sect1/para
en: 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. <application>gtkdocize</application> supports now a <option>--flavour no-tmpl</option> 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 <symbol>GTKDOCIZE_FLAGS</symbol> or set as a 2nd parameter in <symbol>GTK_DOC_CHECK</symbol> macro in the configure script. If you have never changed file in tmpl by hand and migrating from older gtkdoc versions, please remove the directory (e.g. from version control system).
cs: Dříve GTK-Doc generovalo soubory šablon, do kterých vývojáři vkládali dokumentaci. To bylo zrušeno, protože to nebylo příliš dobré (například kvůli potřebě mít generované soubory pod správou verzí). Od GTK-Doc verz 1.9 umí nástroje získávat všechny informace z komentářů ve zdrojových kódech a šablony tak můžete úplně vynechat. Doporučujeme lidem, aby dokumentaci udržovali v rámci kódu. <application>gtkdocize</application> nyní podporuje přepínač <option>--flavour=no-tmpl</option>, který způsobí, že makefile použití tmpl úplně vynechá. Mimo přidání této volby přímo do volaného příkazu, jej můžete předat také jako proměnnou prostředí s názvem <symbol>GTKDOCIZE_FLAGS</symbol>, nebo nastavit jako druhý parametr v makru <symbol>GTK_DOC_CHECK</symbol> v konfiguračním skriptu. Pokud jste nikdy ručně neměnili žádný soubor v tmpl a přecházíte ze starší verze gtkdoc, tak tuto složku prosím odstraňte (například ze správy verzí).

note: (itstool) path: sect1/title (itstool) path: example/title
en: Running the doc build
cs: Sestavení dokumentace

note: (itstool) path: sect1/para
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.
cs: Po dokončení předchozích kroků nastal čas spustit sestavení. Nejdříve musíte znovu spustit <filename>autogen.sh</filename>. Pokud tento skript pro vás provádí nastavení, předejte mu přepínač <option>--enable-gtk-doc</option>. Jinak potom ručně spusťte <filename>configure</filename> s tímto přepínačem.

note: (itstool) path: sect1/para
en: The first make run generates several additional files in the doc-directories. The important ones are: <filename>&lt;package&gt;.types</filename>, <filename>&lt;package&gt;-docs.xml</filename> (in the past .sgml), <filename>&lt;package&gt;-sections.txt</filename>.
cs: První make spustí vygenerování několika doplňujících souborů ve složkách doc. Podstatné jsou tyto: <filename>&lt;package&gt;.types</filename>, <filename>&lt;package&gt;-docs.xml</filename> (dříve .sgml) a <filename>&lt;package&gt;-sections.txt</filename>.

note: (itstool) path: sect1/para
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.
cs: Nyní se můžete ve svém prohlížeči podívat na <filename>docs/reference/&lt;package&gt;/index.html</filename>. Zatím je to poněkud neuspokojivé, že? Ale nebojte, v následující kapitole vám řekneme, jak stránky uvést do života.

note: (itstool) path: sect1/title
en: Integration with version control systems
cs: Integrace se systémem pro správu verzí

note: (itstool) path: sect1/para
en: As a rule of thumb, it's the files you edit which should go under version control. For typical projects it's these files: <filename>&lt;package&gt;.types</filename>, <filename>&lt;package&gt;-docs.xml</filename> (in the past .sgml), <filename>&lt;package&gt;-sections.txt</filename>, <filename>Makefile.am</filename>.
cs: Podle nepsaných pravidel byste soubory, které upravujete, měli udržovat ve správě verzí. U typických projektů to jsou tyto soubory: <filename>&lt;balíček&gt;.types</filename>, <filename>&lt;balíček&gt;-docs.xml</filename> (dříve .sgml), <filename>&lt;balíček&gt;-sections.txt</filename> a <filename>Makefile.am</filename>.

note: (itstool) path: sect1/para
en: Files in the <filename>xml/</filename> and <filename>html/</filename> directories should not go under version control. Neither should any of the <filename>.stamp</filename> files.
cs: Soubory ze složek <filename>xml/</filename> a <filename>html/</filename> by neměly být zařazeny do správy verzí. A ani žádné soubory <filename>.stamp</filename>.

note: (itstool) path: sect1/title
en: Integration with plain makefiles or other build systems
cs: Integrace s prostými soubory Makefile nebo jinými sestavovacími systémy

note: (itstool) path: sect1/para
en: In the case one does not want to use automake and therefore <filename>gtk-doc.mak</filename> one will need to call the gtkdoc tools in the right order in own makefiles (or other build tools).
cs: Když někdo nechce používat automake, a tím pádem <filename>gtk-doc.mak</filename>, bude muset volat nástroje gtkdoc ve správném pořadí ve vlastních souborech make (nebo jiných nástrojích).

note: (itstool) path: example/title
en: Documentation build steps
cs: Kroky sestavení dokumentace

note: (itstool) path: example/programlisting
en: 
    DOC_MODULE=meep
    // sources have changed
    gtkdoc-scan --module=$(DOC_MODULE) &lt;source-dir&gt;
    gtkdoc-scangobj --module=$(DOC_MODULE)
    gtkdoc-mkdb --module=$(DOC_MODULE) --output-format=xml --source-dir=&lt;source-dir&gt;
    // xml files have changed
    mkdir html
    cd html &amp;&amp; gtkdoc-mkhtml $(DOC_MODULE) ../meep-docs.xml
    gtkdoc-fixxref --module=$(DOC_MODULE) --module-dir=html
cs: 
    DOC_MODULE=meep
    // sources have changed
    gtkdoc-scan --module=$(DOC_MODULE) &lt;zdrojová-složka&gt;
    gtkdoc-scangobj --module=$(DOC_MODULE)
    gtkdoc-mkdb --module=$(DOC_MODULE) --output-format=xml --source-dir=&lt;zdrojová-složka&gt;
    // xml files have changed
    mkdir html
    cd html &amp;&amp; gtkdoc-mkhtml $(DOC_MODULE) ../meep-docs.xml
    gtkdoc-fixxref --module=$(DOC_MODULE) --module-dir=html

note: (itstool) path: sect1/para
en: One will need to look at the <filename>Makefile.am</filename> and <filename>gtk-doc.mak</filename> to pick the extra options needed.
cs: Na výběr dalších potřebných voleb se musíte se podívat do <filename>Makefile.am</filename> a <filename>gtk-doc.mak</filename>.

note: (itstool) path: sect1/title
en: Integration with CMake build systems
cs: Integrace se sestavovacím systémem CMake

note: (itstool) path: sect1/para
en: GTK-Doc now provides a <filename>GtkDocConfig.cmake</filename> module (and the corresponding <filename>GtkDocConfigVersion.cmake</filename> module). This provides a <literal>gtk_doc_add_module</literal> command that you can set in your <filename>CMakeLists.txt</filename> file.
cs: GTK-Doc nyní nabízí modul <filename>GtkDocConfig.cmake</filename> (a příslušný modul <filename>GtkDocConfigVersion.cmake</filename>). Ten poskytuje příkaz <literal>gtk_doc_add_module</literal>, který můžete nastavit ve svém souboru <filename>CMakeLists.txt</filename>.

note: (itstool) path: example/title
en: Example of using GTK-Doc from CMake
cs: Příklad použití GTK-Doc z CMake

note: (itstool) path: example/programlisting
en: 
    find_package(GtkDoc 1.25 REQUIRED)
    
    # Create the doc-libmeep target.
    gtk_doc_add_module(
       libmeep ${CMAKE_SOURCE_DIR}/libmeep
          XML meep-docs.xml
          LIBRARIES libmeep
    )
    
    # Build doc-libmeep as part of the default target. Without this, you would
    # have to explicitly run something like `make doc-libmeep` to build the docs.
    add_custom_target(documentation ALL DEPENDS doc-libmeep)
    
    # Install the docs. (This assumes you're using the GNUInstallDirs CMake module
    # to set the CMAKE_INSTALL_DOCDIR variable correctly).
    install(DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}/libmeep/html
            DESTINATION ${CMAKE_INSTALL_DOCDIR})
cs: 
    find_package(GtkDoc 1.25 REQUIRED)
    
    # Vytvoření cíle doc-libmeep.
    gtk_doc_add_module(
       libmeep ${CMAKE_SOURCE_DIR}/libmeep
          XML meep-docs.xml
          LIBRARIES libmeep
    )
    
    # Sestavení doc-libmeep jako součásti výchozího cíle. Bez tohoto byste museli
    # ručně spouštět něco jako `make doc-libmeep`, aby se dokumentace sestavila.
    add_custom_target(documentation ALL DEPENDS doc-libmeep)
    
    # Instalace dokumentace. (Předpokládá to, že používáte modul CMake GNUInstallDirs
    # ke správnému nastavení proměnné CMAKE_INSTALL_DOCDIR).
    install(DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}/libmeep/html
            DESTINATION ${CMAKE_INSTALL_DOCDIR})

note: (itstool) path: sect1/para
en: The following example shows how to use this command. <_:example-1/>
cs: Následující příklad ukazuje, jak tento příkaz použít: <_:example-1/>

note: (itstool) path: chapter/title
en: Documenting the code
cs: Dokumentování v kódu

note: (itstool) path: chapter/para
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 will find all information about the syntax of the comments.
cs: GTK-Doc používá pro kód dokumentace komentáře se speciální syntaxí ve zdrojovém kódu. K tomu se ještě získávají informace o struktuře vašeho projektu z dalších zdrojů. V následujícím oddílu najdete všechny informace o syntaxi komentářů.

note: (itstool) path: note/title
en: Documentation placement
cs: Umístění dokumentace

note: (itstool) path: note/para
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.
cs: Dříve musela být většina dokumentace doplněná do souborů umístěných ve složce <filename>tmpl</filename>. Následkem toho bylo, že informace byly často neaktualizované a soubory měli tendenci způsobovat konflikty v systémech pro správu verzí.

note: (itstool) path: note/para
en: The avoid the aforementioned problems we suggest putting the documentation inside the sources. This manual will only describe this way of documenting code.
cs: Aby se předešlo těmto zmiňovaným problémům, předpokládáme vkládání dokumentace přímo do zdrojových kódů. Tato příručka bude popisovat pouze tento způsob dokumentování kódu.

note: (itstool) path: example/title
en: GTK-Doc comment block
cs: Komentářový blok GTK-Doc

note: (itstool) path: example/programlisting
en: 
    #ifndef __GTK_DOC_IGNORE__
    /* unparseable code here */
    #endif
cs: 
    #ifndef __GTK_DOC_IGNORE__
    /* kód zde se nezpracovává */
    #endif

note: (itstool) path: chapter/para
en: 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. <_:example-1/>
cs: Skener zvládá dobře většinu hlavičkových souborů C. V případě, že od něj obdržíte varování, které vypadá jako speciální případ, můžete GTK-Doc poradit, aby jej přeskakovala. <_:example-1/>

note: (itstool) path: note/title
en: Limitations
cs: Omezení

note: (itstool) path: note/para
en: Note, that GTK-Doc's supports <code>#ifndef(__GTK_DOC_IGNORE__)</code> but not <code>#if !defined(__GTK_DOC_IGNORE__)</code> or other combinations.
cs: Uvědomte si, že GTK-Doc podporuje <code>#ifndef(__GTK_DOC_IGNORE__)</code>, ale ne <code>#if !defined(__GTK_DOC_IGNORE__)</code> nebo jiné kombinace.

note: (itstool) path: sect1/title
en: Documentation comments
cs: Dokumentační komentáře

note: (itstool) path: example/programlisting
en: 
    /**
     * identifier:
     * documentation ...
     */
cs: 
    /**
     * identifikátor:
     * dokumentace …
     */

note: (itstool) path: sect1/para
en: A multiline comment that starts with an additional '*' marks a documentation block that will be processed by the GTK-Doc tools. <_:example-1/>
cs: Každý víceřádkový komentář, který je označený další „*“ navíc, je dokumentačním blokem a bude zpracovaný nástroji GTK-Doc. <_:example-1/>

note: (itstool) path: sect1/para
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)
cs: „identifikátor“ je jeden řádek s názvem položky, ke které se komentář vztahuje. Syntaxe se částečně liší podle položky. (DOPLNIT: přidat tabulku se seznamem identifikátorů)

note: (itstool) path: sect1/para
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). This is useful in preformatted text (code listings).
cs: Blok „dokumentace“ se rovněž liší pro různé typy symbolů. Symboly, které přebírají parametry, jako jsou funkce nebo makra, mají nejdříve popsané parametry, za kterými následuje prázdný řádek (pouze „*“). Za ním pak následuje podrobný popis. Všechny řádky (mimo seznamu programů a oddílu CDATA), které obsahují „ *“ (mezera hvězdička) se převedou na zalomení odstavce. Pokud zalomení odstavce nechcete, změňte to na „ *  “ (mezera hvězdička mezera mezera). To se hodí na text s pevným formátem (výpis kódu).

note: (itstool) path: listitem/para
en: What it is: The name for a class or function can sometimes be misleading for people coming from a different background.
cs: Co to je: Název třídy nebo funkce může být občas matoucí pro lidi, kteří používají něco jiného.

note: (itstool) path: listitem/para
en: What it does: Tell about common uses. Put it in relation with the other API.
cs: K čemu to je: Uveďte běžném použití. Dejte ho do souvislosti se zbytkem API.

note: (itstool) path: tip/para
en: When documenting code, describe two aspects: <_:itemizedlist-1/>
cs: Když píšete dokumentaci ke kódu, popište dva aspekty: <_:itemizedlist-1/>

note: (itstool) path: listitem/para
en: Use function() to refer to functions or macros which take arguments.
cs: Použijte funkce() pro odkaz na funkci nebo makro, které mají argumenty.

note: (itstool) path: listitem/para
en: Use @param to refer to parameters. Also use this when referring to parameters of other functions, related to the one being described.
cs: Použijte @parametr pro odkaz na parametry. Použijte to rovněž, když se odkazujete na parametry jiných funkcí, vztahujících se k popisované funkci.

note: (itstool) path: listitem/para
en: Use %constant to refer to a constant, e.g. %G_TRAVERSE_LEAFS.
cs: Použijte %konstanta pro odkaz na konstantu, např. %G_TRAVERSE_LEAFS.

note: (itstool) path: listitem/para
en: Use #symbol to refer to other types of symbol, e.g. structs and enums and macros which don't take arguments.
cs: Použijte #symbol pro odkaz na jiný typ symbolu, např. strukturu, výčet a makro, který nemá argumenty.

note: (itstool) path: listitem/para
en: Use #Object::signal to refer to a GObject signal.
cs: Použijte #Objekt::signál pro odkaz na signál objektu GObject.

note: (itstool) path: listitem/para
en: Use #Object:property to refer to a GObject property.
cs: Použijte #Objekt:vlastnost pro odkaz na vlastnost objektu GObject.

note: (itstool) path: listitem/para
en: Use #Struct.field to refer to a field inside a structure and #GObjectClass.foo_bar() to refer to a vmethod.
cs: Použijte #Struktura.pole pro odkaz na pole uvnitř struktury a #GObjectTřída.neco() pro odkaz na virtuální metodu.

note: (itstool) path: sect1/para
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. <_:itemizedlist-1/>
cs: Jednou z výhod hypertextu, oproti prostému textu, je možnost mít v dokumentu odkazy. Zápis správných značek pro odkazy může být úmorná práce. GTK-Doc se vám snaží pomoci několika užitečnými zkratkami. <_:itemizedlist-1/>

note: (itstool) path: tip/para
en: If you need to use the special characters '&lt;', '&gt;', '()', '@', '%', or '#' in your documentation without GTK-Doc changing them you can use the XML entities "&amp;lt;", "&amp;gt;", "&amp;lpar;", "&amp;rpar;", "&amp;commat;", "&amp;percnt;" and "&amp;num;" respectively or escape them with a backslash '\'.
cs: V případě, že potřebujete ve své dokumentaci použít speciální znaky „&lt;“, „&gt;“, „()“, „@“, „%“ nebo „#“, aniž by je GTK-Doc změnilo, můžete místo nich použít použít entity XML „&amp;lt;“, „&amp;gt;“, „&amp;lpar;“, „&amp;rpar;“, „&amp;commat;“, „&amp;percnt;“ a „&amp;num;“ nebo únikovou sekvenci se zpětným lomítkem „\“.

note: (itstool) path: sect1/para
en: DocBook can do more than just links. One can also have lists, examples, headings, and images. As of version 1.20, the preferred way is to use a subset of the basic text formatting syntax called <ulink url="http://daringfireball.net/projects/markdown/">Markdown</ulink>. On older GTK-Doc versions any documentation that includes Markdown will be rendered as is. For example, list items will appear as lines starting with a dash.
cs: DocBook toho ale umí více, než jen odkazy. Může mít také seznamy, příklady, nadpisy a obrázky. Od verze 1.20 je dána přednost použití jen podmnožiny ze základní syntaxe formátování textu. Tato podmnožina se nazývá <ulink url="http://daringfireball.net/projects/markdown/">Markdown</ulink>. Dokumentace ze starší verze GTK-Doc, která obsahuje Markdown, bude vygenerována tak, jak je. Například položky seznamu se objeví s pomlčkou na začátku.

note: (itstool) path: sect1/para
en: While markdown is now preferred one can mix both. One limitation here is that one can use docbook xml within markdown, but markdown within docbook xml is not supported.
cs: I když je markdown v současnosti preferovaný, můžete míchat oba dohromady. Má to jediné omezení v tom, že můžete použít docbook xml v markdown, ale markdown v docbook xml podporován není.

note: (itstool) path: sect1/para
en: In older GTK-Doc releases, if you need support for additional formatting, you would need to enable the usage of docbook XML tags inside doc-comments by putting <option>--xml-mode</option> (or <option>--sgml-mode</option>) in the variable <symbol>MKDB_OPTIONS</symbol> inside <filename>Makefile.am</filename>.
cs: Když ve starších vydáních GTK-Doc potřebujete podporu pro dodatečné formátování, musíte zapnout použití značek XML pro DocBook uvnitř dokumentačních komentářů pomocí <option>--xml-mode</option> (nebo <option>--sgml-mode</option>) v proměnné <symbol>MKDB_OPTIONS</symbol> v souboru <filename>Makefile.am</filename>.

note: (itstool) path: example/title
en: GTK-Doc comment block using Markdown
cs: Komentářový blok GTK-Doc používající značkovací jazyk

note: (itstool) path: example/programlisting
en: 
    /**
     * identifier:
     *
     * documentation paragraph ...
     *
     * # Sub Heading #
     *
     * ## Second Sub Heading
     *
     * # Sub Heading With a Link Anchor # {#heading-two}
     *
     * more documentation:
     *
     * - list item 1
     *
     *   Paragraph inside a list item.
     *
     * - list item 2
     *
     * 1. numbered list item
     *
     * 2. another numbered list item
     *
     * Another paragraph. [A Link to the GNOME Website](http://www.gnome.org/)
     *
     * ![an inline image](plot-result.png)
     *
     * [A link to the heading anchor above][heading-two]
     *
     * A C-language example:
     * |[&lt;!-- language="C" --&gt;
     * GtkWidget *label = gtk_label_new ("Gorgeous!");
     * ]|
     */
cs: 
    /**
     * identifikátor:
     *
     * odstavec dokumentace…
     *
     * # Podnadpis #
     *
     * ## Podnadpis druhé úrovně
     *
     * # Podnadpis s kotvou pro odkazy # {#heading-two}
     *
     * další dokumentace:
     *
     * - položka seznamu 1
     *
     *   Odstavec v rámci položky seznamu.
     *
     * - položka seznamu 2
     *
     * 1. číslovaná položka seznamu
     *
     * 2. další číslovaná položka seznamu
     *
     * Další odstavec. [Odkazy na webové stránky GNOME](http://www.gnome.org/)
     *
     * ![vložený obrázek](plot-result.png)
     *
     * [Odkaz na nadpis pomocí kotvy uvedené výše][heading-two]
     *
     * Příklad v jazyce C:
     * |[&lt;!-- language="C" --&gt;
     * GtkWidget *label = gtk_label_new ("Paráda!");
     * ]|
     */

note: (itstool) path: sect1/para
en: More examples of what markdown tags are supported can be found in the <ulink url="https://wiki.gnome.org/Projects/GTK%2B/DocumentationSyntax/Markdown">GTK+ Documentation Markdown Syntax Reference</ulink>.
cs: Více příkladů k podporovaným značkám Markdown můžete najít v <ulink url="https://wiki.gnome.org/Projects/GTK%2B/DocumentationSyntax/Markdown">Referenční příručce k syntaxi Markdown pro dokumentaci GTK+</ulink>.

note: (itstool) path: tip/para
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.
cs: Jak již bylo zmíněno dříve, slouží GTK-Doc pro dokumentování veřejného API. Tím pádem nemůžete psát dokumentaci pro statické symboly. Nicméně je vhodné komentovat i tyto symboly. Pomůže to ostatním porozumět vašemu kódu. Proto doporučujeme komentovat je pomocí normálních komentářů (bez druhé „*“ na prvním řádku). Pokud je budete v budoucnu chtít předělat na veřejné, jediné co budete muset udělat, je přidat do komentářového bloku jednu „*“ a na správné místo v souboru oddílů vložit název symbolu.

note: (itstool) path: sect1/title
en: Documenting sections
cs: Dokumentování oddílů

note: (itstool) path: sect1/para
en: Each section of the documentation contains information about one class or module. To introduce the component one can write a section block. The short description is also used inside the table of contents. All the @fields are optional.
cs: Každý oddíl dokumentace obsahuje informaci o jedné třídě nebo modulu. Můžete do oddílu napsat blok, ve kterém je představíte. Stručný popis se rovněž použije v rámci tabulky s obsahem. Všechna @pole jsou volitelná.

note: (itstool) path: example/title
en: Section comment block
cs: Komentářový blok oddílu

note: (itstool) path: example/programlisting
en: 
    /**
     * 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 ...
     */
cs: 
    /**
     * SECTION:meepapp
     * @short_description: třída plikace
     * @title: Aplikace Meep
     * @section_id:
     * @see_also: #MeepSettings
     * @stability: Stable
     * @include: meep/app.h
     * @image: application.png
     *
     * Třída aplikace starající se o…
     */

note: (itstool) path: varlistentry/term
en: SECTION:&lt;name&gt;
cs: SECTION:&lt;název&gt;

note: (itstool) path: listitem/para
en: The name links the section documentation to the respective part in the <filename>&lt;package&gt;-sections.txt</filename> file. The name given here should match the &lt;FILE&gt; tag in the <filename>&lt;package&gt;-sections.txt</filename> file.
cs: Název prováže oddíl dokumentace s příslušnou částí v souboru <filename>&lt;package&gt;-sections.txt</filename>. Zde zadaný název musí odpovídat značce &lt;SOUBOR&gt; v souboru <filename>&lt;package&gt;-sections.txt</filename>.

note: (itstool) path: listitem/para
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.
cs: Jednořádkový popis oddílu, který se později objeví za odkazy v tabulce s obsahem a na začátku stránky oddílu.

note: (itstool) path: listitem/para
en: The section title defaults to &lt;name&gt; from the SECTION declaration. It can be overridden with the @title field.
cs: Název oddílu se standardně zvolí podle &lt;name&gt; v deklaraci SECTION. Lze jej ale určit i přímo v poli @title.

note: (itstool) path: listitem/para
en: Overrides the use of title as a section identifier. For GObjects the &lt;title&gt; is used as a section_id and for other sections it is &lt;MODULE&gt;-&lt;title&gt;.
cs: Přepíše použití názvu jako identifikátoru oddílu. Pro objekty GObject se jako section_id použije &lt;title&gt; a pro ostatní oddíly to je &lt;MODULE&gt;-&lt;title&gt;.

note: (itstool) path: listitem/para
en: A list of symbols that are related to this section.
cs: Seznam symbolů, které se vztahují k tomuto oddílu.

note: (itstool) path: listitem/para
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.
cs: Stable (stabilní) – Záměrem stabilního rozhraní je umožnit libovolné třetí straně vyvinout aplikace využívající toto rozhraní, vydat je a moci se spolehnout, že poběží na všech podružných vydáních produktu (po té, co je rozhraní vydáno a v rámci stejné hlavní verze). I mezi hlavními vydáními se nekompatibilní změny očekávají zřídka v opravdu odůvodněných případech.

note: (itstool) path: listitem/para
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.
cs: Unstable (nestabilní) – Nestabilní rozhraní je experimentální a přechodné. Typicky bývá dáno vývojářům k dispozici kvůli včasnému přístupu k novým a rychle se měnícím technologiím nebo kvůli poskytnutí provizorního řešení problému, kdy je předpokládané více obecné řešení. Není žádná záruka ohledně zdrojové či binární kompatibility při přechodu z jedné podružné verze na následujíc.

note: (itstool) path: listitem/para
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.
cs: Private (soukromé) – Rozhraní, které může být použité v rámci zásobníku GNOME, ale není dokumentované pro koncového uživatele. Takové funkce by se měly používat jen určeným a dokumentovaným způsobem.

note: (itstool) path: listitem/para
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.
cs: Internal (interní) – Rozhraní, které je určené pro interní potřeby modulu a nevyžaduje dokumentaci pro koncového uživatele. Funkce, které jsou nedokumentované, jsou považované za interní.

note: (itstool) path: listitem/para
en: An informal description of the stability level this API has. We recommend the use of one of these terms: <_:itemizedlist-1/>
cs: Informační popis úrovně stability tohoto API. Doporučujeme použít jeden z těchto termínů: <_:itemizedlist-1/>

note: (itstool) path: listitem/para
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.
cs: Seznam souborů z <literal>#include</literal> oddělených čárkou, aby se zobrazily v oddílu anotace. Přepisuje globální hodnotu ze <link linkend="metafiles_sections">souboru oddílů</link> nebo příkazové řádky. Tato položka je volitelná.

note: (itstool) path: listitem/para
en: 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.
cs: Obrázek, který se má zobrazit na začátku referenční stránky k tomuto oddílu. Často se jedná o nějaký nákres, který schématicky znázorňuje podobu třídy nebo nákres se vztahy vůči jiným třídám. Tato položka je volitelná.

note: (itstool) path: tip/para
en: To avoid unnecessary recompilation after doc-changes put the section docs into the c-source where possible.
cs: Aby se po změně dokumentace předešlo rekompilacím, které nejsou nutné, vložte, kde je to možné, dokumentaci oddílu do zdrojového kódu c.

note: (itstool) path: sect1/title
en: Documenting symbols
cs: Dokumentování symbolů

note: (itstool) path: sect1/para
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 functions are usually documented in the c-source and macros, structs and enums in the header file.
cs: Každý symbol (funkce, makro, struktura, výčet, signál a vlastnost) se dokumentuje v odděleném bloku. Blok je nejlepší umístit v rámci definice symbolu, protože se tak snadno udržuje synchronizovaný. Z tohoto důvodu se funkce obvykle dokumentují ve zdrojovém kódu C a makra, struktury a výčty v hlavičkovém souboru.

note: (itstool) path: sect2/title (itstool) path: example/title
en: General tags
cs: Obecné značky

note: (itstool) path: sect2/para
en: You can add versioning information to all documentation elements to tell when an API was introduced, or when it was deprecated.
cs: Informace o verzích můžete přidat ke všem prvkům dokumentace, abyste sdělili, kdy bylo API zavedeno, nebo kdy bylo označeno za zastaralé.

note: (itstool) path: variablelist/title
en: Versioning Tags
cs: Značky pro verzování

note: (itstool) path: listitem/para
en: Description since which version of the code the API is available.
cs: Popisuje, od které verze kódu je API dostupné.

note: (itstool) path: listitem/para
en: Paragraph denoting that this function should no be used anymore. The description should point the reader to the new API.
cs: Odstavec upozorňující, že by se tato funkce neměla nadále používat. Popis by měl čtenáře odkazovat na nové API.

note: (itstool) path: sect2/para
en: You can also add stability information to all documentation elements to indicate whether API stability is guaranteed for them for all future minor releases of the project.
cs: Můžete také ke všem prvkům dokumentace přidat informaci o stabilitě, abyste dali najevo, že je u API zaručena stabilita pro všechna následující minoritní vydání projektu.

note: (itstool) path: sect2/para
en: The default stability level for all documentation elements can be set by passing the <option>--default-stability</option> argument to <application>gtkdoc-mkdb</application> with one of the values below.
cs: Výchozí stabilitu pro všechny prvky dokumentace můžete pomocí argumentu <option>--default-stability</option> s jednou u níže uvedených hodnot předat do <application>gtkdoc-mkdb</application>.

note: (itstool) path: variablelist/title
en: Stability Tags
cs: Značky pro stabilitu

note: (itstool) path: listitem/para
en: Mark the element as stable. This is for public APIs which are guaranteed to remain stable for all future minor releases of the project.
cs: Označuje prvek jako stabilní. Je to určeno pro veřejná API, která zaručují, že zůstanou stabilní po všechna minoritní vydání projektu.

note: (itstool) path: listitem/para
en: Mark the element as unstable. This is for public APIs which are released as a preview before being stabilised.
cs: Označuje prvek jako nestabilní. Je to určeno pro veřejná API, která jsou vydána jako ukázky před tím, než jsou stabilizována.

note: (itstool) path: listitem/para
en: Mark the element as private. This is for interfaces which can be used by tightly coupled modules, but not by arbitrary third parties.
cs: Označuje prvek jako soukromý. Je to určeno pro rozhraní, která mohou být použita přímo v modulu, ale ne kterýmikoliv třetími stranami.

note: (itstool) path: example/programlisting
en: 
    /**
     * 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)
    {
    ...
cs: 
    /**
     * foo_get_bar:
     * @foo: nějaké něco
     *
     * Získá @foo něčeho.
     *
     * Returns: @foo něčeho
     *
     * Since: 2.6
     * Deprecated: 2.12: Místo toho použijte foo_baz_get_bar().
     */
    Bar *
    foo_get_bar(Foo *foo)
    {
    ...

note: (itstool) path: sect2/title (itstool) path: example/title
en: Annotations
cs: Anotace

note: (itstool) path: sect2/para
en: Documentation blocks can contain annotation-tags. These tags will be rendered with tooltips describing their meaning. The tags are used by gobject-introspection to generate language bindings. A detailed list of the supported tags can be found on <ulink url="http://live.gnome.org/GObjectIntrospection/Annotations" type="http">the wiki</ulink>.
cs: Dokumentační bloky mohou obsahovat anotační štítky. Tyto štítky budou zpracovány jako vysvětlivky popisující jejich význam. Používají se introspekcí objektu GObjekt k vygenerování vazby na další jazyky. Podrobný seznam podporovaných štítků můžete najít na <ulink url="http://live.gnome.org/GObjectIntrospection/Annotations" type="http">wiki</ulink>.

note: (itstool) path: example/programlisting
en: 
    /**
     * foo_get_bar: (annotation)
     * @foo: (annotation): some foo
     *
     * Retrieves @foo's bar.
     *
     * Returns: (annotation): @foo's bar
     */
    ...
    /**
     * foo_set_bar_using_the_frobnicator: (annotation) (another annotation)
     *                                    (and another annotation)
     * @foo: (annotation) (another annotation): some foo
     *
     * Sets bar on @foo.
     */
cs: 
    /**
     * foo_get_bar: (annotation)
     * @foo: (annotation): nějaké něco
     *
     * Získá @foo něčeho.
     *
     * Returns: (annotation): @foo něčeho
     */
    ...
    /**
     * foo_set_bar_using_the_frobnicator: (annotation) (annotation)
     *                                    (annotation) …
     * @foo: (annotation) (annotation) …: nějaké něco
     *
     * Nastaví něco na @foo.
     */

note: (itstool) path: sect2/title (itstool) path: example/title
en: Function comment block
cs: Komentářový blok pro funkci

note: (itstool) path: listitem/para
en: Document whether returned objects, lists, strings, etc, should be freed/unrefed/released.
cs: Zdokumentovat, jestli je třeba vracené objekty, seznamy, řetězce apod. uvolnit z paměti.

note: (itstool) path: listitem/para
en: Document whether parameters can be NULL, and what happens if they are.
cs: Zdokumentovat, jestli může parametr být NULL a co se stane, když tomu tak je.

note: (itstool) path: listitem/para
en: Mention interesting pre-conditions and post-conditions where appropriate.
cs: Kde je to vhodné, zmínit úvodní a koncové podmínky.

note: (itstool) path: sect2/para
en: Please remember to: <_:itemizedlist-1/>
cs: Nezapomeňte prosím: <_:itemizedlist-1/>

note: (itstool) path: sect2/para
en: Gtk-doc assumes all symbols (macros, functions) starting with '_' are private. They are treated like static functions.
cs: Gtk-doc předpokládá, že všechny symboly (makra, funkce) začínající znakem „_“, jsou soukromé. Potom se s nimi zachází jako se statickými funkcemi.

note: (itstool) path: example/programlisting
en: 
    /**
     * 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.
     */
cs: 
    /**
     * function_name:
     * @par1:  popis parametru 1. Může zabírat více jak
     * jeden řádek.
     * @par2:  popis parametru 2
     * @...:  seznam proměnných parametrů zakončených NULL
     *
     * Zde pokračuje popis funkce. K odkazu na parametr můžete použit @par1,
     * takže bude ve výstupu zvýrazněný. Můžete také použít %constant pro
     * konstanty, function_name() pro funkce a #GtkWidget pro odkazy na jiné
     * deklarace (které mohou být zdokumentované jinde).
     *
     * Returns: celé číslo.
     *
     * Since: 2.2
     * Deprecated: 2.18: Místo toho použijte other_function().
     */

note: (itstool) path: variablelist/title
en: Function tags
cs: Značky pro funkce

note: (itstool) path: listitem/para
en: Paragraph describing the returned result.
cs: Odstavec popisující vracený výsledek.

note: (itstool) path: varlistentry/term
en: @...:
cs: @…:

note: (itstool) path: listitem/para
en: In case the function has variadic arguments, you should use this tag (@Varargs: does also work for historic reasons).
cs: Když má funkce proměnný počet argumentů, měli byste použít tuto značku (z historických důvodů funguje i @Varargs:).

note: (itstool) path: sect2/title (itstool) path: example/title
en: Property comment block
cs: Komentářový blok pro vlastnost

note: (itstool) path: example/programlisting
en: 
    /**
     * SomeWidget:some-property:
     *
     * Here you can document a property.
     */
    g_object_class_install_property (object_class, PROP_SOME_PROPERTY, ...);
cs: 
    /**
     * SomeWidget:some-property:
     *
     * Zde vlastnost zdokumentujte.
     */
    g_object_class_install_property (object_class, PROP_SOME_PROPERTY, …);

note: (itstool) path: sect2/title (itstool) path: example/title
en: Signal comment block
cs: Komentářový blok pro signál

note: (itstool) path: listitem/para
en: Document when the signal is emitted and whether it is emitted before or after other signals.
cs: Zdokumentovat, kdy je signál vyslán a jestli je vyslána před nebo po ostatních signálech.

note: (itstool) path: listitem/para
en: Document what an application might do in the signal handler.
cs: Zdokumentovat, co aplikace smí v obsluze signálu provádět.

note: (itstool) path: example/programlisting
en: 
    /**
     * 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[FOOBARIZED] =
      g_signal_new ("foobarized",
                    ...
cs: 
    /**
     * FooWidget::foobarized:
     * @widget: widget, který signál přijímá
     * @foo: nějaké něco
     * @bar: jiné něco
     *
     * Signál ::foobarized je vyslán pokaždé, když někdo zkusí něco s @widget.
     */
    foo_signals[FOOBARIZED] =
      g_signal_new ("foobarized",
                    ...

note: (itstool) path: sect2/title (itstool) path: example/title
en: Struct comment block
cs: Komentářový blok pro strukturu

note: (itstool) path: example/programlisting
en: 
    /**
     * FooWidget:
     * @bar: some #gboolean
     *
     * This is the best widget, ever.
     */
    typedef struct _FooWidget {
      GtkWidget parent_instance;
    
      gboolean bar;
    } FooWidget;
cs: 
    /**
     * FooWidget:
     * @bar: nějaká #gboolean
     *
     * Tohle je ten nejlepší widget.
     */
    typedef struct _FooWidget {
      GtkWidget parent_instance;
    
      gboolean bar;
    } FooWidget;

note: (itstool) path: sect2/para
en: Use <code>/*&lt; private &gt;*/</code> before the private struct fields you want to hide. Use <code>/*&lt; public &gt;*/</code> for the reverse behaviour.
cs: Před privátními poli struktury použijte <code>/*&lt; private &gt;*/</code>, abyste je skryli. K přesně opačnému účelu se používá <code>/*&lt; public &gt;*/</code>.

note: (itstool) path: sect2/para
en: If the first field is "g_iface", "parent_instance" or "parent_class" it will be considered private automatically and doesn't need to be mentioned in the comment block.
cs: Pokud je prvním polem „g_iface“, „parent_instance“ nebo „parent_class“, bude za privátní považováno automaticky a není to zapotřebí zmiňovat v komentářovém bloku.

note: (itstool) path: sect2/para
en: Struct comment blocks can also be used for GObjects and GObjectClasses. It is usually a good idea to add a comment block 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).
cs: Komentářové bloky struktur můžete použít také pro objekty GObject a třídy GObjectClass. Obvykle je rozumné přidat komentářový blok pro třídu, pokud má virtuální metody (protože to je způsob, jakým je lze zdokumentovat). Pro vlastní GObject je možné použít příslušnou dokumentaci oddílu, který bude mít samostatný blok pro strukturu instance, což se může hodit, když má instance veřejná pole. Jedinou nevýhodou je, že se tím vytvoří dvě položky v rejstříku se stejným názvem (struktura a oddíl).

note: (itstool) path: sect2/title (itstool) path: example/title
en: Enum comment block
cs: Komentářový blok pro výčty

note: (itstool) path: example/programlisting
en: 
    /**
     * 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,
      /*&lt; private &gt;*/
      SOMETHING_COUNT
    } Something;
cs: 
    /**
     * Something:
     * @SOMETHING_FOO: nějaké něco
     * @SOMETHING_BAR: jiné něco
     *
     * Výčtové hodnoty používané pro určení věci.
     */
    typedef enum {
      SOMETHING_FOO,
      SOMETHING_BAR,
      /*&lt; private &gt;*/
      SOMETHING_COUNT
    } Something;

note: (itstool) path: sect2/para
en: Use <code>/*&lt; private &gt;*/</code> before the private enum values you want to hide. Use <code>/*&lt; public &gt;*/</code> for the reverse behaviour.
cs: Před privátními výčtovými hodnotami použijte <code>/*&lt; private &gt;*/</code>, abyste je skryli. K přesně opačnému účelu se používá <code>/*&lt; public &gt;*/</code>.

note: (itstool) path: sect1/title
en: Inline program documentation
cs: Dokumentaci k vloženým programům

note: (itstool) path: sect1/para
en: You can document programs and their commandline interface using inline documentation.
cs: Programy a jejich rozhraní příkazového řádku můžete zdokumentovat pomocí vložené dokumentace.

note: (itstool) path: variablelist/title
en: Tags
cs: Značky

note: (itstool) path: listitem/para
en: Defines the start of a program documentation.
cs: Definuje začátek dokumentace k programu.

note: (itstool) path: listitem/para
en: Defines a short description of the program. (Optional)
cs: Definuje krátký popis programu. (volitelné)

note: (itstool) path: listitem/para
en: Defines the arguments, or list of arguments that the program can take. (Optional)
cs: Definuje argumenty nebo seznam argumentů, které program přebírá. (volitelné)

note: (itstool) path: listitem/para
en: See Also manual page section. (Optional)
cs: Část stránky oddílu „Viz také“. (volitelné)

note: (itstool) path: listitem/para
en: Argument(s) passed to the program and their description. (Optional)
cs: Argument(y) předávané do programu a jejich popis. (volitelné)

note: (itstool) path: listitem/para
en: A longer description of the program.
cs: Úplný popis programu.

note: (itstool) path: listitem/para
en: Specificy what value(s) the program returns. (Optional)
cs: Specifikuje, jakou hodnotu či více hodnot program vrací. (volitelné)

note: (itstool) path: sect2/title
en: Example of program documentation.
cs: Příklad dokumentace k programu.

note: (itstool) path: example/title
en: Program documentation block
cs: Komentářový blok pro program

note: (itstool) path: example/programlisting
en: 
    /**
     * PROGRAM:test-program
     * @short_description: A test program
     * @synopsis: test-program [*OPTIONS*...] --arg1 *arg* *FILE*
     * @see_also: test(1)
     * @--arg1 *arg*: set arg1 to *arg*
     * @--arg2 *arg*: set arg2 to *arg*
     * @-v, --version: Print the version number
     * @-h, --help: Print the help message
     *
     * Long description of program.
     *
     * Returns: Zero on success, non-zero on failure
     */
    int main(int argc, char *argv[])
    {
    	return 0;
    }
cs: 
    /**
     * PROGRAM:test-program
     * @short_description: Testovací program
     * @synopsis: test-program [*OPTIONS*...] --arg1 *arg* *FILE*
     * @see_also: test(1)
     * @--arg1 *arg*: nastaví arg1 do *arg*
     * @--arg2 *arg*: nastaví arg2 do *arg*
     * @-v, --version: Vypíše verzi programu
     * @-h, --help: Vypíše nápovědu k programu
     *
     * Úplný popis programu.
     *
     * Returns: Vrací nulu při úspěchu, nenulovou hodnotu při selhání.
     */
    int main(int argc, char *argv[])
    {
    	return 0;
    }

note: (itstool) path: sect1/title
en: Useful DocBook tags
cs: Užitečné značky DocBook

note: (itstool) path: sect1/para
en: Here are some DocBook tags which are most useful when documenting the code.
cs: Zde jsou některé značky DocBook, které mají pro dokumentaci kódu největší význam.

note: (itstool) path: informalexample/programlisting
en: 
    &lt;link linkend="glib-Hash-Tables"&gt;Hash Tables&lt;/link&gt;
cs: 
    &lt;link linkend="glib-Hash-Tables"&gt;Hašovací tabulky&lt;/link&gt;

note: (itstool) path: sect1/para
en: To link to another section in the GTK docs: <_:informalexample-1/> 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.
cs: Odkaz na jiný oddíl v dokumentaci GTK: <_:informalexample-1/> Odkazem je id SGML/XML v první položce stránky, na kterou chcete odkazovat. Pro většinu stránek je to v současnosti část („gtk“, „gdk“, „glib“) a potom název stránky („Hašovací tabulka“). Pro ovládací prvky je to název třídy. Mezery a podtržítka se převedou na „-“, aby to vyhovovalo SGML/XML.

note: (itstool) path: informalexample/programlisting
en: 
    &lt;function&gt;...&lt;/function&gt;
cs: 
    &lt;function&gt;…&lt;/function&gt;

note: (itstool) path: sect1/para
en: To refer to an external function, e.g. a standard C function: <_:informalexample-1/>
cs: Odkaz na externí funkci, například standardní funkci C: <_:informalexample-1/>

note: (itstool) path: informalexample/programlisting
en: 
    &lt;example&gt;
      &lt;title&gt;Using a GHashTable.&lt;/title&gt;
      &lt;programlisting&gt;
          ...
      &lt;/programlisting&gt;
    &lt;/example&gt;
cs: 
    &lt;example&gt;
      &lt;title&gt;Používání GHashTable.&lt;/title&gt;
      &lt;programlisting&gt;
          …
      &lt;/programlisting&gt;
    &lt;/example&gt;

note: (itstool) path: informalexample/programlisting
en: 
    &lt;informalexample&gt;
      &lt;programlisting&gt;
      ...
      &lt;/programlisting&gt;
    &lt;/informalexample&gt;
cs: 
    &lt;informalexample&gt;
      &lt;programlisting&gt;
      …
      &lt;/programlisting&gt;
    &lt;/informalexample&gt;

note: (itstool) path: sect1/para
en: To include example code: <_:informalexample-1/> or possibly this, for very short code fragments which don't need a title: <_:informalexample-2/> For the latter GTK-Doc also supports an abbreviation: |[ ... ]|
cs: Vložení ukázky kódu: <_:informalexample-1/> nebo pro velmi krátké úseky kódu, které nepotřebují nadpisy, je případně možné i: <_:informalexample-2/> V novějších verzích GTK-Doc je také podporované zkracování: |[ … ]|

note: (itstool) path: informalexample/programlisting
en: 
    &lt;itemizedlist&gt;
      &lt;listitem&gt;
        &lt;para&gt;
          ...
        &lt;/para&gt;
      &lt;/listitem&gt;
      &lt;listitem&gt;
        &lt;para&gt;
          ...
        &lt;/para&gt;
      &lt;/listitem&gt;
    &lt;/itemizedlist&gt;
cs: 
    &lt;itemizedlist&gt;
      &lt;listitem&gt;
        &lt;para&gt;
          …
        &lt;/para&gt;
      &lt;/listitem&gt;
      &lt;listitem&gt;
        &lt;para&gt;
          …
        &lt;/para&gt;
      &lt;/listitem&gt;
    &lt;/itemizedlist&gt;

note: (itstool) path: sect1/para
en: To include bulleted lists: <_:informalexample-1/>
cs: Vložení seznamu s odrážkami: <_:informalexample-1/>

note: (itstool) path: informalexample/programlisting
en: 
    &lt;note&gt;
      &lt;para&gt;
        Make sure you free the data after use.
      &lt;/para&gt;
    &lt;/note&gt;
cs: 
    &lt;note&gt;
      &lt;para&gt;
        Ujistěte se, že data po použití uvolníte.
      &lt;/para&gt;
    &lt;/note&gt;

note: (itstool) path: sect1/para
en: To include a note which stands out from the text: <_:informalexample-1/>
cs: Vložení poznámky, která se objeví mimo text: <_:informalexample-1/>

note: (itstool) path: sect1/para
en: To refer to a type: <_:informalexample-1/>
cs: Odkaz na typ: <_:informalexample-1/>

note: (itstool) path: sect1/para
en: To refer to an external structure (not one described in the GTK docs): <_:informalexample-1/>
cs: Odkaz na externí strukturu (která není popsaná v dokumentaci GTK): <_:informalexample-1/>

note: (itstool) path: sect1/para
en: To refer to a field of a structure: <_:informalexample-1/>
cs: Odkaz na pole struktury: <_:informalexample-1/>

note: (itstool) path: sect1/para
en: To refer to a class name, we could possibly use: <_:informalexample-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>).
cs: Pro odkaz na název třídy by se dal nejspíše použít: <_:informalexample-1/> ale pravděpodobně místo toho použijete #GtkWidget (aby se automaticky vytvořil odkaz na stránku ovládacího prvku, viz <link linkend="documenting_syntax">zkratky</link>).

note: (itstool) path: informalexample/programlisting
en: 
    &lt;emphasis&gt;This is important&lt;/emphasis&gt;
cs: 
    &lt;emphasis&gt;Toto je důležité&lt;/emphasis&gt;

note: (itstool) path: sect1/para
en: To emphasize text: <_:informalexample-1/>
cs: Zvýrazněný text: <_:informalexample-1/>

note: (itstool) path: sect1/para
en: For filenames use: <_:informalexample-1/>
cs: Pro název souboru použijte: <_:informalexample-1/>

note: (itstool) path: informalexample/programlisting
en: 
    &lt;keycombo&gt;&lt;keycap&gt;Control&lt;/keycap&gt;&lt;keycap&gt;L&lt;/keycap&gt;&lt;/keycombo&gt;
cs: 
    &lt;keycombo&gt;&lt;keycap&gt;Ctrl&lt;/keycap&gt;&lt;keycap&gt;L&lt;/keycap&gt;&lt;/keycombo&gt;

note: (itstool) path: sect1/para
en: To refer to keys use: <_:informalexample-1/>
cs: Odkaz na použití klávesy: <_:informalexample-1/>

note: (itstool) path: chapter/title
en: Filling the extra files
cs: Vyplňování dodatečných souborů

note: (itstool) path: chapter/para
en: There are a couple of extra files, that need to be maintained along with the inline source code comments: <filename>&lt;package&gt;.types</filename>, <filename>&lt;package&gt;-docs.xml</filename> (in the past .sgml), <filename>&lt;package&gt;-sections.txt</filename>.
cs: Mimo komentářů vložených ve zdrojovém kódu je zde ještě pár dodatečných souborů, které je potřeba udržovat:<filename>&lt;balíček&gt;.types</filename>, <filename>&lt;balíček&gt;-docs.xml</filename> (dříve .sgml) a <filename>&lt;balíček&gt;-sections.txt</filename>.

note: (itstool) path: sect1/title
en: Editing the types file
cs: Úprava souboru s typy

note: (itstool) path: sect1/para
en: If your library or application includes 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.
cs: Pokud vaše knihovna nebo aplikace vkládá objekty GObject, chcete jejich signály, argumenty/parametry a pozici v hierarchii ukázat v dokumentaci. Vše, co pro to potřebujete udělat, je vypsat funkce <function>xxx_get_type</function> spolu s jejich include v souboru <filename>&lt;balíček&gt;.types</filename>.

note: (itstool) path: example/title
en: Example types file snippet
cs: Příklad úryvku ze souboru typů

note: (itstool) path: sect1/para
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.
cs: Od GTK-Doc verze 1.8 vám tento seznam vygeneruje <application>gtkdoc-scan</application>. Stačí jen přidat „--rebuild-types“ do SCAN_OPTIONS v <filename>Makefile.am</filename>. Pokud tento přístup použijete, neměli byste soubor s typy šířit do správy verzí.

note: (itstool) path: sect1/title
en: Editing the master document
cs: Úprava hlavního dokumentu

note: (itstool) path: sect1/para
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 an order.
cs: GTK-Doc produkuje dokumentaci v SGML/XML standardu DocBook. Když se zpracovávají komentáře vložené ve zdrojovém kódu, generují nástroje GTK-Doc pro každou třídu nebo modul jednu stránku dokumentace jako samostatný soubor. Všechny jsou pak uvedené seřazené v hlavním dokumentu.

note: (itstool) path: sect1/para
en: 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 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.
cs: Jakmile pro vás GTK-Doc vytvoří šablonu hlavního dokumentu, při pozdějším spuštění již do ní nezasahuje. To znamená, že můžete dokumentaci bez omezení strukturovat. A to včetně seskupování stránek a přidávání doplňujících stránek. GTK-Doc má v současnosti testovací sadu, ve které je také hlavní dokument vytvořen znovu od začátku. Je dobré se čas od času do něj nahlédnout, jestli se v něm neobjevily nějaké nové věci.

note: (itstool) path: tip/para
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.
cs: Nevytvářejte výukové dokumenty (tutorial) jako zvláštní dokumenty. Napište je jako zvláštní kapitolu. Výhodou přímého spojení výukového dokumentu k vaší knihovně s dokumentací API je snadné vytváření odkazů pro symboly. Zvyšuje se tím také šance, že výukový dokument bude reflektovat aktualizace v knihovně.

note: (itstool) path: sect1/para
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.
cs: Nyní se podívejme, které věci můžete v hlavním dokumentu měnit. Pro začátek je to pouze název. Je zde několik zástupných hodnot (text v hranatých závorkách), o které byste se měli postarat.

note: (itstool) path: example/title
en: Master document header
cs: Hlavička hlavního dokumentu

note: (itstool) path: example/programlisting
en: 
    &lt;bookinfo&gt;
      &lt;title&gt;MODULENAME Reference Manual&lt;/title&gt;
      &lt;releaseinfo&gt;
        for MODULENAME [VERSION]
        The latest version of this documentation can be found on-line at
        &lt;ulink role="online-location" url="http://[SERVER]/MODULENAME/index.html"&gt;http://[SERVER]/MODULENAME/&lt;/ulink&gt;.
      &lt;/releaseinfo&gt;
    &lt;/bookinfo&gt;
    
    &lt;chapter&gt;
      &lt;title&gt;[Insert title here]&lt;/title&gt;
cs: 
    &lt;bookinfo&gt;
      &lt;title&gt;Referenční příručka k NÁZEV_MODULU&lt;/title&gt;
      &lt;releaseinfo&gt;
        pro NÁZEV_MODULU [VERSION]
        Nejvnovější verzi tohoto dokumentu můžete najít on-line na
        &lt;ulink role="online-location" url="http://[SERVER]/NÁZEV_MODULU/index.html"&gt;http://[SERVER]/NÁZEV_MODULU/&lt;/ulink&gt;.
      &lt;/releaseinfo&gt;
    &lt;/bookinfo&gt;
    
    &lt;chapter&gt;
      &lt;title&gt;[Insert title here]&lt;/title&gt;

note: (itstool) path: sect1/para
en: In addition a few option elements are created in commented form. You can review these and enable them as you like.
cs: Navíc se vytvoří pár volitelných prvků ve formě komentáře. Můžete si je projít a případně povolit.

note: (itstool) path: example/title
en: Optional part in the master document
cs: Volitelná část hlavního dokumentu

note: (itstool) path: sect1/para
en: Finally you need to add new section whenever you introduce one. The <link linkend="modernizing-gtk-doc-1-16">gtkdoc-check</link> tool will remind you of newly generated xml files that are not yet included into the doc.
cs: Nakonec musíte přidat nový oddíl, kdekoliv chcete. Nástroj <link linkend="modernizing-gtk-doc-1-16">gtkdoc-check</link> vás upozorní na nově vygenerované soubory XML, které zatím nejsou v dokumentaci zahrnuté.

note: (itstool) path: example/title
en: Including generated sections
cs: Vkládání generovaných oddílů

note: (itstool) path: example/programlisting
en: 
      &lt;chapter&gt;
        &lt;title&gt;my library&lt;/title&gt;
          &lt;xi:include href="xml/object.xml"/&gt;
          ...
cs: 
      &lt;chapter&gt;
        &lt;title&gt;moje knihovna&lt;/title&gt;
          &lt;xi:include href="xml/object.xml"/&gt;
          …

note: (itstool) path: sect1/title
en: Editing the section file
cs: Úprava souboru oddílů

note: (itstool) path: sect1/para
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).
cs: Soubor oddílů se používá k organizování výstupu dokumentace z GTK-Doc. Zde se určuje, který symbol náleží ke kterému modulu nebo třídě, a řídí se viditelnost (jestli je veřejný nebo soukromý).

note: (itstool) path: sect1/para
en: The section file is a plain text file with tags delimiting sections. Blank lines are ignored and lines starting with a '#' are treated as comment lines.
cs: Soubor oddílů je prostý textový soubor, ve kterém jsou oddíly oddělené značkami. Prázdné řádky se ignorují a s řádky začínajícími „#“ se zachází jako s komentářovými řádky.

note: (itstool) path: note/para
en: While the tags make the file look like xml, it is not. Please do not close tags like &lt;SUBSECTION&gt;.
cs: Přestože díky značkám vypadá soubor podobně jako XML, není tomu tak. Neuzavírejte prosím značky jako je &lt;SUBSECTION&gt;.

note: (itstool) path: sect1/para
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 XML file <filename>xml/gnome-config.sgml</filename> or the 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).
cs: Značka &lt;FILE&gt; … &lt;/FILE&gt; se používá k určení názvu souboru bez přípony. Například použití „&lt;FILE&gt;gnome-config&lt;/FILE&gt;“ bude mít v deklaracích oddílu za následek výstup do souboru šablony <filename>tmpl/gnome-config.sgml</filename>, který bude převeden do souboru <filename>sgml/gnome-config.sgml</filename> ve formátu DocBook SGML nebo do souboru <filename>xml/gnome-config.xml</filename> ve formátu DocBook XML. (Název souboru HTML vychází z názvu modulu a názvu oddílu, případně pro GObject z názvu třídy GObject převedeného na malá písmena.)

note: (itstool) path: sect1/para
en: The &lt;TITLE&gt; ... &lt;/TITLE&gt; 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.
cs: Značka &lt;TITLE&gt; … &lt;/TITLE&gt; se používá k určení názvu oddílu. To je použitelné pouze dříve, než je poprvé vytvořena šablona (pokud se používá), protože název nastavený v šabloně tento název přepíše. Navíc je považována za zastaralou v případě, že se používá komentář SECTION ve zdrojovém kódu.

note: (itstool) path: sect1/para
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. Whether you would place GObject and GObjectClass like structs in public or Standard section depends if they have public entries (variables, vmethods).
cs: Můžete také seskupovat položky v oddílu pomocí značky &lt;SUBSECTION&gt;. V současnosti způsobí prázdný řádek mezi pododdíly v souhrnné části. Můžete také použít &lt;SUBSECTION Standard&gt; pro standardní deklarace GObject (například funkce jako je g_object_get_type, makra jako G_OBJECT(), G_IS_OBJECT() atd.). V současnosti jsou tyto v dokumentaci vynechané. Můžete také použít &lt;SUBSECTION Private&gt; pro privátní deklarace, které ve výsledku nebudou (jedná se o ruční způsob, jak zabránit varovným hlášením o nepoužitých deklaracích). Pokud vaše knihovna obsahuje privátní typy, u kterých nechcete, aby se objevily v hierarchii objektů a v seznamu implementovaných nebo vyžadovaných rozhraní, přidejte je do pododdílu Private. Jestli umístit struktury jako GObject a GObjectClass do veřejné nebo standardní části záleží na tom, jestli mají veřejné položky (proměnné, virtuální metody).

note: (itstool) path: sect1/para
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.
cs: Můžete také použít &lt;INCLUDE&gt; ... &lt;/INCLUDE&gt; k určení #include souborů, které jsou zobrazené v souhrnné části. Obsahuje čárkami oddělený seznam jednotlivých #include souborů, bez lomených závorek. Když je nastavíte mimo kterýkoliv oddíl, budou fungovat pro všechny oddíly až do konce souboru. Když je nastavíte v konkrétním oddílu, použijí se jen pro něj.

note: (itstool) path: chapter/title
en: Controlling the result
cs: Ovlivnění výsledku

note: (itstool) path: chapter/para
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.
cs: Spuštění GTK-Doc vygeneruje ve složkách pro dokumentaci soubory s výstupními sestavami. Generované soubory jsou nazvané: <filename>&lt;balíček&gt;-undocumented.txt</filename>, <filename>&lt;balíček&gt;-undeclared.txt</filename> a <filename>&lt;balíček&gt;-unused.txt</filename>. Všechno to jsou prosté textové soubory, které si lze jednoduše prohlížet a zpracovávat je.

note: (itstool) path: chapter/para
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.
cs: Soubor <filename>&lt;balíček&gt;-undocumented.txt</filename> začíná souhrnnými údaji o dokumentaci. Následují dva oddíly oddělené prázdnými řádky. První oddíl je seznam nezdokumentovaných nebo neúplných symbolů. Druhý oddíl je to stejné, ale pro dokumentace oddílů. Neúplné položky jsou takové, které mají dokumentaci, ale u kterých byl například přidán nový parametr.

note: (itstool) path: chapter/para
en: The <filename>&lt;package&gt;-undeclared.txt</filename> file lists symbols given in the <filename>&lt;package&gt;-sections.txt</filename> but not found in the sources. Check if they have been removed or if they are misspelled.
cs: Soubor <filename>&lt;balíček&gt;-undeclared.txt</filename> uvádí symboly, které jsou zadané v <filename>&lt;balíček&gt;-section.txt</filename>, ale nebyly nalezené ve zdrojových kódech. Ověřte, jestli nebyly odstraněny, nebo v nich není překlep.

note: (itstool) path: chapter/para
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;-sections.txt</filename> file.
cs: Soubor  <filename>&lt;balíček&gt;-unused.txt</filename> uvádí názvy symbolů, které GTK-Doc při procházení dokumentace nalezl, ale neví, kam je zařadit. To znamená, že tyto symboly nejsou zatím zařazené v souboru <filename>&lt;balíček&gt;-section.txt</filename>.

note: (itstool) path: tip/para
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 <command>make check</command> run.
cs: Povolte nebo přidejte řádek <option>TESTS=($GTKDOC_CHECK)</option> v Makefile.am. Pokud máte nainstalované GTK-Doc ve verzi minimálně 1.9, bude se díky tomu při spuštění <command>make check</command> provádět kontrola správnosti údajů.

note: (itstool) path: chapter/para
en: One can also look at the files produced by the source code scanner: <filename>&lt;package&gt;-decl-list.txt</filename> and <filename>&lt;package&gt;-decl.txt</filename>. The first one can be compared with the section file if that is manually maintained. The second lists all declarations from the headers. If a symbol is missing one could check if this file contains it.
cs: Můžete se také podívat do souborů vytvořených skenerem zdrojového kódu: <filename>&lt;package&gt;-decl-list.txt</filename> a <filename>&lt;package&gt;-decl.txt</filename>. První můžete porovnat se souborem s oddíly, pokud je ručně spravován. Ve druhém jsou uvedené všechny deklarace z hlavičkových souborů. Pokud v dokumentaci schází některý symbol, můžete zkontrolovat, jestli se vyskytuje v tomto souboru.

note: (itstool) path: chapter/para
en: If the project is GObject based, one can also look into the files produced by the object scanner: <filename>&lt;package&gt;.args.txt</filename>, <filename>&lt;package&gt;.hierarchy.txt</filename>, <filename>&lt;package&gt;.interfaces.txt</filename>, <filename>&lt;package&gt;.prerequisites.txt</filename> and <filename>&lt;package&gt;.signals.txt</filename>. If there are missing symbols in any of those, one can ask GTK-Doc to keep the intermediate scanner file for further analysis, by running it as <command>GTK_DOC_KEEP_INTERMEDIATE=1 make</command>.
cs: Pokud je základem projektu GObject, můžete se také podívat do souborů vytvořených skenerem objektů: <filename>&lt;package&gt;.args.txt</filename>, <filename>&lt;package&gt;.hierarchy.txt</filename>, <filename>&lt;package&gt;.interfaces.txt</filename>, <filename>&lt;package&gt;.prerequisites.txt</filename> a <filename>&lt;package&gt;.signals.txt</filename>. Jestliže v kterémkoliv z nich jsou chybějící symboly, můžete spuštěním <command>GTK_DOC_KEEP_INTERMEDIATE=1 make</command> požádat GTK-Doc, aby přechodně zachovat soubor pro pozdější analýzu.

note: (itstool) path: chapter/title
en: Modernizing the documentation
cs: Modernizace dokumentu

note: (itstool) path: chapter/para
en: GTK-Doc has been around for quite some time. In this section we list new features together with the version since when it is available.
cs: GTK-Doc existuje již nějakou dobu. V této části je uveden seznam nových funkcí spolu s číslem verze, od které je tato funkčnost k dispozici.

note: (itstool) path: sect1/para
en: When using xml instead of sgml, one can actually name the master document <filename>&lt;package&gt;-docs.xml</filename>.
cs: Když používáte XML namísto SGML, můžete ve skutečnosti pojmenovat hlavní dokument <filename>&lt;package&gt;-docs.xml</filename>.

note: (itstool) path: sect1/para
en: This version supports <option>SCAN_OPTIONS=--rebuild-sections</option> in <filename>Makefile.am</filename>. When this is enabled, the <filename>&lt;package&gt;-sections.txt</filename> is autogenerated and can be removed from the vcs. This only works nicely for projects that have a very regular structure (e.g. each .{c,h} pair will create new section). If one organize a project close to that updating a manually maintained section file can be as simple as running <code>meld &lt;package&gt;-decl-list.txt &lt;package&gt;-sections.txt</code>.
cs: Tato verze podporuje <option>SCAN_OPTIONS=--rebuild-sections</option> v <filename>Makefile.am</filename>. Když je tato volba zapnutá, je <filename>&lt;package&gt;-sections.txt</filename> generován automaticky a můžete jej odstranit ze správy verzí. To funguje hezky je u projektů, které mají pravidelnou strukturu (například jednotlivé páry souboru .c a .h vytvoří nový oddíl). Pokud máte projekt takto pečlivě organizovaný, vystačí si aktualizace ručně spravovaného souboru s oddíly s prostým spuštěním <code>meld &lt;package&gt;-decl-list.txt &lt;package&gt;-sections.txt</code>.

note: (itstool) path: sect1/para
en: Version 1.8 already introduced the syntax for documenting sections in the sources instead of the separate files under <filename class="directory">tmpl</filename>. This version adds options to switch the whole doc module to not use the extra tmpl build step at all, by using <option>--flavour no-tmpl</option> in <filename>configure.ac</filename>. If you don't have a <filename class="directory">tmpl</filename> checked into your source control system and haven't yet switched, just add the flag to <filename>configure.ac</filename> and you are done.
cs: Již verze 1.18 zavedla syntax pro dokumentování oddílů ve zdrojovém kódu namísto zvláštních souborů ve složce <filename class="directory">tmpl</filename>. Tato verze přidává pomocí <option>--flavour no-tmpl</option> in <filename>configure.ac</filename> volbu pro přepnutí celého modulu dokumentace, aby nepoužíval speciální složku tmp během sestavení. Jestliže nepotřebujete udržovat <filename class="directory">tmpl</filename> v systému pro správu verzí ještě jste zatím přepnutí neprovedli, stačí přidat tuto volbu do <filename>configure.ac</filename> a je to.

note: (itstool) path: sect1/para
en: This version supports <option>SCAN_OPTIONS=--rebuild-types</option> in <filename>Makefile.am</filename>. When this is enabled, the <filename>&lt;package&gt;.types</filename> is autogenerated and can be removed from the vcs. When using this feature it is important to also setup the <varname>IGNORE_HFILES</varname> in <filename>Makefile.am</filename> for code that is build conditionally.
cs: Tato verze podporuje <option>SCAN_OPTIONS=--rebuild-types</option> v <filename>Makefile.am</filename>. Když je tato volba zapnutá, je <filename>&lt;package&gt;.types</filename> generován automaticky a můžete jej odstranit ze správy verzí. Jestliže tuto funkci využíváte, je důležité nastavit také <varname>IGNORE_HFILES</varname> v <filename>Makefile.am</filename> pro kód, který je sestavován podmíněně.

note: (itstool) path: example/title
en: Enable gtkdoc-check
cs: Povolení gtkdoc-check

note: (itstool) path: sect1/para
en: This version includes a new tool called gtkdoc-check. This tool can run a set of sanity checks on your documentation. It is enabled by adding these lines to the end of <filename>Makefile.am</filename>. <_:example-1/>
cs: Součástí této verze je nový nástroj s názvem gtkdoc-check. Jeho spuštěním se provede kontrola správnosti vašeho dokumentu. Povolit jej můžete přidáním těchto řádků na konec souboru <filename>Makefile.am</filename>. <_:example-1/>

note: (itstool) path: sect1/para
en: Version 1.18 brought some initial markdown support. Using markdown in doc comments is less intrusive than writing docbook xml. This version improves a lot on this and add a lot more styles. The section that explains the <link linkend="documenting_syntax">comment syntax</link> has all the details.
cs: Verze 1.18 přinesla počáteční podporu pro Markdown. Jeho použití v dokumentačních komentářích je méně rušivé, než zápis XML z DocBook. Tato verze jeho podporu značně vylepšuje a přidává mnohem více stylů. Více podrobností je uvedeno v oddílu, který vysvětluje <link linkend="documenting_syntax">syntax komentářů</link>.

note: (itstool) path: example/title
en: Use pre-generated entities
cs: Používání předgenerovaných entit

note: (itstool) path: example/programlisting
en: 
    &lt;?xml version="1.0"?&gt;
    &lt;!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN"
                   "http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd"
    [
      &lt;!ENTITY % local.common.attrib "xmlns:xi  CDATA  #FIXED 'http://www.w3.org/2003/XInclude'"&gt;
      &lt;!ENTITY % gtkdocentities SYSTEM "xml/gtkdocentities.ent"&gt;
      %gtkdocentities;
    ]&gt;
    &lt;book id="index" xmlns:xi="http://www.w3.org/2003/XInclude"&gt;
      &lt;bookinfo&gt;
        &lt;title&gt;&amp;package_name; Reference Manual&lt;/title&gt;
        &lt;releaseinfo&gt;
          for &amp;package_string;.
          The latest version of this documentation can be found on-line at
          &lt;ulink role="online-location" url="http://[SERVER]/&amp;package_name;/index.html"&gt;http://[SERVER]/&amp;package_name;/&lt;/ulink&gt;.
        &lt;/releaseinfo&gt;
      &lt;/bookinfo&gt;
cs: 
    &lt;?xml version="1.0"?&gt;
    &lt;!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN"
                   "http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd"
    [
      &lt;!ENTITY % local.common.attrib "xmlns:xi  CDATA  #FIXED 'http://www.w3.org/2003/XInclude'"&gt;
      &lt;!ENTITY % gtkdocentities SYSTEM "xml/gtkdocentities.ent"&gt;
      %gtkdocentities;
    ]&gt;
    &lt;book id="index" xmlns:xi="http://www.w3.org/2003/XInclude"&gt;
      &lt;bookinfo&gt;
        &lt;title&gt;&amp;Referenční příručka k package_name;&lt;/title&gt;
        &lt;releaseinfo&gt;
          for &amp;package_string;.
          Nejnovější verzi této dokumentace můžete najít on-line na
          &lt;ulink role="online-location" url="http://[SERVER]/&amp;package_name;/index.html"&gt;http://[SERVER]/&amp;package_name;/&lt;/ulink&gt;.
        &lt;/releaseinfo&gt;
      &lt;/bookinfo&gt;

note: (itstool) path: sect1/para
en: The makefiles shipped with this version generate an entity file at <filename>xml/gtkdocentities.ent</filename>, containing entities for e.g. package_name and package_version. You can use this e.g. in the main xml file to avoid hardcoding the version number. Below is an example that shows how the entity file is included and how the entities are used. The entities can also be used in all generated files, GTK-Doc will use the same xml header in generated xml files. <_:example-1/>
cs: Soubory Makefile dodávané s touto verzí generují do <filename>xml/gtkdocentities.ent</filename> soubor s entitami, který obsahuje entity například pro package_name a package_version. Můžete je použít třeba v hlavním souboru XML, abyste nemuseli mít číslo verze zapsané natvrdo. Níže je uveden příklad, jak soubor s entitami vložit a jak entity použít. Použít je lze také ve všech generovaných souborech, GTK-Doc bude používat tu samou hlavičku XML v generovaných souborech XML. <_:example-1/>

note: (itstool) path: chapter/title
en: Documenting other interfaces
cs: Dokumentování ostatních rozhraní

note: (itstool) path: chapter/para
en: 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.
cs: Doposud jsme pomocí GTK-Doc dokumentovali API kódu. Následující oddíl obsahuje doporučení, jak se dají nástroje použít také k dokumentování dalších rozhraní.

note: (itstool) path: sect1/title
en: Command line options and man pages
cs: Přepínače příkazového řádku a manuálové stránky

note: (itstool) path: sect1/para
en: 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.
cs: Protože je stejně možné generovat manuálové stránky pro referenční položky DocBook, zní jako dobrý nápad použít to pro tento účel. Tímto způsobem se rozhraní stane součástí referenční příručky a získáte tak bez námahy manuálovou stránku.

note: (itstool) path: sect2/title
en: Document the tool
cs: Dokumentování nástrojů

note: (itstool) path: sect2/para
en: Create one refentry file per tool. Following <link linkend="settingup_docfiles">our example</link> we would call it <filename>meep/docs/reference/meeper/meep.xml</filename>. 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.
cs: Vytvořte jeden soubor s referenční příručkou pro každý z nástrojů. V <link linkend="settingup_docfiles">našem příkladu</link> by se měl nazývat <filename>meep/docs/reference/meeper/meep.xml</filename>. Na značky XML, který by se měly použít, se podívejte do nějakého ukázkového vygenerovaného souboru v podsložce XML, například v glib.

note: (itstool) path: sect2/title
en: Adding the extra configure check
cs: Přidání doplňkových kontrol do configure

note: (itstool) path: example/title
en: Extra configure checks
cs: Dodatečné kontroly nastavení

note: (itstool) path: sect2/title
en: Adding the extra makefile rules
cs: Přidání doplňkových pravidel do Makefile

note: (itstool) path: sect1/title
en: DBus interfaces
cs: Rozhraní D-Bus

note: (itstool) path: sect1/para
en: (FIXME: http://hal.freedesktop.org/docs/DeviceKit/DeviceKit.html, http://cgit.freedesktop.org/DeviceKit/DeviceKit/tree/doc/dbus)
cs: (OPRAVIT: http://hal.freedesktop.org/docs/DeviceKit/DeviceKit.html, http://cgit.freedesktop.org/DeviceKit/DeviceKit/tree/doc/dbus)

note: (itstool) path: chapter/title
en: Frequently asked questions
cs: Často kladené dotazy

note: (itstool) path: segmentedlist/segtitle
en: Question
cs: Dotaz

note: (itstool) path: segmentedlist/segtitle
en: Answer
cs: Odpověď

note: (itstool) path: seglistitem/seg
en: No class hierarchy.
cs: Schází hierarchie třídy.

note: (itstool) path: seglistitem/seg
en: The objects <function>xxx_get_type()</function> function has not been entered into the <filename>&lt;package&gt;.types</filename> file.
cs: Do souboru <filename>&lt;balíček&gt;.types</filename> nebyla vložena funkce objektu <function>xxx_get_type()</function>.

note: (itstool) path: seglistitem/seg
en: Still no class hierarchy.
cs: Stále schází hierarchie třídy.

note: (itstool) path: seglistitem/seg
en: Missing or wrong naming in <filename>&lt;package&gt;-sections.txt</filename> file (see <ulink url="http://mail.gnome.org/archives/gtk-doc-list/2003-October/msg00006.html">explanation</ulink>).
cs: Chybějící nebo nesprávné pojmenování souboru <filename>&lt;balíček&gt;-sections.txt</filename> (viz <ulink url="http://mail.gnome.org/archives/gtk-doc-list/2003-October/msg00006.html">vysvětlení</ulink>).

note: (itstool) path: seglistitem/seg
en: Damn, I have still no class hierarchy.
cs: Do háje, pořád nemám hierarchii třídy.

note: (itstool) path: seglistitem/seg
en: Is the object name (name of the instance struct, e.g. <type>GtkWidget</type>) part of the normal section (don't put this into Standard or Private subsections).
cs: Je název objektu (název struktury instance, například <type>GtkWidget</type>) součástí normálního oddílu? (Nedávejte je do pododdílu Standard nebo Private).

note: (itstool) path: seglistitem/seg
en: No symbol index.
cs: Chybí rejstřík symbolů.

note: (itstool) path: seglistitem/seg
en: Does the <filename>&lt;package&gt;-docs.{xml,sgml}</filename> contain a index that xi:includes the generated index?
cs: Obsahuje <filename>&lt;package&gt;-docs.{xml,sgml}</filename> rejstřík, který vloží pomocí xi:include vygenerovaný rejstřík?

note: (itstool) path: seglistitem/seg
en: Symbols are not linked to their doc-section.
cs: Symbol nemá odkaz do svého oddílu dokumentace.

note: (itstool) path: seglistitem/seg
en: Is the doc-comment using the correct markup (added #,% or ())? Check if the gtkdoc-fixxref warns about unresolvable xrefs.
cs: Používá dokumentační komentář správnou značku (přidané znaky #,% nebo ())? Podívejte se na varování gtkdoc-fixxref o nevyřešených křížových odkazech.

note: (itstool) path: seglistitem/seg
en: A new class does not appear in the docs.
cs: Nová třída se neobjevila v dokumentaci.

note: (itstool) path: seglistitem/seg
en: Is the new page xi:included from <filename>&lt;package&gt;-docs.{xml,sgml}</filename>.
cs: Je nový balíček vložený pomocí xi:include z <filename>&lt;package&gt;-docs.{xml,sgml}</filename>.

note: (itstool) path: seglistitem/seg
en: A new symbol does not appear in the docs.
cs: Nový symbol se neobjevil v dokumentaci.

note: (itstool) path: seglistitem/seg
en: 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 <filename>&lt;package&gt;-sections.txt</filename> in a public subsection.
cs: Je dokumentační komentář správně naformátovaný? Zkontrolujte překlepy na začátku komentáře. Podívejte se po varováních gtkdoc-fixxref o nevyřešených křížových odkazech. Zkontrolujte, jestli je symbol správně uvedený v <filename>&lt;package&gt;-sections.txt</filename> ve veřejném pododdíle.

note: (itstool) path: seglistitem/seg
en: A type is missing from the class hierarchy.
cs: V hierarchii třídy schází typ.

note: (itstool) path: seglistitem/seg
en: If the type is listed in <filename>&lt;package&gt;.hierarchy</filename> but not in <filename>xml/tree_index.sgml</filename> then double check that the type is correctly placed in the <filename>&lt;package&gt;-sections.txt</filename>. If the type instance (e.g. <type>GtkWidget</type>) is not listed or incidentally marked private it will not be shown.
cs: Jestliže je typ uvedený v <filename>&lt;package&gt;.hierarchy</filename>, ale není v <filename>xml/tree_index.sgml</filename>, tak raději dvakrát zkontrolujte, jestli je typ správně uvedený v <filename>&lt;package&gt;-sections.txt</filename>. Jestliže instance typu (například <type>GtkWidget</type>) není uvedená, nebo je nedopatřením označení jako privátní, nebude zobrazena.

note: (itstool) path: seglistitem/seg
en: I get foldoc links for all gobject annotations.
cs: Vytvořily se mi odkazy na složku s dokumentací pro všechny anotace k GObject

note: (itstool) path: seglistitem/seg
en: Check that <filename>xml/annotation-glossary.xml</filename> is xi:included from <filename>&lt;package&gt;-docs.{xml,sgml}</filename>.
cs: Zkontrolujte, že <filename>xml/annotation-glossary.xml</filename> je vložené pomocí xi:include z <filename>&lt;package&gt;-docs.{xml,sgml}</filename>.

note: (itstool) path: seglistitem/seg
en: Parameter described in source code comment block but does not exist
cs: Parametr je v komentářovém bloku zdrojového kódu popsaný, ale neexistuje.

note: (itstool) path: seglistitem/seg
en: Check if the prototype in the header has different parameter names as in the source.
cs: Zkontrolujte, za nemá prototyp v hlavičkovém souboru jiné názvy parametrů, než ve zdrojovém kódu.

note: (itstool) path: seglistitem/seg
en: multiple "IDs" for constraint linkend: XYZ
cs: Více „ID“ pro tentýž cíl odkazu: XYZ

note: (itstool) path: seglistitem/seg
en: Symbol XYZ appears twice in <filename>&lt;package&gt;-sections.txt</filename> file.
cs: Symbol XYZ se v souboru <filename>&lt;package&gt;-sections.txt</filename> objevuje dvakrát.

note: (itstool) path: seglistitem/seg
en: Element typename in namespace '' encountered in para, but no template matches.
cs: Element typename ve jmenném prostoru '' je uvedený v rodiči, ale neodpovídá mu žádná šablona.

note: (itstool) path: chapter/title
en: Tools related to gtk-doc
cs: Nástroje související s GTK-Doc

note: (itstool) path: chapter/para
en: GtkDocPlugin - a <ulink url="http://trac-hacks.org/wiki/GtkDocPlugin">Trac GTK-Doc</ulink> integration plugin, that adds API docs to a trac site and integrates with the trac search.
cs: GtkDocPlugin – zásuvný modul pro integraci <ulink url="http://trac-hacks.org/wiki/GtkDocPlugin">GTK-Doc do systému Track</ulink>, který přidává dokumentaci k API na sledovací web a integruje ji do vyhledávání.

note: (itstool) path: chapter/para
en: Gtkdoc-depscan - a tool (part of gtk-doc) to check used API against since tags in the API to determine the minimum required version.
cs: Gtkdoc-depscan – nástroj (součást GTK-Doc), který kontroluje použité API vůči štítku since v API, aby určil minimální požadovanou verzi.

note: (itstool) path: appendixinfo/releaseinfo
en: Version 1.1, March 2000
cs: Verze 1.1, březen 2000

note: (itstool) path: legalnotice/para
en: <_:address-1/> Everyone is permitted to copy and distribute verbatim copies of this license document, but changing it is not allowed.
cs: <_:address-1/> Kdokoliv je oprávněn kopírovat a šířit doslovné kopie tohoto dokumentu s licencí, ale nesmí v něm provádět žádné změny.
