scm/generate-documentation.scm

   1 ;;; generate-documentation.scm -- Generate documentation
   2 ;;;
   3 ;;; source file of the GNU LilyPond music typesetter
   4 ;;;
   5 ;;; (c) 2000--2001 Han-Wen Nienhuys <hanwen@cs.uu.nl>
   6 ;;; Jan Nieuwenhuizen <janneke@gnu.org>
   7
   8 ;;; File entry point for generated documentation
   9
  10 ;;; Running LilyPond on this file generates the documentation
  11
  12 (debug-enable 'debug)
  13 (debug-enable 'backtrace)
  14 (read-enable 'positions)
  15
  16 ;;;;;;;;;;;;;;;;
  17 ;;;;;;;;;;;;;;;; TODO : make modules of these!
  18 ;;;;;;;;;;;;;;;;
  19
  20 (define load-files '("documentation-lib.scm"
  21                      "function-documentation.scm"
  22                      "engraver-documentation-lib.scm"
  23                      "music-documentation-lib.scm"
  24                      "backend-documentation-lib.scm"
  25                      ))
  26 (map ly-load load-files)
  27
  28
  29 ;;(define no-copies #t)  ; from 490 to 410K, but doesn't look nice yet
  30 ;;
  31 ;; Also, copies of interfaces use up lots more space, but that's
  32 ;; functional because the default property values of the interfaces
  33 ;; are described...
  34 (define no-copies #f)
  35
  36 (define file-name "lilypond-internals")
  37 (define outname (string-append file-name ".texi"))
  38 (define out-port (open-output-file outname))
  39
  40 (writing-wip outname)
  41
  42 (display
  43  (string-append
  44   "@c -*-texinfo-*-"
  45   (texi-file-head "LilyPond internals" outname "(lilypond.info)")) out-port)
  46
  47 (define top-node
  48   (make <texi-node>
  49     #:name "Top"
  50     #:children
  51     (list
  52      (music-doc-node)
  53      (translation-doc-node)
  54      (backend-doc-node)
  55      (all-scheme-functions-doc)
  56      (make <texi-node>
  57        #:name "Index"
  58        #:text "
  59 @unnumbered Concept index
  60
  61 @printindex cp
  62
  63 @unnumbered Variable index
  64
  65 @printindex vr
  66
  67 @unnumbered Function index
  68
  69 @printindex fn
  70
  71 \n@bye"
  72
  73
  74      )
  75     )))
  76
  77
  78 (dump-node top-node out-port 0)
  79 (newline (current-error-port))