1 ;;; generate-documentation.scm -- Generate documentation
3 ;;; source file of the GNU LilyPond music typesetter
5 ;;; (c) 2000--2001 Han-Wen Nienhuys <hanwen@cs.uu.nl>
6 ;;; Jan Nieuwenhuizen <janneke@gnu.org>
8 ;;; File entry point for generated documentation
10 ;;; Running LilyPond on this file generates the documentation
16 ;;;;;;;;;;;;;;;; TODO : make modules of these!
19 (define load-files '("documentation-lib.scm"
20 "function-documentation.scm"
21 "engraver-documentation-lib.scm"
22 "music-documentation-lib.scm"
23 "backend-documentation-lib.scm"
26 (map load-from-path load-files)
29 ;;(define no-copies #t) ; from 490 to 410K, but doesn't look nice yet
31 ;; Also, copies of interfaces use up lots more space, but that's
32 ;; functional because the default property values of the interfaces
38 (let* ((doc (string-append
39 (document-music "music properties")
40 (document-paper "interpretation contexts")
41 (document-all-engravers "engravers")
42 (document-all-engraver-properties "context properties")
43 (document-all-grobs "backend")
44 (document-all-interfaces "interfaces")
46 (node "backend properties")
47 (texi-section 1 "backend properties" #f)
49 (document-all-backend-properties "backend properties")
51 (node "function documentation")
52 (texi-section 1 "function documentation" #f)
54 (document-all-scheme-functions)
58 (name "lilypond-internals")
59 (outname (string-append name ".texi"))
60 (out (open-output-file outname)))
67 ;; we can't use (dir) and top if we're included by lilypond.tely
68 "LilyPond internals" name "(lilypond.info)"
70 ("music properties" . "properties for Music representation")
71 ("interpretation contexts" . "Hierarchy and grouping of Engravers")
72 ("engravers" . "Engravers create Grobs")
73 ("context properties" . "context properties")
74 ("backend" . "Detailed description of all Grobs")
75 ("interfaces" . "Grob Interfaces")
76 ("backend properties" . "Grob properties")
77 ("function documentation" . "Grob properties")
86 @unnumbered Concept index
90 @unnumbered Variable index
94 @unnumbered Function index
104 (newline (current-error-port))