<?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="book-format" xml:lang="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 livre</title>

<synopsis>
  <p>Dans <app>Devhelp</app>, un « livre » est la documentation d’API pour un module ou un paquet (généralement une bibliothèque). Cette page décrit le format dont le livre a besoin pour que <app>Devhelp</app> le reconnaisse.</p>
</synopsis>

<p>Le contenu d’un livre est placé dans un répertoire (ce répertoire ne contient qu’un seul livre, et ne peut en contenir plusieurs). Le répertoire est composé :</p>
<list>
  <item><p>De pages HTML, plus éventuellement des fichiers CSS, des images, etc.</p></item>
  <item><p>D’un fichier de sommaire avec l’extension de fichier <file>*.devhelp2</file>. Consultez <link xref="index-file-format"/> pour plus d’informations.</p></item>
</list>
<note>
  <p>Limitation : le nom du répertoire dans lequel se trouve le fichier <file>*.devhelp2</file> et le nom du fichier <file>*.devhelp2</file> (sans l’extension) doivent correspondre. En d’autres termes, si le répertoire du livre se nomme <code>$book_name</code>, alors le chemin absolu vers le fichier de sommaire doit se terminer par <code>$book_name/$book_name.devhelp2</code>. De cette façon, lorsque <app>Devhelp</app> connaît le nom du répertoire, il peut directement en déduire le nom du fichier sommaire.</p>
</note>
</page>
