summaryrefslogtreecommitdiff
path: root/doc/user/figure.skb
diff options
context:
space:
mode:
authorLudovic Courtès2008-02-01 13:22:53 +0100
committerLudovic Courtès2008-02-01 13:22:53 +0100
commit654ba1f34b7661a81b0ce720040f17591f79b552 (patch)
tree29494a96d907e1e27f3e79e088a99002429a74ad /doc/user/figure.skb
parent0e2a5636d9e0bb90c3e98cc472e454fe05221dd9 (diff)
downloadskribilo-654ba1f34b7661a81b0ce720040f17591f79b552.tar.gz
skribilo-654ba1f34b7661a81b0ce720040f17591f79b552.tar.lz
skribilo-654ba1f34b7661a81b0ce720040f17591f79b552.zip
doc: Various insignificant cleanups.
Diffstat (limited to 'doc/user/figure.skb')
-rw-r--r--doc/user/figure.skb30
1 files changed, 21 insertions, 9 deletions
diff --git a/doc/user/figure.skb b/doc/user/figure.skb
index 5998986..dd418a6 100644
--- a/doc/user/figure.skb
+++ b/doc/user/figure.skb
@@ -1,5 +1,6 @@
-;;; figure.skb -- Skribe figures
+;;; figure.skb -- Figures.
;;;
+;;; Copyright 2008 Ludovic Courtès <ludo@gnu.org>
;;; Copyright 2003 Manuel Serrano
;;;
;;;
@@ -21,7 +22,14 @@
;*---------------------------------------------------------------------*/
;* Figure ... @label figure@ */
;*---------------------------------------------------------------------*/
-(section :title "Figure" :file #t
+(section :title "Figures" :file #t
+
+ (p [The ,(markup-ref "figure") markup shown below produces floating
+figures. Well, whether the figure is really ``floating'' depends on the
+engine used (see ,(numref :text [Chapter] :ident "engines")): printed
+output as produced by the ,(tt [lout]) and ,(tt [latex]) engines do
+produce floating figures, but on-line output as produced by the ,(tt
+[html]) engine does not.])
(doc-markup 'figure
`((:legend ,[The legend of the figure. If no ,(param :ident) is
@@ -47,17 +55,21 @@
(include "src/api14.skb")
;*--- List of figures -------------------------------------------------*/
-(subsection :title "List of figures"
+(subsection :title "List of Figures"
(index "figure" :note "list of figures")
-(p [Skribe has no builtin facility for displaying the list of figures.
-Instead, it provides a general machinery for displaying any kind of lists
-contained in the document. This is described in the section ,(ref
-:section "Resolve") and ,(ref :section "Introspection") but for the
-sake of the coherence, this section also contains an example that
-shows how to display the list of figures of a document.])
+(p [Skribilo has no built-in facility to display the list of figures.
+Instead, it provides a general machinery for displaying any kind of
+lists of items contained in a document. This is described in the
+section ,(ref :section "Resolve") and ,(ref :subsection
+"Introspection"). For the sake of simplicity, an example showing how to
+display the list of figures of a document is included below.])
(example-produce
(example :legend "The figure markup" (prgm :file "src/api15.skb"))
(disp (include "src/api15.skb")))))
+;;; Local Variables:
+;;; coding: latin-1
+;;; ispell-local-dictionary: "american"
+;;; End: