examples/README.rdoc

   1 = Examples
   2
   3 This directory contains example files in several formats, each
   4 describing the same song.
   5
   6 ---
   7
   8 = {ChordPro (+.cho+)}[http://Vromans.Org/johan/projects/Chordii/chordpro/]
   9
  10 ChordPro is *the* file format for leadsheets. It all started with
  11 a Unix utility called +chord+, which set the basis for many
  12 clones, derivatives, extensions and successors. Unfortunately,
  13 the format was never formally specified, and so each
  14 implementation interpreted it in its own way, added incompatible
  15 extensions and generally made a mess of the format that wasn't
  16 actually that good to begin with.
  17
  18 To see it in action, try:
  19
  20         chordii -o message.ps message.cho
  21
  22 = {GuitarTeX (+.gtx+)}[http://GuitarTeX.SourceForge.Net/]
  23
  24 GuitarTeX is one of those programs that expand upon the original
  25 ChordPro format. It is a frontend to TeX, LaTeX, MusiXTeX and a
  26 couple of other TeX-y things. Its file format is a chimera of a
  27 greatly expanded ChordPro superset and LaTeX. The implementation
  28 is a very hacky Perl script that uses Regexps to convert the
  29 input into equally hacky LaTeX.
  30
  31 To see it in action, try:
  32
  33         gtx2tex message.gtx
  34
  35 = {reStructuredText (+.rst+)}[http://DocUtils.SourceForge.Net/rst.html]
  36
  37 ReStructuredText is the lightweight markup of the Python-docutils
  38 project. It is intended to be a documentation language for Python
  39 sourcecode, and therefore not very friendly to being (ab)used as
  40 a leadsheet markup language. However, it actually works rather
  41 well. This is the format that I use to write my leadsheets in.
  42 (Until Akkordarbeit is finished, of course.) I use
  43 Python-docutils to convert it to HTML, then a Regexp to mark up
  44 the chord symbols with nice HTML and lastly a Ruby script using
  45 Hpricot to clean up the generated HTML.
  46
  47 To see it in action, try:
  48
  49         rst2html -l de message.rst message.html
  50
  51 = {Akkordarbeit (+.akk+)}[https://JoergWMittag.GitHub.Com/akkordarbeit/]
  52
  53 This is the holy grail, of course. This file contains just a few
  54 ideas for some syntactic features of Akkordarbeit. It is meant
  55 purely as a basis for discussion.
  56
  57 To see it in action, try:
  58
  59         akkordarbeit -f html -i message.akk -o message.html