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

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

<title>Bokformat</title>

<synopsis>
  <p>En ”bok” i <app>Devhelp</app> är API-dokumentationen för en modul eller ett paket (vanligen ett bibliotek). Denna sida beskriver formatet som en bok behöver följa för att <app>Devhelp</app> ska kunna känna igen den.</p>
</synopsis>

<p>Innehållet i en bok placeras i en katalog (den katalogen innehåller bara en bok, den kan inte innehålla flera böcker). Katalogen består av:</p>
<list>
  <item><p>HTML-sidor, samt möjligen CSS-filer, bilder o.s.v.;</p></item>
  <item><p>En indexfil med filändelsen <file>*.devhelp2</file>, se <link xref="index-file-format"/> för mer information.</p></item>
</list>
<note>
  <p>Begränsning: namnet på katalogen som <file>*.devhelp2</file>-filen är i och namnet på <file>*.devhelp2</file>-filen (minus filändelsen) måste överensstämma. Med andra ord ska den absoluta sökvägen till indexfilen sluta med <code>$boknamn/$boknamn.devhelp2</code> om bokkatalogen har namnet <code>$boknamn</code>. På det sättet känner <app>Devhelp</app> direkt till platsen för indexfilen om det vet namnet på katalogen.</p>
</note>
</page>
