1 ;;;; generate-documentation.scm -- Generate documentation
3 ;;;; source file of the GNU LilyPond music typesetter
5 ;;;; (c) 2000--2006 Han-Wen Nienhuys <hanwen@xs4all.nl>
6 ;;;; Jan Nieuwenhuizen <janneke@gnu.org>
8 ;;; File entry point for generated documentation
9 ;;; Running LilyPond on this file generates the documentation
11 ;;(set-debug-cell-accesses! 5000)
14 ;;;;;;;;;;;;;;;; TODO : make modules of these!
17 ;; todo: naming: grob vs. layout property
19 (map ly:load '("documentation-lib.scm"
20 "document-functions.scm"
21 "document-translation.scm"
23 "document-identifiers.scm"
24 "document-backend.scm"
25 "document-markup.scm"))
27 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
30 (slot-ref (all-scheme-functions-doc) 'text)
31 (open-output-file "scheme-functions.tely"))
35 (open-output-file "markup-commands.tely"))
38 (identifiers-doc-string)
39 (open-output-file "identifiers.tely"))
43 (backend-properties-doc-string all-user-grob-properties)
44 (open-output-file "layout-properties.tely"))
47 (translation-properties-doc-string all-user-translation-properties)
48 (open-output-file "context-properties.tely"))
50 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
52 (define file-name "lilypond-internals")
53 (define outname (string-append file-name ".texi"))
55 (define out-port (open-output-file outname))
61 (texi-file-head "LilyPond program-reference" file-name
62 "(lilypond/lilypond-internals.info)")
65 @c NOTE: This is documentation-generate.scm, not macros.itexi
68 @macro usermanref{NAME}
69 @ref{\\NAME\\,,,lilypond}
75 @macro usermanref{NAME}
76 @inforef{\\NAME\\,,,lilypond}
82 @macro usermanref{NAME}
88 @macro glossaryref{NAME}
89 @ref{\\NAME\\,,,music-glossary}
95 @macro glossaryref{NAME}
96 @inforef{\\NAME\\,,lilypond/music-glossary}
102 @macro internalsref{NAME}
108 @macro inputfileref{DIR,NAME}
109 @uref{source/\\DIR\\/out-www/collated-files.html#\\NAME\\,@file{\\DIR\\/\\NAME\\}}@c
116 @macro inputfileref{DIR,NAME}
117 @file{\\DIR\\/\\NAME\\}
123 @macro inputfileref{DIR,NAME}@c
124 @file{\\DIR\\/\\NAME\\}@c
130 @omftitle LilyPond internals
131 @omfcreator Han-Wen Nienhuys and Jan Nieuwenhuizen
132 @omfdescription Programmer's reference of the LilyPond music engraving system
133 @omftype user's guide
135 @omfcategory Applications|Publishing
146 (string-append "This is the program reference for LilyPond version " (lilypond-version))
151 (translation-doc-node)
153 (all-scheme-functions-doc)
157 @unnumbered Concept index
161 @unnumbered Variable index
165 @unnumbered Function index
171 (dump-node top-node out-port 0)
172 (newline (current-error-port))