;;;;
;;;; source file of the GNU LilyPond music typesetter
;;;;
-;;;; (c) 2000--2006 Han-Wen Nienhuys <hanwen@cs.uu.nl>
+;;;; (c) 2000--2007 Han-Wen Nienhuys <hanwen@xs4all.nl>
;;;; Jan Nieuwenhuizen <janneke@gnu.org>
(define (engraver-makes-grob? name-symbol grav)
(string-append
"Properties (read)"
(description-list->texi
- (map (lambda (x) (property->texi 'translation x '())) propsr)))
+ (map (lambda (x) (property->texi 'translation x '())) propsr)))
"")
(if (null? propsw)
(string-append
"Properties (write)"
(description-list->texi
- (map (lambda (x) (property->texi 'translation x '())) propsw))))
+ (map (lambda (x) (property->texi 'translation x '())) propsw))))
(if (null? grobs)
""
(string-append
- "This engraver creates the following layout objects: \n "
- (human-listify (map ref-ify (uniq-list (sort grobs string<? ))))
+ "\n\nThis engraver creates the following layout objects:\n\n"
+ (human-listify (map ref-ify (uniq-list (sort grobs string<?))))
"."))
"\n\n"
(string-append
"@item Set "
- (format "grob-property @code{~a} " (string-join (map symbol->string path) " "))
- (format " in @ref{~a} to @code{~a}. " context-sym (scm->texi value))
+ (format "grob-property @code{~a} "
+ (string-join (map symbol->string path) " "))
+ (format "in @ref{~a} to ~a."
+ context-sym (scm->texi value))
"\n")))
((equal? (object-property context-sym 'is-grob?) #t) "")
((equal? tag 'assign)
- (format "@item Set translator property @code{~a} to @code{~a}"
+ (format "@item Set translator property @code{~a} to ~a.\n"
context-sym
(scm->texi (car args))))
)))
(string-append
desc
(if (pair? aliases)
- (string-append "\n\n This context is also known as: \n\n"
- (human-listify aliases))
+ (string-append
+ "\n\nThis context also accepts commands for the following context(s):\n\n"
+ (human-listify aliases)
+ ".")
"")
- "\n\nThis context creates the following layout objects: \n\n"
- (human-listify (uniq-list (sort grob-refs string<? )))
+
+ "\n\nThis context creates the following layout objects:\n\n"
+ (human-listify (uniq-list (sort grob-refs string<?)))
"."
- (if (pair? props)
- (string-append
- "\n\nThis context sets the following properties:\n"
- "@itemize @bullet\n"
- (apply string-append (map document-property-operation props))
- "@end itemize\n")
+
+ (if (and (pair? props) (not (null? props)))
+ (let ((str (apply string-append (map document-property-operation
+ props))))
+ (if (string-null? str)
+ ""
+ (string-append
+ "\n\nThis context sets the following properties:\n\n"
+ "@itemize @bullet\n"
+ str
+ "@end itemize\n")))
"")
(if (null? accepts)
- "\n\nThis context is a `bottom' context; it can not contain other contexts."
+ "\n\nThis context is a `bottom' context; it cannot contain other contexts."
(string-append
"\n\nContext "
- name " can contain \n"
- (human-listify (map ref-ify (map symbol->string accepts)))))
+ name
+ " can contain\n"
+ (human-listify (map ref-ify (map symbol->string accepts)))
+ "."))
- "\n\nThis context is built from the following engravers: "
- (description-list->texi
- (map document-engraver-by-name consists))))))
+ (if (null? consists)
+ ""
+ (string-append
+ "\n\nThis context is built from the following engravers:"
+ (description-list->texi (map document-engraver-by-name consists))))))))
(define (engraver-grobs grav)
(let* ((eg (if (symbol? grav)
(make <texi-node>
#:name "Contexts"
- #:desc "Complete descriptions of all contexts"
+ #:desc "Complete descriptions of all contexts."
#:children
(map context-doc contexts))))
(define (all-engravers-doc)
(make <texi-node>
#:name "Engravers"
- #:desc "All separate engravers"
- #:text "See @usermanref{Modifying context plug-ins}."
+ #:desc "All separate engravers."
+ #:text "See @ruser{Modifying context plug-ins}."
#:children
(map engraver-doc all-engravers-list)))
(define (translation-doc-node)
(make <texi-node>
#:name "Translation"
- #:desc "From music to layout"
+ #:desc "From music to layout."
#:children
(list
(all-contexts-doc)
(all-engravers-doc)
(make <texi-node>
#:name "Tunable context properties"
- #:desc "All tunable context properties"
+ #:desc "All tunable context properties."
#:text (translation-properties-doc-string
all-user-translation-properties))
(make <texi-node>
#:name "Internal context properties"
- #:desc "All internal context properties"
+ #:desc "All internal context properties."
#:text (translation-properties-doc-string
all-internal-translation-properties)))))