Browsing Uyghur translation

6.

An index file with the <file>*.devhelp2</file> file extension, see <link xref="index-file-format"/> for more information.

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.

8.

Index file format

9.

This page describes the purpose and the format of <file>*.devhelp2</file> index files.

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.

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.

12.

The index file mainly contains:

13.

The book structure (like a table of contents).

14.

A list of symbols (functions, types, macros, signals, properties, …).

15.

These contain links to the HTML files to reach the corresponding pages and symbols.