X-Git-Url: https://git.donarmstrong.com/?a=blobdiff_plain;f=scm%2Fdocumentation-generate.scm;h=762d260b07b470f95279ae6af277266e77179932;hb=5d84bfad4626892bcffd05adcced53c8a2329047;hp=6158fbb21c1b2771262520584cfa5adcc282ff69;hpb=5c14a087ca6cbd665fd631452b7b1283ba0387c3;p=lilypond.git diff --git a/scm/documentation-generate.scm b/scm/documentation-generate.scm index 6158fbb21c..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--2007 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,13 +27,18 @@ ;; todo: naming: grob vs. layout property -(map ly:load '("documentation-lib.scm" - "document-functions.scm" - "document-translation.scm" - "document-music.scm" - "document-identifiers.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")) ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;; @@ -30,22 +46,38 @@ (slot-ref (all-scheme-functions-doc) 'text) (open-output-file "scheme-functions.tely")) -;;(display +;;(display ;; (markup-doc-string) ;; (open-output-file "markup-commands.tely")) -(call-with-output-file "markup-commands.tely" - (lambda (port) - (dump-node (markup-doc-node) port 2))) +(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")) -(call-with-output-file "markup-list-commands.tely" - (lambda (port) - (dump-node (markup-list-doc-node) port 2))) +(display + (markup-list-doc-string) + (open-output-file "markup-list-commands.tely")) -(display +(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) @@ -57,7 +89,7 @@ ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;; -(define file-name "lilypond-internals") +(define file-name "internals") (define outname (string-append file-name ".texi")) (define out-port (open-output-file outname)) @@ -66,11 +98,11 @@ (display (string-append - (texi-file-head "LilyPond program-reference" file-name - "(lilypond/lilypond-internals.info)") + (texi-file-head "LilyPond Internals Reference" file-name + "(lilypond-internals.info)") " -@include macros.texi +@include macros.itexi @ignore @omftitle LilyPond internals @@ -83,11 +115,6 @@ @iftex @afourpaper -@c don't replace quotes with directed quotes -@tex -\\gdef\\SETtxicodequoteundirected{Foo} -\\gdef\\SETtxicodequotebacktick{Bla} -@end tex @end iftex @finalout @@ -98,7 +125,12 @@ @titlefont{Internals Reference} @author The LilyPond development team -Copyright @copyright{} 1999--2008 by the authors +@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 @@ -117,14 +149,21 @@ For LilyPond version @version{} (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/user/lilypond-internals.pdf,PDF} and as -@uref{source/Documentation/user/lilypond-internals-big-page.html,one big page}. +@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.") + (lilypond-version) + " of LilyPond, the GNU music typesetter.") #:children (list