Run `make grand-replace'.

[lilypond.git] / scm / documentation-lib.scm

diff --git a/scm/documentation-lib.scm b/scm/documentation-lib.scm
index 859032cc422c661461a7c5921b5443e54d198e2f..0c9a1f117b37cadb1f7876f40a7e7516f654aed7 100644 (file)
--- a/scm/documentation-lib.scm
+++ b/scm/documentation-lib.scm
@@ -3,7 +3,7 @@
 ;;;;
 ;;;; source file of the GNU LilyPond music typesetter
 ;;;; 
-;;;; (c) 2000--2006 Han-Wen Nienhuys <hanwen@cs.uu.nl>
+;;;; (c) 2000--2008 Han-Wen Nienhuys <hanwen@xs4all.nl>
 ;;;;                 Jan Nieuwenhuizen <janneke@gnu.org>
 
 (use-modules (oop goops)
@@ -11,6 +11,7 @@
             (srfi srfi-1))
 
 (define-class <texi-node> ()
+  (appendix #:init-value #f #:accessor appendix? #:init-keyword #:appendix)
   (children #:init-value '() #:accessor node-children #:init-keyword #:children)
   (text #:init-value "" #:accessor node-text #:init-keyword #:text)
   (name #:init-value "" #:accessor node-name #:init-keyword #:name)
@@ -21,13 +22,16 @@
    (node-name x)
    (node-desc x)))
 
-(define (dump-node node port level)
+(define* (dump-node node port level)
   (display
    (string-append
     "\n@node "
-    (node-name node)
-    "\n\n"
-    (texi-section-command level) " "
+    (if (= level 0) "Top" (node-name node))
+    "\n"
+    (if (appendix? node)
+        (texi-appendix-section-command level)
+        (texi-section-command level))
+    " "
     (node-name node)
     "\n\n"
     (node-text node)
@@ -59,28 +63,38 @@
   (cdr (assoc level '(
                      ;; Hmm, texinfo doesn't have ``part''
                      (0 . "@top")
-                     (1 . "@unnumbered")
-                     (2 . "@unnumberedsec")
-                     (3 . "@unnumberedsubsec")
+                     (1 . "@chapter")
+                     (2 . "@section")
+                     (3 . "@subsection")
                      (4 . "@unnumberedsubsubsec")
                      (5 . "@unnumberedsubsubsec")))))
 
+(define (texi-appendix-section-command level)
+  (cdr (assoc level '((0 . "@top")
+                     (1 . "@appendix")
+                     (2 . "@appendixsec")
+                     (3 . "@appendixsubsec")
+                     (4 . "@appendixsubsubsec")
+                     (5 . "@appendixsubsubsec")))))
+
 (define (one-item->texi label-desc-pair)
-  "Document one (LABEL . DESC); return empty string if LABEL is empty string. 
-"
+  "Document one (LABEL . DESC); return empty string if LABEL is empty string."
   (if (eq? (car label-desc-pair) "")
       ""
       (string-append "\n@item " (car label-desc-pair) "\n" (cdr label-desc-pair))))
 
 
-(define (description-list->texi items-alist)
-  "Document ITEMS-ALIST in a table. entries contain (item-label
-. string-to-use)
-"
+(define (description-list->texi items-alist quote?)
+  "Document ITEMS-ALIST in a table; entries contain (item-label .
+string-to-use).  If QUOTE? is #t, embed table in a @quotation environment."
   (string-append
-   "\n@table @asis\n"
+   "\n"
+   (if quote? "@quotation\n" "")
+   "@table @asis\n"
    (apply string-append (map one-item->texi items-alist))
-   "\n@end table\n"))
+   "\n"
+   "@end table\n"
+   (if quote? "@end quotation\n" "")))
 
 (define (texi-menu items-alist)
   "Generate what is between @menu and @end menu."
@@ -102,7 +116,8 @@
      "\n@ignore\n"
      "\n@ifhtml\n"
      (description-list->texi (map (lambda (x) (cons (ref-ify (car x)) (cdr x)))
-                                 items-alist))
+                                 items-alist)
+                            #t)
      "\n@end ifhtml\n"
      "\n@end ignore\n")))
 
@@ -169,7 +184,7 @@ with init values from ALIST (1st optional argument)
         (handle (assoc sym alist)))
 
     (if (eq? desc #f)
-       (ly:error (_ "can't find description for property ~S (~S)") sym where))
+       (ly:error (_ "cannot find description for property ~S (~S)") sym where))
     
     (cons
      (string-append "@code{" name "} "