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

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

    <mal:credit xmlns:mal="http://projectmallard.org/1.0/" type="translator copyright">
      <mal:name>Fran Diéguez</mal:name>
      <mal:email>frandieguez@gnome.org</mal:email>
      <mal:years>2022</mal:years>
    </mal:credit>
  </info>

<title>Formato de libro</title>

<synopsis>
  <p>Un «libro» in <app>Devhelp</app> é unha documentación de API para un módulo, ou paquete (normalmente unha biblioteca). Esta páxina describe o formato que un libre precisa para seguir para que <app>Devhelp</app> o recoñeza.</p>
</synopsis>

<p>O contido dun libro móstrase nun cartafol (ese cartafol contén só un libro, non pode conter varios libros). O cartafol está composto por:</p>
<list>
  <item><p>As páxinas HTML, así como os ficheiros CSS, imaxes, etc;</p></item>
  <item><p>Un ficheiro de índice coa extensión de ficheiro <file>*.devhelp2</file>, vexa <link xref="index-file-format"/> para obter máis información.</p></item>
</list>
<note>
  <p>Restrición: o nome do cartafol do ficheiro <file>*.devhelp2</file> está no nome do ficheiro e o nome do ficheiro <file>*.devhelp2</file> (salvo a extensión) deben coincidir. Noutras palabras, se o cartafol do libro chámase <code>$nome_libro</code>, entón a ruta absoluta do ficheiro de índice debería rematar con <code>$nome_libro/$nome_libro.devhelp2</code>. Desta forma, cando <app>Devhelp</app> coñece o nome do cartafol, directamente sabe a localización do ficheiro de índice.</p>
</note>
</page>
