;;; info.skb  --  Documentation of the Info engine.
;;; -*- coding: iso-8859-1 -*-
;;;
;;; Copyright 2009, 2012  Ludovic Courtès <ludo@gnu.org>
;;;
;;;
;;; This file is part of Skribilo.
;;;
;;; Skribilo 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 3 of the License, or
;;; (at your option) any later version.
;;;
;;; Skribilo 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 Skribilo.  If not, see <http://www.gnu.org/licenses/>.

(section :title "Info Engine" :file #t :ident "info-engine"
   (index "Info" :note "Engine")

   (p [The ,(tt [info]) engine produces GNU,(~)Info files for on-line
browsing with GNU,(~)Emacs or 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.  The ,(markup-ref
"image") markup is also implemented: the Info reader in Emacs 23 and
later is able to display them, or to display the alternate text (the
body of the ,(markup-ref "image") markup) when running in text mode.]))

;;; Local Variables:
;;; ispell-local-dictionary: "american"
;;; End: