X-Git-Url: https://git.donarmstrong.com/?a=blobdiff_plain;f=scm%2Fdocumentation-lib.scm;h=0c9a1f117b37cadb1f7876f40a7e7516f654aed7;hb=5b4b0d6e9a197e8f9eb085b7c2ad78b8be3e5cfc;hp=5dc35f25a9386b03a7922ae2b9c555f6f09d0684;hpb=92e8f758e29427d28c413d1998c895b9c61932fd;p=lilypond.git diff --git a/scm/documentation-lib.scm b/scm/documentation-lib.scm index 5dc35f25a9..0c9a1f117b 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--2008 Han-Wen Nienhuys ;;;; Jan Nieuwenhuizen (use-modules (oop goops) @@ -11,6 +11,7 @@ (srfi srfi-1)) (define-class () + (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,32 +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" - "@quotation\n" + (if quote? "@quotation\n" "") "@table @asis\n" (apply string-append (map one-item->texi items-alist)) "\n" "@end table\n" - "@end quotation\n")) + (if quote? "@end quotation\n" ""))) (define (texi-menu items-alist) "Generate what is between @menu and @end menu." @@ -106,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")))