aboutsummaryrefslogtreecommitdiff
path: root/doc/user
diff options
context:
space:
mode:
authorLudovic Courtès2008-01-19 15:56:44 +0100
committerLudovic Courtès2008-01-19 15:56:44 +0100
commitc8215f1e6075a6472574456318c627f7a04765e8 (patch)
tree5bd8469beeb82c184c7650abdedbf1d47442c861 /doc/user
parentcfe32a6a09ce6af4b993e96fd5a3e2785bf6bb24 (diff)
downloadskribilo-c8215f1e6075a6472574456318c627f7a04765e8.tar.gz
skribilo-c8215f1e6075a6472574456318c627f7a04765e8.tar.lz
skribilo-c8215f1e6075a6472574456318c627f7a04765e8.zip
Document `web-book2'.
* doc/user/package.skb (Web)[web-book]: Improve documentation. [web-book2]: New.
Diffstat (limited to 'doc/user')
-rw-r--r--doc/user/package.skb22
1 files changed, 19 insertions, 3 deletions
diff --git a/doc/user/package.skb b/doc/user/package.skb
index 2bfe4e1..9cf67cc 100644
--- a/doc/user/package.skb
+++ b/doc/user/package.skb
@@ -171,9 +171,25 @@ emission using CSS annotations. The CSS style used is specified in the
(subsection :title (tt "web-book")
(index :index *package-index* "web-book" :note "package")
- (p [
-A convenient mode for rendering books (i.e., documents made of
-chapters and sections) in HTML.]))
+
+ (p [This package provides a convenient mode for rendering books
+(i.e., documents made of chapters and sections) in HTML. It modifies
+the ,(tt [left-margin]) custom of the HTML engine (see ,(ref :text [HTML
+customs] :ident "html-engine")) such that the left margin of each HTML
+file produced contains a menu allowing for quick navigation within the
+HTML document.]))
+
+ (subsection :title (tt "web-book2")
+ (index :index *package-index* "web-book2" :note "package")
+
+ (p [This package provides a different way to render books in HTML.
+Concretely, it prepends a small table of contents to each chapter,
+section, etc., that appears in an HTML file of its own, making it easy
+to move around the various HTML files of the document. Compared to ,(tt
+[web-book]), it does not clutter the left margin of the HTML pages.])
+
+ (p [Unlike ,(tt [web-book]), this package is ``purely functional''
+in that it does not modify the HTML engine customs and writers.]))
(subsection :title (tt [html-navtabs])