blob: 965095189d21c55dc7cbb873b5b12118d9cd27dd (
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
42
43
44
45
46
47
|
;;; toc.skb -- Table of contents
;;;
;;; Copyright 2003 Manuel Serrano
;;;
;;;
;;; 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.
;*---------------------------------------------------------------------*/
;* Sectioning */
;*---------------------------------------------------------------------*/
(section :title "Table of contents" :file #t
(p [The production of table of contains.])
(doc-markup 'toc
'((:chapter [A boolean. The value ,(code "#t") forces the
inclusion of chapters in the table of contents.])
(:section [A boolean controlling sections.])
(:subsection [A boolean controlling subsections.])
(:subsubsection [A boolean controlling subsubsections.])
(#!rest handle [An optional handle pointing to the node from
which the table of contents if computed.]))
:see-also '(document chapter section resolve handle))
(example-produce
(example :legend "The toc markup" (prgm :file "src/api6.skb"))
(disp (include "src/api6.skb")))
(p [The second example only displays the table of contents of the current
chapter.])
(example-produce
(example :legend "A restricted table of contents" (prgm :file "src/api7.skb"))
(disp (include "src/api7.skb"))))
|
