X-Git-Url: https://git.donarmstrong.com/?a=blobdiff_plain;f=scm%2Fdocumentation-generate.scm;h=dcbd1d4f95fe21c18bb7d4a75d4c14147a6d6383;hb=3093b6e2e6233fd007fb8095880c102fdd4bce45;hp=e90b5868923c4883edd2ecc532f815b9aa542c6c;hpb=a48fe82a448339d0acb1a2c63a92e946b5c018b3;p=lilypond.git diff --git a/scm/documentation-generate.scm b/scm/documentation-generate.scm index e90b586892..dcbd1d4f95 100644 --- a/scm/documentation-generate.scm +++ b/scm/documentation-generate.scm @@ -1,158 +1,108 @@ -;;; generate-documentation.scm -- Generate documentation -;;; -;;; source file of the GNU LilyPond music typesetter -;;; -;;; (c) 2000--2004 Han-Wen Nienhuys -;;; Jan Nieuwenhuizen +;;;; This file is part of LilyPond, the GNU music typesetter. +;;;; +;;;; Copyright (C) 2000--2014 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 -(debug-enable 'debug) -(debug-enable 'backtrace) -(read-enable 'positions) +;;(set-debug-cell-accesses! 5000) ;;;;;;;;;;;;;;;; ;;;;;;;;;;;;;;;; TODO : make modules of these! ;;;;;;;;;;;;;;;; -; todo: naming: grob vs. layout property - -(define load-files '("documentation-lib.scm" - "document-functions.scm" - "document-translation.scm" - "document-music.scm" - "document-backend.scm" - "document-markup.scm" - )) -(map ly:load load-files) - - -;;(define no-copies #t) ; from 490 to 410K, but doesn't look nice yet -;; -;; Also, copies of interfaces use up lots more space, but that's -;; functional because the default property values of the interfaces -;; are described... -(define no-copies #f) - - - - - - +;; todo: naming: grob vs. layout property +(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")) +;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;; +(display + (slot-ref (all-scheme-functions-doc) 'text) + (open-output-file "scheme-functions.tely")) +;;(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")) -(dump-node (all-scheme-functions-doc) - (open-output-file "scheme-functions.tely") - 2) +(display + (markup-list-doc-string) + (open-output-file "markup-list-commands.tely")) -(display - (markup-doc-string) +(display + type-predicates-doc-string + (open-output-file "type-predicates.tely")) - (open-output-file "markup-commands.tely") - ) +(display + (identifiers-doc-string) + (open-output-file "identifiers.tely")) -(dump-node - (make - #:name "Layout property overview" - #:desc "All user serviceable layout properties" - #:text (backend-properties-doc-string all-user-grob-properties)) +(display + context-mods-doc-string + (open-output-file "context-mod-identifiers.tely")) - (open-output-file "layout-properties.tely") - 2) +(display + (backend-properties-doc-string all-user-grob-properties) + (open-output-file "layout-properties.tely")) -(dump-node - (make - #:name "Context property overview" - #:desc "All user serviceable context properties" - #:text (translation-properties-doc-string all-user-translation-properties)) - - (open-output-file "context-properties.tely") - 2) +(display + (translation-properties-doc-string all-user-translation-properties) + (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)) (writing-wip outname) - - - - (display (string-append - (texi-file-head "LilyPond program-reference" outname "(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} -@inforef{\\NAME\\,,lilypond} -@cindex \\NAME\\ -@end macro -@end ifinfo - -@ifhtml -@macro glossaryref{NAME} -@uref{../music-glossary/\\NAME\\.html,\\NAME\\} -@cindex \\NAME\\ -@end macro -@end ifhtml - -@ifinfo -@macro glossaryref{NAME} -@inforef{\\NAME\\,,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 @@ -163,12 +113,54 @@ @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 -") out-port) +@c `Internals Reference' was born 2000-10-21 with git commit 01e371f... +Copyright @copyright{} 2000--2014 by the authors + +@vskip 20pt + +For LilyPond version @version{} +@end titlepage + +@contents + +@ifnottex") + out-port) (define top-node (make - #:name "Top" + #: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 (music-doc-node) @@ -176,30 +168,18 @@ (backend-doc-node) (all-scheme-functions-doc) (make - #:name "Index" + #: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 -\n@bye" - - - ) - ))) - +\n@bye")))) (dump-node top-node out-port 0) (newline (current-error-port)) - - - -