X-Git-Url: https://git.donarmstrong.com/?a=blobdiff_plain;f=scm%2Fdocumentation-lib.scm;h=0c9e2bdec6a1a5bbe2491e14b645ae29ba1c4f65;hb=edf17353d89f4f6bd831466262402bb9151a26ca;hp=5a62f9728c15a52244f06cdffea190cc14260b0a;hpb=9f3572d98bb948c9689cd1f75401a029451fa001;p=lilypond.git diff --git a/scm/documentation-lib.scm b/scm/documentation-lib.scm index 5a62f9728c..0c9e2bdec6 100644 --- 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 +;;;; (c) 2000--2007 Han-Wen Nienhuys ;;;; Jan Nieuwenhuizen (use-modules (oop goops) @@ -21,13 +21,16 @@ (node-name x) (node-desc x))) -(define (dump-node node port level) +(define* (dump-node node port level #:optional (appendix #f)) (display (string-append "\n@node " (node-name node) "\n\n" - (texi-section-command level) " " + (if appendix + (texi-appendix-section-command level) + (texi-section-command level)) + " " (node-name node) "\n\n" (node-text node) @@ -38,7 +41,7 @@ (node-children node))) "")) port) - (map (lambda (x) (dump-node x port (+ 1 level))) + (map (lambda (x) (dump-node x port (+ 1 level) appendix)) (node-children node))) (define (processing name) @@ -59,28 +62,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 +115,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"))) @@ -111,7 +125,7 @@ "\\input texinfo @c -*-texinfo-*-" "\n@setfilename " file-name ".info" "\n@settitle " name - "\n@dircategory GNU music project" + "\n@dircategory LilyPond" "\n@direntry" ;; prepend GNU for dir, must be unique "\n* GNU " name ": (" file-name "). " name "." @@ -169,7 +183,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 "} "