diff options
author | Ludovic Courtès | 2009-01-07 18:10:31 +0100 |
---|---|---|
committer | Ludovic Courtès | 2009-01-07 18:10:31 +0100 |
commit | 99da401511a7ca18a7edcee3188def912d6cbd24 (patch) | |
tree | 6f36fc649c201249b8e8e501c12b3c819c985d67 /doc/user/infoe.skb | |
parent | 03cf45121f3fc919af56becafdf311d43cea6e07 (diff) | |
download | skribilo-99da401511a7ca18a7edcee3188def912d6cbd24.tar.gz skribilo-99da401511a7ca18a7edcee3188def912d6cbd24.tar.lz skribilo-99da401511a7ca18a7edcee3188def912d6cbd24.zip |
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'.
Diffstat (limited to 'doc/user/infoe.skb')
-rw-r--r-- | doc/user/infoe.skb | 47 |
1 files changed, 47 insertions, 0 deletions
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: |