summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/doc/latex
diff options
context:
space:
mode:
authorKarl Berry <karl@freefriends.org>2014-09-15 22:57:22 +0000
committerKarl Berry <karl@freefriends.org>2014-09-15 22:57:22 +0000
commit720ab6d5bd9c366793fd8f03c58aec9b4348bf4d (patch)
tree82056343b04f7f5ec1101a536dccfb5ab316c783 /Master/texmf-dist/doc/latex
parentd2fd2a3b5c16b8291823a204b10077dc0bfa0ce2 (diff)
guitarchordschemes (15sep14)
git-svn-id: svn://tug.org/texlive/trunk@35179 c570f23f-e606-0410-a88d-b1316a301751
Diffstat (limited to 'Master/texmf-dist/doc/latex')
-rw-r--r--Master/texmf-dist/doc/latex/guitarchordschemes/README6
-rw-r--r--Master/texmf-dist/doc/latex/guitarchordschemes/guitarchordschemes_en.pdfbin116509 -> 415450 bytes
-rw-r--r--Master/texmf-dist/doc/latex/guitarchordschemes/guitarchordschemes_en.tex633
3 files changed, 281 insertions, 358 deletions
diff --git a/Master/texmf-dist/doc/latex/guitarchordschemes/README b/Master/texmf-dist/doc/latex/guitarchordschemes/README
index 0397df22b11..16e8d67dcf3 100644
--- a/Master/texmf-dist/doc/latex/guitarchordschemes/README
+++ b/Master/texmf-dist/doc/latex/guitarchordschemes/README
@@ -1,15 +1,15 @@
--------------------------------------------------------------------------
-the GUITARCHORDSCHEMES package v 0.4
+the GUITARCHORDSCHEMES package v 0.6
Guitar Chord and Scale Tablatures with TikZ
-2013/08/25
+2014/09/15
--------------------------------------------------------------------------
Clemens Niederberger
Web: https://bitbucket.org/cgnieder/guitarchordschemes/
E-Mail: contact@mychemistry.eu
--------------------------------------------------------------------------
-Copyright 2013 Clemens Niederberger
+Copyright 2013-2014 Clemens Niederberger
This work may be distributed and/or modified under the
conditions of the LaTeX Project Public License, either version 1.3
diff --git a/Master/texmf-dist/doc/latex/guitarchordschemes/guitarchordschemes_en.pdf b/Master/texmf-dist/doc/latex/guitarchordschemes/guitarchordschemes_en.pdf
index 87c0de8bbaf..2f94bd693a2 100644
--- a/Master/texmf-dist/doc/latex/guitarchordschemes/guitarchordschemes_en.pdf
+++ b/Master/texmf-dist/doc/latex/guitarchordschemes/guitarchordschemes_en.pdf
Binary files differ
diff --git a/Master/texmf-dist/doc/latex/guitarchordschemes/guitarchordschemes_en.tex b/Master/texmf-dist/doc/latex/guitarchordschemes/guitarchordschemes_en.tex
index 18891ca9c46..4ad227ba4bf 100644
--- a/Master/texmf-dist/doc/latex/guitarchordschemes/guitarchordschemes_en.tex
+++ b/Master/texmf-dist/doc/latex/guitarchordschemes/guitarchordschemes_en.tex
@@ -1,7 +1,7 @@
-% arara: xelatex
-% !arara: biber
-% !arara: xelatex
-% !arara: xelatex
+% arara: pdflatex
+% arara: biber
+% arara: pdflatex
+% arara: pdflatex
% --------------------------------------------------------------------------
% the GUITARCHORDSCHEMES package
%
@@ -35,63 +35,44 @@
% If you have any ideas, questions, suggestions or bugs to report, please
% feel free to contact me.
% --------------------------------------------------------------------------
-\documentclass[toc=index,toc=bib]{cnpkgdoc}
-\docsetup{
- pkg = [use-rbc]guitarchordschemes ,
- subtitle = Guitar Chord and Scale Tablatures with \TikZ ,
- code-box = {
- backgroundcolor = gray!7!white ,
- skipbelow = .6\baselineskip plus .5ex minus .5ex ,
- skipabove = .6\baselineskip plus .5ex minus .5ex ,
- roundcorner = 3pt ,
+\documentclass[load-preamble+]{cnltx-doc}
+\usepackage{guitarchordschemes}
+\usepackage[chordnames]{leadsheets}
+
+\setcnltx{
+ package = guitarchordschemes ,
+ authors = Clemens Niederberger ,
+ email = contact@mychemistry.eu ,
+ url = https://bitbucket.org/cgnieder/guitarchordschemes/ ,
+ info = guitar chord schemes and fingering scales with \TikZ ,
+ add-cmds = {
+ chordscheme,
+ setchordscheme,
+ scales
} ,
- gobble = 1
-}
-\usepackage{polyglossia}
-\setmainlanguage{english}
-\usepackage[oldstyle,proportional]{libertine}
-\usepackage{libertinehologopatch}
-\cnpkgusecolorscheme{friendly}
-
-\setmonofont[Ligatures=TeX,Scale=MatchLowercase]{Bitstream Vera Sans Mono}
-
-\usepackage{fnpct}
-\pagestyle{headings}
-
-\usepackage[biblatex]{embrac}[2013/03/22]
-\ChangeEmph{[}[,.02em]{]}[.055em,-.08em]
-\ChangeEmph{(}[-.01em,.04em]{)}[.04em,-.05em]
-
-\renewcommand*\othersectionlevelsformat[3]{%
- \textcolor{main}{#3\autodot}\enskip}
-\renewcommand*\partformat{%
- \textcolor{main}{\partname~\thepart\autodot}}
-
-\addcmds{
- chordscheme,
- setchordscheme,
- scales,
- textsuperscript
+ add-silent-cmds = textsuperscript ,
+ abstract = {%
+ \centering
+ \chordscheme[
+ name = Gmi7 ,
+ position = II ,
+ barre = {2/2-4:3} ,
+ show-root = {4/4} ,
+ root = {2/6:2} ,
+ mute = {1,5}
+ ]%
+ } ,
+ index-setup = {
+ othercode = \footnotesize ,
+ level = \addsec ,
+ noclearpage
+ } ,
+ makeindex-setup = {
+ columns = 3 ,
+ columnsep = 1em
+ }
}
-\usepackage{filecontents}
-\usepackage{imakeidx}
-\begin{filecontents*}{\jobname.ist}
- heading_prefix "{\\bfseries "
- heading_suffix "\\hfil}\\nopagebreak\n"
- headings_flag 1
- delim_0 "\\dotfill\\hyperpage{"
- delim_1 "\\dotfill\\hyperpage{"
- delim_2 "\\dotfill\\hyperpage{"
- delim_r "}\\textendash\\hyperpage{"
- delim_t "}"
- suffix_2p "\\nohyperpage{\\,f.}"
- suffix_3p "\\nohyperpage{\\,ff.}"
-\end{filecontents*}
-\indexsetup{othercode=\footnotesize}
-\makeindex[options={-s \jobname.ist},intoc,columns=3,columnsep=1em]
-
-\usepackage[backend=biber,style=alphabetic]{biblatex}
\addbibresource{\jobname.bib}
\begin{filecontents}{\jobname.bib}
@online{web:pietsch:fonts,
@@ -100,36 +81,6 @@
url = {http://notation.jochenpietsch.de/index_e.html} ,
urldate = {2012-05-10}
}
-@package{pkg:etoolbox,
- title = {\paket*{etoolbox}},
- author = {Philipp Lehman},
- date = {2011-01-21},
- version = {2.1},
- url = {http://mirror.ctan.org/macros/latex/contrib/etoolbox}
-}
-@package{pkg:pgfopts,
- title = {\paket*{pgfopts}},
- author = {Joseph Wright},
- date = {2011-06-02},
- version = {2.1},
- url = {http://mirror.ctan.org/macros/latex/contrib/pgfopts}
-}
-@package{pkg:realbookchords,
- title = {\paket*{realbookchords}},
- author = {Clemens Niederberger},
- date = {2013-04-29},
- version = {0.1},
- url = {https://bitbucket.org/cgnieder/guitarchordschemes/}
-}
-@package{pkg:tikz,
- author = {Till Tantau and Mark Wibrow and Christian Feuersänger},
- title = {Ti\textit{k}Z/pgf},
- sorttitle = {TikZ},
- version = {2.10},
- date = {2010-02-25},
- url = {http://sourceforge.net/projects/pgf/},
- urldate = {2013-04-18}
-}
@book{leavitt:mmfg:1,
author = {William G. Leavitt},
title = {A Modern Method for Guitar},
@@ -139,304 +90,276 @@
}
\end{filecontents}
-
-\let\verb\lstinline
-\makeatletter
-\def\TikZ@logo{Ti\textit{k}Z}
-\renewrobustcmd\TikZ{\TikZ@logo\index{TikZ@\TikZ@logo}}
-\makeatother
-
\usepackage{ccicons}
-\usepackage{acro,accsupp}
-\DeclareAcronym{ctan}{
- short = ctan ,
- long = the \textsc{Comprehensive \TeX{} Archive Network} ,
- short-format = \scshape ,
- pdfstring = CTAN ,
- accsupp = CTAN
-}
-\acsetup{first-style=footnote}
-
\setchordscheme{
- finger-format+=\biolinumLF ,
- name-format+=\libertineLF
+ finger-format+ = \biolinumLF ,
+ name-format+ = \libertineLF ,
+ chord-name-cs = \chordname
}
-\TitlePicture{%
-\chordscheme[
- name = Gmi7 ,
- position = II ,
- barre = {2/2-4:3} ,
- show-root = {4/4} ,
- root = {2/6:2} ,
- mute = {1,5}
-]}
+\newcommand*\TikZ{Ti\textit{k}Z}
+
\begin{document}
\section{License and Requirements}
-\guitarchordschemes is placed under the terms of the \LaTeX{} Project Public License,
-version 1.3 or later (\url{http://www.latex-project.org/lppl.txt}).
-It has the status “maintained”.
+\license
+
+\guitarchordschemes{} loads the packages \TikZ~\cite{pkg:pgf},
+\pkg{etoolbox}~\cite{pkg:etoolbox} and \pkg{pgfopts}~\cite{pkg:pgfopts}. It
+also loads the \TikZ{} libraries \code{shapes.misc}, \code{arrows} and
+\code{calc}.
-\guitarchordschemes loads the packages \TikZ~\cite{pkg:tikz},
-\paket*{etoolbox}~\cite{pkg:etoolbox} and \paket*{pgfopts}~\cite{pkg:pgfopts}.
-It also loads the \TikZ{} libraries \code{shapes.misc}, \code{arrows} and \code{calc}.
-Depending on an option it also loads \paket*{realbookchords}~\cite{pkg:realbookchords}.
-This package is not yet published on \ac{ctan} and thus not part of any \TeX{}
-distribution. Until it is you can find it at
-\url{https://bitbucket.org/cgnieder/realbookchords/}.
-See section~\ref{sec:realbookchords} for details on this option.
+% Depending on an option it also loads
+% \pkg{realbookchords}~\cite{pkg:realbookchords}. This package is not yet
+% published on \CTAN{} and thus not part of any \TeX{} distribution. Until it is
+% you can find it at \url{https://bitbucket.org/cgnieder/realbookchords/}. See
+% section~\ref{sec:realbookchords} for details on this option.
\section{The Commands}
This package more or less provides a single command:
-\begin{beschreibung}
- \Befehl{chordscheme}[<options>]
- \Befehl{scales}[<option>]
-\end{beschreibung}
+\begin{commands}
+ \command{chordscheme}[\oarg{options}]
+ Typeset a guitar chord scheme.
+ \command{scales}[\oarg{option}]
+ Typeset a fingering scale.
+\end{commands}
These commands set the frame for the chord and scale tablatures and can be used
to create sheets for manually writing down tablatures:
-\begin{beispiel}
- \chordscheme
-\end{beispiel}
-
-Similarly \cmd{scales} creates a frame with two more frets:
-\begin{beispiel}[below]
- \scales
-\end{beispiel}
-
-\subsection{Options for \cmd*{chordscheme}}
-The \oa{options} argument is where the actual details for a chord happen. These
-are the available ones for \cmd{chordscheme}:
-\begin{beschreibung}
- \Option{name}{<chordsymbol>}\newline
- Set the chord symbol. This option accepts a list of entries.
- \Option{position}{<position>}\newline
- Set the position for the first of the four frets.
- \Option{finger}{<fret>/<string>:<label>}\newline
- Specify the finger positions for a chord. This option accepts a list of entries.
- The \code{:<label>} is optional.
- \Option{root}{<fret>/<string>:<label>}\newline
- The same as finger but uses a square instead of a circle to indicate that
- this finger is playing the root of the chord. This option accepts a list of
- entries. The \code{:<label>} is optional.
- \Option{show-root}{<fret>/<string>}\newline
- Specify positions of the root that are \emph{not} part of the actual chord
- but are somewhere in the vicinity of it on the guitar neck. This option
- accepts a list of entries.
- \Option{barre}{<fret>/<string range>:<label>}\newline
- Specify a barr\'e position for a chord. The \code{<string range>} part must
- contain a two string numbers separated with a dash. This option accepts a list
- of entries. The \code{:<label>} is optional.
- \Option{ring}{<string>}\newline
- Specify open strings. This option accepts a list of entries.
- \Option{mute}{<string>}\newline
- Specify muted/un-played strings This option accepts a list of entries.
-\end{beschreibung}
+\begin{example}[side-by-side]
+ \chordscheme
+\end{example}
+
+Similarly \cs{scales} creates a frame with two more frets:
+\begin{example}
+ \scales
+\end{example}
+
+\subsection{Options for \cs*{chordscheme}}
+The \meta{options} argument is where the actual details for a chord
+happen. These are the available ones for \cs{chordscheme}:
+\begin{options}
+ \keyval{fret-number}{number}\Default{4}
+ \sinceversion{0.6}The number of frets that are drawn. This number must be
+ at least 4. The option should be set as first option since it influences
+ other options.
+ \keyval{name}{chordsymbol}
+ Set the chord symbol. This option accepts a comma separated list of
+ entries.
+ \keyval{position}{position}
+ Set the position for the first of the four frets.
+ \keychoice{finger}{\meta{fret}/\meta{string}:\meta{label}}
+ Specify the finger positions for a chord. This option accepts a comma
+ separated list of entries. The \code{:\meta{label}} is optional.
+ \keychoice{root}{\meta{fret}/\meta{string}:\meta{label}}
+ The same as finger but uses a square instead of a circle to indicate that
+ this finger is playing the root of the chord. This option accepts a comma
+ separated list of entries. The \code{:\meta{label}} is optional.
+ \keychoice{show-root}{\meta{fret}/\meta{string}}
+ Specify positions of the root that are \emph{not} part of the actual chord
+ but are somewhere in the vicinity of it on the guitar neck. This option
+ accepts a comma separated list of entries.
+ \keychoice{barre}{\meta{fret}/\meta{string range}:\meta{label}}
+ Specify a barr\'e position for a chord. The \meta{string range} part must
+ contain a two string numbers separated with a dash. This option accepts a
+ list of entries. The \code{:\meta{label}} is optional.
+ \keyval{ring}{string}
+ Specify open strings. This option accepts a comma separatedlist of
+ entries.
+ \keyval{mute}{string}
+ Specify muted/un-played strings. This option accepts a comma separated
+ list of entries.
+\end{options}
Let's take a look at a few examples:
-\setchordscheme{use-rbc=false}
-\begin{beispiel}
- \chordscheme[
- name = G ,
- position = I ,
- finger = {2/5:1} ,
- root = {3/6:2, 3/1:4} ,
- ring = {2,3,4}
- ]
-\end{beispiel}
+\begin{example}[side-by-side]
+ \chordscheme[
+ name = G ,
+ position = I ,
+ finger = {2/5:1} ,
+ root = {3/6:2, 3/1:4} ,
+ ring = {2,3,4}
+ ]
+\end{example}
+\makeatletter
+\setchordscheme{chord-name-cs=\@firstofone}
+\makeatother
-Or a more “jazzy” chord:
-\begin{beispiel}
- \chordscheme[
- name = G\textsuperscript{6} ,
- position = II ,
- finger = {1/4:1, 3/3:4, 2/2:3} ,
- root = 2/6:2 ,
- show-root = 4/4 ,
- mute = {1,5}
- ]
-\end{beispiel}
+Or a more "`jazzy"' chord:
+\begin{example}[side-by-side]
+ \chordscheme[
+ name = G\textsuperscript{6} ,
+ position = II ,
+ finger = {1/4:1, 3/3:4, 2/2:3} ,
+ root = 2/6:2 ,
+ show-root = 4/4 ,
+ mute = {1,5}
+ ]
+\end{example}
One with a barr\'e:
-\begin{beispiel}
- \chordscheme[
- name = Gmi\textsuperscript{7} ,
- position = II ,
- barre = 2/2-4:3 ,
- show-root = 4/4 ,
- root = 2/6:2 ,
- mute = {1,5}
- ]
-\end{beispiel}
-
-\subsection{Options for \cmd*{scales}}
-The \oa{options} argument for \cmd{scales} are similar to the ones for
-\cmd{chordscheme}:
-\begin{beschreibung}
- \Option{name}{<title>}\newline
- Set a title for the scale.
- \Option{position}{<position>}\newline
- Set the position for the first of the six frets.
- \Option{finger}{<fret>/<string>:<label>}\newline
- Specify the finger positions for the scale. This option accepts a list of entries.
- The \code{:<label>} is optional.
- \Option{root}{<fret>/<string>:<label>}\newline
- The same as finger but uses a square instead of a circle to indicate that
- this finger is playing the root of the scale. This option accepts a list of
- entries. The \code{:<label>} is optional.
- \Option{fret number}{<integer>}\Default{6}
- The number of frets displayed for a scale. The minimum number is 6.
- \Option{fingering}{type 1|type 1A|type 2|type 3|type 4}\newline
- Set a whole predefined fingering. The types correspond to ones taught
- in \citeauthor{leavitt:mmfg:1}'s \citetitle{leavitt:mmfg:1}~\cite{leavitt:mmfg:1}.
- This option assumes an ionic scale a places the roots correspondingly.
- \Option{fingering*}{type 1|type 1A|type 2|type 3|type 4}\newline
- The same as \key{fingering} but not scale is assumed and no roots are
- indicated.
- \Option{fingering?}{type 1|type 1A|type 2|type 3|type 4}\newline
- The same as \key{fingering*} but also no labels for the fingers are given.
-\end{beschreibung}
+\begin{example}[side-by-side]
+ \chordscheme[
+ name = Gmi\textsuperscript{7} ,
+ position = II ,
+ barre = 2/2-4:3 ,
+ show-root = 4/4 ,
+ root = 2/6:2 ,
+ mute = {1,5}
+ ]
+\end{example}
+
+\subsection{Options for \cs*{scales}}
+The \meta{options} argument for \cs{scales} are similar to the ones for
+\cs{chordscheme}:
+\begin{options}
+ \keyval{fret-number}{number}\Default{6}
+ \sinceversion{0.6}The number of frets that are drawn. This number must be
+ at least 6. The option should be set as first option since it influences
+ other options.
+ \keyval{name}{title}
+ Set a title for the scale.
+ \keyval{position}{position}
+ Set the position for the first of the six frets.
+ \keychoice{finger}{\meta{fret}/\meta{string}:\meta{label}}
+ Specify the finger positions for the scale. This option accepts a comma
+ separated list of entries. The \code{:\meta{label}} is optional.
+ \keychoice{root}{\meta{fret}/\meta{string}:\meta{label}}
+ The same as finger but uses a square instead of a circle to indicate that
+ this finger is playing the root of the scale. This option accepts a comma
+ separated list of entries. The \code{:\meta{label}} is optional.
+ \keyval{fret number}{integer}\Default{6}
+ The number of frets displayed for a scale. The minimum number is 6.
+ \keychoice{fingering}{type 1,type 1A,type 2,type 3,type 4}
+ Set a whole predefined fingering. The types correspond to ones taught
+ in \citeauthor{leavitt:mmfg:1}'s
+ \citetitle{leavitt:mmfg:1}~\cite{leavitt:mmfg:1}. This option assumes an
+ ionic scale a places the roots correspondingly.
+ \keychoice{fingering*}{type 1,type 1A,type 2,type 3,type 4}
+ The same as \option{fingering} but not scale is assumed and no roots are
+ indicated.
+ \keychoice{fingering?}{type 1,type 1A,type 2,type 3,type 4}
+ The same as \option{fingering*} but also no labels for the fingers are given.
+\end{options}
Let's see an example:
-\begin{beispiel}[below]
- \scales[
- name = F-major (Fingering Type~1A) ,
- position = I ,
- fingering = type 1A
- ]
-\end{beispiel}
-
-An example for \key{fingering*}:
-\begin{beispiel}[below]
- \scales[
- name = Fingering Type~3 ,
- fingering* = type 3
- ]
-\end{beispiel}
-
-Now an example for \key{fingering?}:
-\begin{beispiel}[below]
- \scales[
- name = Fingering Type~2 ,
- fingering? = type 2
- ]
-\end{beispiel}
+\begin{example}
+ \scales[
+ name = F-major (Fingering Type~1A) ,
+ position = I ,
+ fingering = type 1A
+ ]
+\end{example}
+
+An example for \option{fingering*}:
+\begin{example}
+ \scales[
+ name = Fingering Type~3 ,
+ fingering* = type 3
+ ]
+\end{example}
+
+Now an example for \option{fingering?}:
+\begin{example}
+ \scales[
+ name = Fingering Type~2 ,
+ fingering? = type 2
+ ]
+\end{example}
At last an example for an explicitly set scale:
-\begin{beispiel}[below]
- \scales[
- finger = {
- 2/1:1, 5/1:4,
- 2/2:1, 5/2:4,
- 2/3:1, 4/3:3, 5/3:4,
- 2/4:1, 4/4:3,
- 2/5:1, 3/5:2, 4/5:3,
- 2/6:1, 5/6:4
- }
- ]
-\end{beispiel}
-
+\begin{example}
+ \scales[
+ finger = {
+ 2/1:1, 5/1:4,
+ 2/2:1, 5/2:4,
+ 2/3:1, 4/3:3, 5/3:4,
+ 2/4:1, 4/4:3,
+ 2/5:1, 3/5:2, 4/5:3,
+ 2/6:1, 5/6:4
+ }
+ ]
+\end{example}
\section{Options}
There are quite a number of options determining the layout of the tablatures.
They can either be set as package options or via the setup command:
-\begin{beschreibung}
- \Befehl{setchordscheme}{<options>}
-\end{beschreibung}
+\begin{commands}
+ \command{setchordscheme}{options}
+ The setup command for \guitarchordschemes.
+\end{commands}
Below every option and its corresponding default setting is described.
-\begin{beschreibung}
- \Option{x-unit}{<dim>}\Default{.8cm}
- The basic $x$ unit for the \TikZ{} picture the chord scheme is set in.
- \Option{y-unit}{<dim>}\Default{.8cm}
- The basic $y$ unit for the \TikZ{} picture the chord scheme is set in.
- \Option{finger-format}{<TeX code>}\Default{\cmd*{sffamily}\cmd*{small}}
- The format the numbers for the fingers are typeset with.
- \Option{finger-format+}{<TeX code>}\Default{}
- Code to be appended to \key{finger-format}.
- \Option{position-format}{<TeX code>}\Default{\cmd*{sffamily}}
- The format the number for the position is typeset with.
- \Option{position-format+}{<TeX code>}\Default{}
- Code to be appended to \key{position-format}.
- \Option{name-format}{<TeX code>}\Default{\cmd*{large}}
- The format the chord name/symbol is typeset with.
- \Option{name-format+}{<TeX code>}\Default{}
- Code to be appended to \key{name-format}.
- \Option{string-name-format}{<TeX code>}\Default{\cmd*{sffamily}\cmd*{small}}
- The format the names of the strings are typeset with.
- \Option{string-name-format+}{<TeX code>}\Default{}
- Code to be appended to \key{string-name-format}.
- \Option{line-width}{<dim>}\Default{1pt}
- The line width used for all lines drawn in the chord scheme.
- \Option{finger-radius}{<dim>}\Default{.1875}
- The radius of the circles that represent the fingers in multiples of
- \key{x-unit}. Also determines the size of the root markers and the barr\'e.
- \Option{finger-x-offset}{<dim>}\Default{.375}
- The $x$ offset of the number with respect to the circle in multiples of
- \key{x-unit}.
- \Option{finger-y-offset}{<dim>}\Default{.375}
- The $y$ offset of the number with respect to the circle in multiples of
- \key{y-unit}.
- \Option{finger-style}{<tikz style>}\Default{fill}
- The \TikZ{} style the circles representing the fingers are drawn with.
- This is equivalent to\linebreak \cmd{tikzset}{finger style/.style=\{<tikz style>\}}.
- \Option{root-style}{<tikz style>}\Default{fill}
- The \TikZ{} style the squares representing the roots are drawn with.
- This is equivalent to\linebreak \cmd{tikzset}{root style/.style=\{<tikz style>\}}.
- \Option{show-root-style}{<tikz style>}\Default{draw}
- The \TikZ{} style the squares representing the “ghost roots” are drawn with.
- This is equivalent to \cmd{tikzset}{show root style/.style=\{<tikz style>\}}.
- \Option{ringing-style}{<tikz style>}\Default{draw}
- The \TikZ{} style the circles representing the open string markers are drawn
- with. This is equivalent to \cmd{tikzset}{ringing style/.style=\{<tikz style>\}}.
- \Option{muted-style}{<tikz style>}\Default{\{cross out,draw\}}
- The \TikZ{} style the nodes representing muted strings are drawn with.
- This is equivalent to \cmd{tikzset}{muted style/.style=\{<tikz style>\}}.
- \Option{tuning}{<comma list of string names>}\Default{\{E,B,G,D,A,E\}}
- The tuning.
- \Option{use-rbc}{\default{true}|false}\Default{false}
- If set to true the \key{name} will be set in the command \cmd{rbc} from the
- \paket*{realbookchords}. If this option is not used as a package option
- then make sure you also load \paket*{realbookchords}~\cite{pkg:realbookchords}.
- Please be aware that the latter requires \XeLaTeX{} or \LuaLaTeX. See
- section~\ref{sec:realbookchords} for details.
-\end{beschreibung}
-
-\section{Using \paket*{realbookchords}}\label{sec:realbookchords}
-Setting \cmd{setchordscheme}{use-rbc=true} or using the same as package option
-will set the chord names/symbols in \paket*{realbookchords}' command \cmd{rbc}.
-
-In order to use this option you need to install the \paket*{realbookchords}
-package~\cite{pkg:realbookchords}. I expect it to go to \ac{ctan} eventually but
-until then you can get it at \url{https://bitbucket.org/cgnieder/realbookchords/}.
-The package uses Jochen Pietsch's “New Real Book” font~\cite{web:pietsch:fonts}
-for typesetting the chord symbols which you can get at
-\url{http://notation.jochenpietsch.de/} or from me. I published it here: \url{http://www.niederberger.com.de/gitarren-akkorde-und-skalen-mit-latex}.
-It is placed under the Creative Commons Attribution-Noncommercial-Share Alike~3.0
-Unported License \ccbyncsaeu.
-
-\paket*{realbookchords} requires that you compile your document with \XeLaTeX{}
-or \LuaLaTeX.
-
-Here is an example of how the chord symbol looks with \paket*{realbookchords}:
-\begin{beispiel}
- \setchordscheme{use-rbc=true}
- \chordscheme[
- name = Gmi7(\b5) ,
- position = II ,
- finger = {1/2:1, 2/3:4, 2/4:3} ,
- show-root = {4/4} ,
- root = {2/6:2} ,
- mute = {1,5}
- ]
-\end{beispiel}
-
-\printbibliography
-
-\printindex
+\begin{options}
+ \keyval{x-unit}{dim}\Default{.8cm}
+ The basic $x$ unit for the \TikZ{} picture the chord scheme is set in.
+ \keyval{y-unit}{dim}\Default{.8cm}
+ The basic $y$ unit for the \TikZ{} picture the chord scheme is set in.
+ \keyval{finger-format}{\TeX{} code}\Default{\cs*{sffamily}\cs*{small}}
+ The format the numbers for the fingers are typeset with.
+ \keyval{finger-format+}{\TeX{} code}\Default
+ Code to be appended to \option{finger-format}.
+ \keyval{position-format}{\TeX{} code}\Default{\cs*{sffamily}}
+ The format the number for the position is typeset with.
+ \keyval{position-format+}{\TeX{} code}\Default
+ Code to be appended to \option{position-format}.
+ \keyval{name-format}{\TeX{} code}\Default{\cs*{large}}
+ The format the chord name/symbol is typeset with.
+ \keyval{name-format+}{\TeX{} code}\Default
+ Code to be appended to \option{name-format}.
+ \keyval{chord-name-format}{cs}\Default{\cs*{@firstofone}}
+ \sinceversion{0.5}The command that is used to parse the chord name.
+ \meta{cs} needs to be a command that takes a mandatory argument.
+ \keyval{scales-name-format}{cs}\Default{\cs*{@firstofone}}
+ \sinceversion{0.5}The command that is used to parse the scales name.
+ \meta{cs} needs to be a command that takes a mandatory argument.
+ \keyval{string-name-format}{\TeX{} code}\Default{\cs*{sffamily}\cs*{small}}
+ The format the names of the strings are typeset with.
+ \keyval{string-name-format+}{\TeX{} code}\Default
+ Code to be appended to \option{string-name-format}.
+ \keyval{chord-frets}{number}\Default{4}
+ \sinceversion{0.6}The default number of frets of a chord scheme.
+ \meta{number} must be at least 4.
+ \keyval{scales-frets}{number}\Default{6}
+ \sinceversion{0.6}The default number of frets of a scales scheme.
+ \meta{number} must be at least 6.
+ \keyval{line-width}{dim}\Default{1pt}
+ The line width used for all lines drawn in the chord scheme.
+ \keyval{finger-radius}{num}\Default{.1875}
+ The radius of the circles that represent the fingers in multiples of
+ \option{x-unit}. Also determines the size of the root markers and the
+ barr\'e.
+ \keyval{finger-x-offset}{num}\Default{.375}
+ The $x$ offset of the number with respect to the circle in multiples of
+ \option{x-unit}.
+ \keyval{finger-y-offset}{num}\Default{.375}
+ The $y$ offset of the number with respect to the circle in multiples of
+ \option{y-unit}.
+ \keyval{finger-style}{\TikZ{} style}\Default{fill}
+ The \TikZ{} style the circles representing the fingers are drawn with.
+ This is equivalent to \cs*{tikzset}\Marg{finger
+ style/.style=\{\meta{\TikZ{} style}\}}.
+ \keyval{root-style}{\TikZ{} style}\Default{fill}
+ The \TikZ{} style the squares representing the roots are drawn with.
+ This is equivalent to \cs*{tikzset}\Marg{root style/.style=\{\meta{\TikZ{}
+ style}\}}.
+ \keyval{show-root-style}{\TikZ{} style}\Default{draw}
+ The \TikZ{} style the squares representing the "`ghost roots"' are drawn
+ with. This is equivalent to \cs*{tikzset}\Marg{show root
+ style/.style=\{\meta{\TikZ{} style}\}}.
+ \keyval{ringing-style}{\TikZ{} style}\Default{draw}
+ The \TikZ{} style the circles representing the open string markers are
+ drawn with. This is equivalent to \cs*{tikzset}\Marg{ringing
+ style/.style=\{\meta{\TikZ{} style}\}}.
+ \keyval{muted-style}{\TikZ{} style}\Default{cross out,draw}
+ The \TikZ{} style the nodes representing muted strings are drawn with.
+ This is equivalent to \cs*{tikzset}\Marg{muted style/.style=\{\meta{\TikZ{}
+ style}\}}.
+ \keyval{tuning}{comma separated list of string names}\Default{E,B,G,D,A,E}
+ The tuning.
+\end{options}
\end{document}