summary refs log tree commit diff
path: root/doc/user/document.skb
diff options
context:
space:
mode:
Diffstat (limited to 'doc/user/document.skb')
-rw-r--r--doc/user/document.skb80
1 files changed, 80 insertions, 0 deletions
diff --git a/doc/user/document.skb b/doc/user/document.skb
new file mode 100644
index 0000000..09f8cb3
--- /dev/null
+++ b/doc/user/document.skb
@@ -0,0 +1,80 @@
+;*=====================================================================*/
+;*    serrano/prgm/project/skribe/doc/user/document.skb                */
+;*    -------------------------------------------------------------    */
+;*    Author      :  Manuel Serrano                                    */
+;*    Creation    :  Tue Sep  2 11:39:07 2003                          */
+;*    Last change :  Wed Feb  4 14:51:12 2004 (serrano)                */
+;*    Copyright   :  2003-04 Manuel Serrano                            */
+;*    -------------------------------------------------------------    */
+;*    Document and author                                              */
+;*=====================================================================*/
+
+;*---------------------------------------------------------------------*/
+;*    dummy-document-output ...                                        */
+;*---------------------------------------------------------------------*/
+(define dummy-document-output
+   (lambda (n e)
+      (let* ((a (markup-option n :author))
+	     (t (markup-option n :title))
+	     (b (markup-body n))
+	     (ta (table (tr (map (lambda (n) 
+				    (td :valign 'top :align 'center n))
+				 a)))))
+	 (skribe-eval (center (bold t)) e)
+	 (skribe-eval (center ta) e)
+	 (output b e))))
+
+;*---------------------------------------------------------------------*/
+;*    Document                                                         */
+;*---------------------------------------------------------------------*/
+(section :title "Building documents" :file #t
+
+;*--- document --------------------------------------------------------*/
+(subsection :title "Document"
+
+(p [The ,(tt "document") function defines a Skribe document.])
+
+(doc-markup 'document
+	    '((:title "The title of the document.")
+	      (:html-title "The title of window of the HTML browser.")
+	      (:author "The authors of the document.")
+	      (:ending "An ending text.")
+	      (:env "A counter environment.")
+	      (#!rest node... "The document nodes."))
+	    :see-also '(author chapter toc))
+
+(example-produce
+ (example :legend "The document markup" (prgm :file "src/api2.skb"))
+ (disp 
+  (processor :combinator 
+	     (lambda (e1 e2)
+		(let ((e (copy-engine 'document-engine e2)))
+		   (markup-writer 'document e
+				  :options '(:title :author :ending)
+				  :action dummy-document-output)
+		   e))
+	     (include "src/api2.skb")))))
+	       
+;*---------------------------------------------------------------------*/
+;*    Author ...                                                       */
+;*---------------------------------------------------------------------*/
+(subsection :title "Author"
+
+(p [The ,(tt "author") function is used to specify the authors of a Skribe
+document.])
+
+(doc-markup 'author
+	    '((:name "The name of the author.")
+	      (:title "His title.")
+	      (:affiliation "His affiliation.")
+	      (:email "His email.")
+	      (:url "His web page.")
+	      (:address "His address.")
+	      (:phone "His phone number.")
+	      (:photo "His photograph.")
+	      (:align "The author item alignment."))
+	    :see-also '(mailto ref))
+
+(example-produce 
+ (example :legend "The author markup" (prgm :file "src/api3.skb"))
+ (disp (include "src/api3.skb")))))