summaryrefslogtreecommitdiff
path: root/macros/latex/contrib/songproj/README.md
blob: 1c3c073b52e2f910fb76029a149bb8708a50dcc8 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
songproj
========

Commands and environments for generating Beamer slideshows with song lyrics,
typically for religious services with a projector.

Author: Tanguy Ortolo
License: 3-Clause BSD

Description
-----------

This package, together with the Beamer class, is used to generate slideshows
with song lyrics. This is typically used in religious services in churches
equipped with a projector, for which this package has been written, but it can
be useful for any type of singing assembly. It provides environments to
describe a song in a natural way, and formatting it into slides with overlays.

Example
-------

Detailed usage can be found in the PDF documentation. Here is a simple example:

```latex
\documentclass{beamer}
\usepackage{songproj}
\begin{document}
  \begin{frame}
    \begin{song}{2}
      \longest{Light she was, and like a fairy,}
      \begin{couplet}
        In a cavern, in a canyon, \\
        Excavating for a mine. \\
        Dwelt a miner, forty-niner, \\
        And his daughter, Clementine. \\
      \end{couplet}
      \begin{refrain}
        Oh my darling, oh my darling, \\
        Oh my darling Clementine, \\
        You are lost and gone forever, \\
        Dreadful sorry, Clementine. \\
      \end{refrain}
      \begin{couplet}
        Light she was, and like a fairy, \\
        And her shoes were number nine, \\
        Herring boxes, without topses, \\
        Sandals were for Clementine. \\
      \end{couplet}
      \begin{couplet}
        […]
      \end{couplet}
    \end{song}
  \end{frame}
\end{document}
```

Add-on script
-------------

This package comes with an additional script, `song2tex.py`, that can be used
to convert plain-text song lyrics to the expected LaTeX markup. The file
`example/clementine.txt` can be used to test it:

```sh
./song2tex.py examples/clementine.txt /tmp/clementine.tex
```