initial commit

This commit is contained in:
workinghard
2022-01-05 23:09:35 +01:00
parent 1c785e825c
commit da23cdd254
56 changed files with 1529 additions and 403 deletions

View File

@@ -0,0 +1,459 @@
\documentclass[12pt]{article}
\usepackage[latin1]{inputenc}
\usepackage{amsmath}
\usepackage[english]{babel}
\usepackage{listings}
\usepackage{verbatim}
\usepackage{graphicx}
\newcommand{\ul}{\underline{~}}
\begin{document}
\section{Overview}
$GuitarTeX_2$ is a tool mainly for guitar players. It can generate nice looking song sheets with
guitar riffs, tabs und melodies. It uses the well known chord format with some minor additions. \\
\\
It's based on the idea from Martin Leclerc and Mario Dorion from Canada. They developed Chord version 3.5 in 1993.
$GuitarTeX_2$ is very similar to the original version. It uses the same syntax. The only difference is the used
language Java to parse the chord file and generate the \LaTeX source file. Usually you don't need to know
this because it's happening in the background. The output you usually see is a generated PDF. But it's helpful
to know this in case you already know \LaTeX and want to adjust something very specific.
\subsection{Features}
\begin{itemize}
\item
Grafical user interface with integrated basic editor
\item
Prints nice looking chords, melodies, riffs
\item
Output formats \LaTeX and PDF
\item
Compatible with ChordPro-format, import if ASCII-files possible
\item
Musical notation with \LaTeX-packages MusixTeX, MusixLyr and TabDefs
\item
Flexible page layout (size, border...)
\item
Custom colors for chorus, bridge ...
\item
Optional output of chord definitions at the end of the page
\item
ASCII-tabs, guitar tabs and base tabs
\item
Generated \LaTeX files can be customized for advanced users
\end{itemize}
\subsection{Example}
$GuitarTeX_2$ konvertiert eine Datei mit Text und Akkorden im Chord-Format in
eine \LaTeX-Datei. Ein Beispiel f<>r eine Chord-Datei: \\
\\
{\bf\{title:The Manual Song\} \\
\{st:No-one has yet claimed responsibility\} \\
~[D]I print verses [A7]in a [D]row, \\
The next line gets put [A7]down be[D]low, \\
Mumble mumble [A7]rhymes with [D]grow [G] [G\#] [A] \\
Done this verse, now [A7sus4]on we [quietly]go! \\
\\
\{soc\} \\
~[D]This is the [Bm]manual song \\
~[A7]No-one really knows what's [D]goin' on \\
~[D]This is the [F\#m]manual song \\
~[A7]And now the chorus is already [D]gone \\
\{eoc\} \\
\\
~[D]The second verse is [A7]like the [D]first, \\
The music poor, the [A7]verse is [D]worse, \\
I wrote this since [A7]I'd get [D]sued, \\
If I used real songs. [A7]This'll [D]do. \\
\\
\{c:repeat chorus\} } \\
\\
\includegraphics[width=1.1\textwidth]{pics/example1.pdf}
\\
Wenn Sie sich mit \LaTeX ~auskennen, k<>nnen Sie die Ausgabedatei auch manuell ver<65>ndern,
bevor Sie sie in Postscript oder PDF umwandeln. Der Vorteil ist, dass Sie alle M<>glichkeiten
von \LaTeX ~einschlie<69>lich der vielen Zusatzpackete wie graphics oder MusicTeX einsetzen k<>nnen.
\section{Installation}
\subsection{Woher bekomme ich $GuitarTeX_2$}
Die aktuelle Version bekommen Sie immer auf der Download-Seite des $GuitarTeX_2$-Projektes:
http://sourceforge.net/projects/guitartex2.
\subsection{Systemanforderungen}
$GuitarTeX_2$ ist ein Java Programm welches Betriessystemunabh<62>gig entwickelt wurde.
Ben"otigt werden:
\begin{itemize}
\item
Java 1.4 oder h<>her
\item
PDF - Betrachter (z.B. Acrobat Reader, xpdf)
Bei MacOS X braucht man es nicht
\item
Internetverbindung (optinal)
\item
\LaTeX (optional)
\end{itemize}
\subsection{Installation}
Laden sie sich das bin<69>re Paket (GuitarTeX2.jar) herunter. Je nachdem wie sie Ihr
System konfiguriert haben, reicht es darauf zu Doppelklicken oder mit
''java -jar GuitarTeX2.jar'' aus der Kommandozeile zu starten. \\
\\
Es wird beim ersten Starten eine lokale Konfigurationsdatei
angelegt. Diese ist im Homeverzeichnis des Benutzers zu finden. Sie kann nachtr<74>glich
ver<65>ndert werde und wird immer beim starten zuerst ausgelesen.
\section{Der Editor $GuitarTeX_2$}
<Hier kommt bald eine genaue Beschreibung>
\section{Unterst<EFBFBD>tzte Chord-Direktiven}
Direktiven sind Befehle zwischen geschweiften Klammern, die das Aussehen der erzeugten
Ausgabe steuern. Einige h<>ufig ben<65>tigte Direktiven k<>nnen durch eine Abk<62>rzung ersetzt
werden (siehe Beispiele). $GuitarTeX_2$ bringt einige neue Direktiven mit, die das original
Chord Programm nicht kennt.
\subsection{Spezielle Zeichen}
Einige Zeichen haben in GuitarTeX eine besondere Bedeutung:
\begin{itemize}
\item
\# am Anfang einer Zeile markiert einen Kommentar. Die Zeile wird von $GuitarTeX_2$ ignoriert
\item
/ darf nur in Akkorden mit Bass verwendet werden (z.B. A/E)
\end{itemize}
\subsection{Seitenlayout}
Die Direktive geometry bietet flexible M<>glichkeiten, das Layout einer Seite anzupassen.
Sie benutzt das \LaTeX-Paket geometry. Die folgende Beschreibung ist ein (modifizierter)
Teil der Original-Dokumentation.
\\
Das geometry Paket bietet viele automatische Ausrichtungen, so dass nur wenige manuelle
Angaben zum Seitenlayout erforderlich sind. In diesem Fall reicht ein einfaches \\
\\
{\bf\{geometry:a4paper\}} \\
\\
Das Setzen von Seitenr<6E>ndern erfolgt mit \\
\\
{\bf\{geometry:margin=2.5cm\}} \\
\\
wenn alle R<>nder einer Seite 2,5 Zentimeter betragen sollen.
L<>ngenangaben erfolgen in
\begin{itemize}
\item
Zentimeter (cm)
\item
Millimeter (mm)
\item
Inch (in)
\item
Punkt (pt)
\end{itemize}
\subsubsection{Grunds"atzliches}
Das Seitenlayout besteht aus einer einfachen Struktur: Die Seite (paper) enth<74>lt einen
Textk<74>rper (total-body, druckbarer Bereich) und R<>nder. Der Textk<74>rper besteht aus Kopf-
und Fu<46>zeile, dem eigentlichen Text und (optional) den Randbemerkungen. Die vier R<>nder
hei<65>en left-margin, right-margin, top-margin und bottom-margin.\\
\begin{itemize}
\item
paper: total-body (printable area) and margins
\item
total-body: head, body(text area), foot and marginal notes
\item
margins: left-, right-, top- and bottom-margin
\end{itemize}
Jeder Rand wird von der jeweiligen Kante der Seite aus gemessen, z.B. left-margin meint
den Abstand zwischen linker Seitenkante und dem Textk<74>rper. Die Gr<47><72>en von paper, totalbody
und margins stehen in diesen Ralationen:
\begin{itemize}
\item
paperwidth = left + width + right
\item
paperheight = top + height + bottom
\end{itemize}
\subsubsection{Optionen}
Optionen der Direktive geometry: \\
\begin{tabular}{|l|l|}
\textbf{Name} & \textbf{Bedeutung} \\
\hline
landscape & schaltet um auf Querformat \\
portrait & schaltet um auf Hochformat \\
twoside & schaltet auf zweiseitige Ausgabe um. Die linken und rechen R<>nder werden bei geraden
und ungeraden Seiten symmetrisch angeordnet. \\
reversemp & Randbemerkungen erscheinen am linken Rand (statt am rechten Rand) \\
nohead & keine Reservierung von Platz f<>r Kopfzeilen \\
nofoot & keine Reservierung von Platz f<>r Fu<46>zeilen \\
noheadfoot & keine Reservierung von Platz f<>r Kopf- und Fu<46>zeilen \\
a4paper, a5paper & spezifizert die Papiergr<67><72>e, ohne Wert anzugeben \\
paperwidth & Breite des Papiers. paperwidth=$<$paperwidth$>$ \\
paperheight & H<>he des Papiers. paperheight=$<$paperheight$>$ \\
width & Breite des Textk<74>rpers. width=$<$width$>$or totalwidth=$<$width$>$. Diese Angabe
sollte nicht mit der Textbreite (textwidth) verwechselt werden. width enth<74>lt die
Textbreite und die Breite der Randbemerkungen. \\
height & H<>he des Textk<74>rpers (einschlie<69>lich Kopf- und Fu<46>zeile). height=$<$height$>$ \\
left & linker Rand. left=$<$leftmargin$>$ \\
right & rechter Rand. right=$<$rightmargin$>$ \\
top & oberer Rand. top=$<$topmargin$>$ \\
bottom & unterer Rand. bottom=$<$bottommargin$>$ \\
margin & alle R<>nder. margin=$<$margin$>$ \\
textwidth & Breite des Textes. textwidth=$<$width$>$ \\
textheight & H<>he des Textes. textheight=$<$height$>$ \\
marginpar & Breite der Randbemerkungen. marginpar=$<$length$>$ \\
marginparsep & Abstand zwischen Text und Randbemerkungen. marginparsep=$<$length$>$ \\
head & H<>he der Kopfzeile. head=$<$length$>$ \\
headsep & Abstand zwischen Kopfzeile und Text. headsep=$<$length$>$ \\
foot & Abstand zwischen Fu<46>zeile und Text. foot=$<$length$>$ \\
\end{tabular}
\subsubsection{Beispiele}
Setzen Sie die H<>he des Textk<74>rpers auf 10in, den unteren Rand auf 2cm. Der obere
Rand wird automatisch berechnet:\\
\\
{\bf\{geometry:height=10in,bottom=2cm\}} \\
\\
oder: \\
\\
{\bf\{g:height=10in,bottom=2cm\}} \\
\\
oder: \\
\\
{\bf\{geometry:height=10in\} \\
\\
\{g:bottom:=2cm\}} \\
\\
Setzen Sie den linken, rechten und oberen Rand auf 3cm, 2cm und 2.5in.
Es wird keine Kopfzeile ben<65>tigt. \\
\\
{\bf\{geometry:left=3cm,right=2cm, nohead,top=2.5in\}} \\
\\
oder: \\
\\
{\bf\{geometry:left=3cm\} \\
\{geometry:right=2cm\} \\
\{geometry:nohead\} \\
\{geometry:top=2.5in\}} \\
\\
oder : \\
\\
{\bf\{g:left=3cm,right=2cm\} \\
\{g:nohead, top=2.5in\}} \\
\\
und so weiter ... \\
<09>ndern Sie die Breite der Randbemerkungen auf 3cm \\
\\
{\bf\{geometry:marginpar=3cm\} \\
\{geometry:marginpar=3cm, reversemp\}} \\
\\
l<>sst die Randbemerkungen am linken Rand ausgeben.\\
Verwenden sie A5-Papier im Querformat: \\
\\
{\bf\{geometry:a5paper, landscape\}} \\
\subsection{Dokumentenstrukur}
\subsubsection{title}
Der Titel eines St<53>ckes wird durch die Direktive title markiert. Der
Titel wird zentriert mit einer vergr<67><72>erten Schrift ausgegeben.
In Dokumenten mit mehreren St<53>cken verursacht title einen Seitenumbruch. \\
Beispiel:\\
\\
{\bf\{title:Go Down Moses\} \\
\{t:Go Down Moses\}} \\
\subsubsection{subtitle}
Die Direktive \textbf{subtitle} dient zur Darstellung zus<75>tzlicher
Informationen, wie z.B. Interpret oder Komponist. \\
Beispiel: \\
\\
{\bf\{subtitle:written by John Lennon / Paul McCartney\} \\
\{st:written by John Lennon / Paul McCartney\}} \\
\subsubsection{bridge}
Eine Bridge wird mit \{bridge\} oder \{sob\} (start of bridge) am Anfang,
und \{/bridge\} oder \{eob\} (end of bridge) am Ende markiert. Die Bridge
wird auf Farbdruckern in blau ausgegeben. Die Farbe kann mit der Direktive
color\underline{~}bridge angepasst werden (siehe Abschnitt namens color\underline{~}xxx).\\
Beispiel: \\
\\
{\bf \{bridge\} \\
I want her [Ab]everywhere [Fm] \\
And if [Bbm]she's beside me [C7]I know I need [Fm]never care \\
~[Bb]But to love her [C7]is to meet her \\
\{/bridge\}} \\
\subsubsection{chorus}
Ein Refrain wird mit \{chorus\} oder \{soc\} (start of chorus) am Anfang und mit \{/chorus\}
oder \{eoc\} (end of chorus) am Ende markiert. Der Refrain wird auf Farbdruckern in rot
ausgegeben. Die Farbe kann mit der Direktive color\underline{~}chorus angepasst werden
(siehe Abschnitt namens color\underline{~}xxx).\\
Beispiel: \\
\\
{\bf\{chorus\} \\
Oh, I get [C]by with a little [G]help from my [D]friends \\
Mm, I get [C]high with a little [G]help from my [D]friends \\
Oh, I'm gonna [C]try with a little [G]help from my [D]friends \\
\{/chorus\}} \\
\subsubsection{instr}
Ein Instrumental-Teil wird mit \{instr\} oder \{soi\} (start of instrumental) am Anfang
und \{/instr\} oder \{eoi\} (end of instrumental) am Ende markiert. Der Instrumental-Teil
wird auf Farbdruckern in grau ausgegeben. Die Farbe kann mit der Direktive
color\underline{~}instr angepasst werden (siehe Abschnitt namens color\underline{~}xxx).
\subsubsection{np}
np steht f<>r eine ''neue Seite'' und erzeugt einen Seitenumbruch.\\
Beispiel: \\
{\bf\{np\}} \\
\subsubsection{tab}
Tabulaturen werden mit \{tab\} oder \{sot\} (start of tablature) am Anfang und \{/tab\}
oder \{eot\} (end of tablature) am Ende markiert. Tabulaturen werden auf Farbdruckern
in gr<67>n ausgegeben. Die Farbe kann mit der Direktive color\underline{~}tab directive
angepasst werden (siehe Abschnitt namens color\underline{~}xxx). Tabulaturen werden
in einer nichtproportionalen Schriftart ausgegeben.\\
Beispiel: \\
\includegraphics[width=15cm]{pics/tabs1.pdf}
\subsection{Fonts}
Die Direktiven zur Beeinflussung der Schriftart und -farbe k<>nnen irgendwo in Ihrer Datei
stehen. Trotzdem ist es hilfreich sie am Anfang zu platzieren. Die angegebenen Werte
gelten f<>r das ganze Dokument.
\subsubsection{font\underline{~}size}
\LaTeX ~kennt drei Schriftgr<67><72>en 10pt, 11pt and 12pt. GuitarTeX nutzt normalerweise
11pt (Titel und Untertitel werden automatisch vergr<67><72>ert). Wenn Sie z.B. 12pt
verwenden wollen, schreiben Sie:\\
\\
{\bf\{font\underline{~}size:12\}} \\
\\
Achtung: schreiben Sie nicht 12pt statt 12!\\
\subsubsection{color\underline{~}xxx}
Mit den folgenden Direktiven k<>nnen Sie die Textfarbe f<>r Refrain, Bridge,
Instrumental-Teil Tabulaturen und zweite Stimme anpassen. F<>r die zweite Stimme
k<>nnen Sie auch die Hintergrundfarbe <20>ndern, so dass Sie z.B. wei<65>e Schrift auf einem
farbigen Hintergrund verwenden k<>nnen. Das erleichtert den S<>ngern hoffentlich
die Orientierung bei mehreren Textzeilen. \\
Die Direktiven hei<65>en: \\
\begin{itemize}
\item
color\underline{~}chorus
\item
color\underline{~}bridge
\item
color\underline{~}instr
\item
color\underline{~}tab
\item
color\underline{~}second
\item
color\underline{~}second\underline{~}back
\end{itemize}
Als Parameter wird eine durch Kommas getrennte Liste von Werten zwischen null und
eins, die die Farben rot, gr<67>n und blau repr<70>sentieren.\\
Beispiel: \\
\\
{\bf\{color\underline{~}chorus:.5,.5,1\}}
\subsection{Gitarren- und Bass-Tabulaturen}
$GuitarTeX_2$ kennt zwei neue Direktiven zur Darstellung von Tabulaturen:
\begin{itemize}
\item
\{guitartab: \} f<>r Gitarren-Tabulaturen
\item
\{basstab: \} f<>r Bass-Tabulaturen
\end{itemize}
Jede guitartab oder basstab Direktive stellt eine Zeile mit sechs bzw vier Linien dar.
Sie k<>nnen mit \{guitartab: \} oder \{basstab: \} auch leere Tabulaturen erzeugen.
Setzen Sie eine Leerzeile vor die Direktive, damit die Tabulatur am linken Rand beginnt.\\
Die Klammern k<>nnen enthalten:
\begin{itemize}
\item
normaler Text, der unterhalb der Tabulatur ausgegeben wird
\item
Noten im Format [string;fret], z.B. [2;5] f<>r 5. Bund auf der A-Saite
\item
Taktstriche (durch das Zeichen $|$ dargestellt)
\item
Zus<75>tzlicher Leerraum mit ''\ul{}''
\end{itemize}
Beispiel: leere Gitarrentabulatur \\
\\
{\bf\{guitartab:\}} \\
\\
Beispiel: Eine Bass-Tabulatur mit Text \\
\\
{\bf\{basstab:some text\}} \\
\\
Beispiel: Noten, Taktstriche und Leerraum \\
\\
{\bf\{guitartab:[2;3][3;0][3;2][3;3]$|$[4;0]\ul\ul[4;2]\ul\ul[5;0]\ul\ul[5;1]$|$\}} \\
\\
Beispiel: Text unter den Noten anordnen \\
\\
{\bf\{guitartab:[2;3]do [3;0]re [3;2]mi [3;3]fa $|$[4;0]so [4;2]la [5;0]si [5;1]do$|$\}} \\
\\
Beispiel: Eine einfache Bass-Tabulatur \\
\\
{\bf\{basstab:[2;5][2;5]$|$[2;5][2;5]$|$[3;5][3;5]$|$[2;5][2;5]$|$[3;7][3;7]$|$[3;5][3;5]$|$[2;5]\}} \\
\\
Beispiel: Akkorde \\
\\
{\bf\{guitartab:[2;3]\&[3;5]\&[4;5]C (power chord) $|$[2;3]\&[3;2]\&[4;0]\&[5;1]C chord\}} \\
\subsection{N"utzliches}
\subsubsection{define}
Mit der Direktive define k<>nnen Sie ein Akkord-Symbol am Ende eines St<53>ckes erstellen.
Die Direktive kann irgendwo im St<53>ck platziert sein.\\
define verf<72>gt <20>ber acht Parameter:\\
\begin{itemize}
\item
den Akkordnamen
\item
die Nummer des ersten Bundes
\item
sechs Nummern f<>r die sechs Saiten (ein x bedeutet, dass die Saite nicht gespielt wird)
\end{itemize}
Beispiel:\\
\\
{\bf\{define:A 1 x n 2 2 2 n\} \\
\{define:Cm 3 x 1 3 3 2 1\} \\
\{define:Gm/Bb 4 3 2 2 1 x x\}} \\
\subsubsection{comment}
Die Direktive comment f<>gt einen Text ein, der nicht zum eigentlichen St<53>ck geh<65>rt. \\
Beispiel: \\
\\
{\bf\{comment: repeat chorus\} \\
\{c: repeat chorus\}} \\
\subsubsection{margin}
Die Direktive margin erzeugt eine Randbemerkung. Diese k<>nnen z.B. dazu genutzt werden,
Hinweise f<>r den Musiker einzuf<75>gen.\\
Beispiel: \\
\\
{\bf\{margin:Fade Out\} \\
\{m:Fade Out\}} \\
\subsubsection{second}
In einigen St<53>cken hat die zweite Stimme nicht nur eine andere Melodie, sondern auch
einen anderen oder versetzt gesungenen Text. Bekannte Beispiele sind "California Dreaming"
von The Mamas And The Papas und "Help" von den Beatles. Wenn Sie die zweite Stimme mit
der Direktive second markieren erscheint sie in wei<65>er Schrift auf grauem Hintergrund.
Wegen der proportionalen Schrift m<>ssen Sie ein wenig experimentieren, um die korrekte
Ausrichtung zwischen erster und zweiter Stimme zu erhalten.\\
Beispiel: \\
\\
{\bf[G] When I was younger so much [Hm]younger than today \\
\{second:When when I was young\} \\
~[Em] I never needed anybody's [C]help in [F]any [G]way \\
\{second:I never need help in any way\} \\
~[G]But now these days are gone and I'm [Bm]not so self assured \\
\{second:Now these days are gone\} \\
~[Em] Now I find I've changed my mind, \\
\{second:And now I find\} \\
I've [C]opened [F]up the [G]doors \\
\{second:I've opened up the doors\}} \\
\section{\LaTeX-Kommandos und Pakete verwenden}
\subsection{\LaTeX-Kommandos}
Wie in der Einf<6E>hrung erw<72>hnt, brauchen Sie nichts <20>ber \LaTeX ~zu wissen, um $GuitarTeX_2$
zu nutzen. Wenn Sie sich mit \LaTeX ~auskennen, k<>nnen Sie dessen M<>glichkeiten nutzen,
um Ihre Ergebnisse weiter zu verbessern. Alle Zeilen, die mit einem Backslash beginnen,
werden in die erzeute \LaTeX-Datei <20>bernommen. Sie k<>nnen das einfach mit einem Kommando
wie diesem testen: \\
\\
{\bf$\backslash$marginpar\{test\}} \\
\\
Das Ergebnis ist eine Randbemerkung mit dem Wort ''test''.
Die \LaTeX-Kommandos werden an der Stelle ausgef<65>hrt, an der sie in der Datei vorkommen.
Manche Kommandos m<>ssen allerdings in der sog. Pr<50>ambel der \LaTeX-Datei erscheinen.
Das geschieht mit der Direktive preamble:\\
\\
{\bf\{preamble:$\backslash$usepackage(fancyheadings)\}}\\
\\
Die Direktive preamble kann irgendwo im Dokument stehen. Die enthaltenen Kommandos
erscheinen in der \LaTeX-Pr<50>ambel in der Reihenfolge, in der sie in der Chord-Datei stehen.
\end{document}