Documentation/man/mudela-book.yo

   1
   2 mailto(janneke@gnu.org)
   3 COMMENT(
   4         (PIPETHROUGH(echo -n `date '+%d/%b/%y'|tr '[a-z]' '[A-Z]'`)())
   5 )
   6 manpage(LilyPond)
   7         (1)
   8         (1998)
   9         (The LilyPond package)
  10         (mudela-book)
  11
  12 metalC(Automatically generated by yodl(1) from mudela-book.yo.)
  13
  14 manpagename(mudela-book)(integrate LaTeX and mudela)
  15
  16 manpagesynopsis() bf(mudela-book) [options] inputfile
  17
  18 manpagedescription() file(mudela-book) is a script that helps
  19 integrating mudela and LaTeX.  mudela-book runs LilyPond on
  20 fragments of mudela in your source file, and includes the results into
  21 document that can be processed with LaTeX.  The result is a text
  22 document with formatted music integrated.
  23
  24 Lilypond will create a directory to put temporary files, the default
  25 dir name is file(out). When you run mudela on a file, like this:
  26
  27 verb(mudelab-book myfile.tex)
  28
  29 the a file file(out/myfile.latex) will be created. And to create
  30 the file(.dvi) file you should type:
  31
  32 verb(latex out/myfile.latex)
  33
  34 This will create file(myfile.dvi) in the current directory. Bad things
  35 will happen if you cd to file(out) and then runs verb(latex myfile.latex)
  36
  37 bf(About the input)
  38
  39 If the file contains the ``block''
  40
  41 verb(
  42         \begin{mudela}
  43         CONTENTS
  44         \end{mudela}
  45 )
  46
  47 then LilyPond is run on CONTENTS.  mudela-book puts the result back,
  48 surrounded by code(\preMudelaExample) and code(\postMudelaExample)
  49 commands. code(\preMudelaExample) and code(posMudelaExample) is
  50 defined to nothing by default, and the user can redefine them
  51 to whatever he wants.
  52
  53 code(\begin) takes the following options:
  54
  55 description(
  56 dit(floating)
  57     the created graphics can be inserted in the middle of a text line,
  58     not only as a separate paragraph
  59 dit(fragment)
  60     mudela-book adds some redtape. You
  61     can substitute voice-contents for CONTENTS in this case.
  62 dit(verbatim)
  63     CONTENTS is copied into the TeX source enclosed in a verbatim block.
  64 dit(11pt, 13pt, 16pt, 20pt, 26pt)
  65     set the fontsize to use for the music
  66 )
  67
  68
  69 manpageoptions()
  70
  71 startdit()
  72
  73 dit(--mudela-fontsize)
  74     Set the fontsize to use for mudela if no fontsize is given
  75     as option.
  76 dit(--force-mudela-fontsize)
  77     Force all mudela to use this fontsize, overriding options
  78     given to \begin{mudela}
  79 dit(--outname)
  80     The name of LaTeX() file to output. If this option  is not given,
  81 the output name derived from the input name.
  82 dit(--outdir)
  83     The directory to output lilypond output and input to.
  84 dit(--help)
  85         Print a short help message
  86 dit(--dependencies)
  87         Write dependencies to outdir/filename.dep
  88 dit(--force-verbatim)
  89         Make all mudela verbatim.
  90 enddit()
  91
  92 manpagefiles()
  93   You have to install LaTeX. file(mudela-book) is not tested on LaTeX 2.09
  94   and will probably fail on something else than LaTeX2e.
  95
  96   file(mudela-book) is written in  python 1.5, so you have to install
  97   url(python)(http://www.python.org).
  98
  99 manpagebugs()
 100
 101 The LaTeX \includeonly{...} command is ignored.
 102
 103 You get trouble if you use the --force-verbatim option and have some
 104 music in \footnote{...} or \marginpar{...}.
 105
 106 Ignores almost all LaTeX commands that changes margins and linewidths.
 107
 108 manpageauthor()
 109
 110 nemail(Han-Wen Nienhuys)(hanwen@cs.uu.nl), lurl(http://www.cs.uu.nl/people/hanwen)
 111
 112 nemail(Tom Cato Amundsen)(tomato@xoommail.com)