summaryrefslogtreecommitdiff
path: root/doc/user/lib.skb
diff options
context:
space:
mode:
authorLudovic Courtès2008-01-22 19:17:15 +0100
committerLudovic Courtès2008-01-22 19:17:15 +0100
commit1c48e83c54179144b82f8e1323101baf0c6b1a8d (patch)
tree94a5ceb3a8d140111890c0b1cf290b35184c86b9 /doc/user/lib.skb
parentffd3ed37343917e87d27acb38a377686e866d741 (diff)
downloadskribilo-1c48e83c54179144b82f8e1323101baf0c6b1a8d.tar.gz
skribilo-1c48e83c54179144b82f8e1323101baf0c6b1a8d.tar.lz
skribilo-1c48e83c54179144b82f8e1323101baf0c6b1a8d.zip
doc: Document all the `*xxx-path*' parameters.
* doc/modules/skribilo/documentation/manual.scm (srfi-ref): New. * doc/user/bib.skb: Add `*bib-path*'. * doc/user/image.skb: Add `*image-path*'. * doc/user/lib.skb: Mention `-I' command-line option for `*document-path*'. * doc/user/prgm.skb: Add `*source-path*'. * doc/user/skribec.skb: Add `:ident' for chapter.
Diffstat (limited to 'doc/user/lib.skb')
-rw-r--r--doc/user/lib.skb19
1 files changed, 12 insertions, 7 deletions
diff --git a/doc/user/lib.skb b/doc/user/lib.skb
index f61382a..dcf8d6e 100644
--- a/doc/user/lib.skb
+++ b/doc/user/lib.skb
@@ -1,6 +1,6 @@
;;; lib.skb -- Standard library.
;;;
-;;; Copyright 2007 Ludovic Courtès <ludo@gnu.org>
+;;; Copyright 2007, 2008 Ludovic Courtès <ludo@gnu.org>
;;; Copyright 2003 Erick Gallesio <eg@essi.fr>
;;;
;;;
@@ -53,16 +53,21 @@ when the Skribilo compiler is invoked (see Chapter
:source #f
:def '(define (*document-path* #!optional opt) ...)
:common-args '()
- :others '() ;;'(*image-path* *bib-path* *source-path*)
- :see-also '(include image source bibliography)
+ :others '()
+ :see-also '(include *image-path* *bib-path* *source-path*)
:idx *function-index*)
- (p [,(tt [*document-path*]) is a procedure as returned by SRFI-39
-,(tt [make-parameter]). As such, ,(tt [(*document-path*)]) returns the
-current document path, while ,(tt [(*document-path* '("."
+ (index :index *function-index* "skribe-path")
+ (index :index *function-index* "skribe-path-set!")
+
+ (p [,(tt [*document-path*]) is a procedure as returned by ,(srfi-ref
+39) ,(tt [make-parameter]). As such, ,(tt [(*document-path*)]) returns
+the current document path, while ,(tt [(*document-path* '("."
"/some/path"))]) changes the value of the current path. This is
equivalent to Skribe's ,(tt [skribe-path]) and ,(tt [skribe-path-set!])
-functions.]))
+functions. The value of ,(tt [*document-path*]) can also be changed
+using the ,(tt [-I]) command-line option of the compiler (see ,(numref
+:text [Chapter] :ident "compiler") for details).]))
;;; Misc