summary refs log tree commit diff
path: root/doc/user/engine.skb
diff options
context:
space:
mode:
authorLudovic Courtes2006-01-17 22:51:36 +0000
committerLudovic Courtes2006-01-17 22:51:36 +0000
commitff5f019ffd54745954d8a6ed094f0fd10ac0e467 (patch)
tree93535db7d12eae5cb86a7c1af64bafe07f5d3275 /doc/user/engine.skb
parent36a235bc558321245eb410633c314b03e5bb9f81 (diff)
parent46c709dc1f242fa680d4425da4dfc9314686e9cc (diff)
downloadskribilo-ff5f019ffd54745954d8a6ed094f0fd10ac0e467.tar.gz
skribilo-ff5f019ffd54745954d8a6ed094f0fd10ac0e467.tar.lz
skribilo-ff5f019ffd54745954d8a6ed094f0fd10ac0e467.zip
Towards a self-hosted user manual.
* doc/skr/api.skr: Use `(skribilo reader)' and `(skribilo utils syntax)'.
  (api-search-definition): Added a SKRIBE-SOURCE? argument.
  Determine the appropriate reader based on its value.
  (keyword->symbol): Removed.
  (define-markup?): Fixed.
  (make-engine?): Fixed (but unverified).
  (make-engine-custom): Likewise.
  (sym/kw?): New.
  (define-markup-formals): Fixed.
  (define-markup-options): Likewise.
  (define-markup-rest): Likewise.
  (doc-markup): Added a SKRIBE-SOURCE? argument.
  (doc-engine): Likewise.

* doc/user/*.skb: Updated the `:source' arguments to `doc-markup' and
  `doc-engine'.

* src/guile/skribilo/utils/compat.scm (hashtable-update!): Fixed
  according to the Bigloo manual.

git-archimport-id: lcourtes@laas.fr--2004-libre/skribilo--devel--1.2--patch-29
Diffstat (limited to 'doc/user/engine.skb')
-rw-r--r--doc/user/engine.skb14
1 files changed, 12 insertions, 2 deletions
diff --git a/doc/user/engine.skb b/doc/user/engine.skb
index 06be3c4..b8a5b47 100644
--- a/doc/user/engine.skb
+++ b/doc/user/engine.skb
@@ -11,6 +11,9 @@
 ;; @indent: (put 'doc-markup 'skribe-indent 'skribe-indent-function)@
 
 (cond-expand 
+   (guile
+    (define *engine-src*  "skribilo/engine.scm")
+    (define *types-src*   #f))
    (bigloo 
     (define *engine-src*  "../src/bigloo/engine.scm")
     (define *types-src*   "../src/bigloo/types.scm"))
@@ -55,6 +58,7 @@ given below:])
 	      (:custom [The engine custom list.])
 	      (:info [Miscellaneous.]))
 	    :common-args '()
+            :skribe-source? #f
 	    :source *engine-src*
 	    :idx *function-index*)
 	 
@@ -68,6 +72,7 @@ given below:])
 	      (:symbol-table [The engine symbol table.])
 	      (:custom [The engine custom list.]))
 	    :common-args '()
+            :skribe-source? #f
 	    :source *engine-src*
 	    :idx *function-index*))
 	      
@@ -80,6 +85,7 @@ on failure.])
 	    '((id [The name (a symbol) of the engine to be searched.])
 	      (:version [An optional version number for the searched engine.]))
 	    :common-args '()
+            :skribe-source? #f
 	    :source *engine-src*
 	    :idx *function-index*))
       
@@ -91,7 +97,8 @@ argument is an engine. Otherwise, it returns ,(code "#f"). In other words,
 	 (doc-markup 'engine?
 	    '((obj [The checked object.]))
 	    :common-args '()
-	    :source *types-src*
+            :skribe-source? #f
+	    :source *engine-src*
 	    :idx *function-index*)
 	 
 	 (p [The following functions return information about engines.])
@@ -100,7 +107,8 @@ argument is an engine. Otherwise, it returns ,(code "#f"). In other words,
 	    '((obj [The engine.]))
 	    :common-args '()
 	    :others '(engine-format engine-customs engine-filter engine-symbol-table)
-	    :source *types-src*
+            :skribe-source? #f
+	    :source *engine-src*
 	    :idx *function-index*))
       
       (subsection :title "Engine customs"
@@ -117,6 +125,7 @@ a custom.])
 ,(ref :mark "find-engine" :text (code "find-engine"))).])
 	      (id [The name of the custom.]))
 	    :common-args '()
+            :skribe-source? #f
 	    :source *engine-src*
 	    :idx *function-index*)
 	 
@@ -126,6 +135,7 @@ a custom.])
 	      (id [The name of the custom.])
 	      (val [The new value of the custom.]))
 	    :common-args '()
+            :skribe-source? #f
 	    :source *engine-src*
 	    :idx *function-index*)))