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

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

<title>Liburu-formatua</title>

<synopsis>
  <p><app>Devhelp</app> aplikazioan, “liburu“ bat modulu edo pakete (normalean liburutegi bat) baten API dokumentazioa da. Orri honek liburu batek izan behar duen formatua deskribatzen du <app>Devhelp</app> aplikazioak hura ezagutu dezan.</p>
</synopsis>

<p>Liburu baten edukia direktorio batean kokatzen da (direktorio horrek liburu bakarra da, ezin ditu liburu anitz eduki). Direktorioak honako elementuak ditu:</p>
<list>
  <item><p>HTML orriak, balizko CSS fitxategiak, irudiak, etab.;</p></item>
  <item><p><file>*.devhelp2</file> fitxategi-luzapena duen indize-fitxategi bat, ikus <link xref="index-file-format"/> informazio gehiagorako.</p></item>
</list>
<note>
  <p>
    Restriction: the name of the directory the <file>*.devhelp2</file> file is
    in and the name of the <file>*.devhelp2</file> file (minus the extension)
    must match. In other words, if the book directory is called
    <code>$book_name</code>, then the absolute path to the index file should
    end with <code>$book_name/$book_name.devhelp2</code>. That way, when
    <app>Devhelp</app> knows the directory name, it directly knows the location
    to the index file.
  </p>
</note>
</page>
