Default page

Your IP: 216.73.216.91
Server IP: 157.245.101.34
Server: Linux skvinfotech-website 5.4.0-131-generic #147-Ubuntu SMP Fri Oct 14 17:07:22 UTC 2022 x86_64
Server Software: Apache/2.4.41 (Ubuntu)
PHP Version: 7.4.33
Buat File | Buat Folder

Edit File: index-file-format.page

<?xml version="1.0" encoding="utf-8"?>

<page xmlns="http://projectmallard.org/1.0/" xmlns:its="http://www.w3.org/2005/11/its" type="topic" id="index-file-format" xml:lang="fr">

<mal:credit xmlns:mal="http://projectmallard.org/1.0/" type="translator copyright">
 <mal:name>Charles Monzat</mal:name>
 <mal:email>charles.monzat@numericable.fr</mal:email>
 <mal:years>2018.</mal:years>
 </mal:credit>
 </info>

<title>Index file format</title>

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

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.

<note>
 
 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.
 
</note>

The index file mainly contains:

<list>
 <item>
 The book structure (like a table of contents).
 </item>
 <item>
 A list of symbols (functions, types, macros, signals, properties, …).
 </item>
</list>

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


 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.

<section id="devhelp2-index-format">
 <title>Specification of the <file>*.devhelp2</file> XML file format</title>
 
 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.
 
</section>
</page>