1 ;;;; This file is part of LilyPond, the GNU music typesetter.
3 ;;;; Copyright (C) 2000--2010 Han-Wen Nienhuys <hanwen@xs4all.nl>
4 ;;;; Jan Nieuwenhuizen <janneke@gnu.org>
6 ;;;; LilyPond is free software: you can redistribute it and/or modify
7 ;;;; it under the terms of the GNU General Public License as published by
8 ;;;; the Free Software Foundation, either version 3 of the License, or
9 ;;;; (at your option) any later version.
11 ;;;; LilyPond is distributed in the hope that it will be useful,
12 ;;;; but WITHOUT ANY WARRANTY; without even the implied warranty of
13 ;;;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 ;;;; GNU General Public License for more details.
16 ;;;; You should have received a copy of the GNU General Public License
17 ;;;; along with LilyPond. If not, see <http://www.gnu.org/licenses/>.
19 ;;; File entry point for generated documentation
20 ;;; Running LilyPond on this file generates the documentation
22 ;;(set-debug-cell-accesses! 5000)
25 ;;;;;;;;;;;;;;;; TODO : make modules of these!
28 ;; todo: naming: grob vs. layout property
30 (map ly:load '("documentation-lib.scm"
32 "document-functions.scm"
33 "document-translation.scm"
35 "document-type-predicates.scm"
36 "document-identifiers.scm"
37 "document-backend.scm"
38 "document-markup.scm"))
40 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
43 (slot-ref (all-scheme-functions-doc) 'text)
44 (open-output-file "scheme-functions.tely"))
47 ;; (markup-doc-string)
48 ;; (open-output-file "markup-commands.tely"))
50 (call-with-output-file "markup-commands.tely"
52 (dump-node (markup-doc-node) port 2)))
54 (call-with-output-file "markup-list-commands.tely"
56 (dump-node (markup-list-doc-node) port 2)))
59 type-predicates-doc-string
60 (open-output-file "type-predicates.tely"))
63 (identifiers-doc-string)
64 (open-output-file "identifiers.tely"))
68 (backend-properties-doc-string all-user-grob-properties)
69 (open-output-file "layout-properties.tely"))
72 (translation-properties-doc-string all-user-translation-properties)
73 (open-output-file "context-properties.tely"))
75 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
77 (define file-name "internals")
78 (define outname (string-append file-name ".texi"))
80 (define out-port (open-output-file outname))
86 (texi-file-head "LilyPond Internals Reference" file-name
87 "(lilypond-internals.info)")
93 @omftitle LilyPond internals
94 @omfcreator Han-Wen Nienhuys and Jan Nieuwenhuizen
95 @omfdescription Programmer's reference of the LilyPond music engraving system
98 @omfcategory Applications|Publishing
109 @subtitle The music typesetter
110 @titlefont{Internals Reference}
111 @author The LilyPond development team
113 @c `Internals Reference' was born 2000-10-21 with git commit 01e371f...
114 Copyright @copyright{} 2000--2010 by the authors
118 For LilyPond version @version{}
128 #:name "GNU LilyPond -- Internals Reference"
130 (string-append "@end ifnottex
134 This document is also available as a
135 @uref{source/Documentation/internals.pdf,PDF} and as
136 @uref{source/Documentation/internals-big-page.html,one big page}.
139 This document is also available as a
140 @uref{source/Documentation/internals.pdf,PDF} and as a
141 @uref{source/Documentation/internals/index.html,HTML indexed multiple pages}.
145 This is the Internals Reference (IR) for version "
147 " of LilyPond, the GNU music typesetter.")
152 (translation-doc-node)
154 (all-scheme-functions-doc)
159 @appendixsec Concept index
163 @appendixsec Function index
169 (dump-node top-node out-port 0)
170 (newline (current-error-port))