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

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

<title>Indexfilformat</title>

<synopsis>
  <p>Denna sida beskriver syftet och formatet för <file>*.devhelp2</file>-indexfiler.</p>
</synopsis>

<p>En bok (se <link xref="book-format"/>) innehåller en indexfil. Indexfilen har filändelsen <file>.devhelp2</file> och har ett XML-format.</p>

<note>
  <p>Siffran ”2” i filändelsen <file>*.devhelp2</file> beror på att det är den andra versionen av filformatet. Den första versionen av formatet, med filändelsen <file>*.devhelp</file>, är föråldrad och stöd för den kan tas bort från <app>Devhelp</app> i framtiden. När <app>Devhelp</app> läser av filsystemet för att hitta böcker vid programstart så skriver det ett varningsmeddelande i terminalen för varje bok som använder ett föråldrat format.</p>
</note>

<p>Indexfilen innehåller främst:</p>
<list>
  <item><p>Bokstrukturen (som en innehållsförteckning).</p></item>
  <item><p>En lista över symboler (funktioner, typer, makron, signaler, egenskaper, …).</p></item>
</list>
<p>Dessa innehåller länkar till HTML-filerna för att nå motsvarande sidor och symboler.</p>
<p>I <app>Devhelp</app> visas bokstrukturen i sidopanelen. <link xref="search">Sökningen i sidopanelen</link> visar resultat som hittats i indexfilerna.</p>

<section id="devhelp2-index-format">
  <title>Specifikation för XML-filformatet för <file>*.devhelp2</file></title>
  <p>Tyvärr är inte XML-filformatet för <file>*.devhelp2</file> väldokumenterat. Det finns fortfarande en förhoppning att detta ska lösas i en nära framtid. Under tiden rekommenderar vi att titta på vad <link xref="installing-api-documentation#gtk-doc">GTK-Doc</link> genererar. För den mest precisa definitionen över vad <app>Devhelp</app> stöder kan du läsa källkoden för tolken och API-referensen för <app>Devhelp</app>.</p>
</section>
</page>
