From fc93b1059db8deb6ea76d616a0d3e5c24efa2527 Mon Sep 17 00:00:00 2001
From: Louis <spalax@gresille.org>
Date: Wed, 21 May 2014 17:45:26 +0200
Subject: [PATCH] Documentation des options

---
 songbook_core/data/latex/SongbookUtils.sty | 17 ++++++++++++++---
 songbook_core/data/latex/crepbook.sty      |  3 +++
 2 files changed, 17 insertions(+), 3 deletions(-)

diff --git a/songbook_core/data/latex/SongbookUtils.sty b/songbook_core/data/latex/SongbookUtils.sty
index e6de97c8..251e1063 100644
--- a/songbook_core/data/latex/SongbookUtils.sty
+++ b/songbook_core/data/latex/SongbookUtils.sty
@@ -15,36 +15,47 @@
 \RequirePackage{ifthen}
 \RequirePackage{tikz}
 
+% tabs: display the guitar tabs
 \newif{\iftabs}
 \DeclareOption{tabs}{\tabstrue}
 
+% lilypond: display Lilypond music sheets
 \newif{\iflilypond}
 \DeclareOption{lilypond}{\lilypondtrue}
 
 \newif{\iflilypondauto}
 \DeclareOption{lilypond}{\lilypondautotrue\lilypondtrue}
 
+% diagram: display chord diagrams at the beginning
 \newif{\ifdiagram}
 \DeclareOption{diagram}{\diagramtrue}
 
+% importantdiagramonly: only display important chords
 \newif{\ifimportantdiagramonly}
 \DeclareOption{importantdiagramonly}{\importantdiagramonlytrue\diagramtrue}
 
+% pictures: display song covers and songbook titlepage picture
 \newif{\ifpictures}
 \DeclareOption{pictures}{\picturestrue}
 
+% repeatchords: display chords in every verse if the song allows it
 \newif{\ifrepeatchords}
 \DeclareOption{repeatchords}{\repeatchordstrue}
 
+% onesongperpage: force single page for each song
+\newif{\ifonesongperpage}
+\DeclareOption{onesongperpage}{\onesongperpagetrue}
+
+%%% Instruments
+% ukulele: display ukulele tabs
 \newif{\ifukulele}
 \DeclareOption{ukulele}{\ukuleletrue}
 
+% guitar: display guitar tabs
 \newif{\ifguitar}
 \DeclareOption{guitar}{\guitartrue}
 
-\newif{\ifonesongperpage}
-\DeclareOption{onesongperpage}{\onesongperpagetrue}
-
+% Remaining options are passed to the songs package
 \DeclareOption*{\PassOptionsToPackage{\CurrentOption}{songs}}
 
 \ProcessOptions\relax
diff --git a/songbook_core/data/latex/crepbook.sty b/songbook_core/data/latex/crepbook.sty
index 3488ddec..85e09861 100644
--- a/songbook_core/data/latex/crepbook.sty
+++ b/songbook_core/data/latex/crepbook.sty
@@ -8,8 +8,11 @@
 \NeedsTeXFormat{LaTeX2e}[1994/06/01]
 \ProvidesPackage{crepbook}[2014/04/13 Crepbook Package, version 0.1]
 
+% fancy-capo: TODO
 \newif{\iffancycapo}
 \DeclareOption{fancy-capo}{\fancycapotrue}
+
+% Remaining options are passed to the SongbookUtils package
 \DeclareOption*{\PassOptionsToPackage{\CurrentOption}{SongbookUtils}}
 
 \ProcessOptions\relax