X-Git-Url: https://git.donarmstrong.com/?a=blobdiff_plain;f=scm%2Fdocumentation-generate.scm;h=da2763f5aa136846c4de6e35fe93fd55c299c5de;hb=8ad8f9dd676f29066c66bc57d6c6be53151c941c;hp=6062aae5074f90e8d2ae06e3f0d7ca09c6d3f7c8;hpb=eac637abe55c44aeb090f79c5d67bf64c17e6d32;p=lilypond.git diff --git a/scm/documentation-generate.scm b/scm/documentation-generate.scm index 6062aae507..da2763f5aa 100644 --- a/scm/documentation-generate.scm +++ b/scm/documentation-generate.scm @@ -1,150 +1,122 @@ -;;; generate-documentation.scm -- Generate documentation -;;; -;;; source file of the GNU LilyPond music typesetter -;;; -;;; (c) 2000--2004 Han-Wen Nienhuys -;;; Jan Nieuwenhuizen +;;;; generate-documentation.scm -- Generate documentation +;;;; +;;;; source file of the GNU LilyPond music typesetter +;;;; +;;;; (c) 2000--2007 Han-Wen Nienhuys +;;;; Jan Nieuwenhuizen ;;; File entry point for generated documentation - ;;; Running LilyPond on this file generates the documentation -(debug-enable 'debug) -(debug-enable 'backtrace) -(read-enable 'positions) +;;(set-debug-cell-accesses! 5000) ;;;;;;;;;;;;;;;; ;;;;;;;;;;;;;;;; TODO : make modules of these! ;;;;;;;;;;;;;;;; -; todo: naming: grob vs. layout property - -(define load-files '("documentation-lib.scm" - "document-functions.scm" - "document-translation.scm" - "document-music.scm" - "document-backend.scm" - "document-markup.scm" - )) -(map ly:load load-files) - - -;;(define no-copies #t) ; from 490 to 410K, but doesn't look nice yet -;; -;; Also, copies of interfaces use up lots more space, but that's -;; functional because the default property values of the interfaces -;; are described... -(define no-copies #f) - - - - - - - +;; 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")) +;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;; +(display + (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))) -(dump-node (all-scheme-functions-doc) - (open-output-file "scheme-functions.tely") - 2) +(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")) -(dump-node - (make - #:name "Layout property overview" - #:desc "All user serviceable layout properties" - #:text (backend-properties-doc-string all-user-grob-properties)) - (open-output-file "layout-properties.tely") - 2) +(display + (backend-properties-doc-string all-user-grob-properties) + (open-output-file "layout-properties.tely")) -(dump-node - (make - #:name "Context property overview" - #:desc "All user serviceable context properties" - #:text (translation-properties-doc-string all-user-translation-properties)) - - (open-output-file "context-properties.tely") - 2) +(display + (translation-properties-doc-string all-user-translation-properties) + (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" outname "(lilypond-internals.info)") + (texi-file-head "LilyPond program-reference" file-name + "(lilypond/lilypond-internals.info)") " -@ifhtml -@macro usermanref{NAME} -@uref{../lilypond/\\NAME\\.html,\\NAME\\} -@cindex \\NAME\\ -@end macro -@end ifhtml +@c NOTE: This is documentation-generate.scm, not macros.itexi -@ifinfo -@macro usermanref{NAME} -@inforef{\\NAME\\,,lilypond} -@cindex \\NAME\\ + +@macro q{TEXT} +@quoteleft{}\\TEXT\\@quoteright{} @end macro -@end ifinfo -@iftex -@macro usermanref{NAME} -@ref{\\NAME\\}@c +@macro qq{TEXT} +@quotedblleft{}\\TEXT\\@quotedblright{} @end macro -@end iftex + @ifhtml -@macro glossaryref{NAME} -@uref{../music-glossary/\\NAME\\.html,\\NAME\\} -@cindex \\NAME\\ -@end macro -@end ifhtml +@c ***** HTML ***** -@ifinfo -@macro glossaryref{NAME} -@inforef{\\NAME\\,,music-glossary} -@cindex \\NAME\\ +@ifset bigpage + +@macro ruser{TEXT} +@ref{\\TEXT\\,,,lilypond-big-page,Notation Reference} +@cindex \\TEXT\\ @end macro -@end ifinfo +@end ifset -@macro internalsref{NAME} -@ref{\\NAME\\} +@ifclear bigpage + +@macro ruser{NAME} +@ref{\\NAME\\,,,lilypond,Notation Reference} +@cindex \\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 @end ifhtml + @ifinfo +@c ***** info ***** + +@macro ruser{NAME} +@ref{\\NAME\\,,,lilypond,Notation Reference} +@cindex \\NAME\\ +@end macro @macro inputfileref{DIR,NAME} @file{\\DIR\\/\\NAME\\} @@ -152,13 +124,25 @@ @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 + @ignore @omftitle LilyPond internals @@ -170,11 +154,17 @@ @end ignore -") out-port) +") + out-port) (define top-node (make #:name "Top" + #:text + (string-append "This is the program reference for version " + (lilypond-version) + " of LilyPond, the GNU music typesetter.") + #:children (list (music-doc-node) @@ -182,30 +172,17 @@ (backend-doc-node) (all-scheme-functions-doc) (make - #: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)) - - - -