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

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

    <mal:credit xmlns:mal="http://projectmallard.org/1.0/" type="translator copyright">
      <mal:name>Piotr Drąg</mal:name>
      <mal:email>piotrdrag@gmail.com</mal:email>
      <mal:years>2018-2020</mal:years>
    </mal:credit>
  
    <mal:credit xmlns:mal="http://projectmallard.org/1.0/" type="translator copyright">
      <mal:name>Aviary.pl</mal:name>
      <mal:email>community-poland@mozilla.org</mal:email>
      <mal:years>2018-2020</mal:years>
    </mal:credit>
  </info>

<title>Format pliku indeksu</title>

<synopsis>
  <p>Ta strona opisuje przeznaczenie i format plików indeksów <file>*.devhelp2</file>.</p>
</synopsis>

<p>Książka (patrz: <link xref="book-format"/>) zawiera jeden plik indeksu. Ma on rozszerzenie <file>.devhelp2</file> i jest w formacie XML.</p>

<note>
  <p>„2” jest w rozszerzeniu <file>*.devhelp2</file>, ponieważ to druga wersja tego formatu. Pierwsza wersja, o rozszerzeniu <file>*.devhelp</file>, jest przestarzała i jej obsługa w programie <app>Devhelp</app> może zostać usunięta w przyszłości. Podczas włączania programu, kiedy <app>Devhelp</app> wyszukuje książki w systemie plików, w terminalu emitowany jest komunikat ostrzeżenia dla każdej książki używającej przestarzałego formatu.</p>
</note>

<p>Plik indeksu zawiera głównie:</p>
<list>
  <item><p>strukturę książki (spis treści i podobne),</p></item>
  <item><p>listę symboli (funkcje, typy, makra, sygnały, właściwości…).</p></item>
</list>
<p>Te zawierają odnośniki do plików HTML, aby móc otwierać odpowiednie strony i symbole.</p>
<p>W programie <app>Devhelp</app> struktura książki jest wyświetlana w panelu bocznym. A <link xref="search">wyszukiwanie w panelu bocznym</link> wyświetla wyniki z plików indeksów.</p>

<section id="devhelp2-index-format">
  <title>Specyfikacja formatu pliku XML <file>*.devhelp2</file></title>
  <p>Niestety format pliku XML <file>*.devhelp2</file> nie ma dobrej dokumentacji. Być może zostanie to naprawione w niedalekiej przyszłości. W międzyczasie zalecamy korzystać z wyników działania <link xref="installing-api-documentation#gtk-doc">GTK-Doc</link>. Kod źródłowy parsera i referencja API programu <app>Devhelp</app> najdokładniej określa, co on obsługuje.</p>
</section>
</page>
