From dcc43108bdc08020c229e0d68e56959b2e4380ce Mon Sep 17 00:00:00 2001
From: Nils <>
Date: Wed, 13 Jan 2021 22:08:22 +0100
Subject: [PATCH] generate manual
---
README.md | 2 +-
documentation/english.adoc | 55 +++++++++++++++++++++
documentation/german.adoc | 52 ++++++++++++++++++++
documentation/out/english.html | 89 ++++++++++++++++++++++++++++++++--
documentation/out/german.html | 83 +++++++++++++++++++++++++++++--
5 files changed, 270 insertions(+), 11 deletions(-)
diff --git a/README.md b/README.md
index 3141439..4e31bea 100644
--- a/README.md
+++ b/README.md
@@ -1,5 +1,5 @@
-[//]: # (Generated 2021-01-11T00:17:10.255946. Changes belong into template/documentation/readme.template)
+[//]: # (Generated 2021-01-13T22:07:56.550981. Changes belong into template/documentation/readme.template)
#Patroneo
Program version 2.0.0
diff --git a/documentation/english.adoc b/documentation/english.adoc
index 24546f0..532f066 100644
--- a/documentation/english.adoc
+++ b/documentation/english.adoc
@@ -134,6 +134,30 @@ off. The drop down list selects how long each of these steps is.
* Loop on and off. The currently played measure (in all tracks) is continuously repeated. This function is suitable for working in a certain place by getting to hear your changes quickly. The loop is broken up by pressing the button again or jumping around in the timeline (see letter Z below).
* To the start: Jumps back to the beginning, whether the music is playing or not.
+Die Dauer der Schleife in Takten kann neben dem Schleifen-Knopf eingestellt werden.
+Zur Erinnerung: Die Schleife ist eine Funktion um Ideen auszuprobieren, während man komponiert.
+Sie ist sowohl technisch, als auch von der Benutzerführung her, nicht dafür geeignet während eines Liveauftritts
+oder während einer Aufnahme spontan verändert zu werden.
+
+The duration of the loop in measures can be set next to the loop button. As a reminder, the loop is
+a function to try out ideas while composing. It is not suitable, both technically and in terms of
+user interface, to be changed spontaneously during a live performance or recording, or during a
+recording session.
+
+==== Swing
+
+*Swing* (also called shuffle) can be adjusted by a slider in percent. The slider
+is located on the far right of the toolbar. The slider is only visible when the group
+(see above) is set to a multiple of 2, e.g. 2 or 4. Swing is also only activated in these groupings.
+
+The start value is 0% and means: no swing; in a pair of notes both are of equal length.
+By changing the value, you can lengthen the first note of each pair and shorten the second.
+Which amount you like should be decided by listening.
+
+The swing value has a very different effect, depending on whether a grouping of 2 or 4 notes is
+selected. For example with a grouping of 2, 40% is a moderate value, as experienced in Jazz.
+With a grouping of 4 (same BPM/tempo) already 15% are clearly audible.
+
=== Form Editor
@@ -210,6 +234,23 @@ same.
Scale and half-tone transposition can be combined. First the scale is changed, then the semitone.
These combinations open up many creative possibilities!
+==== Extending Measure Lengths of Individual Tracks
+
+At first, all measures of all tracks are of the same length in Patroneo, namely as you have set the
+steps per pattern (start value: 8).
+
+To the left of the track name is a number field for the "measure multiplier". The start value is
+"1x". If you increase this value, one measure of this track will be x times longer from now on. The
+measure grid changes accordingly and a click now activates the longer measure.
+
+The pattern in the lower part of the screen will be longer, so you have more space to compose.
+compose.
+
+Placing a long measure follows the old grid. You can only switch on a bar every x bars (multiples
+of the set value) to place a measure.
+
+A halving of the measure lengths or crooked multipliers (1,4) are not possible (only whole numbers).
+
=== Pattern Editor
The *[C] Pattern Editor* is used for composing. The tones, also called "steps", are used to form a
@@ -308,6 +349,20 @@ As already described in the scale transposition (see letter Y), it is also possi
input any value between 0 and 127 in the *[R] Fields of the Scale*. The tones do not have to have
musically meaningful intervals, nor do they have to be sorted in ascending or descending order.
+==== Changing the number of available pitches
+
+In the toolbar in the center, next to the transposition and scale options, there is a
+a setting option to change the number of available pitches.
+The starting value is "8 notes". Possible values are 1 to 127, but these are extreme values.
+Normal, and tested, is 1 to about 24 (two chromatic octaves).
+
+Changing the number applies only to the currently selected pattern. Different patterns
+can have different numbers of pitches.
+
+The notes are added or taken away at the bottom. Already existing activated notes
+will remain, even if they become "invisible", because there is no more space for them.
+
+
==== Shadows
Often you want to add more tones to an existing track in a different pattern. A second voice,
diff --git a/documentation/german.adoc b/documentation/german.adoc
index fc42266..378d716 100644
--- a/documentation/german.adoc
+++ b/documentation/german.adoc
@@ -145,6 +145,26 @@ lang jeder dieser Schritte ist.
* Schleife (Loop) ein- und ausschalten. Der momentan abgespielte Takt (in allen Spuren) wird stetig wiederholt. Diese Funktion eignet sich um an einer bestimmten Stelle zu arbeiten indem man seine Veränderungen schnell zu hören bekommt. Die Schleife wird aufgelöst wenn man erneut auf den Knopf drückt oder in der Zeitleiste herumspringt (s.u. Buchstabe Z)
* An den Anfang: Springt wieder an den Anfang, egal ob die Musik gerade läuft oder nicht.
+Die Dauer der Schleife in Takten kann neben dem Schleifen-Knopf eingestellt werden.
+Zur Erinnerung: Die Schleife ist eine Funktion um Ideen auszuprobieren, während man komponiert.
+Sie ist sowohl technisch, als auch von der Benutzerführung her, nicht dafür geeignet während eines Liveauftritts
+oder während einer Aufnahme spontan verändert zu werden.
+
+
+==== Swing
+
+*Swing* (auch Shuffle genannt) kann durch einen Schieberegler in Prozent eingestellt werden. Dieser
+befindet sich ganz rechts in der Werkzeugleiste. Der Regler wird erst sichtbar wenn die Gruppe
+(s.o.) auf einem Vielfachen von 2 steht, z.B. 2 oder 4. Swing ist auch nur in diesen Gruppierungen
+aktiviert.
+Der Startwert ist 0% und bedeutet: Kein Swing; in einem Notenpaar sind beide gleich lang.
+Durch Veränderung des Wertes kann man nur die erste Note eines jeden Paares verlängern und die
+zweite verkürzen. Welcher Anteil gefällt sollte durch das Anhören entschieden werden.
+
+Der Swing-Anteil hat eine stark unterschiedliche Wirkung, je nachdem ob eine Gruppierung von 2 oder 4
+ausgewählt wurde. So ist bei einer 2er Gruppierung 40% ein moderater Wert, wie man ihn etwa im Jazz
+erlebt, während bei der 4er Gruppierung (bei gleichem BPM/Tempo) bereits 15% deutlich hörbar sind.
+
=== Form-Editor
@@ -224,6 +244,23 @@ herschaltet. Oder gar völlig verschiedene Töne benutzt, so dass nur der Rhythm
Skalen- und Halbtontransposition können kombiniert werden. Zuerst wird die Skala verändert, dann
erst der Halbton. Mit diesen Kombinationen ergeben sich viele kreative Möglichkeiten!
+==== Taktlängen einzelner Spuren verlängern
+
+Zunächst sind in Patroneo alle Takte aller Spuren gleich lang, nämlich so wie man die Schritte pro
+Muster eingestellt hat (Startwert: 8).
+
+Links neben dem Spurnamen befindet sich ein Zahlenfeld für den "Takt-Multiplikator".
+Der Startwert ist "1x". Erhöht man hier so wird ein Takt dieser Spur von nun an x mal länger.
+Das Taktraster ändert sich dementsprechend und ein Klick aktiviert nun den längeren Takt.
+
+Das Muster im unteren Bildschirmbereich wird dementsprechend länger, so dass man mehr Platz zum
+komponieren hat.
+
+Das Platzieren eines langen Taktes folgt dem alten Raster. Man kann nur alle x Takte (Vielfache des
+eingestellten Wert) einen Takt einschalten.
+
+Eine Halbierung der Taktlängen oder krumme Multiplikatoren (1,4) sind nicht möglich (nur ganze Zahlen)
+
=== Muster-Editor
Der *[C] Muster-Editor* ermöglicht das eigentliche Komponieren. Dazu setzt man die Töne, auch
@@ -329,6 +366,21 @@ jeden beliebigen Wert zwischen 0 und 127 in die *[R] Felder der Skala* einzutrag
weder musikalisch sinnvolle Abstände haben, noch müssen sie aufsteigend oder absteigend sortiert
sein.
+==== Anzahl der möglichen Tonhöhen verändern
+
+In der Werkzeugleiste in der Mitte, bei den Transpositions- und Tonleiteroptionen befindet sich
+eine Einstellmöglichkeiten um die Anzahl der möglichen Tonhöhen zu verändern.
+Der Startwert ist "8 Noten". Mögliche Werte sind 1 bis 127, dabei handelt es sich um Extremwerte.
+Normal, und getestet, ist 1 bis ca. 24 (zwei chromatische Oktaven).
+
+Die Veränderung der Anzahl gilt nur für das momentan ausgewählte Muster. Unterschiedliche Muster
+können unterschiedliche Töne haben.
+
+Die Töne werden am unteren Ende hinzugefügt bzw. weggenommen. Bereits vorhandene aktiviert Noten
+bleiben erhalten, auch wenn sie "unsichtbar" werden, da es durch eine Anzahlreduzierung keinen
+Platz mehr für sie gibt.
+
+
==== Schatten
Oft möchte man zu einer existierenden Spur noch weitere Töne in einem anderen Muster setzen. Eine
diff --git a/documentation/out/english.html b/documentation/out/english.html
index e44b7cf..d12dc38 100644
--- a/documentation/out/english.html
+++ b/documentation/out/english.html
@@ -456,14 +456,23 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b
2. Description of the graphical user interface and its functions
+
+
Die Dauer der Schleife in Takten kann neben dem Schleifen-Knopf eingestellt werden.
+Zur Erinnerung: Die Schleife ist eine Funktion um Ideen auszuprobieren, während man komponiert.
+Sie ist sowohl technisch, als auch von der Benutzerführung her, nicht dafür geeignet während eines Liveauftritts
+oder während einer Aufnahme spontan verändert zu werden.
+
+
The duration of the loop in measures can be set next to the loop button. As a reminder, the loop is
+a function to try out ideas while composing. It is not suitable, both technically and in terms of
+user interface, to be changed spontaneously during a live performance or recording, or during a
+recording session.
+
+
2.1.1. Swing
+
+
Swing (also called shuffle) can be adjusted by a slider in percent. The slider
+is located on the far right of the toolbar. The slider is only visible when the group
+(see above) is set to a multiple of 2, e.g. 2 or 4. Swing is also only activated in these groupings.
+
+
+
The start value is 0% and means: no swing; in a pair of notes both are of equal length.
+By changing the value, you can lengthen the first note of each pair and shorten the second.
+Which amount you like should be decided by listening.
+
+
+
The swing value has a very different effect, depending on whether a grouping of 2 or 4 notes is
+selected. For example with a grouping of 2, 40% is a moderate value, as experienced in Jazz.
+With a grouping of 4 (same BPM/tempo) already 15% are clearly audible.
+
+
@@ -765,6 +804,29 @@ same.
Scale and half-tone transposition can be combined. First the scale is changed, then the semitone.
These combinations open up many creative possibilities!
+
+
2.2.1. Extending Measure Lengths of Individual Tracks
+
+
At first, all measures of all tracks are of the same length in Patroneo, namely as you have set the
+steps per pattern (start value: 8).
+
+
+
To the left of the track name is a number field for the "measure multiplier". The start value is
+"1x". If you increase this value, one measure of this track will be x times longer from now on. The
+measure grid changes accordingly and a click now activates the longer measure.
+
+
+
The pattern in the lower part of the screen will be longer, so you have more space to compose.
+compose.
+
+
+
Placing a long measure follows the old grid. You can only switch on a bar every x bars (multiples
+of the set value) to place a measure.
+
+
+
A halving of the measure lengths or crooked multipliers (1,4) are not possible (only whole numbers).
+
+
2.3. Pattern Editor
@@ -910,7 +972,24 @@ musically meaningful intervals, nor do they have to be sorted in ascending or de
-
2.3.4. Shadows
+
2.3.4. Changing the number of available pitches
+
+
In the toolbar in the center, next to the transposition and scale options, there is a
+a setting option to change the number of available pitches.
+The starting value is "8 notes". Possible values are 1 to 127, but these are extreme values.
+Normal, and tested, is 1 to about 24 (two chromatic octaves).
+
+
+
Changing the number applies only to the currently selected pattern. Different patterns
+can have different numbers of pitches.
+
+
+
The notes are added or taken away at the bottom. Already existing activated notes
+will remain, even if they become "invisible", because there is no more space for them.
+
+
+
2.3.5. Shadows
Often you want to add more tones to an existing track in a different pattern. A second voice,
question/answer technique etc. To help you, it is possible to display other tracks as [2]
@@ -1278,7 +1357,7 @@ The program is split in two parts. A shared "template" between the Laborejo Soft
diff --git a/documentation/out/german.html b/documentation/out/german.html
index c46179c..5f78dfd 100644
--- a/documentation/out/german.html
+++ b/documentation/out/german.html
@@ -457,14 +457,23 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b