X-Git-Url: https://git.donarmstrong.com/?a=blobdiff_plain;f=scm%2Fdocumentation-generate.scm;h=88016c92ae3a95a84cde8211a35a18384fb8044a;hb=85d4958c021936c64b6ef9d514a6a2b0d269cc58;hp=36af5b3a698baf16b83c714350e2783101ba7c8e;hpb=7e57eb7daf165db3cc1ed70c8173f8692818f83b;p=lilypond.git diff --git a/scm/documentation-generate.scm b/scm/documentation-generate.scm index 36af5b3a69..88016c92ae 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--2012 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 @@ -17,10 +28,13 @@ ;; todo: naming: grob vs. layout property (map 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 +44,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")) + +(display + (markup-list-doc-string) + (open-output-file "markup-list-commands.tely")) -(call-with-output-file "markup-list-commands.tely" - (lambda (port) - (dump-node (markup-list-doc-node) port 2))) +(display + type-predicates-doc-string + (open-output-file "type-predicates.tely")) -(display +(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 +87,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 +96,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,19 +113,8 @@ @iftex @afourpaper -@c don't replace quotes with directed quotes -@tex -\\gdef\\SETtxicodequoteundirected{Foo} -\\gdef\\SETtxicodequotebacktick{Bla} -@end tex @end iftex -@ifhtml -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}. -@end ifhtml - @finalout @titlepage @@ -104,7 +123,8 @@ This document is also available as a @titlefont{Internals Reference} @author The LilyPond development team -Copyright @copyright{} 1999--2008 by the authors +@c `Internals Reference' was born 2000-10-21 with git commit 01e371f... +Copyright @copyright{} 2000--2012 by the authors @vskip 20pt @@ -113,17 +133,29 @@ For LilyPond version @version{} @contents -@ifnottex -") +@ifnottex") out-port) (define top-node (make - #:name "Top" + #:name "GNU LilyPond -- Internals Reference" #:text - (string-append " -@end ifnottex -This is the program reference for 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/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.")