summaryrefslogtreecommitdiff
path: root/doc/user/footnote.skb
blob: 2326a301b2f73d549f8501898d42f8624fe03990 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
;;; footnote.skb  --  Footnotes.
;;;
;;; Copyright 2003  Manuel Serrano
;;; Copyright 2006  Ludovic Court�s <ludovic.courtes@laas.fr>
;;;
;;;
;;; 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.

;*---------------------------------------------------------------------*/
;*    Footnote ...                                                     */
;*---------------------------------------------------------------------*/
(section :title "Footnote" :file #t

(p [By default, footnotes appear at the bottom of the page that contains
the reference to the footnote.])

(doc-markup 'footnote
	    `((:label [This may be either a boolean (i.e., ,(code "#f")
or ,(code "#t")) indicating whether a footnote label should
automatically be produced, a string specifying a label to use (e.g.,
,(code ["*"])), or a number.])
	      (#!rest text... [The text of the footnote.]))
	    :see-also '(document chapter section))

(example-produce
 (example :legend "A footnote" (prgm :file "src/api18.skb"))
 (disp (include "src/api18.skb"))))