1 ;;; generate-documentation.scm -- Generate documentation
3 ;;; source file of the GNU LilyPond music typesetter
5 ;;; (c) 2000--2004 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
12 ;(set-debug-cell-accesses! 5000)
15 ;;;;;;;;;;;;;;;; TODO : make modules of these!
18 ; todo: naming: grob vs. layout property
20 (map ly:load '("documentation-lib.scm"
21 "document-functions.scm"
22 "document-translation.scm"
24 "document-backend.scm"
28 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
31 (slot-ref (all-scheme-functions-doc) 'text)
32 (open-output-file "scheme-functions.tely"))
36 (open-output-file "markup-commands.tely"))
40 (backend-properties-doc-string all-user-grob-properties)
41 (open-output-file "layout-properties.tely") )
44 (translation-properties-doc-string all-user-translation-properties)
45 (open-output-file "context-properties.tely") )
46 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
49 (define file-name "lilypond-internals")
50 (define outname (string-append file-name ".texi"))
53 (define out-port (open-output-file outname))
63 (texi-file-head "LilyPond program-reference" file-name
64 "(lilypond-internals.info)")
68 @macro usermanref{NAME}
69 @uref{../lilypond/\\NAME\\.html,\\NAME\\}
75 @macro usermanref{NAME}
76 @ref{\\NAME\\,,,lilypond/lilypond}
82 @macro usermanref{NAME}
88 @macro glossaryref{NAME}
89 @uref{../music-glossary/\\NAME\\.html,\\NAME\\}
95 @macro glossaryref{NAME}
96 @inforef{\\NAME\\,,lilypond/music-glossary}
102 @macro internalsref{NAME}
108 @macro inputfileref{DIR,NAME}
109 @uref{../../../../\\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
131 @omftitle LilyPond internals
132 @omfcreator Han-Wen Nienhuys and Jan Nieuwenhuizen
133 @omfdescription Programmer's reference of the LilyPond music engraving system
134 @omftype user's guide
136 @omfcategory Applications|Publishing
149 (string-append "This is the program reference for LilyPond version " (lilypond-version))
154 (translation-doc-node)
156 (all-scheme-functions-doc)
160 @unnumbered Concept index
164 @unnumbered Variable index
168 @unnumbered Function index
179 (dump-node top-node out-port 0)
180 (newline (current-error-port))