<?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-uk">

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

    <mal:credit xmlns:mal="http://projectmallard.org/1.0/" type="translator copyright">
      <mal:name>Юрій Чорноіван</mal:name>
      <mal:email>yurchor@ukr.net</mal:email>
      <mal:years>2020</mal:years>
    </mal:credit>
  </info>

<title>Формат файла покажчика</title>

<synopsis>
  <p>На цій сторінці описано призначення та формат файлів покажчика <file>*.devhelp2</file>.</p>
</synopsis>

<p>Книга (див. <link xref="book-format"/>) містить один файл покажчика. Файл покажчика має суфікс назви <file>.devhelp2</file> і форматування XML.</p>

<note>
  <p>«2» у суфіксі назви <file>*.devhelp2</file> означає, що це друга версія цього формату файлів. Перша версія формату з суфіксом назви <file>*.devhelp</file> є застарілою, і її підтримку у наступних версіях <app>Devhelp</app> може бути вилучено. При запуску програм, коли <app>Devhelp</app> шукає книги у файловій системі, програма виводить попередження до термінала для кожної книги, у якій використано застарілий формат.</p>
</note>

<p>В основному файл покажчика містить такі дані:</p>
<list>
  <item><p>Структуру книги (зокрема таблицю змісту).</p></item>
  <item><p>Список символів (функції, типи, макроси, сигнали, властивості, …).</p></item>
</list>
<p>Тут містяться посилання на файли HTML для переходу до відповідних сторінок і символів.</p>
<p>У <app>Devhelp</app> структуру книг буде показано на бічній панелі. А на <link xref="search">панелі пошуку на бічній панелі</link> буде показано результати, які було знайдено у файлах покажчика.</p>

<section id="devhelp2-index-format">
  <title>Специфікація формату файлів XML <file>*.devhelp2</file></title>
  <p>На жаль, формат файлів XML <file>*.devhelp2</file> документовано не дуже добре. Маємо надію, що цю ситуацію буде невдовзі виправлено. Тим часом, ми рекомендуємо ознайомитися із даними, які виводить <link xref="installing-api-documentation#gtk-doc">GTK-Doc</link>. Найточніше визначення того, підтримку чого реалізовано у <app>Devhelp</app>, ознайомтеся із початковим кодом обробника та довідником із програмного інтерфейсу <app>Devhelp</app>.</p>
</section>
</page>
