]> git.donarmstrong.com Git - lilypond.git/blobdiff - scm/documentation-generate.scm
Add lilypond-book ly verbatim gettext quirk
[lilypond.git] / scm / documentation-generate.scm
index d79a701bc06468d5102ed1f441e66bf8dd279815..c64fb3a166e4ed69f8674e5e5af6c72ec68ae2ca 100644 (file)
@@ -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 <hanwen@xs4all.nl>
+;;;; Copyright (C) 2000--2010 Han-Wen Nienhuys <hanwen@xs4all.nl>
 ;;;; Jan Nieuwenhuizen <janneke@gnu.org>
+;;;;
+;;;; 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 <http://www.gnu.org/licenses/>.
 
 ;;; 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"
 
 (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))
 
 (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)")
   "
 
-@c NOTE: This is documentation-generate.scm, not macros.itexi
-
-
-@macro q{TEXT}
-@quoteleft{}\\TEXT\\@quoteright{}
-@end macro
-
-@macro qq{TEXT}
-@quotedblleft{}\\TEXT\\@quotedblright{}
-@end macro
-
-
-@ifhtml
-@c ***** HTML *****
-
-@ifset bigpage
-
-@macro ruser{TEXT}
-@ref{\\TEXT\\,,,lilypond-big-page,Notation Reference}
-@cindex \\TEXT\\
-@end macro
-
-@end ifset
-
-@ifclear bigpage
-
-@macro ruser{NAME}
-@ref{\\NAME\\,,,lilypond,Notation Reference}
-@cindex \\NAME\\
-@end macro
-
-@end ifclear
-
-@macro inputfileref{DIR,NAME}
-@uref{source/\\DIR\\/out-www/collated-files.html#\\NAME\\,@file{\\DIR\\/\\NAME\\}}@c
-@end macro
-
-@end ifhtml
-
-
-@ifinfo
-@c ***** info *****
-
-@macro ruser{NAME}
-@ref{\\NAME\\,,,lilypond,Notation Reference}
-@cindex \\NAME\\
-@end macro
-
-@macro inputfileref{DIR,NAME}
-@file{\\DIR\\/\\NAME\\}
-@end macro
-
-@end ifinfo
-
-
-@iftex
-@c ***** TeX *****
-
-@macro ruser{NAME}
-@ref{\\NAME\\}@c
-@end macro
-
-@macro inputfileref{DIR,NAME}@c
-@file{\\DIR\\/\\NAME\\}@c
-@end macro
-
-@end iftex
-
-
-@macro rinternals{NAME}
-@ref{\\NAME\\}
-@end macro
-
+@include macros.itexi
 
 @ignore
 @omftitle LilyPond internals
 @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 git commit 01e371f...
+Copyright @copyright{} 2000--2010 by the authors
+
+@vskip 20pt
+
+For LilyPond version @version{}
+@end titlepage
+
 @contents
-")
+
+@ifnottex")
  out-port)
 
 (define top-node
   (make <texi-node>
-    #:name "Top"
-    #:text 
-    (string-append  "This is the program reference for 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.")
 
      (backend-doc-node)
      (all-scheme-functions-doc)
      (make <texi-node>
-       #:name "Indexes"
+       #:appendix #t
+       #:name "Indices"
        #:text "
-@unnumbered Concept index
+@appendixsec Concept index
 
 @printindex cp
 
-@unnumbered Function index
+@appendixsec Function index
 
 @printindex fn