X-Git-Url: https://git.donarmstrong.com/?a=blobdiff_plain;f=scm%2Fdocumentation-generate.scm;h=b44fc12e0e0ae5e464d88417a05fd1451beef32d;hb=c5e0a98b86381797e94c5d01c3c9f5dfc7d11cd6;hp=255b460cbec15a73aef7647cc994789bb104ee3b;hpb=15e565fef41ab50d140c3028bc6d9cff1a43a56a;p=lilypond.git diff --git a/scm/documentation-generate.scm b/scm/documentation-generate.scm index 255b460cbe..b44fc12e0e 100644 --- a/scm/documentation-generate.scm +++ b/scm/documentation-generate.scm @@ -1,80 +1,131 @@ -;;; generate-documentation.scm -- Generate documentation -;;; -;;; source file of the GNU LilyPond music typesetter -;;; -;;; (c) 2000--2003 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! ;;;;;;;;;;;;;;;; -(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) +;; 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")) + +(display + (identifiers-doc-string) + (open-output-file "identifiers.tely")) + + +(display + (backend-properties-doc-string all-user-grob-properties) + (open-output-file "layout-properties.tely")) +(display + (translation-properties-doc-string all-user-translation-properties) + (open-output-file "context-properties.tely")) -;;(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) +;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;; (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 - "@c -*-texinfo-*-" - (texi-file-head "LilyPond internals" outname "(lilypond.info)") + (texi-file-head "LilyPond program-reference" file-name + "(lilypond/lilypond-internals.info)") " +@c NOTE: This is documentation-generate.scm, not macros.itexi + @ifhtml @macro usermanref{NAME} -@uref{../lilypond/\\NAME\\.html,\\NAME\\} +@ref{\\NAME\\,,,lilypond} @cindex \\NAME\\ @end macro @end ifhtml @ifinfo @macro usermanref{NAME} -@inforef{\\NAME\\,,lilypond} +@inforef{\\NAME\\,,,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\\} +@ref{\\NAME\\,,,music-glossary} @cindex \\NAME\\ @end macro @end ifhtml @ifinfo @macro glossaryref{NAME} -@inforef{\\NAME\\,,music-glossary} +@inforef{\\NAME\\,,lilypond/music-glossary} @cindex \\NAME\\ @end macro @end ifinfo +@macro internalsref{NAME} +@ref{\\NAME\\} +@end macro + +@ifhtml + +@macro inputfileref{DIR,NAME} +@uref{source/\\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 + + @ignore @omftitle LilyPond internals @omfcreator Han-Wen Nienhuys and Jan Nieuwenhuizen @@ -85,20 +136,23 @@ @end ignore -") out-port) +") + out-port) (define top-node (make #:name "Top" + #:text + (string-append "This is the program reference for LilyPond version " (lilypond-version)) + #:children (list (music-doc-node) (translation-doc-node) (backend-doc-node) (all-scheme-functions-doc) - (markup-doc-node) (make - #:name "Index" + #:name "Indexes" #:text " @unnumbered Concept index @@ -112,12 +166,11 @@ @printindex fn -\n@bye" - - - ) - ))) - +\n@bye")))) (dump-node top-node out-port 0) (newline (current-error-port)) + + + +