Merge branch 'lilypond/translation' of ssh://trettig@git.sv.gnu.org/srv/git/lilypond...

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

diff --git a/scm/documentation-generate.scm b/scm/documentation-generate.scm
index 537579f2f8f47932e137a8b400c26493211fd547..0d56e2c4a9b97db3e4e77f80018ab47f981fe75f 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--2007 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,131 @@
  (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 #t)))
+
+(call-with-output-file "markup-list-commands.tely"
+  (lambda (port)
+    (dump-node (markup-list-doc-node) port 2 #t)))
+
 (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)")
   "
 
+@c NOTE: This is documentation-generate.scm, not macros.itexi
+
+
 @ifhtml
-@macro usermanref{NAME}
-@uref{../lilypond/\\NAME\\.html,\\NAME\\}
-@cindex \\NAME\\
-@end macro
-@end ifhtml
+@c ***** HTML *****
 
-@ifinfo
-@macro usermanref{NAME}
-@ref{\\NAME\\,,,lilypond/lilypond}
-@cindex \\NAME\\
+@ifset bigpage
+
+@macro ruser{TEXT}
+@ref{\\TEXT\\,,,lilypond-big-page,Notation Reference}
+@cindex \\TEXT\\
 @end macro
-@end ifinfo
 
-@iftex
-@macro usermanref{NAME}
-@ref{\\NAME\\}@c
+@macro glossaryref{TEXT}
+@vindex \\TEXT\\
+@ref{\\TEXT\\,,,music-glossary-big-page,Music Glossary}
 @end macro
-@end iftex
 
-@ifhtml
-@macro glossaryref{NAME}
-@uref{../music-glossary/\\NAME\\.html,\\NAME\\}
+@end ifset
+
+@ifclear bigpage
+
+@macro ruser{NAME}
+@ref{\\NAME\\,,,lilypond}
 @cindex \\NAME\\
 @end macro
-@end ifhtml
 
-@ifinfo
 @macro glossaryref{NAME}
-@inforef{\\NAME\\,,lilypond/music-glossary}
+@ref{\\NAME\\,,,music-glossary}
 @cindex \\NAME\\
 @end macro
-@end ifinfo
 
-
-@macro internalsref{NAME}
-@ref{\\NAME\\}
-@end macro
-
-@ifhtml
+@end ifclear
 
 @macro inputfileref{DIR,NAME}
-@uref{../../../../\\DIR\\/out-www/collated-files.html#\\NAME\\,@file{\\DIR\\/\\NAME\\}}@c
+@uref{source/\\DIR\\/out-www/collated-files.html#\\NAME\\,@file{\\DIR\\/\\NAME\\}}@c
 @end macro
 
+@macro q{TEXT}
+@html
+&lsquo;\\TEXT\\&rsquo;
+@end html
+@end macro
 @end ifhtml
 
+
 @ifinfo
+@c ***** info *****
+
+@macro ruser{NAME}
+@ref{\\NAME\\,,,lilypond}
+@cindex \\NAME\\
+@end macro
 
 @macro inputfileref{DIR,NAME}
 @file{\\DIR\\/\\NAME\\}
 @end macro
 
+@macro q{TEXT}
+`\\TEXT\\'
+@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
+
+@macro q{TEXT}
+`\\TEXT\\'
+@end macro
 @end iftex
 
 
+@macro rinternals{NAME}
+@ref{\\NAME\\}
+@end macro
+
 
 @ignore
 @omftitle LilyPond internals
@@ -137,16 +166,16 @@
 @end ignore
 
 
-"
-
-
-  ) out-port)
+")
+ out-port)
 
 (define top-node
   (make <texi-node>
     #:name "Top"
     #:text 
-    (string-append  "This is the program reference for LilyPond version " (lilypond-version))
+    (string-append  "This is the program reference for version "
+                   (lilypond-version)
+                   " of LilyPond, the GNU music typesetter.")
 
     #:children
     (list
@@ -155,30 +184,17 @@
      (backend-doc-node)
      (all-scheme-functions-doc)
      (make <texi-node>
-       #:name "Index"
+       #:name "Indexes"
        #:text "
 @unnumbered Concept index
 
 @printindex cp
 
-@unnumbered Variable index
-
-@printindex vr
-
 @unnumbered Function index
 
 @printindex fn
 
-\n@bye"
-
-       
-     )
-    )))
-
+\n@bye"))))
 
 (dump-node top-node out-port 0)
 (newline (current-error-port))
-
-
-
-