1 ;;;; documentation-generate.scm -- Generate documentation
3 ;;;; source file of the GNU LilyPond music typesetter
5 ;;;; (c) 2000--2009 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"
21 "document-functions.scm"
22 "document-translation.scm"
24 "document-identifiers.scm"
25 "document-backend.scm"
26 "document-markup.scm"))
28 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
31 (slot-ref (all-scheme-functions-doc) 'text)
32 (open-output-file "scheme-functions.tely"))
35 ;; (markup-doc-string)
36 ;; (open-output-file "markup-commands.tely"))
38 (call-with-output-file "markup-commands.tely"
40 (dump-node (markup-doc-node) port 2)))
42 (call-with-output-file "markup-list-commands.tely"
44 (dump-node (markup-list-doc-node) port 2)))
47 (identifiers-doc-string)
48 (open-output-file "identifiers.tely"))
52 (backend-properties-doc-string all-user-grob-properties)
53 (open-output-file "layout-properties.tely"))
56 (translation-properties-doc-string all-user-translation-properties)
57 (open-output-file "context-properties.tely"))
59 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
61 (define file-name "internals")
62 (define outname (string-append file-name ".texi"))
64 (define out-port (open-output-file outname))
70 (texi-file-head "LilyPond Internals Reference" file-name
71 "(lilypond-internals.info)")
77 @omftitle LilyPond internals
78 @omfcreator Han-Wen Nienhuys and Jan Nieuwenhuizen
79 @omfdescription Programmer's reference of the LilyPond music engraving system
82 @omfcategory Applications|Publishing
93 @subtitle The music typesetter
94 @titlefont{Internals Reference}
95 @author The LilyPond development team
97 Copyright @copyright{} 1999--2009 by the authors
101 For LilyPond version @version{}
111 #:name "GNU LilyPond -- Internals Reference"
113 (string-append "@end ifnottex
117 This document is also available as a
118 @uref{source/Documentation/internals.pdf,PDF} and as
119 @uref{source/Documentation/internals-big-page.html,one big page}.
122 This document is also available as a
123 @uref{source/Documentation/internals.pdf,PDF} and as a
124 @uref{source/Documentation/internals/index.html,HTML indexed multiple pages}.
128 This is the Internals Reference (IR) for version "
130 " of LilyPond, the GNU music typesetter.")
135 (translation-doc-node)
137 (all-scheme-functions-doc)
142 @appendixsec Concept index
146 @appendixsec Function index
152 (dump-node top-node out-port 0)
153 (newline (current-error-port))