X-Git-Url: https://git.donarmstrong.com/?a=blobdiff_plain;f=scm%2Fdocumentation-generate.scm;h=c64fb3a166e4ed69f8674e5e5af6c72ec68ae2ca;hb=3b1c477ab2212f124f865c46df350c5a1c1f2412;hp=70e35efd8f0512e16976eb903945298056fc9040;hpb=37c6de63d5f12cf9e42d04d56280aaf261ddc880;p=lilypond.git diff --git a/scm/documentation-generate.scm b/scm/documentation-generate.scm index 70e35efd8f..c64fb3a166 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--2010 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,6 +28,7 @@ ;; todo: naming: grob vs. layout property (map ly:load '("documentation-lib.scm" + "lily-sort.scm" "document-functions.scm" "document-translation.scm" "document-music.scm" @@ -36,11 +48,11 @@ (call-with-output-file "markup-commands.tely" (lambda (port) - (dump-node (markup-doc-node) port 2 #t))) + (dump-node (markup-doc-node) port 2))) (call-with-output-file "markup-list-commands.tely" (lambda (port) - (dump-node (markup-list-doc-node) port 2 #t))) + (dump-node (markup-list-doc-node) port 2))) (display (identifiers-doc-string) @@ -57,7 +69,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 +78,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 +95,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 +105,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--2010 by the authors @vskip 20pt @@ -113,17 +115,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.") @@ -134,13 +148,14 @@ This is the program reference for version " (backend-doc-node) (all-scheme-functions-doc) (make + #:appendix #t #:name "Indices" #:text " -@unnumbered Concept index +@appendixsec Concept index @printindex cp -@unnumbered Function index +@appendixsec Function index @printindex fn