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
71 @macro usermanref{NAME}
72 @ref{\\NAME\\,,,lilypond}
76 @macro glossaryref{NAME}
77 @ref{\\NAME\\,,,music-glossary}
81 @macro inputfileref{DIR,NAME}
82 @uref{source/\\DIR\\/out-www/collated-files.html#\\NAME\\,@file{\\DIR\\/\\NAME\\}}@c
87 ‘\\TEXT\\’
96 @macro usermanref{NAME}
97 @inforef{\\NAME\\,,,lilypond}
101 @macro glossaryref{NAME}
102 @inforef{\\NAME\\,,lilypond/music-glossary}
106 @macro inputfileref{DIR,NAME}
107 @file{\\DIR\\/\\NAME\\}
119 @macro usermanref{NAME}
123 @macro inputfileref{DIR,NAME}@c
124 @file{\\DIR\\/\\NAME\\}@c
133 @macro internalsref{NAME}
139 @omftitle LilyPond internals
140 @omfcreator Han-Wen Nienhuys and Jan Nieuwenhuizen
141 @omfdescription Programmer's reference of the LilyPond music engraving system
142 @omftype user's guide
144 @omfcategory Applications|Publishing
155 (string-append "This is the program reference for LilyPond version " (lilypond-version))
160 (translation-doc-node)
162 (all-scheme-functions-doc)
166 @unnumbered Concept index
170 @unnumbered Variable index
174 @unnumbered Function index
180 (dump-node top-node out-port 0)
181 (newline (current-error-port))