<?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="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 ficheiro de índice</title>

<synopsis>
  <p>Esta páxina describe o propósito e o formato dos ficheiros de índice <file>*.devhelp2</file>.</p>
</synopsis>

<p>Un libro (vexa <link xref="book-format"/>) contén un ficheiro de índice. O ficheiro de índice ten unha extensión <file>.devhelp2</file> e un formato XML.</p>

<note>
  <p>O «2» na extensión de ficheiro <file>*.devhelp2</file> está porque é a segunda versión do formato de ficheiro. A primeira versión do formato, coa extensión de ficheiro <file>*.devhelp</file>, está obsoleto e a compatibilidade en <app>Devhelp</app> podería retirarse no futuro. Ao inicio da aplicación, cando <app>Devhelp</app> analiza o sistema de ficheiros para buscar libros, emite un mensaxe de aviso na terminal para cada libro que use o formato obsoleto.</p>
</note>

<p>Un ficheiro de índice contén principalmente:</p>
<list>
  <item><p>A estrutura dun libro (como unha táboa de contidos).</p></item>
  <item><p>Unha lista de símbolos (función, tipos, macros, sinais, propiedades, …).</p></item>
</list>
<p>Estes conteñen ligazóns a ficheiros HTML para chegar ás páxinas e símbolos correspondentes.</p>
<p>En <app>Devhelp</app> a estrutura dun libro móstrase no panel lateral. E a <link xref="search">busca no panel lateral</link> mostra os resultados atopados nos ficheiros de índice.</p>

<section id="devhelp2-index-format">
  <title>A especificación do formato de ficheiro XML <file>*.devhelp2</file></title>
  <p>Desafortunadamente o formato de ficheiro XML de <file>*.devhelp2</file> non está ben documentado. Aínda hai esperanza que isto se arranxe no futuro cercano. Namentres, recomendámoslle mirar o que xera <link xref="installing-api-documentation#gtk-doc">GTK-Doc</link>. Para unha definición máis precisa do que <app>Devhelp</app> admite, lea o código fonte do analizador e a referencia da API de <app>Devhelp</app>.</p>
</section>
</page>
