X-Git-Url: https://git.donarmstrong.com/?a=blobdiff_plain;f=scm%2Fdocument-translation.scm;h=222ee0985164ac90413bd6c08454c2dfc39a469c;hb=1bb7659e935633c0bb6fb12aa750e5ee298651d2;hp=e7e8cdd5d375b18fe3513e2caaa2b558ecde5f49;hpb=24c7d404da8d79032e767c8441b6f0329d87eb56;p=lilypond.git diff --git a/scm/document-translation.scm b/scm/document-translation.scm index e7e8cdd5d3..222ee09851 100644 --- a/scm/document-translation.scm +++ b/scm/document-translation.scm @@ -1,10 +1,9 @@ - -;;; engraver-doumentation-lib.scm -- Functions for engraver documentation -;;; -;;; source file of the GNU LilyPond music typesetter -;;; -;;; (c) 2000--2004 Han-Wen Nienhuys -;;; Jan Nieuwenhuizen +;;;; document-translation.scm -- Functions for engraver documentation +;;;; +;;;; source file of the GNU LilyPond music typesetter +;;;; +;;;; (c) 2000--2004 Han-Wen Nienhuys +;;;; Jan Nieuwenhuizen (define (engraver-makes-grob? name-symbol grav) @@ -30,7 +29,7 @@ (propsw (cdr (assoc 'properties-written (ly:translator-description engraver)))) (accepted (cdr (assoc 'events-accepted (ly:translator-description engraver)))) (name-sym (ly:translator-name engraver)) - (name (symbol->string name-sym)) + (name-str (symbol->string name-sym)) (desc (cdr (assoc 'description (ly:translator-description engraver)))) (grobs (engraver-grobs engraver)) ) @@ -54,7 +53,7 @@ (string-append "Properties (read)" (description-list->texi - (map (lambda (x) (document-property x 'translation #f)) propsr))) + (map (lambda (x) (property->texi 'translation x '())) propsr))) "") (if (null? propsw) @@ -62,36 +61,46 @@ (string-append "Properties (write)" (description-list->texi - (map (lambda (x) (document-property x 'translation #f)) propsw)))) + (map (lambda (x) (property->texi 'translation x '())) propsw)))) (if (null? grobs) "" (string-append - "This engraver creates the following grobs: \n " - (human-listify (map ref-ify (uniq-list (sort grobs stringstring contexts))))) + "@code{" name-str "} is part of contexts: " + (human-listify (map ref-ify + (sort + (map symbol->string contexts) stringengraver-table (make-vector 61 '())) (map (lambda (x) @@ -124,7 +132,7 @@ (eg (find-engraver-by-name name )) ) - (cons (symbol->string name ) + (cons (string-append "@code{" (ref-ify (symbol->string name)) "}") (engraver-doc-string eg #f) ) )) @@ -180,8 +188,11 @@ (cdr desc-handle) "(not documented)")) (accepts (cdr (assoc 'accepts context-desc))) + (group (assq-ref context-desc 'group-type)) + (consists (append - (list (cdr (assoc 'group-type context-desc))) + (if group (list group) + '()) (cdr (assoc 'consists context-desc)) )) (props (cdr (assoc 'property-ops context-desc))) @@ -193,9 +204,11 @@ #:text (string-append desc - "\n\n This context is also known as: \n\n" - (human-listify aliases) - "\n\nThis context creates the following grobs: \n\n" + (if (pair? aliases) + (string-append "\n\n This context is also known as: \n\n" + (human-listify aliases)) + "") + "\n\nThis context creates the following layout objects: \n\n" (human-listify (uniq-list (sort grob-refs stringtexi - (map document-engraver-by-name consists)) + (map document-engraver-by-name consists)) )))) -(define (engraver-grobs grav) +(define (engraver-grobs grav) (let* ((eg (if (symbol? grav) (find-engraver-by-name grav) grav))) - (if (eq? eg #f) '() (map symbol->string (cdr (assoc 'grobs-created (ly:translator-description eg))))) )) (define (context-grobs context-desc) - (let* ((consists (append - (list (cdr (assoc 'group-type context-desc))) + (let* ( + (group (assq-ref context-desc 'group-type)) + (consists (append + (if group + (list group) + '()) (cdr (assoc 'consists context-desc)) )) (grobs (apply append @@ -246,7 +262,7 @@ (define (all-contexts-doc) (let* ( (paper-alist - (sort (My_lily_parser::paper_description) + (sort (ly:output-description $defaultpaper) (lambda (x y) (symbolstring (map car paper-alist)) string #:name "Engravers" #:desc "All separate engravers" + #:text "See @usermanref{Modifying context plug-ins}." #:children (map engraver-doc all-engravers-list))) @@ -280,7 +297,7 @@ (sortedsyms (map string->symbol ps)) (propdescs (map - (lambda (x) (document-property x 'translation #f)) + (lambda (x) (property->texi 'translation x '())) sortedsyms)) (texi (description-list->texi propdescs))) texi