From bf65015355fc0afe9bde6edc85118818de27bedc Mon Sep 17 00:00:00 2001
From: Ludovic Courtès
Date: Wed, 23 Jan 2008 18:24:22 +0100
Subject: doc: Update `slide' package documentation.

---
 doc/user/slide.skb      | 26 ++++++++++++++------------
 doc/user/src/slides.skb | 13 +++++++------
 2 files changed, 21 insertions(+), 18 deletions(-)

(limited to 'doc')

diff --git a/doc/user/slide.skb b/doc/user/slide.skb
index 9834ff9..b6ccd6b 100644
--- a/doc/user/slide.skb
+++ b/doc/user/slide.skb
@@ -1,7 +1,7 @@
 ;;; slide.skb  --  Slides
 ;;;
+;;; Copyright 2006, 2008  Ludovic Courtès <ludo@gnu.org>
 ;;; Copyright 2004  Manuel Serrano
-;;; Copyright 2006  Ludovic Courtès <ludovic.courtes@laas.fr>
 ;;;
 ;;;
 ;;; This program is free software; you can redistribute it and/or modify
@@ -60,14 +60,16 @@
 ;*---------------------------------------------------------------------*/
 (chapter :title "Slide Package"
 
-   (p [
-This chapter describes the facilities Skribe offers authoring slides.
-In order to access the functionalities described in this chapter, it
-is require to introduce a ,(code [(skribe-load "slides.skr")]) expression
-at the beginning of the document. The Slide package supports two 
-,(markup-ref "skribe-load") user options: ,(param :advi) and ,(param :prosper).
-The first one tells Skribe to generate slides for the Advi presenter. The 
-second one tells Skribe to generate slides for the LaTeX prosper package.])
+   (p [This chapter describes the facilities Skribilo offers authoring
+slides.  As usual, in order to access the functionalities described in
+this chapter, the ,(code [(use-modules (skribilo package slide))])
+expression must be introduced at the beginning of the document.])
+
+   ;; FIXME: The following paragraph describes inaccessible features.
+   #;(p [The Slide package supports two ,(markup-ref "skribe-load") user
+options: ,(param :advi) and ,(param :prosper).  The first one tells
+Skribe to generate slides for the Advi presenter. The second one tells
+Skribe to generate slides for the LaTeX prosper package.])
 
 ;*---------------------------------------------------------------------*/
 ;*    slide ... @label slide@                                          */
@@ -166,7 +168,7 @@ to the embedded application.])
 		 (:transient-opt [The name of the transient option to be sent
 to the embedded application.])
 		 (:transient [The transient value to be sent.])
-		 (:alt [An alternative Skribe expression to be used if the
+		 (:alt [An alternative Skribilo expression to be used if the
 output format does not support embedded application.]))
 	       :common-args '()
 	       :source "skribilo/package/slide.scm"))
@@ -175,7 +177,7 @@ output format does not support embedded application.]))
 ;*    Example                                                          */
 ;*---------------------------------------------------------------------*/
 (section :title "Example"
-   (p [Here is a complete example of Skribe slides:])
+   (p [Here is a complete example of Skribilo slides:])
    
    (if (and (engine-format? "html") 
 	    (not (equal? (engine-custom (find-engine 'html) 'html-variant)
@@ -203,5 +205,5 @@ output format does not support embedded application.]))
 			 e))
 		     (include "src/slides.skb"))))
        ;; Show only the example (i.e. don't produce a document in a document)
-       (example :legend "Example of Skribe slides"
+       (example :legend "Example of Skribilo slides"
 	       (prgm :file "src/slides.skb")))))
diff --git a/doc/user/src/slides.skb b/doc/user/src/slides.skb
index e5e6896..dfc4572 100644
--- a/doc/user/src/slides.skb
+++ b/doc/user/src/slides.skb
@@ -1,12 +1,13 @@
-(skribe-load "slide.skr" :advi #t)
+(use-modules (skribilo package slide))
 
-(document :title (color :fg "red" (sf (font :size +2. "Skribe Slides")))
-   :author (author :name (it "Manuel Serrano")
-	      :affiliation [Inria Sophia Antipolis]
-	      :address (ref :url "http://www.inria.fr/mimosa/Manuel.Serrano"))
+(document :title (color :fg "red" (sf "Skribilo Slides"))
+   :author (author :name (it [Bob Smith])
+	      :affiliation [The Organization]
+	      :address (ref :url "http://example.org/"))
 
    (if (engine-format? "html")
        (slide :title "Table of Contents" :number #f :toc #f
+	  ;; HTML-specific table of contents.
 	  (toc :chapter #f :section #f :subsection #f :subsubsection #f)))
 ;;;	       :slide #t)))
   
@@ -16,7 +17,7 @@
 
    (slide-topic :title "Interactive Features" :outline? #t
 
-     (slide :title "X11 client" :toc #t :vspace 0.3
+     (slide :title "X11 Clients" :toc #t :vspace 0.3
 
 	(itemize
 	   (item "xlock")
-- 
cgit v1.2.3