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

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

    <mal:credit xmlns:mal="http://projectmallard.org/1.0/" type="translator copyright">
      <mal:name>Mario Blättermann</mal:name>
      <mal:email>mario.blaettermann@gmail.com</mal:email>
      <mal:years>2018</mal:years>
    </mal:credit>
  
    <mal:credit xmlns:mal="http://projectmallard.org/1.0/" type="translator copyright">
      <mal:name>Stephan Woidowski</mal:name>
      <mal:email>swoidowski@t-online.de</mal:email>
      <mal:years>2020</mal:years>
    </mal:credit>
  
    <mal:credit xmlns:mal="http://projectmallard.org/1.0/" type="translator copyright">
      <mal:name>Christian Kirbach</mal:name>
      <mal:email>christian.kirbach@gmail.com</mal:email>
      <mal:years>2020.</mal:years>
    </mal:credit>
  </info>

<title>Buchformat</title>

<synopsis>
  <p>Ein »Buch« in <app>Devhelp</app> ist die API-Dokumentation für ein Modul oder Paket (in der Regel eine Bibliothek). Auf dieser Seite wird das Format beschrieben, dem ein Buch folgen muss, damit <app>Devhelp</app> es erkennt.</p>
</synopsis>

<p>Der Inhalt eines Buches wird in einem Ordner abgelegt (dieser Ordner enthält nur ein Buch, es kann nicht mehrere Bücher enthalten). Der Ordner besteht aus:</p>
<list>
  <item><p>HTML-Seiten, plus möglicherweise CSS-Dateien, Bilder, etc</p></item>
  <item><p>Eine Indexdatei mit der Dateierweiterung <file>*.devhelp2</file>. Lesen Sie <link xref="index-file-format"/> für weiterführende Informationen.</p></item>
</list>
<note>
  <p>Einschränkung: Der Name des Ordners, in dem sich die Datei <file>*.devhelp2</file> befindet, und der Name der Datei <file>*.devhelp2</file> (abzüglich der Erweiterung) müssen übereinstimmen. Mit anderen Worten, wenn der Buchordner <code>$Buchname</code> heißt, so sollte der absolute Pfad zur Indexdatei mit <code>$Buchname/$Buchname.devhelp2</code> enden. Wenn <app>Devhelp</app> den Ordnernamen kennt, kennt es auf diese Weise direkt den Speicherort der Indexdatei.</p>
</note>
</page>
