# Chinese (Taiwan) translation for gtk-doc. # Copyright (C) 2025 gtk-doc's COPYRIGHT HOLDER # This file is distributed under the same license as the gtk-doc package. # FIRST AUTHOR , YEAR. # msgid "" msgstr "" "Project-Id-Version: gtk-doc master\n" "POT-Creation-Date: 2025-05-10 19:36+0000\n" "PO-Revision-Date: 2025-05-10 19:36+0000\n" "Last-Translator: FULL NAME \n" "Language-Team: Chinese (Taiwan) \n" "MIME-Version: 1.0\n" "Content-Type: text/plain; charset=UTF-8\n" "Content-Transfer-Encoding: 8bit\n" "Language: zh_TW\n" #. Put one translator per line, in the form NAME , YEAR1, YEAR2 msgctxt "_" msgid "translator-credits" msgstr "" #. (itstool) path: bookinfo/title #: C/index.docbook:12 msgid "GTK-Doc Manual" msgstr "" #. (itstool) path: bookinfo/edition #: C/index.docbook:13 msgid "1.24.1" msgstr "" #. (itstool) path: abstract/para #: C/index.docbook:14 msgid "User manual for developers with instructions of GTK-Doc usage." msgstr "" #. (itstool) path: authorgroup/author #: C/index.docbook:16 msgid "" "Chris Lyttle " "
chris@wilddev.net
" msgstr "" #. (itstool) path: authorgroup/author #: C/index.docbook:25 msgid "" "Dan Mueth
" "d-mueth@uchicago.edu
" msgstr "" #. (itstool) path: authorgroup/author #: C/index.docbook:34 msgid "" "Stefan Sauer (Kost) " "
ensonic@users.sf.net
" msgstr "" #. (itstool) path: publisher/publishername #: C/index.docbook:45 msgid "GTK-Doc project" msgstr "" #. (itstool) path: bookinfo/publisher #: C/index.docbook:44 msgid "" "<_:publishername-1/>
gtk-doc-list@gnome.org
" msgstr "" #. (itstool) path: bookinfo/copyright #: C/index.docbook:48 msgid "2000, 2005 Dan Mueth and Chris Lyttle" msgstr "" #. (itstool) path: bookinfo/copyright #: C/index.docbook:52 msgid "2007-2019 Stefan Sauer (Kost)" msgstr "" #. (itstool) path: legalnotice/para #: C/index.docbook:65 msgid "" "Permission is granted to copy, distribute and/or modify this document under " "the terms of the GNU Free Documentation License, " "Version 1.1 or any later version published by the Free Software Foundation " "with no Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts. A " "copy of the license is included." msgstr "" #. (itstool) path: legalnotice/para #: C/index.docbook:73 msgid "" "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." msgstr "" #. (itstool) path: revhistory/revision #: C/index.docbook:83 msgid "" "1.33.0 1 Oct 2020 mc gtk4 version" msgstr "" #. (itstool) path: revhistory/revision #: C/index.docbook:89 msgid "" "1.32.1 15 Aug 2019 ss dev version" msgstr "" #. (itstool) path: revhistory/revision #: C/index.docbook:95 msgid "" "1.32 15 Aug 2019 ss hotfix release" msgstr "" #. (itstool) path: revhistory/revision #: C/index.docbook:101 msgid "" "1.31 05 Aug 2019 ss refactorings and more test coverage" msgstr "" #. (itstool) path: revhistory/revision #: C/index.docbook:107 msgid "" "1.30 08 May 2019 ss more test coverage" msgstr "" #. (itstool) path: revhistory/revision #: C/index.docbook:113 msgid "" "1.29 28 Aug 2018 ss bug fixes" msgstr "" #. (itstool) path: revhistory/revision #: C/index.docbook:119 msgid "" "1.28 24 Mar 2018 ss bug fixes" msgstr "" #. (itstool) path: revhistory/revision #: C/index.docbook:125 msgid "" "1.27 07 Dec 2017 ss fine tuning of the python port" msgstr "" #. (itstool) path: revhistory/revision #: C/index.docbook:131 msgid "" "1.26 11 Aug 2017 ss port all tools from perl/bash to python" msgstr "" #. (itstool) path: revhistory/revision #: C/index.docbook:137 msgid "" "1.25 21 March 2016 ss bug fixes, test cleanups" msgstr "" #. (itstool) path: revhistory/revision #: C/index.docbook:143 msgid "" "1.24 29 May 2015 ss bug fix" msgstr "" #. (itstool) path: revhistory/revision #: C/index.docbook:149 msgid "" "1.23 17 May 2015 ss bug fix" msgstr "" #. (itstool) path: revhistory/revision #: C/index.docbook:155 msgid "" "1.22 07 May 2015 ss bug fixes, dropping deprecated features" msgstr "" #. (itstool) path: revhistory/revision #: C/index.docbook:161 msgid "" "1.21 17 Jul 2014 ss bug fixes, dropping deprecated features" msgstr "" #. (itstool) path: revhistory/revision #: C/index.docbook:167 msgid "" "1.20 16 Feb 2014 ss bug fixes, markdown support, style improvements" msgstr "" #. (itstool) path: revhistory/revision #: C/index.docbook:173 msgid "" "1.19 05 Jun 2013 ss bug fixes" msgstr "" #. (itstool) path: revhistory/revision #: C/index.docbook:179 msgid "" "1.18 14 Sep 2011 ss bug fixes, speedups, markdown support" msgstr "" #. (itstool) path: revhistory/revision #: C/index.docbook:185 msgid "" "1.17 26 Feb 2011 sk urgent bug fix update" msgstr "" #. (itstool) path: revhistory/revision #: C/index.docbook:191 msgid "" "1.16 14 Jan 2011 sk bugfixes, layout improvements" msgstr "" #. (itstool) path: revhistory/revision #: C/index.docbook:197 msgid "" "1.15 21 May 2010 sk bug and regression fixes" msgstr "" #. (itstool) path: revhistory/revision #: C/index.docbook:203 msgid "" "1.14 28 March 2010 sk bugfixes and performance improvements" msgstr "" #. (itstool) path: revhistory/revision #: C/index.docbook:209 msgid "" "1.13 18 December 2009 " "sk broken tarball update" msgstr "" #. (itstool) path: revhistory/revision #: C/index.docbook:215 msgid "" "1.12 18 December 2009 " "sk new tool features and " "bugfixes" msgstr "" #. (itstool) path: revhistory/revision #: C/index.docbook:221 msgid "" "1.11 16 November 2008 " "mal GNOME doc-utils migration" msgstr "" #. (itstool) path: chapter/title #: C/index.docbook:234 msgid "Introduction" msgstr "" #. (itstool) path: chapter/para #: C/index.docbook:236 msgid "" "This chapter introduces GTK-Doc and gives an overview of what it is and how " "it is used." msgstr "" #. (itstool) path: sect1/title #: C/index.docbook:242 msgid "What is GTK-Doc?" msgstr "" #. (itstool) path: sect1/para #: C/index.docbook:244 msgid "" "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." msgstr "" #. (itstool) path: sect1/title #: C/index.docbook:252 msgid "How Does GTK-Doc Work?" msgstr "" #. (itstool) path: sect1/para #: C/index.docbook:254 msgid "" "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)." msgstr "" #. (itstool) path: sect1/para #: C/index.docbook:261 msgid "" "GTK-Doc consists of a number of python scripts, each performing a different " "step in the process." msgstr "" #. (itstool) path: sect1/para #: C/index.docbook:266 msgid "There are 5 main steps in the process:" msgstr "" #. (itstool) path: listitem/para #: C/index.docbook:273 msgid "" "Writing the documentation. The author fills in the " "source files with the documentation for each function, macro, structs or " "unions, etc." msgstr "" #. (itstool) path: listitem/para #: C/index.docbook:282 msgid "" "Gathering information about the code. " "gtkdoc-scan scans the header files of the code " "looking for declarations of functions, macros, enums, structs, and unions. " "It creates the file <module>-decl-list.txt " "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 " "<module>-sections.txt. The author can rearrange " "the sections, and the order of the declarations within them, to produce the " "final desired order. The second file it generates is " "<module>-decl.txt. This file contains the full " "declarations found by the scanner. If for some reason one would like some " "symbols to show up in the docs, where the full declaration cannot be found " "by the scanner or the declaration should appear differently, one can place " "entities similar to the ones in <module>-decl.txt " "into <module>-overrides.txt." msgstr "" #. (itstool) path: listitem/para #: C/index.docbook:299 msgid "" "gtkdoc-scangobj 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." msgstr "" #. (itstool) path: listitem/para #: C/index.docbook:305 msgid "" "gtkdoc-scanobj should not be used anymore. It was " "needed in the past when GObject was still GtkObject inside gtk+." msgstr "" #. (itstool) path: listitem/para #: C/index.docbook:312 msgid "" "Generating the XML and HTML/PDF. gtkdoc-" "mkdb turns the template files into XML files in the xml/ subdirectory. If the source code " "contains documentation on functions, using the special comment blocks, it " "gets merged in here. If there are no tmpl files used it only reads docs from " "sources and introspection data." msgstr "" #. (itstool) path: listitem/para #: C/index.docbook:321 msgid "" "gtkdoc-mkhtml turns the XML files into HTML files " "in the html/ subdirectory. Likewise " "gtkdoc-mkpdf turns the XML files into a PDF " "document called <package>.pdf." msgstr "" #. (itstool) path: listitem/para #: C/index.docbook:327 msgid "" "Files in xml/ and html/ directories are always overwritten. One " "should never edit them directly." msgstr "" #. (itstool) path: listitem/para #: C/index.docbook:335 msgid "" "Fixing up cross-references between documents. After " "installing the HTML files, gtkdoc-fixxref can be " "run to fix up any cross-references between separate documents. For example, " "the GTK+ documentation contains many cross-references to types documented in " "the GLib manual. When creating the source tarball for distribution, " "gtkdoc-rebase turns all external links into web-" "links. When installing distributed (pregenerated) docs the same application " "will try to turn links back to local links (where those docs are installed)." msgstr "" #. (itstool) path: sect1/title #: C/index.docbook:353 msgid "Getting GTK-Doc" msgstr "" #. (itstool) path: sect2/title #: C/index.docbook:356 msgid "Requirements" msgstr "" #. (itstool) path: sect2/para #: C/index.docbook:357 msgid "" "python 2/3 - the main scripts are written in python." msgstr "" #. (itstool) path: sect2/para #: C/index.docbook:360 msgid "" "xsltproc - the xslt processor from libxslt xmlsoft.org/XSLT/" msgstr "" #. (itstool) path: sect2/para #: C/index.docbook:364 msgid "" "docbook-xsl - the docbook xsl stylesheets sourceforge.net/projects/docbook/files/docbook-xsl" msgstr "" #. (itstool) path: sect2/para #: C/index.docbook:368 msgid "" "One of source-highlight, highlight " "or vim - optional - used for syntax highlighting of " "examples" msgstr "" #. (itstool) path: sect1/title #: C/index.docbook:376 msgid "About GTK-Doc" msgstr "" #. (itstool) path: sect1/para #: C/index.docbook:378 msgid "" "Historically GTK-Doc was used to generate template files from the sources " "code. These template files could be used by developers to enter the API " "documentation. This approach was rather inconvenient because it required to " "keep the generated files under version control. Since GTK-Doc 1.9 it became " "possible to place all API information into source comments, which made the " "template support obsolete. In version 1.26 template support has been removed." msgstr "" #. (itstool) path: sect1/para #: C/index.docbook:388 C/index.docbook:402 msgid "(FIXME)" msgstr "" #. (itstool) path: sect1/para #: C/index.docbook:392 msgid "" "(authors, web pages, mailing list, license, future plans, comparison with " "other similar systems.)" msgstr "" #. (itstool) path: sect1/title #: C/index.docbook:400 msgid "About this Manual" msgstr "" #. (itstool) path: sect1/para #: C/index.docbook:406 msgid "(who it is meant for, where you can get it, license)" msgstr "" #. (itstool) path: chapter/title #: C/index.docbook:415 msgid "Project Setup" msgstr "" #. (itstool) path: chapter/para #: C/index.docbook:417 msgid "" "This Chapter describes the steps that are necessary to integrate GTK-Doc " "into your project. The integration of GTK-Doc into a project includes the " "following steps:" msgstr "" #. (itstool) path: listitem/para #: C/index.docbook:425 msgid "" "Preparation of the directory structure and creating required configuration " "files for your GTK-Doc documentation (see Setting up a skeleton documentation)." msgstr "" #. (itstool) path: listitem/para #: C/index.docbook:433 msgid "" "Adjusting the build system to build your documentation using the GTK-Doc " "tools. Multiple build systems are supported, in this manual we describe how " "to integrate GTK-Doc with Autotools, CMake, and plain Makefiles." msgstr "" #. (itstool) path: listitem/para #: C/index.docbook:443 msgid "" "Adding GTK-Doc specific files to version control and deciding which files to " "ignore (see Integration with version " "control systems)." msgstr "" #. (itstool) path: chapter/para #: C/index.docbook:451 msgid "" "The following sections assume we work on a project called meep. " "This project contains two packages (or modules), a library called " "libmeep and an end-user app called meeper." msgstr "" #. (itstool) path: sect1/title #: C/index.docbook:460 msgid "Setting up a skeleton documentation" msgstr "" #. (itstool) path: sect1/para #: C/index.docbook:462 msgid "" "A common convention is to place documentation into a folder called " "docs inside your top-level project directory. We usually " "distinguish between reference documentation intended " "for developers and an user manual intended for end-" "users. Again the convention is to have separate folders for both. We usually " "place the reference documentation in a folder named reference " "and the end-user manual in a folder named help as. According to " "the above convention the documentation for our libmeep package " "would be placed into: docs/reference/libmeep. For packages with " "just one library or application the documentation could also be placed " "directly into docs/reference. It is not mandatory to use the " "above convention, but if you choose to use a different directory structure " "you must adjust your build system configuration to match your directory " "structure." msgstr "" #. (itstool) path: example/title #: C/index.docbook:493 msgid "Example directory structure of meep project" msgstr "" #. (itstool) path: example/programlisting #: C/index.docbook:495 #, no-wrap msgid "" "\n" "meep/\n" " docs/\n" " reference/ # reference documentation\n" " libmeep/\n" " meeper/\n" " help/ # optional: user manual\n" " meeper/\n" " src/\n" " libmeep/\n" " meeper/\n" msgstr "" #. (itstool) path: sect1/para #: C/index.docbook:487 msgid "" "In the following sections we will assume a directory structure for our " "meep project that uses the above conventions. " "<_:example-1/>" msgstr "" #. (itstool) path: sect1/title #: C/index.docbook:512 msgid "Integration with Autotools" msgstr "" #. (itstool) path: sect1/para #: C/index.docbook:513 msgid "" "Integration of GTK-Doc into an autotools-based build system requires the " "following steps:" msgstr "" #. (itstool) path: listitem/para #: C/index.docbook:519 msgid "" "Ensure that gtkdocize is run once before the " "configure script. If an autogen.sh " "script is present, adjust it to check for GTK-Doc and add a call to " "gtkdocize." msgstr "" #. (itstool) path: listitem/para #: C/index.docbook:527 msgid "" "The main purpose of gtkdocize is to make the " "gtk-doc.make Makefile and the gtk-doc.m4 macro definition file available to the build system, either by " "copying or linking it into the project." msgstr "" #. (itstool) path: listitem/para #: C/index.docbook:536 msgid "" "Add the necessary autoconf macros to " "configure.ac to enable GTK-Doc in your build system to " "allow configuration of GTK-Doc via the generated configure script." msgstr "" #. (itstool) path: listitem/para #: C/index.docbook:542 msgid "" "Among others with registers the --enable-gtk-doc option with " "the configure script." msgstr "" #. (itstool) path: listitem/para #: C/index.docbook:548 msgid "" "Create an automake script for each application or " "library in your project. In the example used in this documentation this step " "applies to both meeper and libmeep." msgstr "" #. (itstool) path: sect1/para #: C/index.docbook:557 msgid "" "In the following sections, we will perform the above steps in reverse order. " "We start with the automake scripts and work our " "way up to configure.ac and autogen.sh. Then we show how enable Gtk-Doc in the build system and how to " "build the documentation." msgstr "" #. (itstool) path: sect2/title #: C/index.docbook:567 msgid "Integration with automake" msgstr "" #. (itstool) path: sect2/para #: C/index.docbook:569 msgid "" "First copy the Makefile.am from the examples sub-directory of the gtkdoc-sources to your project's reference " "documentation directory (e.g. docs/reference/" "<package>). A local copy should be available under e.g. " "/usr/share/doc/gtk-doc-tools/examples/Makefile.am. If " "you have multiple packages repeat this for each one." msgstr "" #. (itstool) path: note/simpara #: C/index.docbook:582 msgid "" "Do not forget to add each Makefile.am to the " "AC_CONFIG_FILES macro in configure.ac. For docs/reference/libmeep/Makefile.am you " "will need to add the entry docs/reference/libmeep/Makefile to AC_CONFIG_FILES." msgstr "" #. (itstool) path: example/title #: C/index.docbook:594 msgid "Example directory structure with Makefiles.am" msgstr "" #. (itstool) path: example/programlisting #: C/index.docbook:597 #, no-wrap msgid "" "\n" "meep/\n" " docs/\n" " reference/ # reference documentation\n" " libmeep/\n" " Makefile.am\n" " meeper/\n" " Makefile.am\n" " help/ # optional: user manual\n" " meeper/\n" " src/\n" " libmeep/\n" " meeper/\n" msgstr "" #. (itstool) path: sect2/para #: C/index.docbook:613 msgid "" "Next, you need to customize the copied Makefiles and provide values for the " "various parameters in each Makefile.am. All settings " "have a comment above them that describes their purpose and how to customize " "the setting. Most settings are used to supply extra flags to the respective " "tools to which they apply. Every tool has a variable of the form " " (e.g. the tool gtkdoc-" "mkhtml has an option named MKHTML_OPTIONS). All " "the tools support to list the supported options." msgstr "" #. (itstool) path: listitem/para #: C/index.docbook:637 msgid "" " is used to provide the name of the package that " "is being documentated (e.g. meeper, or libmeep)." msgstr "" #. (itstool) path: listitem/para #: C/index.docbook:644 msgid "" " is used to specify the location of source " "directory which GTK-Doc searches for your API documentation. This will " "usually be DOC_SOURCE_DIR=$(top_srcdir)/src or a sub-" "directory of that directory." msgstr "" #. (itstool) path: listitem/para #: C/index.docbook:657 msgid "" " and are used for " "dependencies. Each option take a file-glob (e.g. HFILE_GLOB=$" "(top_srcdir)/src/*.c). The documentation will be rebuilt if any of " "the matched files change." msgstr "" #. (itstool) path: listitem/para #: C/index.docbook:669 msgid "" " allows to specify extra header files to " "include when scanning for API documentation, which are not found under " "DOC_SOURCE_DIR (e.g. EXTRA_HFILES=$(top_srcdir}/contrib/" "extra.h)." msgstr "" #. (itstool) path: listitem/para #: C/index.docbook:679 msgid "" " allows to specify header files or directories " "to ignore when scanning for API documentation. Use the basename of the file " "or directory (e.g. IGNORE_HFILES=gtkdebug.h gtkintl.h " "private_code_folder)." msgstr "" #. (itstool) path: listitem/para #: C/index.docbook:689 msgid "" " allows to specify images files which will be " "copied into the html/ directory of the generated " "documentation. If your API documentation includes any images they need to be " "added to this option (e.g. HTML_IMAGES=$(top_srcdir)/gtk/stock-icons/" "stock_about_24.png)." msgstr "" #. (itstool) path: listitem/para #: C/index.docbook:702 msgid "" " allows to specify extra files that are " "included by $(DOC_MAIN_SGML_FILE) (e.g. " "content_files=running.xml building.xml changes-2.0.xml)." msgstr "" #. (itstool) path: listitem/para #: C/index.docbook:713 msgid "" " allows to specify files where " "gtk-doc abbreviations such as #GtkWidget " "are expanded (e.g. expand_content_files=running.xml)." msgstr "" #. (itstool) path: sect2/para #: C/index.docbook:631 msgid "" "The following list explains the most relevant options. Check the example " "Makefile.am for additional options. <_:itemizedlist-1/>" msgstr "" #. (itstool) path: sect2/title #: C/index.docbook:728 msgid "Integration with autoconf" msgstr "" #. (itstool) path: sect2/para #: C/index.docbook:730 msgid "" "Integration with autoconf is very simple and " "includes one required step and an additional optional (but recommended) " "step. The first step is to add the GTK_DOC_CHECK macro " "to your configure.ac script. This registers several " "configure options to enable GTK-Doc and allows you to set default arguments " "for gtkdocize." msgstr "" #. (itstool) path: warning/simpara #: C/index.docbook:742 msgid "" "Make sure that the GTK_DOC_CHECK macro is not indented. The " "macro must start at the beginning of the line and should not start with " "whitespace." msgstr "" #. (itstool) path: sect2/para #: C/index.docbook:749 msgid "" "The second step is to add the AC_CONFIG_MACRO_DIR(m4) to your " "configure.ac. This is not required but helps " "gtkdocize to automatically copy the macro " "definition (e.g gtk-doc.m4) which contains the " "GTK_DOC_CHECK macro to your project's macro directory. " "Without this, the GTK_DOC_CHECK macro might not be found and you would need " "to explicitly tell the aclocal tool where to find " "the macro definition file." msgstr "" #. (itstool) path: example/title #: C/index.docbook:762 msgid "Minimal integration with autoconf" msgstr "" #. (itstool) path: example/programlisting #: C/index.docbook:763 #, no-wrap msgid "" "\n" "# recommended: set m4 directory\n" "AC_CONFIG_MACRO_DIR(m4)\n" "# optional: register gtk-doc in configure\n" "GTK_DOC_CHECK([1.28])\n" msgstr "" #. (itstool) path: example/title #: C/index.docbook:778 msgid "Integration with optional gtk-doc dependency" msgstr "" #. (itstool) path: example/programlisting #: C/index.docbook:779 #, no-wrap msgid "" "\n" "m4_ifdef([GTK_DOC_CHECK], [\n" "# recommended: set m4 directory\n" "AC_CONFIG_MACRO_DIR(m4)\n" "# optional: register gtk-doc in configure\n" "GTK_DOC_CHECK([1.28])\n" "],[\n" "AM_CONDITIONAL([ENABLE_GTK_DOC], false)\n" "])\n" msgstr "" #. (itstool) path: sect2/para #: C/index.docbook:772 msgid "" "The above example works, but will require all developers to have gtk-doc " "installed. A better way is to make building the documentation optional as " "shown in the next example: <_:example-1/>" msgstr "" #. (itstool) path: sect2/para #: C/index.docbook:792 msgid "" "The first argument is used to check for the Gtk-Doc version at configure " "time. The 2nd, optional argument is used by gtkdocize. The GTK_DOC_CHECK macro also adds several " "configure switches:" msgstr "" #. (itstool) path: listitem/para #: C/index.docbook:801 msgid "--with-html-dir=PATH : path to installed docs" msgstr "" #. (itstool) path: listitem/para #: C/index.docbook:802 msgid "--enable-gtk-doc : use gtk-doc to build documentation [default=no]" msgstr "" #. (itstool) path: listitem/para #: C/index.docbook:803 msgid "" "--enable-gtk-doc-html : build documentation in html format [default=yes]" msgstr "" #. (itstool) path: listitem/para #: C/index.docbook:804 msgid "--enable-gtk-doc-pdf : build documentation in pdf format [default=no]" msgstr "" #. (itstool) path: important/para #: C/index.docbook:808 msgid "" "GTK-Doc is disabled by default! Remember to pass the option to the next configure run. " "Otherwise pregenerated documentation is installed (which makes sense for " "users but not for developers)." msgstr "" #. (itstool) path: sect2/para #: C/index.docbook:816 msgid "" "After all changes to configure.ac are made, update the " "configure file. This can be done by re-running " "autogen.sh." msgstr "" #. (itstool) path: sect2/title #: C/index.docbook:824 msgid "Integration with autogen" msgstr "" #. (itstool) path: sect2/para #: C/index.docbook:826 msgid "" "Most projects will have an autogen.sh script to setup " "the build infrastructure after the project was checked out from a version " "control system (such as git or svn). GTK-Doc comes with a script called " "gtkdocize which can be used to copy the necessary " "files needed by Gtk-Doc to the source directory." msgstr "" #. (itstool) path: sect2/para #: C/index.docbook:834 msgid "It should be run before autoreconf, autoheader, automake or autoconf." msgstr "" #. (itstool) path: example/title #: C/index.docbook:839 msgid "Running gtkdocize from autogen.sh" msgstr "" #. (itstool) path: example/programlisting #: C/index.docbook:840 #, no-wrap msgid "" "\n" "gtkdocize || exit 1\n" msgstr "" #. (itstool) path: example/title #: C/index.docbook:848 msgid "Conditionally run gtkdocize from autogen.sh" msgstr "" #. (itstool) path: example/programlisting #: C/index.docbook:849 #, no-wrap msgid "" "\n" "GTKDOCIZE=$(which gtkdocize 2>/dev/null)\n" "if test $? -ne 0; then\n" " echo \"No gtk-doc support found. You can't build the docs.\"\n" "else\n" " $GTKDOCIZE || exit 1\n" "fi\n" msgstr "" #. (itstool) path: sect2/para #: C/index.docbook:860 msgid "" "When running gtkdocize it copies gtk-" "doc.make to your project root (or any directory specified by the " " option)." msgstr "" #. (itstool) path: sect2/para #: C/index.docbook:866 msgid "" "gtkdocize checks your configure.ac script for the GTK_DOC_CHECK macro. The " "GTK_DOC_CHECK macro can be used to pass extra arguments " "to the gtkdocize script. the 2nd parameter in the " "GTK_DOC_CHECK macro." msgstr "" #. (itstool) path: sect2/para #: C/index.docbook:875 msgid "" "Alternatively, additional arguments can also be passed to " "gtkdocize via the GTKDOCIZE_FLAGS environment variable, or by directly specifying them to " "gtkdocize in autogen.sh." msgstr "" #. (itstool) path: sect2/title #: C/index.docbook:886 msgid "Executing GTK-Doc from the Build System" msgstr "" #. (itstool) path: sect2/para #: C/index.docbook:888 msgid "" "After the previous steps it's time to run the build. First we need to rerun " "autogen.sh. If this script runs configure for you, then " "give it the option. Otherwise manually run " "configure with this option afterwards." msgstr "" #. (itstool) path: sect2/para #: C/index.docbook:895 msgid "" "The first make run generates several additional files in the doc-" "directories. The important ones are: <package>.types, <package>-docs.xml (in the " "past .sgml), <package>-sections.txt." msgstr "" #. (itstool) path: example/title #: C/index.docbook:903 msgid "Running the doc build" msgstr "" #. (itstool) path: example/programlisting #: C/index.docbook:904 #, no-wrap msgid "" "\n" "./autogen.sh --enable-gtk-doc\n" "make\n" msgstr "" #. (itstool) path: sect2/para #: C/index.docbook:911 msgid "" "Now you can point your browser to docs/reference/<package>/" "index.html. With this initial setup you will only see a very " "simple document. The next chapter will teach you how to add API " "documentation to your code via special comment blocks. The Chapter " "afterwards introduces additional files " "and shows how to edit the master " "template to add additional chapters and sections to your " "documentation files." msgstr "" #. (itstool) path: sect1/title #: C/index.docbook:927 msgid "Integration with CMake build systems" msgstr "" #. (itstool) path: sect1/para #: C/index.docbook:929 msgid "" "GTK-Doc now provides a GtkDocConfig.cmake module (and " "the corresponding GtkDocConfigVersion.cmake module). " "This provides a gtk_doc_add_module command that you can " "set in your CMakeLists.txt file." msgstr "" #. (itstool) path: example/title #: C/index.docbook:939 msgid "Example of using GTK-Doc from CMake" msgstr "" #. (itstool) path: example/programlisting #: C/index.docbook:940 #, no-wrap msgid "" "\n" "find_package(GtkDoc 1.25 REQUIRED)\n" "\n" "# Create the doc-libmeep target.\n" "gtk_doc_add_module(\n" " libmeep ${CMAKE_SOURCE_DIR}/libmeep\n" " XML meep-docs.xml\n" " LIBRARIES libmeep\n" ")\n" "\n" "# Build doc-libmeep as part of the default target. Without this, you would\n" "# have to explicitly run something like `make doc-libmeep` to build the docs.\n" "add_custom_target(documentation ALL DEPENDS doc-libmeep)\n" "\n" "# Install the docs. (This assumes you're using the GNUInstallDirs CMake module\n" "# to set the CMAKE_INSTALL_DOCDIR variable correctly).\n" "install(DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}/libmeep/html\n" " DESTINATION ${CMAKE_INSTALL_DOCDIR})\n" msgstr "" #. (itstool) path: sect1/para #: C/index.docbook:937 msgid "The following example shows how to use this command. <_:example-1/>" msgstr "" #. (itstool) path: sect1/title #: C/index.docbook:964 msgid "Integration with plain makefiles or other build systems" msgstr "" #. (itstool) path: sect1/para #: C/index.docbook:966 msgid "" "In the case one does not want to use automake and therefore gtk-" "doc.mak one will need to call the gtkdoc tools in the right order " "in own makefiles (or other build tools)." msgstr "" #. (itstool) path: example/title #: C/index.docbook:973 msgid "Documentation build steps" msgstr "" #. (itstool) path: example/programlisting #: C/index.docbook:974 #, no-wrap msgid "" "\n" "DOC_MODULE=meep\n" "// sources have changed\n" "gtkdoc-scan --module=$(DOC_MODULE) <source-dir>\n" "gtkdoc-scangobj --module=$(DOC_MODULE)\n" "gtkdoc-mkdb --module=$(DOC_MODULE) --output-format=xml --source-dir=<source-dir>\n" "// xml files have changed\n" "mkdir html\n" "cd html && gtkdoc-mkhtml $(DOC_MODULE) ../meep-docs.xml\n" "gtkdoc-fixxref --module=$(DOC_MODULE) --module-dir=html\n" msgstr "" #. (itstool) path: sect1/para #: C/index.docbook:988 msgid "" "One will need to look at the Makefile.am and " "gtk-doc.mak to pick the extra options needed." msgstr "" #. (itstool) path: sect1/title #: C/index.docbook:995 msgid "Integration with version control systems" msgstr "" #. (itstool) path: sect1/para #: C/index.docbook:997 msgid "" "As a rule of thumb, it's the files you edit which should go under version " "control. For typical projects it's these files: " "<package>.types, <package>-" "docs.xml (in the past .sgml), <package>-" "sections.txt, Makefile.am." msgstr "" #. (itstool) path: sect1/para #: C/index.docbook:1005 msgid "" "Files in the xml/ and html/ " "directories should not go under version control. Neither should any of the " ".stamp files." msgstr "" #. (itstool) path: chapter/title #: C/index.docbook:1015 msgid "Documenting the code" msgstr "" #. (itstool) path: chapter/para #: C/index.docbook:1017 msgid "" "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." msgstr "" #. (itstool) path: example/title #: C/index.docbook:1028 C/index.docbook:1054 msgid "GTK-Doc comment block" msgstr "" #. (itstool) path: example/programlisting #: C/index.docbook:1029 #, no-wrap msgid "" "\n" "#ifndef __GTK_DOC_IGNORE__\n" "/* unparseable code here */\n" "#endif\n" msgstr "" #. (itstool) path: chapter/para #: C/index.docbook:1024 msgid "" "The GTK-Doc 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/>" msgstr "" #. (itstool) path: note/title #: C/index.docbook:1038 msgid "Limitations" msgstr "" #. (itstool) path: note/para #: C/index.docbook:1039 msgid "" "Note, that GTK-Doc's supports #ifndef(__GTK_DOC_IGNORE__) but " "not #if !defined(__GTK_DOC_IGNORE__) or other combinations." msgstr "" #. (itstool) path: sect1/title #: C/index.docbook:1049 msgid "Documentation comments" msgstr "" #. (itstool) path: example/programlisting #: C/index.docbook:1055 #, no-wrap msgid "" "\n" "/**\n" " * identifier:\n" " * documentation ...\n" " */\n" msgstr "" #. (itstool) path: sect1/para #: C/index.docbook:1051 msgid "" "A multiline comment that starts with an additional '*' marks a documentation " "block that will be processed by the GTK-Doc tools. <_:example-1/>" msgstr "" #. (itstool) path: sect1/para #: C/index.docbook:1064 msgid "" "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)" msgstr "" #. (itstool) path: sect1/para #: C/index.docbook:1070 msgid "" "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)." msgstr "" #. (itstool) path: listitem/para #: C/index.docbook:1087 msgid "" "What it is: The name for a class or function can sometimes be misleading for " "people coming from a different background." msgstr "" #. (itstool) path: listitem/para #: C/index.docbook:1093 msgid "" "What it does: Tell about common uses. Put it in relation with the other API." msgstr "" #. (itstool) path: tip/para #: C/index.docbook:1083 msgid "When documenting code, describe two aspects: <_:itemizedlist-1/>" msgstr "" #. (itstool) path: listitem/para #: C/index.docbook:1108 msgid "Use function() to refer to functions or macros which take arguments." msgstr "" #. (itstool) path: listitem/para #: C/index.docbook:1113 msgid "" "Use @param to refer to parameters. Also use this when referring to " "parameters of other functions, related to the one being described." msgstr "" #. (itstool) path: listitem/para #: C/index.docbook:1119 msgid "Use %constant to refer to a constant, e.g. %G_TRAVERSE_LEAFS." msgstr "" #. (itstool) path: listitem/para #: C/index.docbook:1124 msgid "" "Use #symbol to refer to other types of symbol, e.g. structs and enums and " "macros which don't take arguments." msgstr "" #. (itstool) path: listitem/para #: C/index.docbook:1130 msgid "Use #Object::signal to refer to a GObject signal." msgstr "" #. (itstool) path: listitem/para #: C/index.docbook:1135 msgid "Use #Object:property to refer to a GObject property." msgstr "" #. (itstool) path: listitem/para #: C/index.docbook:1140 msgid "" "Use #Struct.field to refer to a field inside a structure and " "#GObjectClass.foo_bar() to refer to a vmethod." msgstr "" #. (itstool) path: sect1/para #: C/index.docbook:1102 msgid "" "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/>" msgstr "" #. (itstool) path: tip/para #: C/index.docbook:1149 msgid "" "If you need to use the special characters '<', '>', '()', '@', '%', or " "'#' in your documentation without GTK-Doc changing them you can use the XML " "entities \"&lt;\", \"&gt;\", \"&lpar;\", \"&rpar;\", " "\"&commat;\", \"&percnt;\" and \"&num;\" respectively or escape " "them with a backslash '\\'." msgstr "" #. (itstool) path: sect1/para #: C/index.docbook:1158 msgid "" "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 Markdown. 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." msgstr "" #. (itstool) path: sect1/para #: C/index.docbook:1169 msgid "" "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." msgstr "" #. (itstool) path: sect1/para #: C/index.docbook:1175 msgid "" "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 (or ) in " "the variable MKDB_OPTIONS inside Makefile.am." msgstr "" #. (itstool) path: example/title #: C/index.docbook:1184 msgid "GTK-Doc comment block using Markdown" msgstr "" #. (itstool) path: example/programlisting #: C/index.docbook:1185 #, no-wrap msgid "" "\n" "/**\n" " * identifier:\n" " *\n" " * documentation paragraph ...\n" " *\n" " * # Sub Heading #\n" " *\n" " * ## Second Sub Heading\n" " *\n" " * # Sub Heading With a Link Anchor # {#heading-two}\n" " *\n" " * more documentation:\n" " *\n" " * - list item 1\n" " *\n" " * Paragraph inside a list item.\n" " *\n" " * - list item 2\n" " *\n" " * 1. numbered list item\n" " *\n" " * 2. another numbered list item\n" " *\n" " * Another paragraph. [A Link to the GNOME Website](http://www.gnome.org/)\n" " *\n" " * ![an inline image](plot-result.png)\n" " *\n" " * [A link to the heading anchor above][heading-two]\n" " *\n" " * A C-language example:\n" " * |[<!-- language=\"C\" -->\n" " * GtkWidget *label = gtk_label_new (\"Gorgeous!\");\n" " * ]|\n" " */\n" msgstr "" #. (itstool) path: sect1/para #: C/index.docbook:1224 msgid "" "More examples of what markdown tags are supported can be found in the GTK " "Documentation Markdown Syntax Reference." msgstr "" #. (itstool) path: tip/para #: C/index.docbook:1230 msgid "" "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 developers to understand your " "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." msgstr "" #. (itstool) path: sect1/title #: C/index.docbook:1245 msgid "Documenting sections" msgstr "" #. (itstool) path: sect1/para #: C/index.docbook:1247 msgid "" "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." msgstr "" #. (itstool) path: example/title #: C/index.docbook:1255 msgid "Section comment block" msgstr "" #. (itstool) path: example/programlisting #: C/index.docbook:1256 #, no-wrap msgid "" "\n" "/**\n" " * SECTION:meepapp\n" " * @short_description: the application class\n" " * @title: Meep application\n" " * @section_id:\n" " * @see_also: #MeepSettings\n" " * @stability: Stable\n" " * @include: meep/app.h\n" " * @image: application.png\n" " *\n" " * The application class handles ...\n" " */\n" msgstr "" #. (itstool) path: varlistentry/term #: C/index.docbook:1275 msgid "SECTION:<name>" msgstr "" #. (itstool) path: listitem/para #: C/index.docbook:1277 msgid "" "The name links the section documentation to the respective part in the " "<package>-sections.txt file. The name given here " "should match the <FILE> tag in the <package>-" "sections.txt file." msgstr "" #. (itstool) path: varlistentry/term #: C/index.docbook:1286 msgid "@short_description" msgstr "" #. (itstool) path: listitem/para #: C/index.docbook:1288 msgid "" "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." msgstr "" #. (itstool) path: varlistentry/term #: C/index.docbook:1295 msgid "@title" msgstr "" #. (itstool) path: listitem/para #: C/index.docbook:1297 msgid "" "The section title defaults to <name> from the SECTION declaration. It " "can be overridden with the @title field." msgstr "" #. (itstool) path: varlistentry/term #: C/index.docbook:1304 msgid "@section_id" msgstr "" #. (itstool) path: listitem/para #: C/index.docbook:1306 msgid "" "Overrides the use of title as a section identifier. For GObjects the " "<title> is used as a section_id and for other sections it is " "<MODULE>-<title>." msgstr "" #. (itstool) path: varlistentry/term #: C/index.docbook:1314 msgid "@see_also" msgstr "" #. (itstool) path: listitem/para #: C/index.docbook:1316 msgid "A list of symbols that are related to this section." msgstr "" #. (itstool) path: varlistentry/term #: C/index.docbook:1322 msgid "@stability" msgstr "" #. (itstool) path: listitem/para #: C/index.docbook:1329 msgid "" "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." msgstr "" #. (itstool) path: listitem/para #: C/index.docbook:1341 msgid "" "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." msgstr "" #. (itstool) path: listitem/para #: C/index.docbook:1353 msgid "" "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." msgstr "" #. (itstool) path: listitem/para #: C/index.docbook:1362 msgid "" "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." msgstr "" #. (itstool) path: listitem/para #: C/index.docbook:1324 msgid "" "An informal description of the stability level this API has. We recommend " "the use of one of these terms: <_:itemizedlist-1/>" msgstr "" #. (itstool) path: varlistentry/term #: C/index.docbook:1374 msgid "@include" msgstr "" #. (itstool) path: listitem/para #: C/index.docbook:1376 msgid "" "The #include files to show in the section synopsis (a " "comma separated list), overriding the global value from the section file or command line. This " "item is optional." msgstr "" #. (itstool) path: varlistentry/term #: C/index.docbook:1385 msgid "@image" msgstr "" #. (itstool) path: listitem/para #: C/index.docbook:1387 msgid "" "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." msgstr "" #. (itstool) path: tip/para #: C/index.docbook:1398 msgid "" "To avoid unnecessary recompilation after doc-changes put the section docs " "into the c-source where possible." msgstr "" #. (itstool) path: sect1/title #: C/index.docbook:1407 msgid "Documenting symbols" msgstr "" #. (itstool) path: sect1/para #: C/index.docbook:1409 msgid "" "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." msgstr "" #. (itstool) path: sect2/title #. (itstool) path: example/title #: C/index.docbook:1417 C/index.docbook:1483 msgid "General tags" msgstr "" #. (itstool) path: sect2/para #: C/index.docbook:1419 msgid "" "You can add versioning information to all documentation elements to tell " "when an API was introduced, or when it was deprecated." msgstr "" #. (itstool) path: variablelist/title #: C/index.docbook:1424 msgid "Versioning Tags" msgstr "" #. (itstool) path: varlistentry/term #: C/index.docbook:1425 msgid "Since:" msgstr "" #. (itstool) path: listitem/para #: C/index.docbook:1427 msgid "Description since which version of the code the API is available." msgstr "" #. (itstool) path: varlistentry/term #: C/index.docbook:1432 msgid "Deprecated:" msgstr "" #. (itstool) path: listitem/para #: C/index.docbook:1434 msgid "" "Paragraph denoting that this function should no be used anymore. The " "description should point the reader to the new API." msgstr "" #. (itstool) path: sect2/para #: C/index.docbook:1442 msgid "" "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." msgstr "" #. (itstool) path: sect2/para #: C/index.docbook:1448 msgid "" "The default stability level for all documentation elements can be set by " "passing the argument to " "gtkdoc-mkdb with one of the values below." msgstr "" #. (itstool) path: variablelist/title #: C/index.docbook:1454 msgid "Stability Tags" msgstr "" #. (itstool) path: varlistentry/term #: C/index.docbook:1455 msgid "Stability: Stable" msgstr "" #. (itstool) path: listitem/para #: C/index.docbook:1457 msgid "" "Mark the element as stable. This is for public APIs which are guaranteed to " "remain stable for all future minor releases of the project." msgstr "" #. (itstool) path: varlistentry/term #: C/index.docbook:1464 msgid "Stability: Unstable" msgstr "" #. (itstool) path: listitem/para #: C/index.docbook:1466 msgid "" "Mark the element as unstable. This is for public APIs which are released as " "a preview before being stabilised." msgstr "" #. (itstool) path: varlistentry/term #: C/index.docbook:1472 msgid "Stability: Private" msgstr "" #. (itstool) path: listitem/para #: C/index.docbook:1474 msgid "" "Mark the element as private. This is for interfaces which can be used by " "tightly coupled modules, but not by arbitrary third parties." msgstr "" #. (itstool) path: example/programlisting #: C/index.docbook:1484 #, no-wrap msgid "" "\n" "/**\n" " * foo_get_bar:\n" " * @foo: some foo\n" " *\n" " * Retrieves @foo's bar.\n" " *\n" " * Returns: @foo's bar\n" " *\n" " * Since: 2.6\n" " * Deprecated: 2.12: Use foo_baz_get_bar() instead.\n" " */\n" "Bar *\n" "foo_get_bar(Foo *foo)\n" "{\n" "...\n" msgstr "" #. (itstool) path: sect2/title #. (itstool) path: example/title #: C/index.docbook:1504 C/index.docbook:1514 msgid "Annotations" msgstr "" #. (itstool) path: sect2/para #: C/index.docbook:1506 msgid "" "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 in the GObject Introspection " "documentation." msgstr "" #. (itstool) path: example/programlisting #: C/index.docbook:1515 #, no-wrap msgid "" "\n" "/**\n" " * foo_get_bar: (annotation)\n" " * @foo: (annotation): some foo\n" " *\n" " * Retrieves @foo's bar.\n" " *\n" " * Returns: (annotation): @foo's bar\n" " */\n" "...\n" "/**\n" " * foo_set_bar_using_the_frobnicator: (annotation) (another annotation)\n" " * (and another annotation)\n" " * @foo: (annotation) (another annotation): some foo\n" " *\n" " * Sets bar on @foo.\n" " */\n" msgstr "" #. (itstool) path: sect2/title #. (itstool) path: example/title #: C/index.docbook:1536 C/index.docbook:1565 msgid "Function comment block" msgstr "" #. (itstool) path: listitem/para #: C/index.docbook:1542 msgid "" "Document whether returned objects, lists, strings, etc, should be freed/" "unrefed/released." msgstr "" #. (itstool) path: listitem/para #: C/index.docbook:1548 msgid "Document whether parameters can be NULL, and what happens if they are." msgstr "" #. (itstool) path: listitem/para #: C/index.docbook:1553 msgid "" "Mention interesting pre-conditions and post-conditions where appropriate." msgstr "" #. (itstool) path: sect2/para #: C/index.docbook:1538 C/index.docbook:1624 msgid "Please remember to: <_:itemizedlist-1/>" msgstr "" #. (itstool) path: sect2/para #: C/index.docbook:1560 msgid "" "Gtk-doc assumes all symbols (macros, functions) starting with '_' are " "private. They are treated like static functions." msgstr "" #. (itstool) path: example/programlisting #: C/index.docbook:1566 #, no-wrap msgid "" "\n" "/**\n" " * function_name:\n" " * @par1: description of parameter 1. These can extend over more than\n" " * one line.\n" " * @par2: description of parameter 2\n" " * @...: a %NULL-terminated list of bars\n" " *\n" " * The function description goes here. You can use @par1 to refer to parameters\n" " * so that they are highlighted in the output. You can also use %constant\n" " * for constants, function_name2() for functions and #GtkWidget for links to\n" " * other declarations (which may be documented elsewhere).\n" " *\n" " * Returns: an integer.\n" " *\n" " * Since: 2.2\n" " * Deprecated: 2.18: Use other_function() instead.\n" " */\n" msgstr "" #. (itstool) path: variablelist/title #: C/index.docbook:1587 msgid "Function tags" msgstr "" #. (itstool) path: varlistentry/term #: C/index.docbook:1588 C/index.docbook:1795 msgid "Returns:" msgstr "" #. (itstool) path: listitem/para #: C/index.docbook:1590 msgid "Paragraph describing the returned result." msgstr "" #. (itstool) path: varlistentry/term #: C/index.docbook:1595 msgid "@...:" msgstr "" #. (itstool) path: listitem/para #: C/index.docbook:1597 msgid "" "In case the function has variadic arguments, you should use this tag " "(@Varargs: does also work for historic reasons)." msgstr "" #. (itstool) path: sect2/title #. (itstool) path: example/title #: C/index.docbook:1607 C/index.docbook:1609 msgid "Property comment block" msgstr "" #. (itstool) path: example/programlisting #: C/index.docbook:1610 #, no-wrap msgid "" "\n" "/**\n" " * SomeWidget:some-property:\n" " *\n" " * Here you can document a property.\n" " */\n" "g_object_class_install_property (object_class, PROP_SOME_PROPERTY, ...);\n" msgstr "" #. (itstool) path: sect2/title #. (itstool) path: example/title #: C/index.docbook:1622 C/index.docbook:1641 msgid "Signal comment block" msgstr "" #. (itstool) path: listitem/para #: C/index.docbook:1628 msgid "" "Document when the signal is emitted and whether it is emitted before or " "after other signals." msgstr "" #. (itstool) path: listitem/para #: C/index.docbook:1634 msgid "Document what an application might do in the signal handler." msgstr "" #. (itstool) path: example/programlisting #: C/index.docbook:1642 #, no-wrap msgid "" "\n" "/**\n" " * FooWidget::foobarized:\n" " * @widget: the widget that received the signal\n" " * @foo: some foo\n" " * @bar: some bar\n" " *\n" " * The ::foobarized signal is emitted each time someone tries to foobarize @widget.\n" " */\n" "foo_signals[FOOBARIZED] =\n" " g_signal_new (\"foobarized\",\n" " ...\n" msgstr "" #. (itstool) path: sect2/title #. (itstool) path: example/title #: C/index.docbook:1659 C/index.docbook:1660 msgid "Struct comment block" msgstr "" #. (itstool) path: example/programlisting #: C/index.docbook:1661 #, no-wrap msgid "" "\n" "/**\n" " * FooWidget:\n" " * @bar: some #gboolean\n" " *\n" " * This is the best widget, ever.\n" " */\n" "typedef struct _FooWidget {\n" " GtkWidget parent_instance;\n" "\n" " gboolean bar;\n" "} FooWidget;\n" msgstr "" #. (itstool) path: sect2/para #: C/index.docbook:1676 msgid "" "Use /*< private >*/ before the private struct fields you " "want to hide. Use /*< public >*/ for the reverse " "behaviour." msgstr "" #. (itstool) path: sect2/para #: C/index.docbook:1682 msgid "" "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." msgstr "" #. (itstool) path: sect2/para #: C/index.docbook:1688 msgid "" "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)." msgstr "" #. (itstool) path: sect2/title #. (itstool) path: example/title #: C/index.docbook:1700 C/index.docbook:1701 msgid "Enum comment block" msgstr "" #. (itstool) path: example/programlisting #: C/index.docbook:1702 #, no-wrap msgid "" "\n" "/**\n" " * Something:\n" " * @SOMETHING_FOO: something foo\n" " * @SOMETHING_BAR: something bar\n" " *\n" " * Enum values used for the thing, to specify the thing.\n" " */\n" "typedef enum {\n" " SOMETHING_FOO,\n" " SOMETHING_BAR,\n" " /*< private >*/\n" " SOMETHING_COUNT\n" "} Something;\n" msgstr "" #. (itstool) path: sect2/para #: C/index.docbook:1719 msgid "" "Use /*< private >*/ before the private enum values you " "want to hide. Use /*< public >*/ for the reverse " "behaviour." msgstr "" #. (itstool) path: sect1/title #: C/index.docbook:1730 msgid "Inline program documentation" msgstr "" #. (itstool) path: sect1/para #: C/index.docbook:1731 msgid "" "You can document programs and their commandline interface using inline " "documentation." msgstr "" #. (itstool) path: variablelist/title #: C/index.docbook:1737 msgid "Tags" msgstr "" #. (itstool) path: varlistentry/term #: C/index.docbook:1739 msgid "PROGRAM" msgstr "" #. (itstool) path: listitem/para #: C/index.docbook:1742 msgid "Defines the start of a program documentation." msgstr "" #. (itstool) path: varlistentry/term #: C/index.docbook:1749 msgid "@short_description:" msgstr "" #. (itstool) path: listitem/para #: C/index.docbook:1751 msgid "Defines a short description of the program. (Optional)" msgstr "" #. (itstool) path: varlistentry/term #: C/index.docbook:1758 msgid "@synopsis:" msgstr "" #. (itstool) path: listitem/para #: C/index.docbook:1760 msgid "" "Defines the arguments, or list of arguments that the program can take. " "(Optional)" msgstr "" #. (itstool) path: varlistentry/term #: C/index.docbook:1768 msgid "@see_also:" msgstr "" #. (itstool) path: listitem/para #: C/index.docbook:1770 msgid "See Also manual page section. (Optional)" msgstr "" #. (itstool) path: varlistentry/term #: C/index.docbook:1777 msgid "@arg:" msgstr "" #. (itstool) path: listitem/para #: C/index.docbook:1779 msgid "Argument(s) passed to the program and their description. (Optional)" msgstr "" #. (itstool) path: varlistentry/term #: C/index.docbook:1786 msgid "Description:" msgstr "" #. (itstool) path: listitem/para #: C/index.docbook:1788 msgid "A longer description of the program." msgstr "" #. (itstool) path: listitem/para #: C/index.docbook:1797 msgid "Specify what value(s) the program returns. (Optional)" msgstr "" #. (itstool) path: sect2/title #: C/index.docbook:1806 msgid "Example of program documentation." msgstr "" #. (itstool) path: example/title #: C/index.docbook:1807 msgid "Program documentation block" msgstr "" #. (itstool) path: example/programlisting #: C/index.docbook:1808 #, no-wrap msgid "" "\n" "/**\n" " * PROGRAM:test-program\n" " * @short_description: A test program\n" " * @synopsis: test-program [*OPTIONS*...] --arg1 *arg* *FILE*\n" " * @see_also: test(1)\n" " * @--arg1 *arg*: set arg1 to *arg*\n" " * @--arg2 *arg*: set arg2 to *arg*\n" " * @-v, --version: Print the version number\n" " * @-h, --help: Print the help message\n" " *\n" " * Long description of program.\n" " *\n" " * Returns: Zero on success, non-zero on failure\n" " */\n" "int main(int argc, char *argv[])\n" "{\n" "\treturn 0;\n" "}\n" msgstr "" #. (itstool) path: sect1/title #: C/index.docbook:1834 msgid "Useful DocBook tags" msgstr "" #. (itstool) path: sect1/para #: C/index.docbook:1836 msgid "" "Here are some DocBook tags which are most useful when documenting the code." msgstr "" #. (itstool) path: informalexample/programlisting #: C/index.docbook:1845 #, no-wrap msgid "" "\n" "<link linkend=\"glib-Hash-Tables\">Hash Tables</link>\n" msgstr "" #. (itstool) path: sect1/para #: C/index.docbook:1841 msgid "" "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." msgstr "" #. (itstool) path: informalexample/programlisting #: C/index.docbook:1858 #, no-wrap msgid "" "\n" "<function>...</function>\n" msgstr "" #. (itstool) path: sect1/para #: C/index.docbook:1855 msgid "" "To refer to an external function, e.g. a standard C function: " "<_:informalexample-1/>" msgstr "" #. (itstool) path: informalexample/programlisting #: C/index.docbook:1867 #, no-wrap msgid "" "\n" "<example>\n" " <title>Using a GHashTable.</title>\n" " <programlisting language=\"C\">\n" " ...\n" " </programlisting>\n" "</example>\n" msgstr "" #. (itstool) path: informalexample/programlisting #: C/index.docbook:1878 #, no-wrap msgid "" "\n" "<informalexample>\n" " <programlisting language=\"C\">\n" " ...\n" " </programlisting>\n" "</informalexample>\n" msgstr "" #. (itstool) path: informalexample/programlisting #: C/index.docbook:1890 #, no-wrap msgid "" "\n" "|[<!-- language=\"C\" -->\n" " ...\n" "]|\n" msgstr "" #. (itstool) path: sect1/para #: C/index.docbook:1864 msgid "" "To include example code: <_:informalexample-1/> or possibly this, for very " "short code fragments which don't need a title: <_:informalexample-2/> In " "both cases, the language attribute is optional and is used as a hint to the " "syntax highlighting engine (pygments for html output). For the latter GTK-" "Doc also supports an abbreviation: <_:informalexample-3/>" msgstr "" #. (itstool) path: informalexample/programlisting #: C/index.docbook:1901 #, no-wrap msgid "" "\n" "<itemizedlist>\n" " <listitem>\n" " <para>\n" " ...\n" " </para>\n" " </listitem>\n" " <listitem>\n" " <para>\n" " ...\n" " </para>\n" " </listitem>\n" "</itemizedlist>\n" msgstr "" #. (itstool) path: sect1/para #: C/index.docbook:1898 msgid "To include bulleted lists: <_:informalexample-1/>" msgstr "" #. (itstool) path: informalexample/programlisting #: C/index.docbook:1921 #, no-wrap msgid "" "\n" "<note>\n" " <para>\n" " Make sure you free the data after use.\n" " </para>\n" "</note>\n" msgstr "" #. (itstool) path: sect1/para #: C/index.docbook:1918 msgid "" "To include a note which stands out from the text: <_:informalexample-1/>" msgstr "" #. (itstool) path: informalexample/programlisting #: C/index.docbook:1934 #, no-wrap msgid "" "\n" "<type>unsigned char</type>\n" msgstr "" #. (itstool) path: sect1/para #: C/index.docbook:1931 msgid "To refer to a type: <_:informalexample-1/>" msgstr "" #. (itstool) path: informalexample/programlisting #: C/index.docbook:1943 #, no-wrap msgid "" "\n" "<structname>XFontStruct</structname>\n" msgstr "" #. (itstool) path: sect1/para #: C/index.docbook:1940 msgid "" "To refer to an external structure (not one described in the GTK docs): " "<_:informalexample-1/>" msgstr "" #. (itstool) path: informalexample/programlisting #: C/index.docbook:1952 #, no-wrap msgid "" "\n" "<structfield>len</structfield>\n" msgstr "" #. (itstool) path: sect1/para #: C/index.docbook:1949 msgid "To refer to a field of a structure: <_:informalexample-1/>" msgstr "" #. (itstool) path: informalexample/programlisting #: C/index.docbook:1961 #, no-wrap msgid "" "\n" "<classname>GtkWidget</classname>\n" msgstr "" #. (itstool) path: sect1/para #: C/index.docbook:1958 msgid "" "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 the " "abbreviations)." msgstr "" #. (itstool) path: informalexample/programlisting #: C/index.docbook:1972 #, no-wrap msgid "" "\n" "<emphasis>This is important</emphasis>\n" msgstr "" #. (itstool) path: sect1/para #: C/index.docbook:1969 msgid "To emphasize text: <_:informalexample-1/>" msgstr "" #. (itstool) path: informalexample/programlisting #: C/index.docbook:1981 #, no-wrap msgid "" "\n" "<filename>/home/user/documents</filename>\n" msgstr "" #. (itstool) path: sect1/para #: C/index.docbook:1978 msgid "For filenames use: <_:informalexample-1/>" msgstr "" #. (itstool) path: informalexample/programlisting #: C/index.docbook:1990 #, no-wrap msgid "" "\n" "<keycombo><keycap>Control</keycap><keycap>L</keycap></keycombo>\n" msgstr "" #. (itstool) path: sect1/para #: C/index.docbook:1987 msgid "To refer to keys use: <_:informalexample-1/>" msgstr "" #. (itstool) path: chapter/title #: C/index.docbook:2000 msgid "Filling the extra files" msgstr "" #. (itstool) path: chapter/para #: C/index.docbook:2002 msgid "" "There are a couple of extra files, that need to be maintained along with the " "inline source code comments: <package>.types, " "<package>-docs.xml (in the past .sgml), " "<package>-sections.txt." msgstr "" #. (itstool) path: sect1/title #: C/index.docbook:2011 msgid "Editing the types file" msgstr "" #. (itstool) path: sect1/para #: C/index.docbook:2013 msgid "" "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 xxx_get_type functions together with their include inside the " "<package>.types file." msgstr "" #. (itstool) path: example/title #: C/index.docbook:2022 msgid "Example <package>.types file" msgstr "" #. (itstool) path: example/programlisting #: C/index.docbook:2023 #, no-wrap msgid "" "\n" "#include <gtk/gtk.h>\n" "\n" "gtk_accel_label_get_type\n" "gtk_adjustment_get_type\n" "gtk_alignment_get_type\n" "gtk_arrow_get_type\n" msgstr "" #. (itstool) path: sect1/para #: C/index.docbook:2034 msgid "" "Since GTK-Doc 1.8 gtkdoc-scan can generate this " "list for you. Just add \"--rebuild-types\" to SCAN_OPTIONS in " "Makefile.am. If you use this approach you should not " "dist the types file nor have it under version control." msgstr "" #. (itstool) path: sect1/title #: C/index.docbook:2043 msgid "Editing the master document" msgstr "" #. (itstool) path: sect1/para #: C/index.docbook:2045 msgid "" "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." msgstr "" #. (itstool) path: sect1/para #: C/index.docbook:2052 msgid "" "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." msgstr "" #. (itstool) path: tip/para #: C/index.docbook:2062 msgid "" "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." msgstr "" #. (itstool) path: sect1/para #: C/index.docbook:2071 msgid "" "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." msgstr "" #. (itstool) path: example/title #: C/index.docbook:2078 msgid "Master document header" msgstr "" #. (itstool) path: example/programlisting #: C/index.docbook:2079 #, no-wrap msgid "" "\n" "<bookinfo>\n" " <title>MODULENAME Reference Manual</title>\n" " <releaseinfo>\n" " for MODULENAME [VERSION]\n" " The latest version of this documentation can be found on-line at\n" " <ulink role=\"online-location\" url=\"http://[SERVER]/MODULENAME/index.html\">http://[SERVER]/MODULENAME/</ulink>.\n" " </releaseinfo>\n" "</bookinfo>\n" "\n" "<chapter>\n" " <title>[Insert title here]</title>\n" msgstr "" #. (itstool) path: sect1/para #: C/index.docbook:2095 msgid "" "In addition a few option elements are created in commented form. You can " "review these and enable them as you like." msgstr "" #. (itstool) path: example/title #: C/index.docbook:2101 msgid "Optional part in the master document" msgstr "" #. (itstool) path: example/programlisting #: C/index.docbook:2102 #, no-wrap msgid "" "\n" " <!-- enable this when you use gobject introspection annotations\n" " <xi:include href=\"xml/annotation-glossary.xml\"><xi:fallback /></xi:include>\n" " -->\n" msgstr "" #. (itstool) path: sect1/para #: C/index.docbook:2110 msgid "" "Finally you need to add new section whenever you introduce one. The gtkdoc-check tool will remind " "you of newly generated xml files that are not yet included into the doc." msgstr "" #. (itstool) path: example/title #: C/index.docbook:2118 C/index.docbook:2153 msgid "Including generated sections" msgstr "" #. (itstool) path: example/programlisting #: C/index.docbook:2119 #, no-wrap msgid "" "\n" " <chapter>\n" " <title>my library</title>\n" " <xi:include href=\"xml/object.xml\"/>\n" " ...\n" msgstr "" #. (itstool) path: sect1/title #: C/index.docbook:2131 msgid "Editing the section file" msgstr "" #. (itstool) path: sect1/para #: C/index.docbook:2133 msgid "" "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)." msgstr "" #. (itstool) path: sect1/para #: C/index.docbook:2139 msgid "" "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." msgstr "" #. (itstool) path: note/para #: C/index.docbook:2146 msgid "" "While the tags make the file look like xml, it is not. Please do not close " "tags like <SUBSECTION>." msgstr "" #. (itstool) path: example/programlisting #: C/index.docbook:2154 #, no-wrap msgid "" "\n" "<INCLUDE>libmeep/meep.h</INCLUDE>\n" "\n" "<SECTION>\n" "<FILE>meepapp</FILE>\n" "<TITLE>MeepApp</TITLE>\n" "MeepApp\n" "<SUBSECTION Standard>\n" "MEEP_APP\n" "...\n" "MeepAppClass\n" "meep_app_get_type\n" "</SECTION>\n" msgstr "" #. (itstool) path: sect1/para #: C/index.docbook:2171 msgid "" "The <FILE> ... </FILE> tag is used to specify the file name, " "without any suffix. For example, using '<FILE>gnome-config</" "FILE>' will result in the section declarations being output in the " "template file tmpl/gnome-config.sgml, which will be " "converted into the DocBook XML file xml/gnome-config.sgml or the DocBook XML file xml/gnome-config.xml. " "(The name of the HTML file is based on the module name and the section " "title, or for GObjects it is based on the GObjects class name converted to " "lower case)." msgstr "" #. (itstool) path: sect1/para #: C/index.docbook:2183 msgid "" "The <TITLE> ... </TITLE> tag is used to specify the title of the " "section. It is only useful before the templates (if used) are initially " "created, since the title set in the template file overrides this. Also if " "one uses SECTION comment in the sources, this is obsolete." msgstr "" #. (itstool) path: sect1/para #: C/index.docbook:2190 msgid "" "You can group items in the section by using the <SUBSECTION> tag. " "Currently it outputs a blank line between subsections in the synopsis " "section. You can also use <SUBSECTION Standard> for standard GObject " "declarations (e.g. the functions like g_object_get_type and macros like " "G_OBJECT(), G_IS_OBJECT() etc.). Currently these are left out of the " "documentation. You can also use <SUBSECTION Private> for private " "declarations which will not be output (it is a handy way to avoid warning " "messages about unused declarations). If your library contains private types " "which you don't want to appear in the object hierarchy and the list of " "implemented or required interfaces, add them to a Private subsection. " "Whether you would place GObject and GObjectClass like structs in public or " "Standard section depends if they have public entries (variables, vmethods)." msgstr "" #. (itstool) path: sect1/para #: C/index.docbook:2209 msgid "" "You can also use <INCLUDE> ... </INCLUDE> to specify the " "#include files which are shown in the synopsis sections. It contains a comma-" "separate list of #include files, without the angle brackets. If you set it " "outside of any sections, it acts for all sections until the end of the file. " "If you set it within a section, it only applies to that section." msgstr "" #. (itstool) path: chapter/title #: C/index.docbook:2223 msgid "Controlling the result" msgstr "" #. (itstool) path: chapter/para #: C/index.docbook:2225 msgid "" "A GTK-Doc run generates report files inside the documentation directory. The " "generated files are named: <package>-undocumented.txt, <package>-undeclared.txt and " "<package>-unused.txt. All those are plain text " "files that can be viewed and postprocessed easily." msgstr "" #. (itstool) path: chapter/para #: C/index.docbook:2234 msgid "" "The <package>-undocumented.txt file starts with " "the documentation coverage summary. Below are two sections divided by blank " "lines. The first section lists undocumented or incomplete symbols. The " "second section does the same for section docs. Incomplete entries are those, " "which have documentation, but where e.g. a new parameter has been added." msgstr "" #. (itstool) path: chapter/para #: C/index.docbook:2243 msgid "" "The <package>-undeclared.txt file lists symbols " "given in the <package>-sections.txt but not found " "in the sources. Check if they have been removed or if they are misspelled." msgstr "" #. (itstool) path: chapter/para #: C/index.docbook:2250 msgid "" "The <package>-unused.txt file lists symbol names, " "where the GTK-Doc scanner has found documentation, but does not know where " "to put it. This means that the symbol has not yet been added to the " "<package>-sections.txt file." msgstr "" #. (itstool) path: tip/para #: C/index.docbook:2258 msgid "" "Enable or add the line in " "Makefile.am. If at least GTK-Doc 1.9 is installed, this will run sanity " "checks during make check run." msgstr "" #. (itstool) path: chapter/para #: C/index.docbook:2265 msgid "" "One can also look at the files produced by the source code scanner: " "<package>-decl-list.txt and " "<package>-decl.txt. The first one can be compared " "with the section file if that is manually maintained. The second lists all " "declarations from the headers. If a symbol is missing one could check if " "this file contains it." msgstr "" #. (itstool) path: chapter/para #: C/index.docbook:2274 msgid "" "If the project is GObject based, one can also look into the files produced " "by the object scanner: <package>.args.txt, " "<package>.hierarchy.txt, " "<package>.interfaces.txt, " "<package>.prerequisites.txt and " "<package>.signals.txt. If there are missing " "symbols in any of those, one can ask GTK-Doc to keep the intermediate " "scanner file for further analysis, by running it as " "GTK_DOC_KEEP_INTERMEDIATE=1 make." msgstr "" #. (itstool) path: chapter/title #: C/index.docbook:2289 msgid "Modernizing the documentation" msgstr "" #. (itstool) path: chapter/para #: C/index.docbook:2291 msgid "" "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." msgstr "" #. (itstool) path: sect1/title #: C/index.docbook:2297 msgid "GTK-Doc 1.9" msgstr "" #. (itstool) path: sect1/para #: C/index.docbook:2299 msgid "" "When using xml instead of sgml, one can actually name the master document " "<package>-docs.xml." msgstr "" #. (itstool) path: sect1/para #: C/index.docbook:2304 msgid "" "This version supports in " "Makefile.am. When this is enabled, the " "<package>-sections.txt 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 meld <package>-decl-list.txt " "<package>-sections.txt." msgstr "" #. (itstool) path: sect1/para #: C/index.docbook:2315 msgid "" "Version 1.8 already introduced the syntax for documenting sections in the " "sources instead of the separate files under tmpl. This version adds options to switch the " "whole doc module to not use the extra tmpl build step at all, by using " " in configure.ac. If " "you don't have a tmpl checked into " "your source control system and haven't yet switched, just add the flag to " "configure.ac and you are done." msgstr "" #. (itstool) path: sect1/title #: C/index.docbook:2327 msgid "GTK-Doc 1.10" msgstr "" #. (itstool) path: sect1/para #: C/index.docbook:2329 msgid "" "This version supports in " "Makefile.am. When this is enabled, the " "<package>.types is autogenerated and can be " "removed from the vcs. When using this feature it is important to also setup " "the IGNORE_HFILES in Makefile.am for " "code that is build conditionally." msgstr "" #. (itstool) path: sect1/title #: C/index.docbook:2340 msgid "GTK-Doc 1.16" msgstr "" #. (itstool) path: example/title #: C/index.docbook:2346 msgid "Enable gtkdoc-check" msgstr "" #. (itstool) path: example/programlisting #: C/index.docbook:2347 #, no-wrap msgid "" "\n" "if ENABLE_GTK_DOC\n" "TESTS_ENVIRONMENT = \\\n" " DOC_MODULE=$(DOC_MODULE) DOC_MAIN_SGML_FILE=$(DOC_MAIN_SGML_FILE) \\\n" " SRCDIR=$(abs_srcdir) BUILDDIR=$(abs_builddir)\n" "TESTS = $(GTKDOC_CHECK)\n" "endif\n" msgstr "" #. (itstool) path: sect1/para #: C/index.docbook:2342 msgid "" "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 Makefile.am. <_:example-1/>" msgstr "" #. (itstool) path: sect1/title #: C/index.docbook:2360 msgid "GTK-Doc 1.20" msgstr "" #. (itstool) path: sect1/para #: C/index.docbook:2362 msgid "" "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 comment syntax has all the details." msgstr "" #. (itstool) path: sect1/title #: C/index.docbook:2372 msgid "GTK-Doc 1.25" msgstr "" #. (itstool) path: example/title #: C/index.docbook:2383 msgid "Use pre-generated entities" msgstr "" #. (itstool) path: example/programlisting #: C/index.docbook:2384 #, no-wrap msgid "" "\n" "<?xml version=\"1.0\"?>\n" "<!DOCTYPE book PUBLIC \"-//OASIS//DTD DocBook XML V4.3//EN\"\n" " \"http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd\"\n" "[\n" " <!ENTITY % local.common.attrib \"xmlns:xi CDATA #FIXED 'http://www.w3.org/2003/XInclude'\">\n" " <!ENTITY % gtkdocentities SYSTEM \"xml/gtkdocentities.ent\">\n" " %gtkdocentities;\n" "]>\n" "<book id=\"index\" xmlns:xi=\"http://www.w3.org/2003/XInclude\">\n" " <bookinfo>\n" " <title>&package_name; Reference Manual</title>\n" " <releaseinfo>\n" " for &package_string;.\n" " The latest version of this documentation can be found on-line at\n" " <ulink role=\"online-location\" url=\"http://[SERVER]/&package_name;/index.html\">http://[SERVER]/&package_name;/</ulink>.\n" " </releaseinfo>\n" " </bookinfo>\n" msgstr "" #. (itstool) path: sect1/para #: C/index.docbook:2374 msgid "" "The makefiles shipped with this version generate an entity file at " "xml/gtkdocentities.ent, 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 in the master template 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/>" msgstr "" #. (itstool) path: chapter/title #: C/index.docbook:2409 msgid "Documenting other interfaces" msgstr "" #. (itstool) path: chapter/para #: C/index.docbook:2411 msgid "" "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." msgstr "" #. (itstool) path: sect1/title #: C/index.docbook:2418 msgid "Command line options and man pages" msgstr "" #. (itstool) path: sect1/para #: C/index.docbook:2420 msgid "" "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." msgstr "" #. (itstool) path: sect2/title #: C/index.docbook:2427 msgid "Document the tool" msgstr "" #. (itstool) path: sect2/para #: C/index.docbook:2429 msgid "" "Create one refentry file per tool. Following our example we would call it " "meep/docs/reference/meeper/meep.xml. For the xml tags " "that should be used and can look at generated file in the xml subdirectory " "as well as examples e.g. in glib." msgstr "" #. (itstool) path: sect2/title #: C/index.docbook:2439 msgid "Adding the extra configure check" msgstr "" #. (itstool) path: example/title #: C/index.docbook:2442 C/index.docbook:2460 msgid "Extra configure checks" msgstr "" #. (itstool) path: example/programlisting #: C/index.docbook:2443 #, no-wrap msgid "" "\n" "AC_ARG_ENABLE(man,\n" " [AC_HELP_STRING([--enable-man],\n" " [regenerate man pages from Docbook [default=no]])],enable_man=yes,\n" " enable_man=no)\n" "\n" "AC_PATH_PROG([XSLTPROC], [xsltproc])\n" "AM_CONDITIONAL(ENABLE_MAN, test x$enable_man != xno)\n" msgstr "" #. (itstool) path: sect2/title #: C/index.docbook:2457 msgid "Adding the extra makefile rules" msgstr "" #. (itstool) path: example/programlisting #: C/index.docbook:2461 #, no-wrap msgid "" "\n" "man_MANS = \\\n" " meeper.1\n" "\n" "if ENABLE_GTK_DOC\n" "if ENABLE_MAN\n" "\n" "%.1 : %.xml\n" " @XSLTPROC@ -nonet http://docbook.sourceforge.net/release/xsl/current/manpages/docbook.xsl $<\n" "\n" "endif\n" "endif\n" "\n" "BUILT_EXTRA_DIST = $(man_MANS)\n" "EXTRA_DIST += meep.xml\n" msgstr "" #. (itstool) path: sect1/title #: C/index.docbook:2483 msgid "DBus interfaces" msgstr "" #. (itstool) path: sect1/para #: C/index.docbook:2485 msgid "" "(FIXME: http://hal.freedesktop.org/docs/DeviceKit/DeviceKit.html, http://" "cgit.freedesktop.org/DeviceKit/DeviceKit/tree/doc/dbus)" msgstr "" #. (itstool) path: chapter/title #: C/index.docbook:2494 msgid "Frequently asked questions" msgstr "" #. (itstool) path: segmentedlist/segtitle #: C/index.docbook:2498 msgid "Question" msgstr "" #. (itstool) path: segmentedlist/segtitle #: C/index.docbook:2499 msgid "Answer" msgstr "" #. (itstool) path: seglistitem/seg #: C/index.docbook:2501 msgid "No class hierarchy." msgstr "" #. (itstool) path: seglistitem/seg #: C/index.docbook:2502 msgid "" "The objects xxx_get_type() function has not been " "entered into the <package>.types file." msgstr "" #. (itstool) path: seglistitem/seg #: C/index.docbook:2508 msgid "Still no class hierarchy." msgstr "" #. (itstool) path: seglistitem/seg #: C/index.docbook:2509 msgid "" "Missing or wrong naming in <package>-sections.txt " "file (see explanation)." msgstr "" #. (itstool) path: seglistitem/seg #: C/index.docbook:2515 msgid "Damn, I have still no class hierarchy." msgstr "" #. (itstool) path: seglistitem/seg #: C/index.docbook:2516 msgid "" "Is the object name (name of the instance struct, e.g. GtkWidget) part of the normal section (don't put this into Standard or Private " "subsections)." msgstr "" #. (itstool) path: seglistitem/seg #: C/index.docbook:2523 msgid "No symbol index." msgstr "" #. (itstool) path: seglistitem/seg #: C/index.docbook:2524 msgid "" "Does the <package>-docs.{xml,sgml} contain a " "index that xi:includes the generated index?" msgstr "" #. (itstool) path: seglistitem/seg #: C/index.docbook:2530 msgid "Symbols are not linked to their doc-section." msgstr "" #. (itstool) path: seglistitem/seg #: C/index.docbook:2531 msgid "" "Is the doc-comment using the correct markup (added #,% or ())? Check if the " "gtkdoc-fixxref warns about unresolvable xrefs." msgstr "" #. (itstool) path: seglistitem/seg #: C/index.docbook:2537 msgid "A new class does not appear in the docs." msgstr "" #. (itstool) path: seglistitem/seg #: C/index.docbook:2538 msgid "" "Is the new page xi:included from <package>-docs.{xml,sgml}." msgstr "" #. (itstool) path: seglistitem/seg #: C/index.docbook:2544 msgid "A new symbol does not appear in the docs." msgstr "" #. (itstool) path: seglistitem/seg #: C/index.docbook:2545 msgid "" "Is the doc-comment properly formatted. Check for spelling mistakes in the " "begin of the comment. Check if the gtkdoc-fixxref warns about unresolvable " "xrefs. Check if the symbol is correctly listed in the " "<package>-sections.txt in a public subsection." msgstr "" #. (itstool) path: seglistitem/seg #: C/index.docbook:2553 msgid "A type is missing from the class hierarchy." msgstr "" #. (itstool) path: seglistitem/seg #: C/index.docbook:2554 msgid "" "If the type is listed in <package>.hierarchy but " "not in xml/tree_index.sgml then double check that the " "type is correctly placed in the <package>-sections.txt. If the type instance (e.g. GtkWidget) is not listed " "or incidentally marked private it will not be shown." msgstr "" #. (itstool) path: seglistitem/seg #: C/index.docbook:2563 msgid "I get foldoc links for all gobject annotations." msgstr "" #. (itstool) path: seglistitem/seg #: C/index.docbook:2564 msgid "" "Check that xml/annotation-glossary.xml is xi:included " "from <package>-docs.{xml,sgml}." msgstr "" #. (itstool) path: seglistitem/seg #: C/index.docbook:2572 msgid "Parameter described in source code comment block but does not exist" msgstr "" #. (itstool) path: seglistitem/seg #: C/index.docbook:2573 msgid "" "Check if the prototype in the header has different parameter names as in the " "source." msgstr "" #. (itstool) path: seglistitem/seg #: C/index.docbook:2578 msgid "multiple \"IDs\" for constraint linkend: XYZ" msgstr "" #. (itstool) path: seglistitem/seg #: C/index.docbook:2579 msgid "" "Symbol XYZ appears twice in <package>-sections.txt file." msgstr "" #. (itstool) path: seglistitem/seg #: C/index.docbook:2582 msgid "" "Element typename in namespace '' encountered in para, but no template " "matches." msgstr "" #. (itstool) path: chapter/title #: C/index.docbook:2589 msgid "Tools related to gtk-doc" msgstr "" #. (itstool) path: chapter/para #: C/index.docbook:2591 msgid "" "GtkDocPlugin - a Trac " "GTK-Doc integration plugin, that adds API docs to a trac site and " "integrates with the trac search." msgstr "" #. (itstool) path: chapter/para #: C/index.docbook:2596 msgid "" "Gtkdoc-depscan - a tool (part of gtk-doc) to check used API against since " "tags in the API to determine the minimum required version." msgstr "" #. (itstool) path: appendixinfo/releaseinfo #: C/fdl-appendix.xml:12 msgid "Version 1.1, March 2000" msgstr "" #. (itstool) path: copyright/year #: C/fdl-appendix.xml:16 msgid "2000" msgstr "" #. (itstool) path: copyright/holder #: C/fdl-appendix.xml:16 msgid "Free Software Foundation, Inc." msgstr "" #. (itstool) path: address/street #: C/fdl-appendix.xml:20 msgid "51 Franklin Street, Suite 330" msgstr "" #. (itstool) path: address/city #: C/fdl-appendix.xml:21 msgid "Boston" msgstr "" #. (itstool) path: address/state #: C/fdl-appendix.xml:21 msgid "MA" msgstr "" #. (itstool) path: address/postcode #: C/fdl-appendix.xml:22 msgid "02110-1301" msgstr "" #. (itstool) path: address/country #: C/fdl-appendix.xml:22 msgid "USA" msgstr "" #. (itstool) path: para/address #: C/fdl-appendix.xml:20 msgid "" "Free Software Foundation, Inc. <_:street-1/>, <_:city-2/>, <_:state-3/> " "<_:postcode-4/> <_:country-5/>" msgstr "" #. (itstool) path: legalnotice/para #: C/fdl-appendix.xml:19 msgid "" "<_:address-1/> Everyone is permitted to copy and distribute verbatim copies " "of this license document, but changing it is not allowed." msgstr "" #. (itstool) path: appendix/title #. (itstool) path: para/quote #: C/fdl-appendix.xml:28 C/fdl-appendix.xml:642 msgid "GNU Free Documentation License" msgstr "" #. (itstool) path: sect1/title #: C/fdl-appendix.xml:31 msgid "0. PREAMBLE" msgstr "" #. (itstool) path: para/quote #: C/fdl-appendix.xml:34 msgid "free" msgstr "" #. (itstool) path: sect1/para #: C/fdl-appendix.xml:32 msgid "" "The purpose of this License is to make a manual, textbook, or other written " "document <_:quote-1/> in the sense of freedom: to assure everyone the " "effective freedom to copy and redistribute it, with or without modifying it, " "either commercially or noncommercially. Secondarily, this License preserves " "for the author and publisher a way to get credit for their work, while not " "being considered responsible for modifications made by others." msgstr "" #. (itstool) path: para/quote #: C/fdl-appendix.xml:44 msgid "copyleft" msgstr "" #. (itstool) path: sect1/para #: C/fdl-appendix.xml:43 msgid "" "This License is a kind of <_:quote-1/>, which means that derivative works of " "the document must themselves be free in the same sense. It complements the " "GNU General Public License, which is a copyleft license designed for free " "software." msgstr "" #. (itstool) path: sect1/para #: C/fdl-appendix.xml:50 msgid "" "We have designed this License in order to use it for manuals for free " "software, because free software needs free documentation: a free program " "should come with manuals providing the same freedoms that the software does. " "But this License is not limited to software manuals; it can be used for any " "textual work, regardless of subject matter or whether it is published as a " "printed book. We recommend this License principally for works whose purpose " "is instruction or reference." msgstr "" #. (itstool) path: sect1/title #: C/fdl-appendix.xml:62 msgid "1. APPLICABILITY AND DEFINITIONS" msgstr "" #. (itstool) path: para/quote #. (itstool) path: para/link #: C/fdl-appendix.xml:67 C/fdl-appendix.xml:82 C/fdl-appendix.xml:99 #: C/fdl-appendix.xml:107 C/fdl-appendix.xml:113 C/fdl-appendix.xml:156 #: C/fdl-appendix.xml:179 C/fdl-appendix.xml:190 C/fdl-appendix.xml:205 #: C/fdl-appendix.xml:224 C/fdl-appendix.xml:235 C/fdl-appendix.xml:253 #: C/fdl-appendix.xml:271 C/fdl-appendix.xml:294 C/fdl-appendix.xml:354 #: C/fdl-appendix.xml:368 C/fdl-appendix.xml:400 C/fdl-appendix.xml:462 #: C/fdl-appendix.xml:472 C/fdl-appendix.xml:482 C/fdl-appendix.xml:519 #: C/fdl-appendix.xml:540 C/fdl-appendix.xml:565 C/fdl-appendix.xml:583 #: C/fdl-appendix.xml:608 msgid "Document" msgstr "" #. (itstool) path: para/quote #: C/fdl-appendix.xml:69 msgid "you" msgstr "" #. (itstool) path: sect1/para #: C/fdl-appendix.xml:63 msgid "" "This License applies to any manual or other work that contains a notice " "placed by the copyright holder saying it can be distributed under the terms " "of this License. The <_:quote-1/>, below, refers to any such manual or work. " "Any member of the public is a licensee, and is addressed as <_:quote-2/>." msgstr "" #. (itstool) path: para/quote #. (itstool) path: para/link #: C/fdl-appendix.xml:73 C/fdl-appendix.xml:234 C/fdl-appendix.xml:269 #: C/fdl-appendix.xml:283 C/fdl-appendix.xml:315 C/fdl-appendix.xml:351 #: C/fdl-appendix.xml:413 C/fdl-appendix.xml:433 C/fdl-appendix.xml:447 #: C/fdl-appendix.xml:459 C/fdl-appendix.xml:475 C/fdl-appendix.xml:543 msgid "Modified Version" msgstr "" #. (itstool) path: sect1/para #: C/fdl-appendix.xml:72 msgid "" "A <_:quote-1/> of the Document means any work containing the Document or a " "portion of it, either copied verbatim, or with modifications and/or " "translated into another language." msgstr "" #. (itstool) path: para/quote #: C/fdl-appendix.xml:80 msgid "Secondary Section" msgstr "" #. (itstool) path: sect1/para #: C/fdl-appendix.xml:79 msgid "" "A <_:quote-1/> is a named appendix or a front-matter section of the " "<_:link-2/> that deals exclusively with the relationship of the publishers " "or authors of the Document to the Document's overall subject (or to related " "matters) and contains nothing that could fall directly within that overall " "subject. (For example, if the Document is in part a textbook of mathematics, " "a Secondary Section may not explain any mathematics.) The relationship could " "be a matter of historical connection with the subject or with related " "matters, or of legal, commercial, philosophical, ethical or political " "position regarding them." msgstr "" #. (itstool) path: para/quote #. (itstool) path: para/link #: C/fdl-appendix.xml:95 C/fdl-appendix.xml:327 C/fdl-appendix.xml:398 #: C/fdl-appendix.xml:439 C/fdl-appendix.xml:486 C/fdl-appendix.xml:494 #: C/fdl-appendix.xml:567 C/fdl-appendix.xml:637 C/fdl-appendix.xml:648 msgid "Invariant Sections" msgstr "" #. (itstool) path: para/link #: C/fdl-appendix.xml:96 C/fdl-appendix.xml:435 msgid "Secondary Sections" msgstr "" #. (itstool) path: sect1/para #: C/fdl-appendix.xml:94 msgid "" "The <_:quote-1/> are certain <_:link-2/> whose titles are designated, as " "being those of Invariant Sections, in the notice that says that the " "<_:link-3/> is released under this License." msgstr "" #. (itstool) path: para/quote #. (itstool) path: para/link #: C/fdl-appendix.xml:104 C/fdl-appendix.xml:181 C/fdl-appendix.xml:328 #: C/fdl-appendix.xml:458 msgid "Cover Texts" msgstr "" #. (itstool) path: sect1/para #: C/fdl-appendix.xml:103 msgid "" "The <_:quote-1/> are certain short passages of text that are listed, as " "Front-Cover Texts or Back-Cover Texts, in the notice that says that the " "<_:link-2/> is released under this License." msgstr "" #. (itstool) path: para/quote #. (itstool) path: para/link #: C/fdl-appendix.xml:112 C/fdl-appendix.xml:124 C/fdl-appendix.xml:207 #: C/fdl-appendix.xml:369 msgid "Transparent" msgstr "" #. (itstool) path: para/quote #. (itstool) path: para/link #: C/fdl-appendix.xml:125 C/fdl-appendix.xml:204 msgid "Opaque" msgstr "" #. (itstool) path: sect1/para #: C/fdl-appendix.xml:111 msgid "" "A <_:quote-1/> copy of the <_:link-2/> means a machine-readable copy, " "represented in a format whose specification is available to the general " "public, whose contents can be viewed and edited directly and " "straightforwardly with generic text editors or (for images composed of " "pixels) generic paint programs or (for drawings) some widely available " "drawing editor, and that is suitable for input to text formatters or for " "automatic translation to a variety of formats suitable for input to text " "formatters. A copy made in an otherwise Transparent file format whose markup " "has been designed to thwart or discourage subsequent modification by readers " "is not Transparent. A copy that is not <_:quote-3/> is called <_:quote-4/>." msgstr "" #. (itstool) path: sect1/para #: C/fdl-appendix.xml:128 msgid "" "Examples of suitable formats for Transparent copies include plain ASCII " "without markup, Texinfo input format, LaTeX input format, SGML or XML using " "a publicly available DTD, and standard-conforming simple HTML designed for " "human modification. Opaque formats include PostScript, PDF, proprietary " "formats that can be read and edited only by proprietary word processors, " "SGML or XML for which the DTD and/or processing tools are not generally " "available, and the machine-generated HTML produced by some word processors " "for output purposes only." msgstr "" #. (itstool) path: para/quote #. (itstool) path: para/link #: C/fdl-appendix.xml:142 C/fdl-appendix.xml:146 C/fdl-appendix.xml:250 #: C/fdl-appendix.xml:266 C/fdl-appendix.xml:281 C/fdl-appendix.xml:352 msgid "Title Page" msgstr "" #. (itstool) path: sect1/para #: C/fdl-appendix.xml:141 msgid "" "The <_:quote-1/> means, for a printed book, the title page itself, plus such " "following pages as are needed to hold, legibly, the material this License " "requires to appear in the title page. For works in formats which do not have " "any title page as such, <_:quote-2/> means the text near the most prominent " "appearance of the work's title, preceding the beginning of the body of the " "text." msgstr "" #. (itstool) path: sect1/title #: C/fdl-appendix.xml:153 msgid "2. VERBATIM COPYING" msgstr "" #. (itstool) path: para/link #: C/fdl-appendix.xml:166 C/fdl-appendix.xml:551 msgid "section 3" msgstr "" #. (itstool) path: sect1/para #: C/fdl-appendix.xml:154 msgid "" "You may copy and distribute the <_:link-1/> in any medium, either " "commercially or noncommercially, provided that this License, the copyright " "notices, and the license notice saying this License applies to the Document " "are reproduced in all copies, and that you add no other conditions " "whatsoever to those of this License. You may not use technical measures to " "obstruct or control the reading or further copying of the copies you make or " "distribute. However, you may accept compensation in exchange for copies. If " "you distribute a large enough number of copies you must also follow the " "conditions in <_:link-2/>." msgstr "" #. (itstool) path: sect1/para #: C/fdl-appendix.xml:169 msgid "" "You may also lend copies, under the same conditions stated above, and you " "may publicly display copies." msgstr "" #. (itstool) path: sect1/title #: C/fdl-appendix.xml:176 msgid "3. COPYING IN QUANTITY" msgstr "" #. (itstool) path: sect1/para #: C/fdl-appendix.xml:177 msgid "" "If you publish printed copies of the <_:link-1/> numbering more than 100, " "and the Document's license notice requires <_:link-2/>, you must enclose the " "copies in covers that carry, clearly and legibly, all these Cover Texts: " "Front-Cover Texts on the front cover, and Back-Cover Texts on the back " "cover. Both covers must also clearly and legibly identify you as the " "publisher of these copies. The front cover must present the full title with " "all words of the title equally prominent and visible. You may add other " "material on the covers in addition. Copying with changes limited to the " "covers, as long as they preserve the title of the <_:link-3/> and satisfy " "these conditions, can be treated as verbatim copying in other respects." msgstr "" #. (itstool) path: sect1/para #: C/fdl-appendix.xml:195 msgid "" "If the required texts for either cover are too voluminous to fit legibly, " "you should put the first ones listed (as many as fit reasonably) on the " "actual cover, and continue the rest onto adjacent pages." msgstr "" #. (itstool) path: sect1/para #: C/fdl-appendix.xml:202 msgid "" "If you publish or distribute <_:link-1/> copies of the <_:link-2/> numbering " "more than 100, you must either include a machine-readable <_:link-3/> copy " "along with each Opaque copy, or state in or with each Opaque copy a publicly-" "accessible computer-network location containing a complete Transparent copy " "of the Document, free of added material, which the general network-using " "public has access to download anonymously at no charge using public-standard " "network protocols. If you use the latter option, you must take reasonably " "prudent steps, when you begin distribution of Opaque copies in quantity, to " "ensure that this Transparent copy will remain thus accessible at the stated " "location until at least one year after the last time you distribute an " "Opaque copy (directly or through your agents or retailers) of that edition " "to the public." msgstr "" #. (itstool) path: sect1/para #: C/fdl-appendix.xml:222 msgid "" "It is requested, but not required, that you contact the authors of the " "<_:link-1/> well before redistributing any large number of copies, to give " "them a chance to provide you with an updated version of the Document." msgstr "" #. (itstool) path: sect1/title #: C/fdl-appendix.xml:231 msgid "4. MODIFICATIONS" msgstr "" #. (itstool) path: para/link #: C/fdl-appendix.xml:236 msgid "2" msgstr "" #. (itstool) path: para/link #: C/fdl-appendix.xml:237 msgid "3" msgstr "" #. (itstool) path: sect1/para #: C/fdl-appendix.xml:232 msgid "" "You may copy and distribute a <_:link-1/> of the <_:link-2/> under the " "conditions of sections <_:link-3/> and <_:link-4/> above, provided that you " "release the Modified Version under precisely this License, with the Modified " "Version filling the role of the Document, thus licensing distribution and " "modification of the Modified Version to whoever possesses a copy of it. In " "addition, you must do these things in the Modified Version:" msgstr "" #. (itstool) path: formalpara/title #: C/fdl-appendix.xml:248 msgid "A" msgstr "" #. (itstool) path: formalpara/para #: C/fdl-appendix.xml:249 msgid "" "Use in the <_:link-1/> (and on the covers, if any) a title distinct from " "that of the <_:link-2/>, and from those of previous versions (which should, " "if there were any, be listed in the History section of the Document). You " "may use the same title as a previous version if the original publisher of " "that version gives permission." msgstr "" #. (itstool) path: formalpara/title #: C/fdl-appendix.xml:264 msgid "B" msgstr "" #. (itstool) path: formalpara/para #: C/fdl-appendix.xml:265 msgid "" "List on the <_:link-1/>, as authors, one or more persons or entities " "responsible for authorship of the modifications in the <_:link-2/>, together " "with at least five of the principal authors of the <_:link-3/> (all of its " "principal authors, if it has less than five)." msgstr "" #. (itstool) path: formalpara/title #: C/fdl-appendix.xml:279 msgid "C" msgstr "" #. (itstool) path: formalpara/para #: C/fdl-appendix.xml:280 msgid "" "State on the <_:link-1/> the name of the publisher of the <_:link-2/>, as " "the publisher." msgstr "" #. (itstool) path: formalpara/title #: C/fdl-appendix.xml:291 msgid "D" msgstr "" #. (itstool) path: formalpara/para #: C/fdl-appendix.xml:292 msgid "Preserve all the copyright notices of the <_:link-1/>." msgstr "" #. (itstool) path: formalpara/title #: C/fdl-appendix.xml:301 msgid "E" msgstr "" #. (itstool) path: formalpara/para #: C/fdl-appendix.xml:302 msgid "" "Add an appropriate copyright notice for your modifications adjacent to the " "other copyright notices." msgstr "" #. (itstool) path: formalpara/title #: C/fdl-appendix.xml:311 msgid "F" msgstr "" #. (itstool) path: formalpara/para #: C/fdl-appendix.xml:312 msgid "" "Include, immediately after the copyright notices, a license notice giving " "the public permission to use the <_:link-1/> under the terms of this " "License, in the form shown in the Addendum below." msgstr "" #. (itstool) path: formalpara/title #: C/fdl-appendix.xml:324 msgid "G" msgstr "" #. (itstool) path: para/link #: C/fdl-appendix.xml:330 msgid "Document's" msgstr "" #. (itstool) path: formalpara/para #: C/fdl-appendix.xml:325 msgid "" "Preserve in that license notice the full lists of <_:link-1/> and required " "<_:link-2/> given in the <_:link-3/> license notice." msgstr "" #. (itstool) path: formalpara/title #: C/fdl-appendix.xml:337 msgid "H" msgstr "" #. (itstool) path: formalpara/para #: C/fdl-appendix.xml:338 msgid "Include an unaltered copy of this License." msgstr "" #. (itstool) path: formalpara/title #: C/fdl-appendix.xml:346 msgid "I" msgstr "" #. (itstool) path: para/quote #: C/fdl-appendix.xml:348 C/fdl-appendix.xml:353 C/fdl-appendix.xml:372 #: C/fdl-appendix.xml:507 C/fdl-appendix.xml:508 msgid "History" msgstr "" #. (itstool) path: formalpara/para #: C/fdl-appendix.xml:347 msgid "" "Preserve the section entitled <_:quote-1/>, and its title, and add to it an " "item stating at least the title, year, new authors, and publisher of the " "<_:link-2/> as given on the <_:link-3/>. If there is no section entitled " "<_:quote-4/> in the <_:link-5/>, create one stating the title, year, " "authors, and publisher of the Document as given on its Title Page, then add " "an item describing the Modified Version as stated in the previous sentence." msgstr "" #. (itstool) path: formalpara/title #: C/fdl-appendix.xml:365 msgid "J" msgstr "" #. (itstool) path: formalpara/para #: C/fdl-appendix.xml:366 msgid "" "Preserve the network location, if any, given in the <_:link-1/> for public " "access to a <_:link-2/> copy of the Document, and likewise the network " "locations given in the Document for previous versions it was based on. These " "may be placed in the <_:quote-3/> section. You may omit a network location " "for a work that was published at least four years before the Document " "itself, or if the original publisher of the version it refers to gives " "permission." msgstr "" #. (itstool) path: formalpara/title #: C/fdl-appendix.xml:383 msgid "K" msgstr "" #. (itstool) path: para/quote #: C/fdl-appendix.xml:385 C/fdl-appendix.xml:509 msgid "Acknowledgements" msgstr "" #. (itstool) path: para/quote #: C/fdl-appendix.xml:386 C/fdl-appendix.xml:510 msgid "Dedications" msgstr "" #. (itstool) path: formalpara/para #: C/fdl-appendix.xml:384 msgid "" "In any section entitled <_:quote-1/> or <_:quote-2/>, preserve the section's " "title, and preserve in the section all the substance and tone of each of the " "contributor acknowledgements and/or dedications given therein." msgstr "" #. (itstool) path: formalpara/title #: C/fdl-appendix.xml:396 msgid "L" msgstr "" #. (itstool) path: formalpara/para #: C/fdl-appendix.xml:397 msgid "" "Preserve all the <_:link-1/> of the <_:link-2/>, unaltered in their text and " "in their titles. Section numbers or the equivalent are not considered part " "of the section titles." msgstr "" #. (itstool) path: formalpara/title #: C/fdl-appendix.xml:409 msgid "M" msgstr "" #. (itstool) path: para/quote #: C/fdl-appendix.xml:412 C/fdl-appendix.xml:424 C/fdl-appendix.xml:445 msgid "Endorsements" msgstr "" #. (itstool) path: formalpara/para #: C/fdl-appendix.xml:410 msgid "" "Delete any section entitled <_:quote-1/>. Such a section may not be included " "in the <_:link-2/>." msgstr "" #. (itstool) path: formalpara/title #: C/fdl-appendix.xml:421 msgid "N" msgstr "" #. (itstool) path: para/link #: C/fdl-appendix.xml:425 msgid "Invariant Section" msgstr "" #. (itstool) path: formalpara/para #: C/fdl-appendix.xml:422 msgid "" "Do not retitle any existing section as <_:quote-1/> or to conflict in title " "with any <_:link-2/>." msgstr "" #. (itstool) path: sect1/para #: C/fdl-appendix.xml:432 msgid "" "If the <_:link-1/> includes new front-matter sections or appendices that " "qualify as <_:link-2/> and contain no material copied from the Document, you " "may at your option designate some or all of these sections as invariant. To " "do this, add their titles to the list of <_:link-3/> in the Modified " "Version's license notice. These titles must be distinct from any other " "section titles." msgstr "" #. (itstool) path: sect1/para #: C/fdl-appendix.xml:444 msgid "" "You may add a section entitled <_:quote-1/>, provided it contains nothing " "but endorsements of your <_:link-2/> by various parties--for example, " "statements of peer review or that the text has been approved by an " "organization as the authoritative definition of a standard." msgstr "" #. (itstool) path: para/link #: C/fdl-appendix.xml:455 msgid "Front-Cover Text" msgstr "" #. (itstool) path: para/link #: C/fdl-appendix.xml:457 msgid "Back-Cover Text" msgstr "" #. (itstool) path: sect1/para #: C/fdl-appendix.xml:453 msgid "" "You may add a passage of up to five words as a <_:link-1/>, and a passage of " "up to 25 words as a <_:link-2/>, to the end of the list of <_:link-3/> in " "the <_:link-4/>. Only one passage of Front-Cover Text and one of Back-Cover " "Text may be added by (or through arrangements made by) any one entity. If " "the <_:link-5/> already includes a cover text for the same cover, previously " "added by you or by arrangement made by the same entity you are acting on " "behalf of, you may not add another; but you may replace the old one, on " "explicit permission from the previous publisher that added the old one." msgstr "" #. (itstool) path: sect1/para #: C/fdl-appendix.xml:470 msgid "" "The author(s) and publisher(s) of the <_:link-1/> do not by this License " "give permission to use their names for publicity for or to assert or imply " "endorsement of any <_:link-2/>." msgstr "" #. (itstool) path: sect1/title #: C/fdl-appendix.xml:480 msgid "5. COMBINING DOCUMENTS" msgstr "" #. (itstool) path: para/link #: C/fdl-appendix.xml:484 C/fdl-appendix.xml:566 msgid "section 4" msgstr "" #. (itstool) path: sect1/para #: C/fdl-appendix.xml:481 msgid "" "You may combine the <_:link-1/> with other documents released under this " "License, under the terms defined in <_:link-2/> above for modified versions, " "provided that you include in the combination all of the <_:link-3/> of all " "of the original documents, unmodified, and list them all as Invariant " "Sections of your combined work in its license notice." msgstr "" #. (itstool) path: sect1/para #: C/fdl-appendix.xml:492 msgid "" "The combined work need only contain one copy of this License, and multiple " "identical <_:link-1/> may be replaced with a single copy. If there are " "multiple Invariant Sections with the same name but different contents, make " "the title of each such section unique by adding at the end of it, in " "parentheses, the name of the original author or publisher of that section if " "known, or else a unique number. Make the same adjustment to the section " "titles in the list of Invariant Sections in the license notice of the " "combined work." msgstr "" #. (itstool) path: para/quote #: C/fdl-appendix.xml:511 msgid "Endorsements." msgstr "" #. (itstool) path: sect1/para #: C/fdl-appendix.xml:505 msgid "" "In the combination, you must combine any sections entitled <_:quote-1/> in " "the various original documents, forming one section entitled <_:quote-2/>; " "likewise combine any sections entitled <_:quote-3/>, and any sections " "entitled <_:quote-4/>. You must delete all sections entitled <_:quote-5/>" msgstr "" #. (itstool) path: sect1/title #: C/fdl-appendix.xml:516 msgid "6. COLLECTIONS OF DOCUMENTS" msgstr "" #. (itstool) path: sect1/para #: C/fdl-appendix.xml:517 msgid "" "You may make a collection consisting of the <_:link-1/> and other documents " "released under this License, and replace the individual copies of this " "License in the various documents with a single copy that is included in the " "collection, provided that you follow the rules of this License for verbatim " "copying of each of the documents in all other respects." msgstr "" #. (itstool) path: sect1/para #: C/fdl-appendix.xml:527 msgid "" "You may extract a single document from such a collection, and distribute it " "individually under this License, provided you insert a copy of this License " "into the extracted document, and follow this License in all other respects " "regarding verbatim copying of that document." msgstr "" #. (itstool) path: sect1/title #: C/fdl-appendix.xml:537 msgid "7. AGGREGATION WITH INDEPENDENT WORKS" msgstr "" #. (itstool) path: para/quote #: C/fdl-appendix.xml:546 msgid "aggregate" msgstr "" #. (itstool) path: para/link #: C/fdl-appendix.xml:550 msgid "Cover Text" msgstr "" #. (itstool) path: sect1/para #: C/fdl-appendix.xml:538 msgid "" "A compilation of the <_:link-1/> or its derivatives with other separate and " "independent documents or works, in or on a volume of a storage or " "distribution medium, does not as a whole count as a <_:link-2/> of the " "Document, provided no compilation copyright is claimed for the compilation. " "Such a compilation is called an <_:quote-3/>, and this License does not " "apply to the other self-contained works thus compiled with the Document , on " "account of their being thus compiled, if they are not themselves derivative " "works of the Document. If the <_:link-4/> requirement of <_:link-5/> is " "applicable to these copies of the Document, then if the Document is less " "than one quarter of the entire aggregate, the Document's Cover Texts may be " "placed on covers that surround only the Document within the aggregate. " "Otherwise they must appear on covers around the whole aggregate." msgstr "" #. (itstool) path: sect1/title #: C/fdl-appendix.xml:561 msgid "8. TRANSLATION" msgstr "" #. (itstool) path: sect1/para #: C/fdl-appendix.xml:562 msgid "" "Translation is considered a kind of modification, so you may distribute " "translations of the <_:link-1/> under the terms of <_:link-2/>. Replacing " "<_:link-3/> with translations requires special permission from their " "copyright holders, but you may include translations of some or all Invariant " "Sections in addition to the original versions of these Invariant Sections. " "You may include a translation of this License provided that you also include " "the original English version of this License. In case of a disagreement " "between the translation and the original English version of this License, " "the original English version will prevail." msgstr "" #. (itstool) path: sect1/title #: C/fdl-appendix.xml:580 msgid "9. TERMINATION" msgstr "" #. (itstool) path: sect1/para #: C/fdl-appendix.xml:581 msgid "" "You may not copy, modify, sublicense, or distribute the <_:link-1/> except " "as expressly provided for under this License. Any other attempt to copy, " "modify, sublicense or distribute the Document is void, and will " "automatically terminate your rights under this License. However, parties who " "have received copies, or rights, from you under this License will not have " "their licenses terminated so long as such parties remain in full compliance." msgstr "" #. (itstool) path: sect1/title #: C/fdl-appendix.xml:594 msgid "10. FUTURE REVISIONS OF THIS LICENSE" msgstr "" #. (itstool) path: para/ulink #: C/fdl-appendix.xml:597 msgid "Free Software Foundation" msgstr "" #. (itstool) path: para/ulink #: C/fdl-appendix.xml:603 msgid "http://www.gnu.org/copyleft/" msgstr "" #. (itstool) path: sect1/para #: C/fdl-appendix.xml:595 msgid "" "The <_:ulink-1/> may publish new, revised versions of the GNU Free " "Documentation License from time to time. Such new versions will be similar " "in spirit to the present version, but may differ in detail to address new " "problems or concerns. See <_:ulink-2/>." msgstr "" #. (itstool) path: para/quote #: C/fdl-appendix.xml:610 msgid "or any later version" msgstr "" #. (itstool) path: sect1/para #: C/fdl-appendix.xml:606 msgid "" "Each version of the License is given a distinguishing version number. If the " "<_:link-1/> specifies that a particular numbered version of this License " "<_:quote-2/> applies to it, you have the option of following the terms and " "conditions either of that specified version or of any later version that has " "been published (not as a draft) by the Free Software Foundation. If the " "Document does not specify a version number of this License, you may choose " "any version ever published (not as a draft) by the Free Software Foundation." msgstr "" #. (itstool) path: sect1/title #: C/fdl-appendix.xml:621 msgid "Addendum" msgstr "" #. (itstool) path: sect1/para #: C/fdl-appendix.xml:622 msgid "" "To use this License in a document you have written, include a copy of the " "License in the document and put the following copyright and license notices " "just after the title page:" msgstr "" #. (itstool) path: blockquote/para #: C/fdl-appendix.xml:629 msgid "Copyright YEAR YOUR NAME." msgstr "" #. (itstool) path: para/link #: C/fdl-appendix.xml:639 C/fdl-appendix.xml:651 msgid "Front-Cover Texts" msgstr "" #. (itstool) path: para/link #: C/fdl-appendix.xml:640 C/fdl-appendix.xml:654 msgid "Back-Cover Texts" msgstr "" #. (itstool) path: blockquote/para #: C/fdl-appendix.xml:632 msgid "" "Permission is granted to copy, distribute and/or modify this document under " "the terms of the GNU Free Documentation License, Version 1.1 or any later " "version published by the Free Software Foundation; with the <_:link-1/> " "being LIST THEIR TITLES, with the <_:link-2/> being LIST, and with the " "<_:link-3/> being LIST. A copy of the license is included in the section " "entitled <_:quote-4/>." msgstr "" #. (itstool) path: para/quote #: C/fdl-appendix.xml:649 msgid "with no Invariant Sections" msgstr "" #. (itstool) path: para/quote #: C/fdl-appendix.xml:652 msgid "no Front-Cover Texts" msgstr "" #. (itstool) path: para/quote #: C/fdl-appendix.xml:653 msgid "Front-Cover Texts being LIST" msgstr "" #. (itstool) path: sect1/para #: C/fdl-appendix.xml:647 msgid "" "If you have no <_:link-1/>, write <_:quote-2/> instead of saying which ones " "are invariant. If you have no <_:link-3/>, write <_:quote-4/> instead of " "<_:quote-5/>; likewise for <_:link-6/>." msgstr "" #. (itstool) path: para/ulink #: C/fdl-appendix.xml:661 msgid "GNU General Public License" msgstr "" #. (itstool) path: sect1/para #: C/fdl-appendix.xml:657 msgid "" "If your document contains nontrivial examples of program code, we recommend " "releasing these examples in parallel under your choice of free software " "license, such as the <_:ulink-1/>, to permit their use in free software." msgstr ""