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

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

    <mal:credit xmlns:mal="http://projectmallard.org/1.0/" type="translator copyright">
      <mal:name>Miquel-Àngel Burgos i Fradeja</mal:name>
      <mal:email>miquel.angel.burgos@gmail.com</mal:email>
      <mal:years>2020</mal:years>
    </mal:credit>
  </info>

<title>Format del fitxer d'índex</title>

<synopsis>
  <p>Aquesta pàgina descriu el propòsit i el format dels fitxers d'índex <file>*.devhelp2</file>.</p>
</synopsis>

<p>Un llibre (vegeu <link xref="book-format"/>) conté un fitxer d'índex. El fitxer d'índex té l'extensió <file>.devhelp2</file> i format XML.</p>

<note>
  <p>El «2» de l'extensió de fitxer <file>*.devhelp2</file> es deu al fet que és la segona versió del format de fitxers. La primera versió del format, amb l'extensió de fitxer <file>*.devhelp</file>, és obsoleta i pot deixar de tenir compatibilitat al <app>Devhelp</app> en el futur. En iniciar l'aplicació, quan el <app>Devhelp</app> escaneja el sistema de fitxers cercant llibres, emet un missatge d'avís al terminal per cada llibre que utilitza un format obsolet.</p>
</note>

<p>El fitxer d'índex conté principalment:</p>
<list>
  <item><p>L'estructura del llibre (una mena de taula de continguts).</p></item>
  <item><p>Una llista de símbols (funcions, tipus, macros, senyals, propietats, etc.).</p></item>
</list>
<p>Aquests elements contenen enllaços als fitxers HTML per a arribar a les pàgines i símbols corresponents.</p>
<p>Al <app>Devhelp</app>, l'estructura del llibre es mostra al quadre lateral. I la <link xref="search">cerca al quadre lateral</link> mostra resultats trobats als fitxers d'índex.</p>

<section id="devhelp2-index-format">
  <title>Especificació del format de fitxer XML <file>*.devhelp2</file></title>
  <p>Malauradament, el format de fitxer XML <file>*.devhelp2</file> no està ben documentat. Encara hi ha alguna esperança que això s'arregli en un futur pròxim. Mentrestant, recomanem consultar el que genera <link xref="installing-api-documentation#gtk-doc">GTK-Doc</link>. Per a la definició més precisa de què és compatible amb el <app>Devhelp</app>, llegiu el codi font de l'analitzador i la referència API del <app>Devhelp</app>.</p>
</section>
</page>
