Update documentation and info files

README.md

@@ -20,6 +20,8 @@ This README is just a short introduction. Consult the manual (see below) for mor
 # Contact and Information
 
 * Website https://www.laborejo.org
+* Bugs and Issues: https://www.laborejo.org/bugs
+* Git Repositories for all programs: https://git.laborejo.org
 * Documentation and Manual https://www.laborejo.org/documentation/patroneo
 
 # Installation and Starting

documentation/english.adoc

@@ -86,12 +86,12 @@ The *[A] Toolbar* combines various commands with properties of the entire piece.
 
 *[D] Clone Selected Track* adds a new track based on the currently selected one. This is an important and often used command that is mainly used to enable variants. The cloned track is empty, but inherits the scale of the original, its average velocity or volume, color and name. If the name ends in a single letter like "A", "g" or a number, it is automatically incremented, as you can see in the screenshot. The new track automatically connects to the same JACK instrument.
 
-*[E] Add Track* adds an empty track. It is given a random name and is not connected in JACK.
+*[E] Add Track* adds an empty track. It is given a random name and is not connected in JACK. Scale, note-names etc. will be taken from the currently selected track.
 
 *[F] BPM / Tempo*: The tempo can be completely deactivated by unchecking the box. In this case, the "JACK Transport" system takes over, as indicated by the "JACK" logo in the deactivated input field. This allows programs running in parallel to create complex tempo sequences, which is not possible in Patroneo alone. +
 If the checkbox is activated, the specified tempo is considered to be beats per minute. A "beat" is the selected note value of the list [H]. More on that later.
 
-*[G] Measures per Track* controls the total length of the piece, whereby the absolute number of seconds can change depending on how the tempo is selected and how long a measure should be. If the number of measures is reduced, no measures are actually deleted, but just ignored. If you later set the number of measures higher again, you will get your old configuration back.
+*[G] Measures per Track* controls the total length of the piece, whereby the absolute number of seconds can change depending on how the tempo is selected and how long a measure should be. If the number of measures is reduced, no measures are actually deleted, but just ignored. If you later set the number of measures higher again, you will get your old configuration back. Patroneo nevers stops playback on its own. Especially in a JACK-transport environment it will continue playing even after its own end.
 
 *[H] Steps per Pattern, in groups of ... so that each group produces a ...* note. Here you can set how long the patterns are and what grouping below the beat they have. This is the most complicated part in Patroneo and will be discussed later in this manual. For now it is recommended to ignore the "groups" field. Steps per Pattern is simply the number of tones that can be switched on and off. The drop down list selects how long each of these steps is.
 
@@ -210,6 +210,8 @@ To help you, it is possible to display other tracks as *[2] Shadows*. Just click
 
 You can display as many shadows as you want, until you lose track. All shadows disappear as soon as the active track changes.
 
+Shadows are just a guidance and not litereal pitches: If you choose a shadow-track with a different scale than your current one the shadow-pitches will be technically wrong. Shadows are very simple in principle. They just show which steps are marked, nothing more.
+
 === Grouping in the Pattern
 
 Grouping is part of the time signature.
@@ -291,6 +293,7 @@ If you find a bug in the program (or it runs too slow) please contact us in a wa
 We are thankful for any help.
 
 .How to contact us
+* Report bugs and issues: https://www.laborejo.org/bugs
 * Website: https://www.laborejo.org
 * E-Mail: info@laborejo.org
 * If you see the opportunity and know that a developer will read it also forums, social media etc..

documentation/german.adoc

@@ -86,12 +86,12 @@ Die *[A] Werkzeugleiste* kombiniert verschiedene Befehle mit Eigenschaften des g
 
 *[D] Klon* der ausgewählten Spur fügt eine neue Spur auf Grundlage der momentan ausgewählten hinzu. Dies ist ein wichtiger und oft benutzer Befehl, der hauptsächlich benutzt wird um Varianten zu ermöglichen. Die "Klonspur" ist zwar leer, erbt allerdings die Skala der Originals, seine Durchschnittslautstärke, die Farbe sowie den Namen. Endet der Name auf einem Einzelbuchstaben wie "A", "g" oder einer Zahl so wird diese automatisch erhöht, wie man am Bild gut sehen kann. Die neue Spur verbindet sich darüberhinaus automatisch zum gleichen JACK-Instrument.
 
-*[E] Neue Spur* fügt eine leere Spur hinzu. Diese bekommt einen Zufallsnamen und ist nicht in JACK verbunden.
+*[E] Neue Spur* fügt eine leere Spur hinzu. Diese bekommt einen Zufallsnamen und ist nicht in JACK verbunden. Skala, Notennamen usw. werden von der momentan aktivien Spur übernommen.
 
 *[F] BPM / Tempo*: Das Tempo kann zunächst durch setzen des Hakens komplett deaktiviert werden. In diesem Fall übernimmt das "JACK Transport" System die Geschwindigkeit, erkennbar am Schriftzug "JACK" im deaktivierten Eingabefeld. Somit können parallel laufende Programme komplexe Tempoverläufe erstellen, was in Patroneo allein nicht möglich ist. +
 Aktiviert man den Haken so gilt das angegebene Tempo als Schläge pro Minute. Ein "Schlag" ist hierbei der ausgewählte Notenwert der Liste ganz rechts, bei [H]. Dazu später mehr.
 
-*[G] Takte pro Spur* regelt die Gesamtlänge des Stückes, wobei sich die absolute Sekundenzahl ändern kann, je nachdem wie das Tempo gewählt wird und wie lang ein Takt sein soll. Reduziert man die Taktanzahl werden keine Takte gelöscht, sondern nur ignoriert. Setzt man später die Taktzahl wieder höher bekommt man seine alte Auswahl wieder.
+*[G] Takte pro Spur* regelt die Gesamtlänge des Stückes, wobei sich die absolute Sekundenzahl ändern kann, je nachdem wie das Tempo gewählt wird und wie lang ein Takt sein soll. Reduziert man die Taktanzahl werden keine Takte gelöscht, sondern nur ignoriert. Setzt man später die Taktzahl wieder höher bekommt man seine alte Auswahl wieder. Patroneo stoppt niemals Playback von alleine, insbesondere in einer JACK-Transport Umgebung läuft diese weiter, auch wenn keine Takte mehr "übrig" sind.
 
 *[H] Schritte pro Takt, gruppiert in je ... und jede Gruppe ergibt eine ...* Note. Hier kann eingestellt werden wie lang die Muster sind und welche rhythmische Aufspaltung sie haben. Dies ist der komplizierteste Teil in Patroneo und wird daher erst später in dieser Bedienungsanleitung besprochen. Fürs erste empfiehlt es sich das "gruppiert"-Feld zu ignorieren. Schritte pro Takt ist einfach die Anzahl an Tönen, die man ein- und ausschalten kann. Die Auswahlliste stellt ein wie lang jeder dieser Schritte ist.
 
@@ -210,6 +210,8 @@ Als Hilfe gibt es die Möglichkeit sich andere Spuren als *[2] Schatten* anzeige
 
 Du kannst so viele Schatten anzeigen, bist du die Übersicht verlierst. Alle Schatten verschwinden sobald die ausgewählte Spur wechselt.
 
+Schatten sind nur eine Hilfestellung und nicht wörtlich für die Tonhöhe zu nehmen: Sucht man sich einen Track als Schatten aus, der eine andere Skala hat (was auch Transposition mit einschließt), dann werden falsche Töne angezeigt. Schatten sind tatsächlich sehr simpel: Sie zeigen keine Tonhöhen sondern nur die markierten Kästchen an, egal was diese als Töne bedeuten.
+
 === Gruppierung im Muster
 
 Die Gruppierung gehört zur Taktart.
@@ -295,6 +297,7 @@ Falls Sie einen Fehler im Programm entdecken (oder es zu langsam läuft) melden
 eine Art und Weise, die ihnen am besten passt.
 
 .Kontaktmöglichkeiten
+* Bugs und Probleme melden: https://www.laborejo.org/bugs
 * Webseite: https://www.laborejo.org
 * E-Mail: info@laborejo.org
 * Wenn Sie die Gelegenheiten sehen und wissen, dass ein Entwickler es lesen wird sind auch Foren, Socialmedia etc. möglich.

documentation/manpageinclude.h2m

@@ -0,0 +1,45 @@
+
+[name]
+Patroneo - Easy to use pattern based midi sequencer.
+
+[usage]
+
+Patroneo (which is Esperanto for "Pattern") is an easy to use, pattern based midi sequencer, a 
+program that sends digital "notes" to software instruments such as synthesizers and samplers.
+
+Patroneo is primarily designed for educational purposes, where the main goal is to teach the
+importance of patterns and repetitions in any kind of music. However, Patroneo is a full sequencer
+you can use to create real music. The constraints it presents will more likely boost your
+creativity than suppressing it.
+
+You have tracks with one pattern each. Turn on steps in the pattern to play
+musical notes. Switch the patterns on and off in a sequence to create a song structure.
+Connect external synthesizers and samplers to create sounds.
+
+
+[Reporting bugs]
+https://www.laborejo.org/bugs
+
+[copyright]
+Patroneo 1.5 - Copyright 2020
+Laborejo Software Suite
+https://www.laborejo.org/
+
+[examples]
+Start patroneo through NSM, e.g. through Argodejo. This will take care of all
+settings and save directories.
+
+Other modes of operations, mostly for testing, are:
+
+Run without session management and save in /tmp. 
+    patroneo --save /tmp
+
+Run without audio and midi. Skips all JACK checks. Used to just look at the GUI, e.g. to make screenshots
+    patroneo --mute 
+
+[see also]
+The  full  documentation for Patroneo is maintained as a multi-lingual html site to your systems doc-dir.
+For example:
+    xdg-open file:///usr/share/doc/patroneo/index.html
+
+The documentation can also be found online https://www.laborejo.org/documentation/patroneo

documentation/out/english.html

@@ -591,14 +591,14 @@ Your browser does not support the video tag.
 <p><strong>[D] Clone Selected Track</strong> adds a new track based on the currently selected one. This is an important and often used command that is mainly used to enable variants. The cloned track is empty, but inherits the scale of the original, its average velocity or volume, color and name. If the name ends in a single letter like "A", "g" or a number, it is automatically incremented, as you can see in the screenshot. The new track automatically connects to the same JACK instrument.</p>
 </div>
 <div class="paragraph">
-<p><strong>[E] Add Track</strong> adds an empty track. It is given a random name and is not connected in JACK.</p>
+<p><strong>[E] Add Track</strong> adds an empty track. It is given a random name and is not connected in JACK. Scale, note-names etc. will be taken from the currently selected track.</p>
 </div>
 <div class="paragraph">
 <p><strong>[F] BPM / Tempo</strong>: The tempo can be completely deactivated by unchecking the box. In this case, the "JACK Transport" system takes over, as indicated by the "JACK" logo in the deactivated input field. This allows programs running in parallel to create complex tempo sequences, which is not possible in Patroneo alone.<br>
 If the checkbox is activated, the specified tempo is considered to be beats per minute. A "beat" is the selected note value of the list [H]. More on that later.</p>
 </div>
 <div class="paragraph">
-<p><strong>[G] Measures per Track</strong> controls the total length of the piece, whereby the absolute number of seconds can change depending on how the tempo is selected and how long a measure should be. If the number of measures is reduced, no measures are actually deleted, but just ignored. If you later set the number of measures higher again, you will get your old configuration back.</p>
+<p><strong>[G] Measures per Track</strong> controls the total length of the piece, whereby the absolute number of seconds can change depending on how the tempo is selected and how long a measure should be. If the number of measures is reduced, no measures are actually deleted, but just ignored. If you later set the number of measures higher again, you will get your old configuration back. Patroneo nevers stops playback on its own. Especially in a JACK-transport environment it will continue playing even after its own end.</p>
 </div>
 <div class="paragraph">
 <p><strong>[H] Steps per Pattern, in groups of &#8230;&#8203; so that each group produces a &#8230;&#8203;</strong> note. Here you can set how long the patterns are and what grouping below the beat they have. This is the most complicated part in Patroneo and will be discussed later in this manual. For now it is recommended to ignore the "groups" field. Steps per Pattern is simply the number of tones that can be switched on and off. The drop down list selects how long each of these steps is.</p>
@@ -811,6 +811,9 @@ To help you, it is possible to display other tracks as <strong>[2] Shadows</stro
 <div class="paragraph">
 <p>You can display as many shadows as you want, until you lose track. All shadows disappear as soon as the active track changes.</p>
 </div>
+<div class="paragraph">
+<p>Shadows are just a guidance and not litereal pitches: If you choose a shadow-track with a different scale than your current one the shadow-pitches will be technically wrong. Shadows are very simple in principle. They just show which steps are marked, nothing more.</p>
+</div>
 </div>
 </div>
 <div class="sect2">
@@ -1038,6 +1041,9 @@ We are thankful for any help.</p>
 <div class="title">How to contact us</div>
 <ul>
 <li>
+<p>Report bugs and issues: <a href="https://www.laborejo.org/bugs" class="bare">https://www.laborejo.org/bugs</a></p>
+</li>
+<li>
 <p>Website: <a href="https://www.laborejo.org" class="bare">https://www.laborejo.org</a></p>
 </li>
 <li>
@@ -1160,7 +1166,7 @@ The program is split in two parts. A shared "template" between the Laborejo Soft
 </div>
 <div id="footer">
 <div id="footer-text">
-Last updated 2020-04-07 20:53:35 +0200
+Last updated 2020-04-12 23:24:00 +0200
 </div>
 </div>
 </body>

documentation/out/german.html

@@ -600,14 +600,14 @@ Your browser does not support the video tag.
 <p><strong>[D] Klon</strong> der ausgewählten Spur fügt eine neue Spur auf Grundlage der momentan ausgewählten hinzu. Dies ist ein wichtiger und oft benutzer Befehl, der hauptsächlich benutzt wird um Varianten zu ermöglichen. Die "Klonspur" ist zwar leer, erbt allerdings die Skala der Originals, seine Durchschnittslautstärke, die Farbe sowie den Namen. Endet der Name auf einem Einzelbuchstaben wie "A", "g" oder einer Zahl so wird diese automatisch erhöht, wie man am Bild gut sehen kann. Die neue Spur verbindet sich darüberhinaus automatisch zum gleichen JACK-Instrument.</p>
 </div>
 <div class="paragraph">
-<p><strong>[E] Neue Spur</strong> fügt eine leere Spur hinzu. Diese bekommt einen Zufallsnamen und ist nicht in JACK verbunden.</p>
+<p><strong>[E] Neue Spur</strong> fügt eine leere Spur hinzu. Diese bekommt einen Zufallsnamen und ist nicht in JACK verbunden. Skala, Notennamen usw. werden von der momentan aktivien Spur übernommen.</p>
 </div>
 <div class="paragraph">
 <p><strong>[F] BPM / Tempo</strong>: Das Tempo kann zunächst durch setzen des Hakens komplett deaktiviert werden. In diesem Fall übernimmt das "JACK Transport" System die Geschwindigkeit, erkennbar am Schriftzug "JACK" im deaktivierten Eingabefeld. Somit können parallel laufende Programme komplexe Tempoverläufe erstellen, was in Patroneo allein nicht möglich ist.<br>
 Aktiviert man den Haken so gilt das angegebene Tempo als Schläge pro Minute. Ein "Schlag" ist hierbei der ausgewählte Notenwert der Liste ganz rechts, bei [H]. Dazu später mehr.</p>
 </div>
 <div class="paragraph">
-<p><strong>[G] Takte pro Spur</strong> regelt die Gesamtlänge des Stückes, wobei sich die absolute Sekundenzahl ändern kann, je nachdem wie das Tempo gewählt wird und wie lang ein Takt sein soll. Reduziert man die Taktanzahl werden keine Takte gelöscht, sondern nur ignoriert. Setzt man später die Taktzahl wieder höher bekommt man seine alte Auswahl wieder.</p>
+<p><strong>[G] Takte pro Spur</strong> regelt die Gesamtlänge des Stückes, wobei sich die absolute Sekundenzahl ändern kann, je nachdem wie das Tempo gewählt wird und wie lang ein Takt sein soll. Reduziert man die Taktanzahl werden keine Takte gelöscht, sondern nur ignoriert. Setzt man später die Taktzahl wieder höher bekommt man seine alte Auswahl wieder. Patroneo stoppt niemals Playback von alleine, insbesondere in einer JACK-Transport Umgebung läuft diese weiter, auch wenn keine Takte mehr "übrig" sind.</p>
 </div>
 <div class="paragraph">
 <p><strong>[H] Schritte pro Takt, gruppiert in je &#8230;&#8203; und jede Gruppe ergibt eine &#8230;&#8203;</strong> Note. Hier kann eingestellt werden wie lang die Muster sind und welche rhythmische Aufspaltung sie haben. Dies ist der komplizierteste Teil in Patroneo und wird daher erst später in dieser Bedienungsanleitung besprochen. Fürs erste empfiehlt es sich das "gruppiert"-Feld zu ignorieren. Schritte pro Takt ist einfach die Anzahl an Tönen, die man ein- und ausschalten kann. Die Auswahlliste stellt ein wie lang jeder dieser Schritte ist.</p>
@@ -820,6 +820,9 @@ Als Hilfe gibt es die Möglichkeit sich andere Spuren als <strong>[2] Schatten</
 <div class="paragraph">
 <p>Du kannst so viele Schatten anzeigen, bist du die Übersicht verlierst. Alle Schatten verschwinden sobald die ausgewählte Spur wechselt.</p>
 </div>
+<div class="paragraph">
+<p>Schatten sind nur eine Hilfestellung und nicht wörtlich für die Tonhöhe zu nehmen: Sucht man sich einen Track als Schatten aus, der eine andere Skala hat (was auch Transposition mit einschließt), dann werden falsche Töne angezeigt. Schatten sind tatsächlich sehr simpel: Sie zeigen keine Tonhöhen sondern nur die markierten Kästchen an, egal was diese als Töne bedeuten.</p>
+</div>
 </div>
 </div>
 <div class="sect2">
@@ -1047,6 +1050,9 @@ eine Art und Weise, die ihnen am besten passt.</p>
 <div class="title">Kontaktmöglichkeiten</div>
 <ul>
 <li>
+<p>Bugs und Probleme melden: <a href="https://www.laborejo.org/bugs" class="bare">https://www.laborejo.org/bugs</a></p>
+</li>
+<li>
 <p>Webseite: <a href="https://www.laborejo.org" class="bare">https://www.laborejo.org</a></p>
 </li>
 <li>
@@ -1174,7 +1180,7 @@ Ansonsten starten Sie patroneo mit diesem Befehl, Sprachcode ändern, vom Termin
 </div>
 <div id="footer">
 <div id="footer-text">
-Last updated 2020-04-07 20:53:35 +0200
+Last updated 2020-04-12 23:24:00 +0200
 </div>
 </div>
 </body>

documentation/patroneo.1

@@ -0,0 +1,70 @@
+.\" DO NOT MODIFY THIS FILE!  It was generated by help2man 1.47.13.
+.TH PATRONEO "1" "April 2020" "Patroneo 1.5" "User Commands"
+.SH NAME
+Patroneo - Easy to use pattern based midi sequencer.
+.SH DESCRIPTION
+usage: patroneo [\-h] [\-v] [\-s DIRECTORY] [\-p] [\-m] [\-V]
+.PP
+Patroneo \- Version 1.5 \- Copyright 2020 by Laborejo Software Suite \-
+https://www.laborejo.org/patroneo
+.SS "optional arguments:"
+.TP
+\fB\-h\fR, \fB\-\-help\fR
+show this help message and exit
+.TP
+\fB\-v\fR, \fB\-\-version\fR
+show program's version number and exit
+.TP
+\fB\-s\fR DIRECTORY, \fB\-\-save\fR DIRECTORY
+Use this directory to save. Will be created or loaded
+from if already present. Deactivates Non\-SessionManager support.
+.TP
+\fB\-p\fR, \fB\-\-profiler\fR
+(Development) Run the python profiler and produce a
+\&.cprof file at quit. The name will appear in your
+STDOUT.
+.TP
+\fB\-m\fR, \fB\-\-mute\fR
+(Development) Use a fake cbox module, effectively
+deactivating midi and audio.
+.TP
+\fB\-V\fR, \fB\-\-verbose\fR
+(Development) Switch the logger to INFO and print out
+all kinds of information to get a high\-level idea of
+what the program is doing.
+.SH USAGE
+
+Patroneo (which is Esperanto for "Pattern") is an easy to use, pattern based midi sequencer, a 
+program that sends digital "notes" to software instruments such as synthesizers and samplers.
+
+Patroneo is primarily designed for educational purposes, where the main goal is to teach the
+importance of patterns and repetitions in any kind of music. However, Patroneo is a full sequencer
+you can use to create real music. The constraints it presents will more likely boost your
+creativity than suppressing it.
+
+You have tracks with one pattern each. Turn on steps in the pattern to play
+musical notes. Switch the patterns on and off in a sequence to create a song structure.
+Connect external synthesizers and samplers to create sounds.
+.SH EXAMPLES
+Start patroneo through NSM, e.g. through Argodejo. This will take care of all
+settings and save directories.
+
+Other modes of operations, mostly for testing, are:
+
+Run without session management and save in /tmp. 
+    patroneo --save /tmp
+
+Run without audio and midi. Skips all JACK checks. Used to just look at the GUI, e.g. to make screenshots
+    patroneo --mute 
+.SH "REPORTING BUGS"
+https://www.laborejo.org/bugs
+.SH COPYRIGHT
+Patroneo 1.5 - Copyright 2020
+Laborejo Software Suite
+https://www.laborejo.org/
+.SH "SEE ALSO"
+The  full  documentation for Patroneo is maintained as a multi-lingual html site to your systems doc-dir.
+For example:
+    xdg-open file:///usr/share/doc/patroneo/index.html
+
+The documentation can also be found online https://www.laborejo.org/documentation/patroneo