sandbox/cben/rolehack/README.txt

   1 Mathhack Instructions
   2 =====================
   3
   4 ::
   5
   6    Just write :texmath:`formula` or simply `formula` for inline
   7    formulas; for display formulas use a directive:
   8
   9    .. texmath:: formula
  10
  11    Inline formulas can also be written with |substitution| references:
  12
  13    .. |substitution| formula
  14
  15 Now you take this (in file foo.txt) and run::
  16
  17    mathhack.py foo.txt | rst2latex.py - foo.tex
  18
  19 which converts the roles/directives to ``raw:: latex`` directives or::
  20
  21    imgmathhack.py foo.txt | html.py - foo.html
  22
  23 which runs TeX (generating images into a subdirectory!) and converts
  24 the roles/directives into ``img::`` directives.  Quick, dirty and
  25 convenient ;-).
  26
  27 To allow including preprocessed files, do::
  28
  29    mathhack.py included.txt > included.txt.mathhack
  30    imgmathhack.py included.txt > included.txt.imgmathhack
  31
  32 and include ``included.txt.mathhack`` (imgmathhack.py will mangle this to
  33 include ``included.txt.imgmathhack`` automatically).  My makefile_ can do all
  34 this for you (just set ENABLE_MATHHACK=1).
  35
  36 .. _makefile: ../make/Makefile.docutils
  37
  38 Note that the `<imgmathhack.py>`_ script relies on some external commands (see
  39 the comments at its top).  `tex_to_images` seems to be separately availiable
  40 from the `speech_tools CVS`__
  41
  42 __ http://cvs.sf.net/viewcvs.py/*checkout*/emu/speech_tools/scripts/tex_to_images.prl?rev=HEAD
  43
  44 Also note that the scripts use regexps to "parse" the roles/directives, so
  45 expect some bugs (e.g. don't try to split a formula into multiple lines inside
  46 a table cell...).