From 09039355539a79187669b688ff6a03c8a74e2099 Mon Sep 17 00:00:00 2001
From: Ludovic Courtes
Date: Tue, 31 Jan 2006 23:23:15 +0000
Subject: First time the user manual is compiled to HTML.

* doc/skr/api.skr (make-engine?): Fixed.
  (make-engine-custom): Likewise.

* doc/skr/manual.skr (the-index): Don't pass `:&skribe-eval-location'.

* doc/user/emacs.skb: Fixed typo.

* doc/user/htmle.skb: Documented the `file-name-proc' custom.

* doc/user/package.skb: Fixed the `prgm' example there.

* doc/user/skribe-config.skb: Commented out the `OPTIONS' section.

* doc/user/skribec.skb: Likewise.

* doc/user/slide.skb: Don't refer to HTML-ENGINE, use `find-engine'
  instead.

* doc/user/src/slides.skb: Don't pass `:slide' to `toc'.

* doc/user/toc.skb: Commented the `:subsubsection' argument.

* doc/user/user.skb (Index): Set `:indent' to "Index".

* src/guile/skribilo.scm (skribilo-options): Added `--image-path'.
  (skribilo): Handle it.

* src/guile/skribilo/ast.scm (ast->file-location): Exported.

* src/guile/skribilo/engine/base.scm (the-index): Don't pass
  `:&skribe-eval-location'.

* src/guile/skribilo/engine/html.scm: Export `html-width' and
  `html-title-authors'.

* src/guile/skribilo/engine/lout.scm (lout-width): Don't use `flonum?'.

* src/guile/skribilo/evaluator.scm (load-document): Added
  `:allow-other-keys' so that the optional parameters may contain
  keywords, too.

* src/guile/skribilo/package/slide.scm: Use `(skribilo engine html)'.

* src/guile/skribilo/skribe/api.scm (toc): Added `subsubsection'.

git-archimport-id: lcourtes@laas.fr--2005-mobile/skribilo--devel--1.2--patch-31
---
 doc/user/emacs.skb         |  2 +-
 doc/user/htmle.skb         |  3 +++
 doc/user/package.skb       |  2 +-
 doc/user/skribe-config.skb | 22 ++++++++++++----------
 doc/user/skribec.skb       |  8 ++++----
 doc/user/slide.skb         |  3 ++-
 doc/user/src/slides.skb    |  4 ++--
 doc/user/toc.skb           |  1 +
 doc/user/user.skb          |  4 ++--
 9 files changed, 28 insertions(+), 21 deletions(-)

(limited to 'doc/user')

diff --git a/doc/user/emacs.skb b/doc/user/emacs.skb
index 742fa87..a526790 100644
--- a/doc/user/emacs.skb
+++ b/doc/user/emacs.skb
@@ -52,7 +52,7 @@ The ,(code "skribe") mode is a minor mode. It is intended to be used with
 a Lisp or Scheme mode. Hence, to use the ,(code "skribe") mode you will
 have to use the following Emacs commands:])
 
-,(disp :vert #t (source :language lisp [
+,(disp :verb #t (source :language lisp [
 ESC-x: scheme-mode
 ESC-x: skribe-mode
 ]))]))
diff --git a/doc/user/htmle.skb b/doc/user/htmle.skb
index 5e556cc..90343b9 100644
--- a/doc/user/htmle.skb
+++ b/doc/user/htmle.skb
@@ -65,6 +65,9 @@ the document.])
 	   (title-background "The title background color.")
 	   (title-foreground "The title foreground color.")
 	   (file-title-separator "A text to be inserted in between the document title and the chapter or section title when the chapter or section is rendered in a separate file.")
+           (file-name-proc "A two-argument procedure that should return
+a string.  This procedure is to be passed a node and an engine and
+should return a file name for the HTML page corresponding to this node.")
 	   ;; index configuration
 	   (index-header-font-size "The index header font size.")
 	   ;; chapter configuration
diff --git a/doc/user/package.skb b/doc/user/package.skb
index b3fe6c3..19c99c9 100644
--- a/doc/user/package.skb
+++ b/doc/user/package.skb
@@ -25,7 +25,7 @@ Skribe distribution.])
 In order to use the facilities described in the following sections, the 
 Skribe source file must contains expressions such as:])
 
-(prgm [(skribe-load ,(it "package.skr") ...)])
+(prgm "(skribe-load \"package.skr\" ...)")
 
 [where ,(it (tt "package.skr")) is the described package.]
 
diff --git a/doc/user/skribe-config.skb b/doc/user/skribe-config.skb
index 956af63..e96e35b 100644
--- a/doc/user/skribe-config.skb
+++ b/doc/user/skribe-config.skb
@@ -29,16 +29,18 @@ The ,(code "skribe-config") gives information about the Skribe configuration.
 This information can be the directories used to install Skribe, the Scheme
 implementation used for compiling Skribe, etc.])
 
-;; Options
-(section :title "OPTIONS" :number #f [
-,(pre (let* ((proc (run-process "../etc/skribe-config" "--help" error: pipe:))
-	     (port (process-error-port proc)))
-	 (let loop ((line (read-line port))
-		    (lines '()))
-	    (if (eof-object? line)
-		(reverse! lines)
-		(begin
-		   (loop (read-line port) (cons* line "\n" lines)))))))]))
+;; Options (FIXME)
+; (section :title "OPTIONS" :number #f [
+; ,(pre (let* ((proc (run-process "../etc/skribe-config" "--help" error: pipe:))
+; 	     (port (process-error-port proc)))
+; 	 (let loop ((line (read-line port))
+; 		    (lines '()))
+; 	    (if (eof-object? line)
+; 		(reverse! lines)
+; 		(begin
+; 		   (loop (read-line port) (cons* line "\n" lines)))))))])
+
+)
 
 
 
diff --git a/doc/user/skribec.skb b/doc/user/skribec.skb
index 0f00632..cad8f35 100644
--- a/doc/user/skribec.skb
+++ b/doc/user/skribec.skb
@@ -43,10 +43,10 @@ its possible targets which one to choose. These suffixes are:
 	      (item :key (it ".tex") [a ,(it "TeX") target file.])
 	      (item :key (it ".sui") [a ,(it "Skribe url index") file.]))])
 
-;; Options
-(section :title "OPTIONS" :number #f [
-,(mark "skribe compiler option")
-,(compiler-options *skribe-bin*)])
+;; Options (FIXME)
+;;(section :title "OPTIONS" :number #f [
+;;,(mark "skribe compiler option")
+;;,(compiler-options *skribe-bin*)])
 
 ;; Environment variables
 (section :title "ENVIRONMENT VARIABLES" :number #f [
diff --git a/doc/user/slide.skb b/doc/user/slide.skb
index 0137e84..aff8ab5 100644
--- a/doc/user/slide.skb
+++ b/doc/user/slide.skb
@@ -101,7 +101,8 @@ output format does not support embedded application.]))
    (p [Here is a complete example of Skribe slides:])
    
    (if (and (engine-format? "html") 
-	    (not (equal? (engine-custom html-engine 'html-variant) "html4")))
+	    (not (equal? (engine-custom (find-engine 'html) 'html-variant)
+	         "html4")))
        ;; Show the example and its result
        (example-produce
          (example :legend "Example of Skribe slides"
diff --git a/doc/user/src/slides.skb b/doc/user/src/slides.skb
index ac584d1..1606e91 100644
--- a/doc/user/src/slides.skb
+++ b/doc/user/src/slides.skb
@@ -7,8 +7,8 @@
 
    (if (engine-format? "html")
        (slide :title "Table of contents" :number #f :toc #f
-	  (toc :chapter #f :section #f :subsection #f :subsubsection #f
-	       :slide #t)))
+	  (toc :chapter #f :section #f :subsection #f :subsubsection #f)))
+;;;	       :slide #t)))
 
    (slide :title "X11 client" :toc #t :vspace 0.3
 
diff --git a/doc/user/toc.skb b/doc/user/toc.skb
index aa6c0dc..657ed7c 100644
--- a/doc/user/toc.skb
+++ b/doc/user/toc.skb
@@ -21,6 +21,7 @@
                          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))
diff --git a/doc/user/user.skb b/doc/user/user.skb
index d5ed06b..0c74e66 100644
--- a/doc/user/user.skb
+++ b/doc/user/user.skb
@@ -146,12 +146,12 @@ as HTML, Info pages, man pages, Postscript, etc.]))))
     (begin
        (chapter :title "Table of contents"
 	  (toc :chapter #t :section #t :subsection #t))
-       (section :title "Index" :number #f
+       (section :title "Index" :number #f :ident "Index"
 	  (mark "global index")
 	  (the-index :column (if (engine-format? "latex") 2 3)
 	     *markup-index* *custom-index* *function-index* *package-index*
 	     (default-index))))
-    (chapter :title "Index"
+    (chapter :title "Index" :ident "Index"
        (mark "global index")
        (the-index :column (if (engine-format? "latex") 2 3)
 	  *markup-index* *custom-index* *function-index* *package-index*
-- 
cgit v1.2.3