summary refs log tree commit diff
path: root/doc/user/lib.skb
diff options
context:
space:
mode:
authorLudovic Courtès2007-12-14 19:43:47 +0100
committerLudovic Courtès2007-12-14 19:43:47 +0100
commit70830b1187d3d1924f38573caf8aeda2372ae84c (patch)
tree8e6a955d716475a8535f8f6cad756e0832b18b1c /doc/user/lib.skb
parent8a9464a8afabf6066636858f3ed2f1e2e8ef55ac (diff)
downloadskribilo-70830b1187d3d1924f38573caf8aeda2372ae84c.tar.gz
skribilo-70830b1187d3d1924f38573caf8aeda2372ae84c.tar.lz
skribilo-70830b1187d3d1924f38573caf8aeda2372ae84c.zip
doc: Update "Standard Library" and chapter about `skribilo-config'.
* doc/user/Makefile.am (EXTRA_DIST): Rename `skribe-config.skb' to
  `skribilo-config.skb'.
  (skrflags): Add `-e' flags defining `%top-srcdir' and `%top-builddir'.

* doc/user/lib.skb: Update stuff, removing references to `skribe-*'
  functions.  Remove doc for `load-document' and `skribe-configure',
  both of which have become essentially useless.

* doc/user/skribilo-config.skb: Updated.  Actually run `skribilo-config'
  and get options from there.

* doc/user/user.skb: Use `(ice-9 popen)' and `(ice-9 rdelim)'.  Update
  includes.
Diffstat (limited to 'doc/user/lib.skb')
-rw-r--r--doc/user/lib.skb166
1 files changed, 49 insertions, 117 deletions
diff --git a/doc/user/lib.skb b/doc/user/lib.skb
index 0cdfe80..f61382a 100644
--- a/doc/user/lib.skb
+++ b/doc/user/lib.skb
@@ -1,5 +1,6 @@
 ;;; lib.skb  --  Standard library.
 ;;;
+;;; Copyright 2007  Ludovic Courtès <ludo@gnu.org>
 ;;; Copyright 2003  Erick Gallesio <eg@essi.fr>
 ;;;
 ;;;
@@ -20,10 +21,11 @@
 
 (chapter :title "Standard Library" 
 
-   (p [This section describes the Skribe standard library])
+   (p [This section describes Skribilo's standard library.])
 
+
 ;;;
-(section :title "File functions"
+(section :title "File Functions"
    
    (p [The function ,(code "include") is particularily useful to spread a
 long document amongst several files.])
@@ -33,47 +35,15 @@ long document amongst several files.])
 These nodes are included in the document in place of the ,(code "include") 
 call.]))
 	       :common-args '()
-	       :see-also '(skribe-load skribe-path skribe-path-set!)
+	       :see-also '(*document-path*)
 	       :idx *function-index*)
    
-   (p [The given file is searched in the current 
-,(ref :mark "skribe-path" :text "Skribe path")])
-   
-   (p [The function ,(code "skribe-load") is generally used to load in the
-Skribe memory, a package or an extension. In general the prelude of a 
-Skribe document (the expressions placed before the ,(markup-ref "document")
-call) contains several ,(code "skribe-load"). The file is search
-in the ,(ref :mark "skribe-path" :text "Skribe path").])
+   (p [The given file is searched in the current ,(ref :mark
+"*document-path*" :text "document path").])
    
-   (doc-markup 'load-document
-	       `((file [The file containing the expressions to be loaded.])
-		 (:engine [The engine used to evaluate the expressions.])
-		 (:path ,[The optional path where to find the file. The default
-                          path is ,(markup-ref "skribe-path").])
-		 (#!rest opt... [Additional user options.]))
-               ;;:skribe-source? #f
-	       ;;:source "skribilo/evaluator.scm"
-               :source #f
-      	       :def '(define (load-document file #!rest opt #!key engine path) ...)
-	       :common-args '()
-	       :see-also '(skribe-load-options skribe-path skribe-path-set!)
-	       :idx *function-index*)
-   
-   (p [Returns the user of options of the last call to 
-,(markup-ref "skribe-load")])
-   (doc-markup '*load-options*
-	       '()
-               :skribe-source? #f-
-	       ;;:source "skribilo/evaluator.scm"
-               :source #f
-               :def '(define (*load-options* #!optional opt) ...)
-	       :common-args '()
-	       :see-also '(load-document)
-	       :idx *function-index*)
-   
-   (p [Skribe provides functions for dealing with paths. These functions
+   (p [Skribilo provides functions to deal with paths.  These functions
 are related to the path that can be specified on the command line,
-when the Skribe compiler is invoked (see Chapter 
+when the Skribilo compiler is invoked (see Chapter 
 ,(ref :chapter "Skribe compiler").)])
    
    (doc-markup '*document-path*
@@ -84,100 +54,62 @@ when the Skribe compiler is invoked (see Chapter
                :def '(define (*document-path* #!optional opt) ...)
 	       :common-args '()
 	       :others '()  ;;'(*image-path* *bib-path* *source-path*)
-	       :see-also '(include-document load-document image source
-bibliography)
+	       :see-also '(include image source bibliography)
 	       :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* '("."
-"/some/path"))]) changes the value of the current path.  An equivalent
-way to achieve this is by using ,(tt [skribe-path-set!]):])
+"/some/path"))]) changes the value of the current path.  This is
+equivalent to Skribe's ,(tt [skribe-path]) and ,(tt [skribe-path-set!])
+functions.]))
 
-   (doc-markup 'skribe-path-set!
-	       '((path [A list of strings which is the new Skribe search path.]))
-               :skribe-source? #f
-	       :source "skribilo/utils/compat.scm"
-	       :common-args '()
-	       :others '()
-	       :see-also '(*document-path*)
-	       :idx *function-index*))
-   
+
 ;;; Misc   
-(section :title "Misc. Functions"
+(section :title "Configuration Functions"
+         :ident "config-module"
    
-   (p [The function ,(code "skribe-release") returns the Skribe version 
-as a string])
-   (doc-markup 'skribe-release
+   (p [Several functions describing the configuration of Skribilo are
+exported by the ,(code [(skribilo config)]) module.  First, the ,(code
+"skribilo-version") function returns the version of Skribilo being used
+as a string.]
+
+   (doc-markup 'skribilo-version
 	       '()
 	       :common-args '()
-	       :source #f
-	       :def '(define (skribe-release) ...)
-	       :idx *function-index*)
+	       :source "skribilo/config.scm"
+	       :idx *function-index*))
    
    (p [For instance, the following piece of code:])
-   (prgm :language skribe 
-	 "[This manual documents the ,(bold (skribe-release)) Skribe release]")
+   (prgm :language skribe
+        "[This manual documents version ,(bold (skribilo-version)) of Skribilo.]")
    (p [produces the following output])
-   (disp [This manual documents the ,(bold (skribe-release)) Skribe release]))
-   
-   (p [The function ,(code "skribe-configure") accesses the whole
-Skribe configuration. It can be used to ,(emph "get") or ,(emph "check")
-the configuration.])
-   
-   (doc-markup 'skribe-configure
-	       '((#!rest opt... [Optional arguments.]))
-	       :common-args '()
-	       :source #f
-	       :def '(define (skribe-configure #!rest opt...) ...)
-	       :idx *function-index*)
-   
-   (p [The function ,(code "skribe-configure") can be used in three distinct 
-ways depending on the number of provided arguments:])
-   
-   (enumerate
-      (item [If no argument is provided, ,(code "skribe-configure") returns 
-a fresh list of Skribe configuration.])
-      (item [If one keyword argument is provided, ,(code "skribe-configure") 
-returns the value associated with this keyword in the configuration list. 
-If this value does not exist, it returns the symbol ,(code "void").])
-      (item [(code "skribe-configure") is invoked with a list composed 
-of ,(emph "keyword") ,(emph "value"). The actual configuration is checked 
-against the provided values. Values are compared with ,(code "equal") except 
-if the value to check has to be compared with a procedure. In that particular 
-case the value of the check is the value produces by ,(emph "applying") the 
-function to the actual value. The result of ,(code "skribe-configure") is a 
-boolean.]))
+   (disp [This manual documents version ,(bold (skribilo-version)) of Skribilo.])
    
-   (p [Here are some examples.])
-   (prgm :language skribe [
-;; fetch the whole configuration list
-(skribe-configure) 
-
-;; fetch the release number
-(skribe-configure :release) 
-
-;; test if the release number is 1.0b
-(skribe-configure :release "1.0b") 
-
-;; test if the release number is greater or equal than "1.0b"
-(skribe-configure :release (lambda (v) (string>=? v "1.0b")))
-
-;; test if the release number is greater or equal than "1.0b"
-;; and the implementation is bigloo
-(skribe-configure :release (lambda (v) (string>=? v "1.0b")) :scheme "bigloo")])
+   (p [The ,(code "skribilo-url") function returns, not surprisingly,
+the URL of the project:]
    
-   (p [The function ,(code "skribe-enforce-configure") checks for the Skribe
-configuration. In case of mismatch, it raises an error. The syntax of the
-arguments if the same as that of ,(code "skribe-configure") when invoked
-with several arguments.])
+   (doc-markup 'skribilo-url
+               '()
+               :common-args '()
+               :source "skribilo/config.scm"
+               :idx *function-index*))
    
-   (doc-markup 'skribe-enforce-configure
-	       '((#!rest opt... [Optional arguments.]))
+   (p [The ,(code [skribilo-module-directory]) returns the directory
+under which Skribilo modules were installed:]
+      
+   (doc-markup 'skribilo-module-directory
+	       '()
 	       :common-args '()
-	       :source #f
-	       :def '(define (skribe-enforce-configure #!rest opt...) ...)
-	       :idx *function-index*))
-   
+	       :source "skribilo/config.scm"
+	       :idx *function-index*)
+	       
+   [Similar information can be obtained using the ,(code
+[skribilo-config]) program, as described in ,(numref :text [Section]
+:ident "skribilo-config").])))
 
 
+;;; Local Variables:
+;;; coding: latin-1
+;;; ispell-local-dictionary: "american"
+;;; End: