* VERSION (MY_PATCH_LEVEL): make 1.7.0

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

diff --git a/scm/documentation-lib.scm b/scm/documentation-lib.scm
index 5bc447653120e3dca7e7edba5b188592d0e74cfe..626f2fc250ce7350f237f2eeec4609accb42ce36 100644 (file)
--- a/scm/documentation-lib.scm
+++ b/scm/documentation-lib.scm
@@ -3,15 +3,11 @@
 ;;;
 ;;; source file of the GNU LilyPond music typesetter
 ;;; 
-;;; (c) 2000 Han-Wen Nienhuys <hanwen@cs.uu.nl>
+;;; (c) 2000--2001 Han-Wen Nienhuys <hanwen@cs.uu.nl>
 ;;; Jan Nieuwenhuizen <janneke@gnu.org>
 
-(define (uniqued-alist  alist acc)
-  (if (null? alist) acc
-      (if (assoc (caar alist) acc)
-         (uniqued-alist (cdr alist) acc)
-         (uniqued-alist (cdr alist) (cons (car alist) acc)
-  ))))
+(define (processing name)
+  (display (string-append "\nProcessing " name " ... ") (current-error-port)))
 
 (define (self-evaluating? x)
   (or (number? x) (string? x) (procedure? x) (boolean? x)))
@@ -25,21 +21,32 @@
 ;;       )
 ;;    x2))
 
+
+
+(define (scm->texi x)
+  (string-append "@code{" (texify (scm->string x)) "}")
+  )
+
+
+;;
+;; don't confuse users with #<procedure .. > syntax. 
+;; 
 (define (scm->string val)
-  (string-append
-   (if (self-evaluating? val) "" "'")
-   (texify 
-    (call-with-output-string (lambda (port) (display val port))))
-  ))
+  (if (and (procedure? val) (symbol? (procedure-name val)))
+      (symbol->string (procedure-name val))
+      (string-append
+       (if (self-evaluating? val) "" "'")
+       (call-with-output-string (lambda (port) (display val port)))
+       )))
 
 (define (node name)
   (string-append
    "\n@html"
    "\n<hr>"
    "\n@end html"
-   "\n@node " name ",,,"))
+   "\n@node " name))
 
-(define section-alist
+(define texi-section-alist
   '(
     ;; Hmm, texinfo doesn't have ``part''
     (0 . "@top")
@@ -50,60 +57,125 @@
     (5 . "@unnumberedsubsubsec")
     ))
     
-(define (section level name)
-  (string-append "\n" (cdr (assoc level section-alist)) " " name "\n"))
-   
-(define (description-list items-alist)
+(define (texi-section level name ref)
+  "texi sectioning command (lower LEVEL means more significant).
+Add a ref if REF is set
+"
+     
+  (string-append
+   "\n" (cdr (assoc level texi-section-alist)) " "
+   (if ref
+       (ref-ify name)
+       name)
+   "\n"))
+
+
+(define (one-item->texi label-desc-pair)
+  "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)
+"
   (string-append
    "\n@table @samp\n"
-   (apply string-append
-         (map (lambda (x) (string-append "\n@item " (car x) "\n" (cdr x)))
-              items-alist))
+   (apply string-append (map one-item->texi items-alist))
    "\n@end table\n"))
 
 (define (texi-menu items-alist)
+  (let
+      (
+       (maxwid (apply max (map (lambda (x) (string-length (car x)))
+                              items-alist)))
+       )
+    
+
+    
   (string-append
   "\n@menu"
   (apply string-append
-        (map (lambda (x) (string-append "\n* " (car x) ":: " (cdr x)))
+        (map (lambda (x)
+               (string-append
+               (pad-string-to 
+                (string-append "\n* " (car x) ":: ")
+                (+ maxwid 8)
+                )
+               (cdr x))
+               )
              items-alist))
   "\n@end menu\n"
   ;; Menus don't appear in html, so we make a list ourselves
+  "\n@ignore\n"
   "\n@ifhtml\n"
-  (description-list (map (lambda (x) (cons (reffy (car x)) (cdr x)))
+  (description-list->texi (map (lambda (x) (cons (ref-ify (car x)) (cdr x)))
                         items-alist))
-  "\n@end ifhtml\n"))
+  "\n@end ifhtml\n"
+  "\n@end ignore\n")))
 
   
 (define (texi-node-menu name items-alist)
   (string-append
    (node name)
-   (section 1 name)
+   (texi-section 1 name #f)
    (texi-menu items-alist)))
 
+
+
 (define (texi-file-head name file-name top items-alist)
+
+  
   (string-append
-   "\input texinfo @c -*-texinfo-*-\n"
-   "@settitle " name
+   "\\input texinfo @c -*-texinfo-*-"
    "\n@setfilename " file-name ".info"
-   (node "Top") top
+   "\n@settitle " name
+   "\n@dircategory GNU music project"
+   "\n@direntry"
+   ;; prepend GNU for dir, must be unique
+   "\n* GNU " name ": (" file-name ").          " name "."
+   "\n@end direntry"
+   ;; ugh, prev and next should be settable, of course
+   (node "Top") ",(lilypond)Index,(lilypond)Full Grob interface list," top
    "\n@top"
-   (section 1 name)
-   (texi-menu items-alist)))
+   (texi-section 1 name #f)
+   (texi-menu items-alist)
+   "\n@contents"
+   ))
+
+(define (itexi-file-head name file-name top items-alist)
+  (string-append
+   "@c -*-texinfo-*-"
+   (node name) ",,," top
+   (texi-section 1 name #f)
+   (texi-menu items-alist)
+   "\n@contents"
+   ))
+
 
 (define (context-name name)
-  (string-append "Context " name))
+  name)
 
 (define (engraver-name name)
   name)
 
-(define (element-name name)
-  (string-append "Element " name))
+(define (grob-name name)
+  (if (symbol? name)
+      (symbol->string name)
+      name))
 
-(define (reffy x)
+(define (interface-name name)
+  name)
+
+(define (ref-ify x)
   (string-append "@ref{" x "}"))
 
 (define (human-listify l)
+  "Produce a textual enumeration from L, a list of strings"
+  
   (cond
    ((null? l) "none")
    ((null? (cdr l)) (car l))