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

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

<title>Formát indexového souboru</title>

<synopsis>
  <p>Tato stránka popisuje účel a formát indexových souborů <file>*.devhelp2</file>.</p>
</synopsis>

<p>Kniha (viz <link xref="book-format"/>) obsahuje jeden indexový soubr. Indexový soubor má příponu <file>.devhelp2</file> a formát  XML.</p>

<note>
  <p>„2“ v příponě souboru <file>*.devhelp2</file> je proto, že se jedná o druhou verzi tohoto souborového formátu. První verze s příponou <file>*.devhelp</file> je označená za zastaralou a její podpora v aplikaci <app>Devhelp</app> může být v budoucnu odstraněna. Při spuštění aplikace, kdy <app>Devhelp</app> prohledává souborový systém na výskyt knih, vysílá do terminálu varovné zprávy pro každou knihu, která používá zastaralý formát.</p>
</note>

<p>Indexový soubor obsahuje zejména:</p>
<list>
  <item><p>Strukturu knihy (obdoba obsahu knihy).</p></item>
  <item><p>Seznam symbolů (funkce, typy, makra, signály, vlastnosti, …).</p></item>
</list>
<p>Ty pak obsahují odkazy na jednotlivé soubory HTML, díky čemuž se dá dostat na příslušnou stránku a symbol.</p>
<p>Struktura knihy je v aplikaci <app>Devhelp</app> zobrazená v postranním panelu. A <link xref="search">hledání v postranním panelu</link> zobrazuje výsledky nalezené v indexovém souboru.</p>

<section id="devhelp2-index-format">
  <title>Specifikace souborového formátu XML <file>*.devhelp2</file>.</title>
  <p>Naneštěstí souborový formát XML <file>*.devhelp2</file> není příliš dobře zdokumentován. Je tu ale šance, že se to do budoucna zlepší. Než se tak stane, doporučujeme podívat se, co generuje <link xref="installing-api-documentation#gtk-doc">GTK-Doc</link>. Podrobnější definice, co <app>Devhelp</app> podporuje, pak můžete zjistit čtením jeho zdrojového kódu a referenční příručky k API <app>Devhelp</app>.</p>
</section>
</page>
