|
1.
|
|
|
translator-credits
|
Context: |
|
_
|
|
|
Put one translator per line, in the form NAME <EMAIL>, YEAR1, YEAR2
|
|
|
|
To prevent privacy issues, this translation is not
available to anonymous users,
if you want to see it, please, log in
first.
|
|
2.
|
|
|
Book format
|
|
|
(itstool) path: page/title
(itstool) path: section/title
|
|
|
|
(no translation yet)
|
|
|
|
Located in
C/book-format.page:14
C/installing-api-documentation.page:23
|
|
3.
|
|
|
A “book” in <app>Devhelp</app> 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 <app>Devhelp</app> to recognize it.
|
|
|
(itstool) path: synopsis/p
|
|
|
|
(no translation yet)
|
|
|
|
Located in
C/book-format.page:17
|
|
4.
|
|
|
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:
|
|
|
(itstool) path: page/p
|
|
|
|
(no translation yet)
|
|
|
|
Located in
C/book-format.page:24
|
|
5.
|
|
|
HTML pages, plus possibly CSS files, images, etc;
|
|
|
(itstool) path: item/p
|
|
|
|
(no translation yet)
|
|
|
|
Located in
C/book-format.page:30
|
|
6.
|
|
|
An index file with the <file>*.devhelp2</file> file extension, see <link xref="index-file-format"/> for more information.
|
|
|
(itstool) path: item/p
|
|
|
|
(no translation yet)
|
|
|
|
Located in
C/book-format.page:33
|
|
7.
|
|
|
Restriction: the name of the directory the <file>*.devhelp2</file> file is in and the name of the <file>*.devhelp2</file> file (minus the extension) must match. In other words, if the book directory is called <code>$book_name</code>, then the absolute path to the index file should end with <code>$book_name/$book_name.devhelp2</code>. That way, when <app>Devhelp</app> knows the directory name, it directly knows the location to the index file.
|
|
|
(itstool) path: note/p
|
|
|
|
(no translation yet)
|
|
|
|
Located in
C/book-format.page:39
|
|
8.
|
|
|
Index file format
|
|
|
(itstool) path: page/title
|
|
|
|
(no translation yet)
|
|
|
|
Located in
C/index-file-format.page:14
|
|
9.
|
|
|
This page describes the purpose and the format of <file>*.devhelp2</file> index files.
|
|
|
(itstool) path: synopsis/p
|
|
|
|
(no translation yet)
|
|
|
|
Located in
C/index-file-format.page:17
|
|
10.
|
|
|
A book (see <link xref="book-format"/>) contains one index file. The index file has the extension <file>.devhelp2</file> and has an XML format.
|
|
|
(itstool) path: page/p
|
|
|
|
(no translation yet)
|
|
|
|
Located in
C/index-file-format.page:23
|