<?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="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>Indexdateiformat</title>

<synopsis>
  <p>Diese Seite beschreibt den Zweck und das Format von <file>*.devhelp2</file>-Indexdateien.</p>
</synopsis>

<p>Ein Buch (siehe <link xref="book-format"/>) enthält eine Indexdatei. Die Indexdatei hat die Erweiterung <file>.devhelp2</file> und ist im XML-Format.</p>

<note>
  <p>Die »2« in der <file>*.devhelp2</file> Dateierweiterung deutet an, dass es die zweite Version des Dateiformats ist. Die erste Version des Formats mit der Dateierweiterung <file>*.devhelp</file> ist veraltet und seine Unterstützung kann in der Zukunft aus <app>Devhelp</app> entfernt werden. Wenn <app>Devhelp</app> beim Anwendungsstart das Dateisystem nach Büchern durchsucht, gibt es im Terminal eine Warnmeldung für jedes Buch aus, das ein veraltetes Format verwendet.</p>
</note>

<p>Die Indexdatei enthält hauptsächlich:</p>
<list>
  <item><p>Die Buchstruktur (ähnlich einem Inhaltsverzeichnis).</p></item>
  <item><p>Eine Liste von Symbolen (Funktionen, Typen, Makros, Signale, Eigenschaften …).</p></item>
</list>
<p>Diese enthalten Verweise zu den HTML-Dateien, um die entsprechenden Seiten und Symbole zu erreichen.</p>
<p>In <app>Devhelp</app> wird die Buchstruktur im Seitenbereich angezeigt. Und die <link xref="search"> Suche im Seitenbereich</link> zeigt die Ergebnisse in den Indexdateien.</p>

<section id="devhelp2-index-format">
  <title>Spezifikation des <file>*.devhelp2</file>-XML-Dateiformats</title>
  <p>Leider ist das <file>*.devhelp2</file>-XML-Dateiformat nicht gut dokumentiert. Es besteht noch Hoffnung, dass dies in naher Zukunft behoben wird. In der Zwischenzeit empfehlen wir, sich anzusehen, was <link xref="installing-api-documentation#gtk-doc">GTK-Doc</link> erstellt. Lesen Sie den Parser-Quellcode und die <app>Devhelp</app>-API-Referenz, um ziemlich detailliert zu erfahren, was <app>Devhelp</app> unterstützt.</p>
</section>
</page>
