]> git.donarmstrong.com Git - lilypond.git/blobdiff - scm/documentation-lib.scm
release: 1.5.13
[lilypond.git] / scm / documentation-lib.scm
index e94a23de9afcb6793c72a66add3cdc0a56aa6c67..3a27cbbc7772fb0e4db131f246ee5955817786e7 100644 (file)
@@ -1,18 +1,11 @@
-;;
+;;;
 ;;; documentation-lib.scm -- Assorted Functions for generated documentation
 ;;;
 ;;; 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)))
 
@@ -45,7 +38,7 @@
    "\n@html"
    "\n<hr>"
    "\n@end html"
-   "\n@node " name ",,,"))
+   "\n@node " name))
 
 (define texi-section-alist
   '(
@@ -66,7 +59,7 @@ Add a ref if REF is set
   (string-append
    "\n" (cdr (assoc level texi-section-alist)) " "
    (if ref
-       (string-append "@ref{" name "}") 
+       (ref-ify name)
        name)
    "\n"))
 
@@ -98,7 +91,7 @@ Add a ref if REF is set
   ;; Menus don't appear in html, so we make a list ourselves
   "\n@ignore\n"
   "\n@ifhtml\n"
-  (description-list->texi (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 ignore\n"))
@@ -115,29 +108,49 @@ Add a ref if REF is set
    "\\input texinfo @c -*-texinfo-*-"
    "\n@setfilename " file-name ".info"
    "\n@settitle " name
-   (node "Top") top
+   "\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"
    (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 (interface-name name)
   name)
 
-(define (reffy x)
+(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))