<?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="ca">

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

    <mal:credit xmlns:mal="http://projectmallard.org/1.0/" type="translator copyright">
      <mal:name>Miquel-Àngel Burgos i Fradeja</mal:name>
      <mal:email>miquel.angel.burgos@gmail.com</mal:email>
      <mal:years>2020</mal:years>
    </mal:credit>
  </info>

<title>Format del llibre</title>

<synopsis>
  <p>Al <app>Devhelp</app>, un «llibre» és la documentació de l'API d'un mòdul o paquet (normalment, una biblioteca). Aquesta pàgina descriu el format que un llibre ha de seguir perquè el <app>Devhelp</app> el reconegui.</p>
</synopsis>

<p>El contingut d'un llibre es col·loca en un directori (aquest directori conté un sol llibre, no pot contenir-ne diversos). El directori es compon de:</p>
<list>
  <item><p>pàgines HTML amb possibles fitxers CSS, imatges, etc., i</p></item>
  <item><p>Un fitxer d'índex amb l'extensió de fitxer <file>*.devhelp2</file>. Vegeu <link xref="index-file-format"/> per a més informació.</p></item>
</list>
<note>
  <p>Restricció: el nom del directori on és el fitxer <file>*.devhelp2</file> i el nom del fitxer <file>*.devhelp2</file> (sense l'extensió) han de coincidir. En altres paraules, si el directori del llibre s'anomena <code>$book_name</code>, el camí absolut al fitxer d'índex ha d'acabar amb <code>$book_name/$book_name.devhelp2</code>. D'aquesta manera, quan el <app>Devhelp</app> coneix el nom del directori, també coneix directament la ubicació del fitxer d'índex.</p>
</note>
</page>
