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

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

    <mal:credit xmlns:mal="http://projectmallard.org/1.0/" type="translator copyright">
      <mal:name>Daniel Mustieles</mal:name>
      <mal:email>daniel.mustieles@gmail.com</mal:email>
      <mal:years>2018-2021</mal:years>
    </mal:credit>
  </info>

<title>Formato del archivo índice</title>

<synopsis>
  <p>Esta página describe el propósito y el formato de los archivos <file>*.devhelp2</file> índice.</p>
</synopsis>

<p>Un libro (consulte la sección <link xref="book-format"/>) sólo contiene un archivo índice. Este archivo tiene la extensión <file>.devhelp2</file> y está en formato XML.</p>

<note>
  <p>El «2» en la extensión <file>*.devhelp2</file> del archivo se debe a que es la segunda versión del formato del archivo. La primera versión del formato, con la extensión <file>*.devhelp</file>, está obsoleta y su soporte en <app>Devhelp</app> se eliminará en un futuro. Al iniciar la aplicación, cuando <app>Devhelp</app> analiza el sistema de archivos para buscar libros, muestra un mensaje de advertencia en la consola por cada libro que usa un formato obsoleto.</p>
</note>

<p>El archivo índice contiene:</p>
<list>
  <item><p>La estructura del libro (como una tabla de contenidos).</p></item>
  <item><p>Una lista de símbolos (funciones, tipos, macros, señales, propiedades, etc).</p></item>
</list>
<p>Este contiene enlaces a los archivos HTML para llegar a las páginas y símbolos correspondientes.</p>
<p>En <app>Devhelp</app> la estructura del libro del libro se muestra en el panel lateral. Y la <link xref="search">búsqueda en el panel lateral</link> muestra lo resultados encontrados en los archivos índice.</p>

<section id="devhelp2-index-format">
  <title>Especificación del formato de archivo XML <file>*.devhelp2</file></title>
  <p>El formato de archivo XML <file>*.devhelp2</file> no estña bien documentado. Todavía se espera que esto se solucione en un futuro cercano, pero mientras tanto se recomienda consultar lo que genera <link xref="installing-api-documentation#gtk-doc">GTK-Doc</link>. Para una definición más precisa de lo que soporta <app>Devhelp</app> lea el código fuente del analizador y la referencia de la API de <app>Devhelp</app>.</p>
</section>
</page>
