|
|
11.
|
|
|
The “2” in the <file>*.devhelp2</file> file extension is because it is the second version of the file format. The first version of the format, with the <file>*.devhelp</file> file extension, is deprecated and its support in <app>Devhelp</app> may be removed in the future. On application startup, when <app>Devhelp</app> scans the filesystem to find books, it emits a warning message in the terminal for each book that uses a deprecated format.
|
|
|
(itstool) path: note/p
|
|
|
|
|
(no translation yet)
|
|
|
|
Located in
C/index-file-format.page:29
|
|
|
12.
|
|
|
The index file mainly contains:
|
|
|
(itstool) path: page/p
|
|
|
|
|
(no translation yet)
|
|
|
|
Located in
C/index-file-format.page:40
|
|
|
13.
|
|
|
The book structure (like a table of contents).
|
|
|
(itstool) path: item/p
|
|
|
|
|
(no translation yet)
|
|
|
|
Located in
C/index-file-format.page:44
|
|
|
14.
|
|
|
A list of symbols (functions, types, macros, signals, properties, …).
|
|
|
(itstool) path: item/p
|
|
|
|
|
(no translation yet)
|
|
|
|
Located in
C/index-file-format.page:47
|
|
|
15.
|
|
|
These contain links to the HTML files to reach the corresponding pages and symbols.
|
|
|
(itstool) path: page/p
|
|
|
|
|
(no translation yet)
|
|
|
|
Located in
C/index-file-format.page:51
|
|
|
16.
|
|
|
In <app>Devhelp</app> the book structure is shown in the side panel. And the <link xref="search">search in the side panel</link> shows results found in the index files.
|
|
|
(itstool) path: page/p
|
|
|
|
|
(no translation yet)
|
|
|
|
Located in
C/index-file-format.page:55
|
|
|
17.
|
|
|
Specification of the <file>*.devhelp2</file> XML file format
|
|
|
(itstool) path: section/title
|
|
|
|
|
(no translation yet)
|
|
|
|
Located in
C/index-file-format.page:62
|
|
|
18.
|
|
|
Unfortunately the <file>*.devhelp2</file> 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 <link xref="installing-api-documentation#gtk-doc">GTK-Doc</link> generates. For the most precise definition of what <app>Devhelp</app> supports, read the parser source code and the <app>Devhelp</app> API reference.
|
|
|
(itstool) path: section/p
|
|
|
|
|
(no translation yet)
|
|
|
|
Located in
C/index-file-format.page:63
|
|
|
19.
|
|
|
Devhelp User Documentation
|
|
|
(itstool) path: page/title
|
|
|
|
|
(no translation yet)
|
|
|
|
Located in
C/index.page:8
|
|
|
20.
|
|
|
Devhelp is a developer tool for browsing and searching API documentation.
|
|
|
(itstool) path: synopsis/p
|
|
|
|
|
(no translation yet)
|
|
|
|
Located in
C/index.page:11
|
