X-Git-Url: https://git.donarmstrong.com/?a=blobdiff_plain;f=scm%2Fdocumentation-generate.scm;h=fa6298cd00e32caf6af5be4846720e7509d7cc84;hb=06179214e6e296a7befd73b6eb84d09ce5c98a19;hp=efb76d62eddf54a0874fa3d637444978a234e45f;hpb=7f73809b99160928a2af54b364f63303cde967b5;p=lilypond.git diff --git a/scm/documentation-generate.scm b/scm/documentation-generate.scm index efb76d62ed..fa6298cd00 100644 --- a/scm/documentation-generate.scm +++ b/scm/documentation-generate.scm @@ -1,32 +1,28 @@ -;;; 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--2006 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 +;; 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) +(map ly:load '("documentation-lib.scm" + "document-functions.scm" + "document-translation.scm" + "document-music.scm" + "document-identifiers.scm" + "document-backend.scm" + "document-markup.scm")) ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;; @@ -38,97 +34,110 @@ (markup-doc-string) (open-output-file "markup-commands.tely")) +(display + (markup-list-doc-string) + (open-output-file "markup-list-commands.tely")) + +(display + (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 +@c ***** HTML ***** + @macro usermanref{NAME} -@uref{../lilypond/\\NAME\\.html,\\NAME\\} +@ref{\\NAME\\,,,lilypond} @cindex \\NAME\\ @end macro -@end ifhtml -@ifinfo -@macro usermanref{NAME} -@ref{\\NAME\\,,,lilypond/lilypond} +@macro glossaryref{NAME} +@ref{\\NAME\\,,,music-glossary} @cindex \\NAME\\ @end macro -@end ifinfo -@iftex -@macro usermanref{NAME} -@ref{\\NAME\\}@c +@macro inputfileref{DIR,NAME} +@uref{source/\\DIR\\/out-www/collated-files.html#\\NAME\\,@file{\\DIR\\/\\NAME\\}}@c @end macro -@end iftex -@ifhtml -@macro glossaryref{NAME} -@uref{../music-glossary/\\NAME\\.html,\\NAME\\} -@cindex \\NAME\\ +@macro q{TEXT} +@html +‘\\TEXT\\’ +@end html @end macro @end ifhtml + @ifinfo +@c ***** info ***** + +@macro usermanref{NAME} +@inforef{\\NAME\\,,,lilypond} +@cindex \\NAME\\ +@end macro + @macro glossaryref{NAME} @inforef{\\NAME\\,,lilypond/music-glossary} @cindex \\NAME\\ @end macro -@end ifinfo - -@macro internalsref{NAME} -@ref{\\NAME\\} +@macro inputfileref{DIR,NAME} +@file{\\DIR\\/\\NAME\\} @end macro -@ifhtml - -@macro inputfileref{DIR,NAME} -@uref{../../../../\\DIR\\/out-www/collated-files.html#\\NAME\\,@file{\\DIR\\/\\NAME\\}}@c +@macro q{TEXT} +`\\TEXT\\' @end macro +@end ifinfo -@end ifhtml -@ifinfo +@iftex +@c ***** TeX ***** -@macro inputfileref{DIR,NAME} -@file{\\DIR\\/\\NAME\\} +@macro usermanref{NAME} +@ref{\\NAME\\}@c @end macro -@end ifinfo - -@iftex @macro inputfileref{DIR,NAME}@c @file{\\DIR\\/\\NAME\\}@c @end macro + +@macro q{TEXT} +`\\TEXT\\' +@end macro @end iftex +@macro internalsref{NAME} +@ref{\\NAME\\} +@end macro + @ignore @omftitle LilyPond internals @@ -140,15 +149,17 @@ @end ignore -" - - "This is the program reference for LilyPond version " (lilypond-version) - - ) 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) @@ -156,30 +167,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)) - - - -