[devhelp] help: book-format: improve a little the page
- From: Sébastien Wilmet <swilmet src gnome org>
- To: commits-list gnome org
- Cc:
- Subject: [devhelp] help: book-format: improve a little the page
- Date: Thu, 19 Dec 2019 15:16:02 +0000 (UTC)
commit 918b05b17b239119eb34097d69e7d2c34e6c166b
Author: Sébastien Wilmet <swilmet gnome org>
Date: Thu Dec 19 15:55:15 2019 +0100
help: book-format: improve a little the page
help/C/book-format.page | 27 +++++++++++++++------------
1 file changed, 15 insertions(+), 12 deletions(-)
---
diff --git a/help/C/book-format.page b/help/C/book-format.page
index d93e6380..8bd8514e 100644
--- a/help/C/book-format.page
+++ b/help/C/book-format.page
@@ -12,8 +12,8 @@
<synopsis>
<p>
A “book” in <app>Devhelp</app> is the API documentation for one module, or
- package. A book needs to follow a certain format in order for
- <app>Devhelp</app> to recognize it.
+ package (usually a library). This page describes the format that a book
+ needs to follow in order for <app>Devhelp</app> to recognize it.
</p>
</synopsis>
@@ -27,16 +27,19 @@
HTML pages, plus possibly CSS files, images, etc;
</p></item>
<item><p>
- An index file, see <link xref="index-file-format" /> for more information.
+ An index file with the <file>*.devhelp2</file> file extension, see
+ <link xref="index-file-format" /> for more information.
</p></item>
</list>
-<p>
- Restriction: the name of the directory the <file>*.devhelp2</file> file is
- in and the name of the <file>*.devhelp2</file> file (minus the extension)
- must match. In other words, if the book directory is called
- <code>$book_name</code>, then the absolute path to the index file should
- end with <code>$book_name/$book_name.devhelp2</code>. That way, when
- <app>Devhelp</app> knows the directory name, it directly knows the location
- to the index file.
-</p>
+<note>
+ <p>
+ Restriction: the name of the directory the <file>*.devhelp2</file> file is
+ in and the name of the <file>*.devhelp2</file> file (minus the extension)
+ must match. In other words, if the book directory is called
+ <code>$book_name</code>, then the absolute path to the index file should
+ end with <code>$book_name/$book_name.devhelp2</code>. That way, when
+ <app>Devhelp</app> knows the directory name, it directly knows the location
+ to the index file.
+ </p>
+</note>
</page>
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]