X-Git-Url: https://git.donarmstrong.com/?a=blobdiff_plain;f=scm%2Fdocumentation-generate.scm;h=762d260b07b470f95279ae6af277266e77179932;hb=2c894ac3f60274f9fdd0bf2593cfb856c5c7b13f;hp=82649a53ac4029b7fba130fa8652c9d2d4b09c10;hpb=3b2376c6828136cdbc078015c0b9bee26bffb448;p=lilypond.git diff --git a/scm/documentation-generate.scm b/scm/documentation-generate.scm index 82649a53ac..762d260b07 100644 --- a/scm/documentation-generate.scm +++ b/scm/documentation-generate.scm @@ -1,9 +1,20 @@ -;;;; generate-documentation.scm -- Generate documentation +;;;; This file is part of LilyPond, the GNU music typesetter. ;;;; -;;;; source file of the GNU LilyPond music typesetter -;;;; -;;;; (c) 2000--2004 Han-Wen Nienhuys +;;;; Copyright (C) 2000--2015 Han-Wen Nienhuys ;;;; Jan Nieuwenhuizen +;;;; +;;;; LilyPond is free software: you can redistribute it and/or modify +;;;; it under the terms of the GNU General Public License as published by +;;;; the Free Software Foundation, either version 3 of the License, or +;;;; (at your option) any later version. +;;;; +;;;; LilyPond is distributed in the hope that it will be useful, +;;;; but WITHOUT ANY WARRANTY; without even the implied warranty of +;;;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +;;;; GNU General Public License for more details. +;;;; +;;;; You should have received a copy of the GNU General Public License +;;;; along with LilyPond. If not, see . ;;; File entry point for generated documentation ;;; Running LilyPond on this file generates the documentation @@ -16,12 +27,18 @@ ;; todo: naming: grob vs. layout property -(map ly:load '("documentation-lib.scm" - "document-functions.scm" - "document-translation.scm" - "document-music.scm" - "document-backend.scm" - "document-markup.scm")) +(use-modules (scm accreg)) + +(for-each ly:load '("documentation-lib.scm" + "lily-sort.scm" + "document-functions.scm" + "document-translation.scm" + "document-music.scm" + "document-type-predicates.scm" + "document-identifiers.scm" + "document-context-mods.scm" + "document-backend.scm" + "document-markup.scm")) ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;; @@ -29,22 +46,50 @@ (slot-ref (all-scheme-functions-doc) 'text) (open-output-file "scheme-functions.tely")) -(display - (markup-doc-string) +;;(display +;; (markup-doc-string) +;; (open-output-file "markup-commands.tely")) + +(display + ;; ugly hack to remove the @node... @appendixsec... portion + (substring + (call-with-output-string + (lambda (port) + (dump-node (markup-doc-node) port 2))) + ;; magic number to remove the initial part. 63 comes from: + ;; "\nnode Text markup commands\n@appendixsec Text markup commands\n\n\n\n" + ;; which is generated by (dump-node...) in documentation-lib.scm + 63 + ) (open-output-file "markup-commands.tely")) +(display + (markup-list-doc-string) + (open-output-file "markup-list-commands.tely")) + +(display + type-predicates-doc-string + (open-output-file "type-predicates.tely")) + +(display + (identifiers-doc-string) + (open-output-file "identifiers.tely")) + +(display + context-mods-doc-string + (open-output-file "context-mod-identifiers.tely")) (display (backend-properties-doc-string all-user-grob-properties) - (open-output-file "layout-properties.tely") ) + (open-output-file "layout-properties.tely")) (display (translation-properties-doc-string all-user-translation-properties) - (open-output-file "context-properties.tely") ) + (open-output-file "context-properties.tely")) ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;; -(define file-name "lilypond-internals") +(define file-name "internals") (define outname (string-append file-name ".texi")) (define out-port (open-output-file outname)) @@ -53,72 +98,11 @@ (display (string-append - (texi-file-head "LilyPond program-reference" file-name - "(lilypond-internals.info)") + (texi-file-head "LilyPond Internals Reference" file-name + "(lilypond-internals.info)") " -@ifhtml -@macro usermanref{NAME} -@uref{../lilypond/\\NAME\\.html,\\NAME\\} -@cindex \\NAME\\ -@end macro -@end ifhtml - -@ifinfo -@macro usermanref{NAME} -@ref{\\NAME\\,,,lilypond/lilypond} -@cindex \\NAME\\ -@end macro -@end ifinfo - -@iftex -@macro usermanref{NAME} -@ref{\\NAME\\}@c -@end macro -@end iftex - -@ifhtml -@macro glossaryref{NAME} -@uref{../music-glossary/\\NAME\\.html,\\NAME\\} -@cindex \\NAME\\ -@end macro -@end ifhtml - -@ifinfo -@macro glossaryref{NAME} -@inforef{\\NAME\\,,lilypond/music-glossary} -@cindex \\NAME\\ -@end macro -@end ifinfo - - -@macro internalsref{NAME} -@ref{\\NAME\\} -@end macro - -@ifhtml - -@macro inputfileref{DIR,NAME} -@uref{../../../../\\DIR\\/out-www/collated-files.html#\\NAME\\,@file{\\DIR\\/\\NAME\\}}@c -@end macro - -@end ifhtml - -@ifinfo - -@macro inputfileref{DIR,NAME} -@file{\\DIR\\/\\NAME\\} -@end macro - -@end ifinfo - -@iftex -@macro inputfileref{DIR,NAME}@c -@file{\\DIR\\/\\NAME\\}@c -@end macro -@end iftex - - +@include macros.itexi @ignore @omftitle LilyPond internals @@ -129,15 +113,57 @@ @omfcategory Applications|Publishing @end ignore +@iftex +@afourpaper +@end iftex + +@finalout + +@titlepage +@title LilyPond +@subtitle The music typesetter +@titlefont{Internals Reference} +@author The LilyPond development team -") +@c `Internals Reference' was born 2000-10-21 with this commit: +@c patch::: 1.3.96.jcn9 +@c author: Jan Nieuwenhuizen +@c commit: 8ecd09ad7514d57630fb611d38c161f3c3c708db +@c file: scm/generate-documentation.scm +Copyright @copyright{} 2000--2015 by the authors + +@vskip 20pt + +For LilyPond version @version{} +@end titlepage + +@contents + +@ifnottex") out-port) (define top-node (make - #:name "Top" - #:text - (string-append "This is the program reference for LilyPond version " (lilypond-version)) + #:name "GNU LilyPond -- Internals Reference" + #:text + (string-append "@end ifnottex + +@ifhtml +@ifclear bigpage +This document is also available as a +@uref{source/Documentation/internals.pdf,PDF} and as +@uref{source/Documentation/internals-big-page.html,one big page}. +@end ifclear +@ifset bigpage +This document is also available as a +@uref{source/Documentation/internals.pdf,PDF} and as a +@uref{source/Documentation/internals/index.html,HTML indexed multiple pages}. +@end ifset +@end ifhtml + +This is the Internals Reference (IR) for version " + (lilypond-version) + " of LilyPond, the GNU music typesetter.") #:children (list @@ -146,17 +172,14 @@ (backend-doc-node) (all-scheme-functions-doc) (make - #:name "Indexes" + #:appendix #t + #:name "Indices" #:text " -@unnumbered Concept index +@appendixsec Concept index @printindex cp -@unnumbered Variable index - -@printindex vr - -@unnumbered Function index +@appendixsec Function index @printindex fn @@ -164,7 +187,3 @@ (dump-node top-node out-port 0) (newline (current-error-port)) - - - -