X-Git-Url: https://git.donarmstrong.com/?a=blobdiff_plain;ds=sidebyside;f=scm%2Fdocumentation-generate.scm;h=1650bf1b96329de267e15aafccf3f63b9cc374ee;hb=95f56d089547ceaaf17062f7e32b0d33811d7533;hp=c0c0b13521ffa03b9d1dc867e1adb4fd900f3a1e;hpb=f23a0d9dcda87d3f6f072fba3addeae941cce4aa;p=lilypond.git diff --git a/scm/documentation-generate.scm b/scm/documentation-generate.scm index c0c0b13521..1650bf1b96 100644 --- a/scm/documentation-generate.scm +++ b/scm/documentation-generate.scm @@ -9,41 +9,59 @@ ;;; 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-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 + (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 program-reference" outname "(lilypond-internals.info)") + (texi-file-head "LilyPond program-reference" file-name + "(lilypond-internals.info)") " @ifhtml @@ -55,11 +73,17 @@ @ifinfo @macro usermanref{NAME} -@inforef{\\NAME\\,,lilypond} +@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\\} @@ -69,12 +93,40 @@ @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{../../../../\\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 +137,25 @@ @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 @@ -121,3 +178,7 @@ (dump-node top-node out-port 0) (newline (current-error-port)) + + + +