msgid "" msgstr "" "Project-Id-Version: PACKAGE VERSION\n" "POT-Creation-Date: 2025-09-02 23:18+0000\n" "PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n" "Last-Translator: FULL NAME \n" "Language-Team: LANGUAGE \n" "MIME-Version: 1.0\n" "Content-Type: text/plain; charset=UTF-8\n" "Content-Transfer-Encoding: 8bit\n" #. Put one translator per line, in the form NAME , YEAR1, YEAR2 msgctxt "_" msgid "translator-credits" msgstr "" #. (itstool) path: page/title #. (itstool) path: section/title #: C/book-format.page:14 #: C/installing-api-documentation.page:23 msgid "Book format" msgstr "" #. (itstool) path: synopsis/p #: C/book-format.page:17 msgid "A “book” in Devhelp is the API documentation for one module, or package (usually a library). This page describes the format that a book needs to follow in order for Devhelp to recognize it." msgstr "" #. (itstool) path: page/p #: C/book-format.page:24 msgid "The content of a book is placed in one directory (that directory contains only one book, it cannot contain several books). The directory is comprised of:" msgstr "" #. (itstool) path: item/p #: C/book-format.page:30 msgid "HTML pages, plus possibly CSS files, images, etc;" msgstr "" #. (itstool) path: item/p #: C/book-format.page:33 msgid "An index file with the *.devhelp2 file extension, see for more information." msgstr "" #. (itstool) path: note/p #: C/book-format.page:39 msgid "Restriction: the name of the directory the *.devhelp2 file is in and the name of the *.devhelp2 file (minus the extension) must match. In other words, if the book directory is called $book_name, then the absolute path to the index file should end with $book_name/$book_name.devhelp2. That way, when Devhelp knows the directory name, it directly knows the location to the index file." msgstr "" #. (itstool) path: page/title #: C/index-file-format.page:14 msgid "Index file format" msgstr "" #. (itstool) path: synopsis/p #: C/index-file-format.page:17 msgid "This page describes the purpose and the format of *.devhelp2 index files." msgstr "" #. (itstool) path: page/p #: C/index-file-format.page:23 msgid "A book (see ) contains one index file. The index file has the extension .devhelp2 and has an XML format." msgstr "" #. (itstool) path: note/p #: C/index-file-format.page:29 msgid "The “2” in the *.devhelp2 file extension is because it is the second version of the file format. The first version of the format, with the *.devhelp file extension, is deprecated and its support in Devhelp may be removed in the future. On application startup, when Devhelp scans the filesystem to find books, it emits a warning message in the terminal for each book that uses a deprecated format." msgstr "" #. (itstool) path: page/p #: C/index-file-format.page:40 msgid "The index file mainly contains:" msgstr "" #. (itstool) path: item/p #: C/index-file-format.page:44 msgid "The book structure (like a table of contents)." msgstr "" #. (itstool) path: item/p #: C/index-file-format.page:47 msgid "A list of symbols (functions, types, macros, signals, properties, …)." msgstr "" #. (itstool) path: page/p #: C/index-file-format.page:51 msgid "These contain links to the HTML files to reach the corresponding pages and symbols." msgstr "" #. (itstool) path: page/p #: C/index-file-format.page:55 msgid "In Devhelp the book structure is shown in the side panel. And the search in the side panel shows results found in the index files." msgstr "" #. (itstool) path: section/title #: C/index-file-format.page:62 msgid "Specification of the *.devhelp2 XML file format" msgstr "" #. (itstool) path: section/p #: C/index-file-format.page:63 msgid "Unfortunately the *.devhelp2 XML file format is not well documented. There is still some hope that it will be fixed in the near future. In the meantime, we recommend to look at what GTK-Doc generates. For the most precise definition of what Devhelp supports, read the parser source code and the Devhelp API reference." msgstr "" #. (itstool) path: info/title #: C/index.page:10 msgctxt "link:trail" msgid "Devhelp User Documentation" msgstr "" #. (itstool) path: info/title #: C/index.page:11 msgctxt "text" msgid "Devhelp User Documentation" msgstr "" #. (itstool) path: info/title #: C/index.page:12 msgctxt "link" msgid "Devhelp User Documentation" msgstr "" #. (itstool) path: info/desc #: C/index.page:14 msgid "Devhelp User Documentation" msgstr "" #. (itstool) path: page/title #: C/index.page:17 msgid "<_:media-1/> Devhelp User Documentation" msgstr "" #. (itstool) path: synopsis/p #: C/index.page:23 msgid "Devhelp is a developer tool for browsing and searching API documentation." msgstr "" #. (itstool) path: page/title #: C/installing-api-documentation.page:14 msgid "Installing API documentation" msgstr "" #. (itstool) path: synopsis/p #: C/installing-api-documentation.page:17 msgid "How Devhelp finds the API documentation." msgstr "" #. (itstool) path: section/p #: C/installing-api-documentation.page:24 msgid "See for information on the API documentation format that Devhelp recognizes." msgstr "" #. (itstool) path: section/title #: C/installing-api-documentation.page:31 msgid "Books locations" msgstr "" #. (itstool) path: section/p #: C/installing-api-documentation.page:32 msgid "Once a book follows the right format, its directory needs to be installed at a location where Devhelp will find it." msgstr "" #. (itstool) path: section/p #: C/installing-api-documentation.page:36 msgid "Devhelp uses the XDG Base Directory Specification to find the books. The list of locations searched is:" msgstr "" #. (itstool) path: section/p #: C/installing-api-documentation.page:47 msgid "Note that the two latter consist of lists of directories to look for. Directory values are separated by : characters. Those environment variables are normally set up by the desktop environment or distribution." msgstr "" #. (itstool) path: section/p #: C/installing-api-documentation.page:53 msgid "Examples of locations to index files with $XDG_DATA_HOME on a typical system:" msgstr "" #. (itstool) path: item/p #: C/installing-api-documentation.page:61 msgid "~/.var/app/org.gnome.Devhelp/data/devhelp/books/glib/glib.devhelp2 if Devhelp is launched with Flatpak." msgstr "" #. (itstool) path: section/p #: C/installing-api-documentation.page:67 msgid "Example of a location to an index file with $XDG_DATA_DIRS on a typical system:" msgstr "" #. (itstool) path: section/title #: C/installing-api-documentation.page:79 msgid "GTK-Doc" msgstr "" #. (itstool) path: section/p #: C/installing-api-documentation.page:80 msgid "GTK-Doc is a tool to generate API documentation from comments added to C code. It is used by GLib, GTK and GNOME libraries and applications." msgstr "" #. (itstool) path: section/p #: C/installing-api-documentation.page:85 msgid "GTK-Doc installs the API reference of a module into:" msgstr "" #. (itstool) path: section/p #: C/installing-api-documentation.page:91 msgid "It follows the book format supported by Devhelp. So by using GTK-Doc, the API reference can be browsed in Devhelp automatically (once installed in the right location, that is)." msgstr "" #. (itstool) path: page/title #: C/search.page:14 msgid "Search in the side panel" msgstr "" #. (itstool) path: synopsis/p #: C/search.page:17 msgid "How the search in the side panel works." msgstr "" #. (itstool) path: section/title #: C/search.page:21 msgid "Case sensitivity" msgstr "" #. (itstool) path: section/p #: C/search.page:22 msgid "The search is case sensitive when there is an uppercase letter. If the search terms are all in lowercase, the search is case insensitive. It's like the “smartcase” feature present in some text editors." msgstr "" #. (itstool) path: section/title #: C/search.page:30 msgid "Glob-style pattern matching" msgstr "" #. (itstool) path: section/p #: C/search.page:31 msgid "A search term can be a pattern containing ‘*’ and ‘?’ wildcards. ‘*’ matches an arbitrary, possibly empty, string; and ‘?’ matches an arbitrary character." msgstr "" #. (itstool) path: section/title #: C/search.page:39 msgid "Several search terms" msgstr "" #. (itstool) path: section/p #: C/search.page:40 msgid "You can search with several search terms (separated by spaces). A symbol will match only if all the search terms individually match (not necessarily in the same order of appearance)." msgstr "" #. (itstool) path: section/p #: C/search.page:45 msgid "Note that it is different than searching with the ‘*’ wildcard: with the ‘*’ wildcard it forces the keywords to be in the same order." msgstr "" #. (itstool) path: section/p #: C/search.page:49 msgid "For example when searching “gtk window application”, it matches both “gtk_window_get_application()” and “GtkApplicationWindow” (among other symbols)." msgstr "" #. (itstool) path: section/p #: C/search.page:54 msgid "On the other hand, searching “gtk*window*application” will match “gtk_window_get_application()” but not “GtkApplicationWindow”." msgstr ""