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

<synopsis>
  <p>Um “livro” no <app>Devhelp</app> é a documentação da API para um módulo ou pacote (geralmente uma biblioteca). Esta página descreve o formato que um livro precisa seguir para que o <app>Devhelp</app> o reconheça.</p>
</synopsis>

<p>O conteúdo de um livro é colocado em um diretório (esse diretório contém apenas um livro, não pode conter vários livros). O diretório é composto por:</p>
<list>
  <item><p>Páginas HTML, além de arquivos CSS, imagens etc;</p></item>
  <item><p>Um arquivo de índice com a extensão <file>*.devhelp2</file>, consulte <link xref="index-file-format"/> para obter mais informações.</p></item>
</list>
<note>
  <p>Restrição: o nome do diretório no qual o arquivo <file>*.devhelp2</file> se encontra e o nome do arquivo <file>*.devhelp2</file> (sem a extensão) deve ser o mesmo. Em outras palavras, se o diretório do livro for chamado <code>$book_name</code>, o caminho absoluto para o arquivo de índice deverá terminar com <code>$book_name/$book_name.devhelp2</code>. Dessa forma, quando o <app>Devhelp</app> souber o nome do diretório, ele conhecerá diretamente o local do arquivo de índice.</p>
</note>
</page>
