Skip to content

Latest commit

 

History

History
27 lines (21 loc) · 2.37 KB

README.md

File metadata and controls

27 lines (21 loc) · 2.37 KB
Raw

Absolem's Treasure Chest

This is a modular songbook using latex's songs-package with a simple java-script to generate the index, chapters etc. automatically. Its contents are automatically assembled from individual .tex files in the bands-folder.

Usage

  • For every artist, create a new file <bandid>.tex in the bands-folder. This file should contain the individual songs by that artist. Note, that the artists will be sorted by the filename (i.e. <bandid>), not the actual name of the artist. This allows for sorting e.g. Steven Wilson under W, by naming the corresponding file e.g. wilson_steven.tex.
  • The first line of an artist's file needs to contain the full name of the artist as a comment. E.g. the file wilson_steven.tex would have as first line % Steven Wilson. This is the name that will actually appear in the final document.
  • Add the individual songs to the artist's file using the syntax provided by the songs package. With the small exception that you should use the command \newsong{<title>} to start a new song to add it to the table of contents (the handling of indices in the songs packages is... not well suited for artist-song-subordering). Details on the syntax can be found in the official documentation of the package. Note, that the songs will appar in the final document in the same order as they are in the artists .tex-file.
  • Having done so, simply run the build.jar (usually via java -jar build.jar), which should take care of all the rest for you by assembling the individual band files into one main.tex and compiling it to two pdf files (main.pdf and mobile.pdf, which is optimized for phone screens - well, mine, to be precise) with table of contents etc. directly. In case there are problems, you can manually compile the main.tex to get proper error messages.

Additional Features

  • The macro \tab{<filename>} will insert an image (intended to be guitar tabs) with the ideal width. The image should be in the tabs-folder.
  • The macro \todosong{<Name>} will insert a TODO both in the body of the document as well as the TOC if turned on, and will be ignored if turned off. Whether TODOs are shown is toggled in the boolean flag \setboolean{show}{<value>} in songbook.template.

Some entries taken from the Patacrep Songbook