sandbox/verse-writer/README.txt

   1 verse writer
   2 ============
   3
   4 :Date: 2007-01-04
   5
   6 rst2verse is a LaTeX-writer to transfer single file poems into
   7 LaTeX. The generated files are assumed to be included into a master
   8 LaTeX document.
   9
  10 Usage :
  11
  12   rst2vers.py input output
  13
  14 simple transformation from a reStructured text into a LaTeX
  15 verse poem.
  16
  17 reSt input ::
  18
  19   All My Exes
  20   ---------------
  21
  22   | your dogs, your daughters
  23   | or the state of your kitchen.
  24   |
  25   | I will live in the secure orbit
  26
  27 output ::
  28
  29   \poemtitle{All My Exes}
  30
  31   \begin{verse}
  32   your dogs, your daughters \\
  33   or the state of your kitchen. \\
  34
  35   I will live in the secure orbit \\
  36
  37   \end{verse}
  38
  39 verse commands
  40 --------------
  41
  42 * ``\poemtitle{TITEL}``  poems title. Similar to ``\section`` commands
  43   this is included in a table of contents.
  44 * ``\\``   new line in verse.
  45 * ``\\!``  end of last line in a stanza. Adds a separating line.
  46 * ``\vin`` indent line by 1,5 em.
  47
  48 Open issues
  49 -----------
  50
  51 * Inlcude into the standard latex-writer to be able to set poems with
  52   surrounding text. This would require a option to use verse for
  53   literal-blocks and to use poemtitle if the section contains only
  54   a literal-block (poem).
  55 * Only one ``\vin`` level is supported.