<?xml version="1.0" encoding="utf-8"?>
<!--
SPDX-FileCopyrightText: 2019 Sébastien Wilmet <swilmet@gnome.org>
SPDX-License-Identifier: CC-BY-SA-4.0
-->
<page xmlns="http://projectmallard.org/1.0/" xmlns:its="http://www.w3.org/2005/11/its" type="topic" id="index-file-format" xml:lang="devhelp-fr">

<info>
  <link type="guide" xref="index"/>

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

<title>Format de fichier de sommaire</title>

<synopsis>
  <p>Cette page décrit le but et le format des fichiers de sommaire <file>*.devhelp2</file>.</p>
</synopsis>

<p>Un livre (voir <link xref="book-format"/>) contient un fichier de sommaire. Le fichier de sommaire possède l’extension <file>.devhelp2</file> et est écrit en format XML.</p>

<note>
  <p>Le chiffre « 2 » dans l’extension de fichier <file>*.devhelp2</file> est dû au fait qu’il s’agit de la deuxième version du format de fichier. La première version du format, comportant l’extension de fichier <file>*.devhelp</file>, est obsolète et sa prise en charge dans <app>Devhelp</app> peut être supprimée à l’avenir. Au démarrage de l’application, lorsque <app>Devhelp</app> analyse le système de fichiers pour trouver des livres, il émet un message d’avertissement dans le terminal pour chaque livre qui utilise un format obsolète.</p>
</note>

<p>Le fichier de sommaire contient principalement :</p>
<list>
  <item><p>La structure du livre (comme une table des matières).</p></item>
  <item><p>Une liste de symboles (fonctions, types, macros, signaux, propriétés…).</p></item>
</list>
<p>Ceux-ci contiennent des liens vers les fichiers HTML pour accéder aux pages et symboles correspondants.</p>
<p>Dans <app>Devhelp</app>, la structure du livre est affichée dans le panneau latéral. Quant à la <link xref="search">recherche dans le panneau latéral</link>, elle affiche les résultats trouvés dans les fichiers de sommaire.</p>

<section id="devhelp2-index-format">
  <title>Caractéristiques du format de fichier XML <file>*.devhelp2</file></title>
  <p>Malheureusement, le format de fichier XML <file>*.devhelp2</file> est très peu documenté. Cela sera sans doute corrigé dans un futur proche. En attendant, nous vous recommandons de regarder ce que génère <link xref="installing-api-documentation#gtk-doc">GTK-Doc</link>. Pour obtenir la définition la plus précise de ce que <app>Devhelp</app> prend en charge, lisez le code source de l’analyseur et la référence d’API de <app>Devhelp</app>.</p>
</section>
</page>
