summaryrefslogtreecommitdiff
path: root/skribe/doc/user/toc.skb
diff options
context:
space:
mode:
authorLudovic Court`es2005-06-15 13:00:39 +0000
committerLudovic Court`es2005-06-15 13:00:39 +0000
commitfc42fe56a57eace2dbdb31574c2e161f0eacf839 (patch)
tree18111570156cb0e3df0d81c8d104517a2263fd2c /skribe/doc/user/toc.skb
downloadskribilo-fc42fe56a57eace2dbdb31574c2e161f0eacf839.tar.gz
skribilo-fc42fe56a57eace2dbdb31574c2e161f0eacf839.tar.lz
skribilo-fc42fe56a57eace2dbdb31574c2e161f0eacf839.zip
Initial import of Skribe 1.2d.
Initial import of Skribe 1.2d. git-archimport-id: lcourtes@laas.fr--2004-libre/skribilo--devel--1.2--base-0
Diffstat (limited to 'skribe/doc/user/toc.skb')
-rw-r--r--skribe/doc/user/toc.skb37
1 files changed, 37 insertions, 0 deletions
diff --git a/skribe/doc/user/toc.skb b/skribe/doc/user/toc.skb
new file mode 100644
index 0000000..aa6c0dc
--- /dev/null
+++ b/skribe/doc/user/toc.skb
@@ -0,0 +1,37 @@
+;*=====================================================================*/
+;* serrano/prgm/project/skribe/doc/user/toc.skb */
+;* ------------------------------------------------------------- */
+;* Author : Manuel Serrano */
+;* Creation : Wed Sep 3 13:01:03 2003 */
+;* Last change : Fri Sep 12 15:31:14 2003 (serrano) */
+;* Copyright : 2003 Manuel Serrano */
+;* ------------------------------------------------------------- */
+;* Table of contents */
+;*=====================================================================*/
+
+;*---------------------------------------------------------------------*/
+;* 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.])
+ (#!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"))))