<?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="book-format" xml:lang="cs">

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

<title>Formát knihy</title>

<synopsis>
  <p>Knihou se v pojetí aplikace <app>Devhelp</app> míní dokumentace k API pro jeden modul nebo balíček (obvykle knihovnu). Tato stránka popisuje formát takovéto knihy, kterého je zapotřebí se držet, aby ji <app>Devhelp</app> rozpoznal.</p>
</synopsis>

<p>Obsah knihy je umístěný v jedné složce (tato složka obsahuje právě jednu knihu, nemůže jich obsahovat více). Obsah této složky sestává z:</p>
<list>
  <item><p>stránek HTML, plus soubory CSS, obrázky atd.</p></item>
  <item><p>indexového souboru s příponou <file>*.devhelp2</file>, více informací viz <link xref="index-file-format"/></p></item>
</list>
<note>
  <p>Omezení: název složky se souborem <file>*.devhelp2</file> a název samotného souboru <file>*.devhelp2</file> musí být stejné (myšleno bez přípony). Jinak řečeno, pokus se složka knihy nazývá <code>$nazev_knihy</code>, pak absolutní cesta k indexovému souboru by měla končit <code>$nazev_knihy/$nazev_knihy.devhelp2</code>. Díky tomu, když <app>Devhelp</app> zná název složky, zná i přímo umístění indexového souboru.</p>
</note>
</page>
