Doc: link Internals bigpage to HTML multiple pages.

[lilypond.git] / scm / documentation-generate.scm

diff --git a/scm/documentation-generate.scm b/scm/documentation-generate.scm
index 537579f2f8f47932e137a8b400c26493211fd547..56f86e00d6c459cd5b138d6e7cde0a966032a490 100644 (file)
--- a/scm/documentation-generate.scm
+++ b/scm/documentation-generate.scm
@@ -1,29 +1,28 @@
-;;; generate-documentation.scm -- Generate documentation
-;;;
-;;; source file of the GNU LilyPond music typesetter
-;;; 
-;;; (c)  2000--2004 Han-Wen Nienhuys <hanwen@cs.uu.nl>
-;;; Jan Nieuwenhuizen <janneke@gnu.org>
+;;;; generate-documentation.scm -- Generate documentation
+;;;;
+;;;; source file of the GNU LilyPond music typesetter
+;;;; 
+;;;; (c) 2000--2008 Han-Wen Nienhuys <hanwen@xs4all.nl>
+;;;; Jan Nieuwenhuizen <janneke@gnu.org>
 
 ;;; File entry point for generated documentation
-
 ;;; Running LilyPond on this file generates the documentation
 
-;(set-debug-cell-accesses! 5000)
+;;(set-debug-cell-accesses! 5000)
 
 ;;;;;;;;;;;;;;;;
 ;;;;;;;;;;;;;;;; TODO : make modules of these!
 ;;;;;;;;;;;;;;;;
 
-; todo: naming: grob vs. layout property
+;; 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"
-              ))
+              "document-markup.scm"))
 
 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
 
@@ -31,101 +30,47 @@
  (slot-ref (all-scheme-functions-doc) 'text)
  (open-output-file "scheme-functions.tely"))
 
+;;(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)))
+
+(call-with-output-file "markup-list-commands.tely"
+  (lambda (port)
+    (dump-node (markup-list-doc-node) port 2)))
+
 (display 
- (markup-doc-string)
- (open-output-file "markup-commands.tely"))
+ (identifiers-doc-string)
+ (open-output-file "identifiers.tely"))
 
 
 (display
  (backend-properties-doc-string all-user-grob-properties)
- (open-output-file "layout-properties.tely") )
+ (open-output-file "layout-properties.tely"))
 
 (display
  (translation-properties-doc-string all-user-translation-properties)
- (open-output-file "context-properties.tely") )
-;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
+ (open-output-file "context-properties.tely"))
 
+;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
 
 (define file-name "lilypond-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" file-name
-                 "(lilypond-internals.info)")
+                 "(lilypond/lilypond-internals.info)")
   "
 
-@ifhtml
-@macro usermanref{NAME}
-@uref{../lilypond/\\NAME\\.html,\\NAME\\}
-@cindex \\NAME\\
-@end macro
-@end ifhtml
-
-@ifinfo
-@macro usermanref{NAME}
-@ref{\\NAME\\,,,lilypond/lilypond}
-@cindex \\NAME\\
-@end macro
-@end ifinfo
-
-@iftex
-@macro usermanref{NAME}
-@ref{\\NAME\\}@c
-@end macro
-@end iftex
-
-@ifhtml
-@macro glossaryref{NAME}
-@uref{../music-glossary/\\NAME\\.html,\\NAME\\}
-@cindex \\NAME\\
-@end macro
-@end ifhtml
-
-@ifinfo
-@macro glossaryref{NAME}
-@inforef{\\NAME\\,,lilypond/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
@@ -136,17 +81,57 @@
 @omfcategory Applications|Publishing
 @end ignore
 
+@iftex
+@afourpaper
+@c don't replace quotes with directed quotes
+@tex
+\\gdef\\SETtxicodequoteundirected{Foo}
+\\gdef\\SETtxicodequotebacktick{Bla}
+@end tex
+@end iftex
+
+@finalout
+
+@titlepage
+@title LilyPond
+@subtitle The music typesetter
+@titlefont{Internals Reference}
+@author The LilyPond development team
+
+Copyright @copyright{} 1999--2008 by the authors
 
-"
+@vskip 20pt
 
+For LilyPond version @version{}
+@end titlepage
 
-  ) out-port)
+@contents
+
+@ifnottex")
+ out-port)
 
 (define top-node
   (make <texi-node>
-    #:name "Top"
-    #:text 
-    (string-append  "This is the program reference for LilyPond version " (lilypond-version))
+    #:name "GNU LilyPond -- Internals Reference"
+    #:text
+    (string-append  "@end ifnottex
+
+@ifhtml
+@ifclear 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}.
+@end ifclear
+@ifset bigpage
+This document is also available as a
+@uref{source/Documentation/user/lilypond-internals.pdf,PDF} and as a
+@uref{source/Documentation/user/lilypond-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
@@ -155,30 +140,18 @@
      (backend-doc-node)
      (all-scheme-functions-doc)
      (make <texi-node>
-       #: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))
-
-
-
-