scm/generate-documentation.scm

   1
   2 ;;; generate-documentation.scm -- Generate documentation
   3 ;;;
   4 ;;; source file of the GNU LilyPond music typesetter
   5 ;;;
   6 ;;; (c) 2000 Han-Wen Nienhuys <hanwen@cs.uu.nl>
   7 ;;; Jan Nieuwenhuizen <janneke@gnu.org>
   8
   9 ;;; File entry point for generated documentation
  10
  11 ;;; Running LilyPond on this file generates the documentation
  12
  13
  14
  15 ;; We use ly-gulp because these files live in
  16 ;;
  17 ;;     PATH=$LILYPONDPREFIX/scm:<datadir>/scm
  18 ;;
  19 (eval-string (ly-gulp-file "documentation-lib.scm"))
  20 (eval-string (ly-gulp-file "engraver-documentation-lib.scm"))
  21 (eval-string (ly-gulp-file "backend-documentation-lib.scm"))
  22
  23
  24
  25 ;;(define no-copies #t)  ; from 490 to 410K, but doesn't look nice yet
  26 ;;
  27 ;; Also, copies of interfaces use up lots more space, but that's
  28 ;; functional because the default property values of the interfaces
  29 ;; are described...
  30 (define no-copies #f)
  31
  32 (let* ((doc (string-append
  33              (document-paper "LilyPond interpretation contexts")
  34              (document-all-engravers "LilyPond engravers")
  35              (document-all-elements "LilyPond backend")
  36              (document-all-interfaces "LilyPond interfaces"))
  37        )
  38        (name "lilypond-internals")
  39        (outname (string-append name ".texi"))
  40        (out (open-output-file outname)))
  41
  42   (writing-wip outname)
  43   (display
  44    (string-append
  45     (texi-file-head
  46
  47      ;; we can't use (dir) and top if we're included by lilypond.tely
  48      "LilyPond internals" name "(lilypond.info)"
  49      '(("LilyPond interpretation contexts" . "Hierarchy and grouping of Engravers")
  50        ("LilyPond engravers" . "Engravers create Elements")
  51        ("LilyPond backend" . "Detailed description of all Elements")
  52        ("LilyPond interfaces" . "Element Interfaces")))
  53
  54     doc
  55     "\n@bye")
  56    out))
  57
  58 (newline (current-error-port))