-;;
+;;;
;;; 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 (alist<? x y)
- (string<? (symbol->string (car x))
- (symbol->string (car y))))
-
(define (processing name)
(display (string-append "\nProcessing " name " ... ") (current-error-port)))
(string-append "@code{" (texify (scm->string x)) "}")
)
+
+;;
+;; don't confuse users with #<procedure .. > syntax.
+;;
(define (scm->string val)
- (string-append
- (if (self-evaluating? val) "" "'")
- (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
(string-append
"\n" (cdr (assoc level texi-section-alist)) " "
(if ref
- (string-append "@ref{" name "}")
+ (ref-ify name)
name)
"\n"))
"\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->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"))
+ "\n@end ignore\n")))
(define (texi-node-menu name items-alist)
(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@setfilename " file-name ".info"
"\n@dircategory GNU music project"
"\n@direntry"
;; prepend GNU for dir, must be unique
- "\n* GNU " name " (" file-name "). " name "."
+ "\n* GNU " name ": (" file-name "). " name "."
"\n@end direntry"
- (node "Top") ",(lilypond)Development,," top
+ ;; 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 (grob-name name)
- (string-append "Grob " 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))