From 99da401511a7ca18a7edcee3188def912d6cbd24 Mon Sep 17 00:00:00 2001
From: Ludovic Courtès
Date: Wed, 7 Jan 2009 18:10:31 +0100
Subject: doc: Document the Info engine.

* doc/modules/skribilo/documentation/env.scm (*api-engines*): Add
  `info'.

* doc/user/Makefile.am (EXTRA_DIST): Add `infoe.skb'.

* doc/user/engine.skb: Include `infoe.skb'.
---
 doc/user/infoe.skb | 47 +++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 47 insertions(+)
 create mode 100644 doc/user/infoe.skb

(limited to 'doc/user/infoe.skb')

diff --git a/doc/user/infoe.skb b/doc/user/infoe.skb
new file mode 100644
index 0000000..85fbb0f
--- /dev/null
+++ b/doc/user/infoe.skb
@@ -0,0 +1,47 @@
+;;; info.skb  --  Documentation of the Info engine.
+;;;
+;;; Copyright 2009  Ludovic Courtès <ludo@gnu.org>
+;;;
+;;;
+;;; This program is free software; you can redistribute it and/or modify
+;;; it under the terms of the GNU General Public License as published by
+;;; the Free Software Foundation; either version 2 of the License, or
+;;; (at your option) any later version.
+;;;
+;;; This program is distributed in the hope that it will be useful,
+;;; but WITHOUT ANY WARRANTY; without even the implied warranty of
+;;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+;;; GNU General Public License for more details.
+;;;
+;;; You should have received a copy of the GNU General Public License
+;;; along with this program; if not, write to the Free Software
+;;; Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301,
+;;; USA.
+
+(section :title "Info Engine" :file #t
+   (mark "info-engine")
+   (index "Info" :note "Engine")
+
+   (p [The ,(tt [info]) engine produces GNU,(~)Info files for on-line
+browsing with GNU,(~)Emacs of with the stand-alone Info reader of ,(ref
+:text [GNU,(~)Texinfo] :url "http://www.gnu.org/software/texinfo/").])
+   
+   (p [For each ,(markup-ref "chapter"), ,(markup-ref "section"), etc.,
+an Info node is created, whose name is inferred from the ,(param :title)
+option.  However, Info node names have to be unique, which the ,(param
+:title) options are not necessarily.  Thus, the Info engine does two
+things:
+
+,(enumerate
+    (item [It warns you about duplicate Info node titles.])
+    (item [It allows you to choose a different node name to avoid
+conflicts, using the ,(param :info-node) option of ,(markup-ref
+"chapter"), etc.]))
+
+Most markups shown in ,(numref :text [Chapter] :ident "std-markups") are
+meaningfully rendered in Info, including tables.]))
+
+;;; Local Variables:
+;;; coding: latin-1
+;;; ispell-local-dictionary: "american"
+;;; End:
-- 
cgit v1.2.3