<?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-pt-BR">

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

    <mal:credit xmlns:mal="http://projectmallard.org/1.0/" type="translator copyright">
      <mal:name>Rafael Fontenelle</mal:name>
      <mal:email>rafaelff@gnome.org</mal:email>
      <mal:years>2018-2021</mal:years>
    </mal:credit>
  </info>

<title>Formato do arquivo de índice</title>

<synopsis>
  <p>Esta página descreve o propósito e o formato de arquivos de índice <file>*.devhelp2</file>.</p>
</synopsis>

<p>Um livro (consulte <link xref="book-format"/>) contém um arquivo de índice. O arquivo de índice tem a extensão <file>.devhelp2</file> e possui um formato XML.</p>

<note>
  <p>O “2” na extensão de arquivo <file>*.devhelp2</file> é porque é a segunda versão do formato do arquivo. A primeira versão do formato, com a extensão de arquivo <file>*.devhelp</file>, está obsoleta e seu suporte no <app>Devhelp</app> pode ser removido no futuro. Na inicialização do aplicativo, quando o <app>Devhelp</app> verifica o sistema de arquivos para encontrar livros, ele emite uma mensagem de aviso no terminal para cada livro que usa um formato obsoleto.</p>
</note>

<p>O arquivo de índice contém principalmente:</p>
<list>
  <item><p>A estrutura do livro (como um sumário).</p></item>
  <item><p>Uma lista de símbolos (funções, tipos, macros, sinais, propriedades, …).</p></item>
</list>
<p>Eles contêm links para os arquivos HTML para alcançar as páginas e os símbolos correspondentes.</p>
<p>No <app>Devhelp</app>, a estrutura do livro é mostrada no painel lateral. E a <link xref="search">pesquisa no painel lateral</link> mostra os resultados encontrados nos arquivos de índice.</p>

<section id="devhelp2-index-format">
  <title>Especificação do formato do arquivo XML <file>*.devhelp2</file></title>
  <p>Infelizmente, o formato de arquivo XML <file>*.devhelp2</file> não está bem documentado. Ainda há alguma esperança de que isso seja corrigido no futuro próximo. Enquanto isso, recomendamos verificar o que o <link xref="installing-api-documentation#gtk-doc">GTK-Doc</link> gera. Para obter a definição mais precisa do que o <app>Devhelp</app> suporta, leia o código-fonte do analisador e a referência da API do <app>Devhelp</app>.</p>
</section>
</page>
