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

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

<title>Indizearen fitxategi-formatua</title>

<synopsis>
  <p>Orri honek <file>*.devhelp2</file> indize-fitxategien xedea eta formatua deskribatzen ditu.</p>
</synopsis>

<p>Liburu batek (ikus <link xref="book-format"/>) indize-fitxategi bat du. Indize-fitxategiak <file>.devhelp2</file> luzapena du eta XML formatuko da.</p>

<note>
  <p>
    The “2” in the <file>*.devhelp2</file> file extension is because it is the
    second version of the file format. The first version of the format, with
    the <file>*.devhelp</file> file extension, is deprecated and its support in
    <app>Devhelp</app> may be removed in the future. On application startup,
    when <app>Devhelp</app> scans the filesystem to find books, it emits a
    warning message in the terminal for each book that uses a deprecated
    format.
  </p>
</note>

<p>Indize-fitxategiak honakoak ditu gehien bat:</p>
<list>
  <item><p>Liburuaren egitura (aurkibide antzeko bat).</p></item>
  <item><p>Ikurren zerrenda bat (funtzioak, motak, makroak, seinaleak, propietateak...).</p></item>
</list>
<p>Honek HTML fitxategien estekak ditu, bakoitzari dagokion orria edo ikurra atzitzeko.</p>
<p>
  In <app>Devhelp</app> the book structure is shown in the side panel. And the
  <link xref="search">search in the side panel</link> shows results found in
  the index files.
</p>

<section id="devhelp2-index-format">
  <title><file>*.devhelp2</file> XML fitxategi-formatuaren espezifikazioa</title>
  <p>
    Unfortunately the <file>*.devhelp2</file> XML file format is not well
    documented. There is still some hope that it will be fixed in the near
    future. In the meantime, we recommend to look at what
    <link xref="installing-api-documentation#gtk-doc">GTK-Doc</link> generates.
    For the most precise definition of what <app>Devhelp</app> supports, read
    the parser source code and the <app>Devhelp</app> API reference.
  </p>
</section>
</page>
