1 ;;;; This file is part of LilyPond, the GNU music typesetter.
3 ;;;; Copyright (C) 2000--2011 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-context-mods.scm"
38 "document-backend.scm"
39 "document-markup.scm"))
41 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
44 (slot-ref (all-scheme-functions-doc) 'text)
45 (open-output-file "scheme-functions.tely"))
48 ;; (markup-doc-string)
49 ;; (open-output-file "markup-commands.tely"))
52 ;; ugly hack to remove the @node... @appendixsec... portion
54 (call-with-output-string
56 (dump-node (markup-doc-node) port 2)))
57 ;; magic number to remove the initial part. 63 comes from:
58 ;; "\nnode Text markup commands\n@appendixsec Text markup commands\n\n\n\n"
59 ;; which is generated by (dump-node...) in documentation-lib.scm
62 (open-output-file "markup-commands.tely"))
65 (markup-list-doc-string)
66 (open-output-file "markup-list-commands.tely"))
69 type-predicates-doc-string
70 (open-output-file "type-predicates.tely"))
73 (identifiers-doc-string)
74 (open-output-file "identifiers.tely"))
77 context-mods-doc-string
78 (open-output-file "context-mod-identifiers.tely"))
81 (backend-properties-doc-string all-user-grob-properties)
82 (open-output-file "layout-properties.tely"))
85 (translation-properties-doc-string all-user-translation-properties)
86 (open-output-file "context-properties.tely"))
88 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
90 (define file-name "internals")
91 (define outname (string-append file-name ".texi"))
93 (define out-port (open-output-file outname))
99 (texi-file-head "LilyPond Internals Reference" file-name
100 "(lilypond-internals.info)")
103 @include macros.itexi
106 @omftitle LilyPond internals
107 @omfcreator Han-Wen Nienhuys and Jan Nieuwenhuizen
108 @omfdescription Programmer's reference of the LilyPond music engraving system
109 @omftype user's guide
111 @omfcategory Applications|Publishing
122 @subtitle The music typesetter
123 @titlefont{Internals Reference}
124 @author The LilyPond development team
126 @c `Internals Reference' was born 2000-10-21 with git commit 01e371f...
127 Copyright @copyright{} 2000--2011 by the authors
131 For LilyPond version @version{}
141 #:name "GNU LilyPond -- Internals Reference"
143 (string-append "@end ifnottex
147 This document is also available as a
148 @uref{source/Documentation/internals.pdf,PDF} and as
149 @uref{source/Documentation/internals-big-page.html,one big page}.
152 This document is also available as a
153 @uref{source/Documentation/internals.pdf,PDF} and as a
154 @uref{source/Documentation/internals/index.html,HTML indexed multiple pages}.
158 This is the Internals Reference (IR) for version "
160 " of LilyPond, the GNU music typesetter.")
165 (translation-doc-node)
167 (all-scheme-functions-doc)
172 @appendixsec Concept index
176 @appendixsec Function index
182 (dump-node top-node out-port 0)
183 (newline (current-error-port))