Browse Source

Update documentation

master
Nils 4 years ago
parent
commit
32c67e2ca5
  1. 310
      documentation/english.adoc
  2. 342
      documentation/german.adoc
  3. 5
      documentation/index.adoc
  4. 324
      documentation/out/english.html
  5. 365
      documentation/out/german.html

310
documentation/english.adoc

@ -0,0 +1,310 @@
:Author: Laborejo Software Suite
:Version: 1.1
:iconfont-remote!:
:!webfonts:
////
This documentation is licensed under the Creative Commons Attribution-ShareAlike 4.0 International License.
To view a copy of this license, visit http://creativecommons.org/licenses/by-sa/4.0/ or send a
letter to Creative Commons, PO Box 1866, Mountain View, CA 94042, USA.
A copy of the license has been provided in the file documentation/LICENSE.
////
////
https://powerman.name/doc/asciidoc
https://asciidoctor.org/docs/user-manual/
////
:sectnums:
:toc: left
:toc-title: Table of Contents
:toclevels: 3
= Patroneo
== Usage
We are happy you chose Patroneo. Patroneo is an easy-to-use sequencer, a program that sends digital "notes" to software instruments such as synthesizers and samplers.
Patroneo means "pattern" in Esperanto. The reason for this is that you don't put single notes in a row but build whole measures, which you can repeat - or leave out - at any place.
== How to use Patroneo
The following explains how to use Patroneo.
The program is almost exclusively operated with the mouse. You need three mouse buttons and a mouse wheel. Most of the time the mouse wheel itself is the middle mouse button, and you can press it down.
We encourage you to experiment a lot. Very often good music is created when users have not only used programs as it was intended.
=== Quick Start
To get to know the most important functions and workflows, this video has been created.
video::patroneo-quickstart-english.mp4[width=500]
Or as Youtube Mirror
video::ygpwn0gzO8g[youtube, width=500]
=== Basic Principles
Patroneo organizes its music in tracks that contain measures. All measures of a track play the same "pattern" that creates music through a sequence of "steps".
The track is connected to an instrument through JACK, so Patroneo itself does not produce any sounds.
If you press Play, the track plays back from left to right. Whenever a measure is highlighted in the Form Editor, the pattern is played.
If you want to hear different patterns from the same instrument, you create several tracks for the same JACK instrument.
The selection of the tones per pattern is freely selectable. You can use normal musical scales or set any tones in any order. If you change the scale later, the pattern sounds different without having to switch tones on and off again.
Saving and loading your project is done by the Non Session Manager. There you will find a "Save" button.
=== Keyboard Controls
In principle, Patroneo can be operated with the mouse. The keyboard is needed for only a few functions, such as changing track names or setting half-tone transposition. However, the keyboard makes some workflows faster and more convenient.
.Shortcuts
* Space: Start and pause playback
* L: Play the current measure as a loop
* Backspace: Set playback to the beginning of the track.
== Description of the graphical user interface and its functions
Use your browser's search function to locate the individual letters like [B] and their explanation.
image::overview-english.png[Screenshot with Captions, link="overview-english.png"]
Patroneo consists of three parts: The Toolbar, the Form Editor, and the Pattern Editor. Between form- and pattern editor there is a *[L] Handle* which you can grab with the left mouse button and move it up or down to give more space to one or the other area.
=== Toolbar
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.
*[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.
*[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.
*[I] Playback Controls* are three buttons. From left to right:
* Play / Pause. Press to play or pause the music at the current location. You can also press the space bar.
* 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.
=== Form Editor
In the *[B] Form Editor* you create the structure of a piece. To do this, the measures in each track can be switched on and off as desired. One can imagine, for example, a drum set that plays three bars in a row and makes a "break" every fourth bar. For this common drum technique you need two tracks. In the screenshot this "3+1" pattern can be seen in the third section (bars 17 to 24) in the orange bass track. +
Whole parts (e.g. verse and chorus) are implemented by using different tracks. To make the creation of related tracks as comfortable as possible, the "clone" command exists (see letter D).
It is possible to zoom in on the measures. To do this, hold down the *CTRL* key and turn the mouse wheel up or down. Please make sure that the mouse cursor is actually over the measures and not over the track names or on the timeline.
*[Z] Timeline*: a click with the left mouse button sets the playback position, even during playback. +
In addition, the measure groups (not to be confused with grouping in the pattern, see letter H) can be seen and set here. If you hover over the timeline with the mouse cursor, you can reduce or increase the size of the groups with the mouse wheel. The groups not only have an cosmetical function but are also used as units of measurement if you want to delete or add entire ranges (see letter K).
*[J] Track Names*. Here you can move tracks, rename them, give them a different color and more:
* A single click with the left mouse button on a name selects a track without changing anything. This is the best way to just look at a track. (A click on the measure area changes a measure immediately!)
* The double arrow on the far left can be used to move tracks up and down to organize them. It has no effect on the sound or the JACK connections. To move, click on the arrow with the left mouse button, hold it down and move the mouse up and down.
* The colored square shows the current color. A left mouse click opens a dialog.
* Track names can be changed at any time by a double-clicking with the left mouse button. Press the Return key to finish renaming. The JACK connection is retained when renaming. +
It is a good habit to end tracks on a single letter or number. These are used in "cloning" to construct a variant of the name. See the screenshot above.
* A click with the right mouse button on a name opens the context menu of a track. Here you can
** Switch all measures on or off (only applies to the visible measures)
** Invert the activated measures: Off becomes On and vice versa.
** Clone this track (same function as in the toolbar)
** Delete the track permanently and irreversibly
** Copy the measure sequence of another track onto the selected one. Measures that have already been set are preserved. If you use this function from an empty track you will practically get "copy track".
Now finally the *[K] Track* itself. A left click on a measure switches it on or off again. You can switch several measures in a row on and off by holding down the left mouse button after clicking and moving the mouse left or right.
A right click on a specific measure opens a context menu: Insert new measures in all tracks(!) at this position or delete measures from all tracks. The number of measures results from the current measure group setting from the time line (see letter Z). +
These functions are especially understandable if you apply them to the first measure of a group (after the white line). This allows you to insert new "parts" or delete an entire part. +
A good method is also to change the group size for these functions briefly and then reset them immediately afterwards.
*[X] Half Tone Transposition* is adjusted by holding down the SHIFT key and then turning the mouse wheel up or down over an activated measure. In the measure itself a small text appears, e.g. +5h. Five semitones upwards; C becomes F, MIDI note 60 becomes 65; the transposition is only valid for the respective measure and is not visible in the pattern itself (see below). If the measure is switched off (and on again), the transposition is deleted.
*[Y] In-Scale Transposition*. It is recommended to familiarize yourself with the pattern and its scale (see letters O to R) first. Are you back? All right, here we go: +
If you hold the mouse cursor over an activated measure, you can adjust the transposition, based on the scale, with the mouse wheel up or down. The label shows how many steps up or down (-6s to +6s) this measure is shifted. If the measure is switched off, the transposition also disappears. In the pattern itself (see below) you cannot see whether a measure is transposed or not.
One can imagine that the steps in the pattern are shifted up or down in the rows behind the scenes. Whatever tone is set in this row gets played. With a normal scale, this is musically easy to understand: The tones are moved up or down in the scale. +
However, if the scale is chosen freely, there are non-intuitive outcomes; "up and down" with respect to pitches may lose their meaning. It is possible to use two interleaved scales in the pattern and to switch between them by scale transposition +1. Or even uses completely different tones, so that only the rhythm remains the same.
Scale and half-tone transposition can be combined. First the scale is changed, then the semitone. These combinations open up many creative possibilities!
=== Pattern Editor
The *[C] Pattern Editor* is used for composing. The tones, also called "steps", are used to form a measure. The pattern is exactly as long as a measure and is played from left to right. There are several possibilities for tonal arrangement, which are now explained.
The pattern is always as long as set in the toolbar (see letter H). Steps that have been set are never deleted by rezising! If you make the measures shorter, tones "too far to the right" are simply ignored. You can see them again as soon as you make the measures longer again.
If the pattern is larger than the screen you can either use the scroll bars or zoom. To zoom hold down the *CTRL* key and turn the mouse wheel up or down.
At the top you can see a label for the *[M] Active Track*.
The pattern itself is arranged in rows and columns. The rows symbolise the (adjustable) pitches, the columns show their rhythmic sequence and position in time.
==== Duration and Volume
A *[S] Step* is a grey or coloured box. Grey means pause, coloured means *[T] Sounding Tone*. A click with the left mouse button switches the steps on and off. +
A right click opens the context menu. Here you can switch all (currently visible) steps on, off or invert all: Off On becomes Off and vice versa. All volume information (see below) will be lost.
All steps are equal length. *[V] Other Durations* are also possible: If you hold down the left mouse button after activating a step, you can shorten or lengthen the tone by moving it to the left or right. It must be at least half the length. A tone is at most as long as the measure itself.
You can activate as many steps in a row or simultaneously as you like. Thus *[W] Chords* can be built.
Steps can have different *[U] Volumes*. For this Patroneo uses so-called MIDI Velocity. If you hold the mouse cursor over an activated step, you can make its sound softer or louder by turning the mouse wheel. The volumes are displayed as numbers between 1 and 127. If you want to see all volumes at once you can click with the mouse wheel (middle mouse button) into the free area left or right of the pattern. In addition, a step looks more transparent the quieter it is. If the step is switched on and off, the volume is set back to the normal value, derived from the average volume of all tones of this pattern. +
You can use the *[M] Velocity* buttons to make all tones of a pattern quieter or louder. If you click on it, the volume changes by 1 each, but if you hold the mouse cursor over a button and rotate your mouse wheel the velocity changes by 10 each. It doesn't matter which velocity button (plus or minus) you hover over.
==== Pitches and Scales
Click with the middle mouse button on a step to hear the sound it plays. This allows you to "pre-listen" before you decide to set a note. Tip: Hold down the middle mouse button and move the mouse up and down the steps.
Which actual pitch is played ("MIDI Key") is determined by the *[R] Scale*. Patroneo always works with eight-note scales. Normally, this is a common musical scale: seven different notes and the octave of the root note.
Such common *[Q] Scales* can be selected directly. For example, major, minor, various so-called "church modes" but also the blues scale or chromatic (e.g. to GM drum mapping) +
If you select a scale from the list, it will be built upon the bottom row. As a rule of thumb this is also the lowest note. In the screenshot this is midi note 60 / C4, located bottom left. You must first select the root directly and then select a *[Q] Scale*.
There are four buttons to change the pitch of both the root note and the entire scale:
* *[O] Half Tone* Plus or minus shifts the whole scale up or down by one semitone each. This should not be confused with the temporary transposition from the form editor (see letter X). This is called destructive change, since the values themselves are permanently changed.
* *[P] Octave* Plus or minus shifts directly by a whole octave. You could also press the half-tone button 12 times. Don't.
As already described in the scale transposition (see letter Y), it is also possible to directly 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.
==== 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] Shadows*. Just click with the middle mouse button on the track you want to see. This is only possible in the measure area, not on the track name or on the timeline.
You can display as many shadows as you want, until you lose track. All shadows disappear as soon as the active track changes.
=== Grouping in the Pattern
Grouping is part of the time signature.
As mentioned above *steps per pattern*, sets the length of the pattern. Patroneo starts with 8 steps per measure for a new project (see screenshot). On the far right is a drop down list, which is set to "Quarter" for a new project. You start with a traditional 8/4 time signature.
The field *in groups of* allows you to group steps together, each group being as long as specified in the drop down list. This allows you to further subdivide your time signature. The "beat", i.e. the tempo, is based on the main beats, the first step of each group.
.Examples
* 4/4 time signature with eights notes as smallest rhythmical unit
** 8 steps per pattern / in groups of 2 / so that each group produces a quarter
* 4/4 time signature subdivided as triplet eights notes (swing)
** 9 steps per pattern / in groups of 3 / so that each group produces a quarter
* 12/8 time signature
** 12 steps per pattern / in groups of 1 / so that each group produces an eigth
* 8/4 time signature subdivided as sixteenth notes
** 32 steps per pattern / in groups of 4 / so that each group produces a quarter
Normally, the time signature is set relatively at the beginning of a new project. However, it happens every now and then that you need smaller rhythm values than you thought at the beginning. If you simply increase the value of the grouping, you get more subdivisions, but the number of steps remains the same. Likewise, the notes remain exactly in the "column" in which they were previously placed. In other words, the music will sound different. Overall, the measure is also getting shorter, since the same number of steps is now used for shorter steps.
Patroneo therefore offers the function *[3] Convert Grouping* to change the existing measure structure and to resize steps already set so that the music sounds the same.
If you click on the button in the toolbar, a small dialog box opens in which you can enter the desired grouping. It is also possible to set what should happen if the conversion would not work properly for musical reasons (see below).
Conversion is often possible without any problems:
* If the grouping of `1` is set to a higher value, it always works
* If the grouping is set from `2` to `4` it always works
For all other transformations it depends on whether the existing tones lie between the new grid after the conversion or not. The former case is not possible and you have to decide:
.Error Handling
* Do nothing (default)
** The operation is aborted, everything remains as before.
* Delete wrong steps
** Anything that would appear between the grid will be deleted or discarded.
* Merge wrong steps
** Impossible positions are moved to the next possible position. In any case, this means that the music now sounds different. Usually several notes are pushed on top of each other and form chords.
With a little experience you will be able to estimate what error handling you need.
== Installation and Start
Patroneo is exclusive for Linux. The best way to install is to use your package manager.
If it is not there, or only in an outdated version, please ask your Linux distribution to provide a recent version.
If available in the package repository, please continue reading directly at "Start <shortname> from Non Session Manager".
If not, you can build Patroneo yourself.
.Build and Install
* Please check the supplied README.md for dependencies.
* You can download a release or clone the git version
** Download the latest version from https://www.laborejo.org/downloads and extract it.
** `git clone https://laborejo.org/<shortname>.git`
* Change into the new directory and use these commands:
* `./configure --prefix=/usr`
** The default prefix is /usr/local
* `make`
* `sudo make install`
.Start <shortname> from Non Session Manager (NSM)
* Run `non-session-manager`
* Press the `New` button, and enter a name for your piece of music.
* Press the `Add Client to Session` button, enter `<shortname>` here, in lower case.
* Add Client again, this time `jackpatch`.
* Add any compatible programs, e.g. synthesizers.
** See the list of NSM compatible programs: http://non.tuxfamily.org/wiki/ApplicationsSupportingNsm
** And the NSM manual: http://non.tuxfamily.org/nsm/
Please read README.md for other ways of starting <shortname>, which are impractical for actual use but can
be helpful for testing and development.
== Help and Development
You can help Patroneo in several ways: Testing and reporting errors, translating, marketing, support, programming and more.
=== Testing and Reporting Errors
If you find a bug in the program (or it runs too slow) please contact us in a way that suits you best.
We are thankful for any help.
.How to contact us
* Website: https://www.laborejo.org
* E-Mail: info@laborejo.org
* IRC: #laborejo on server irc.freenode.org
* If you see the opportunity and know that a developer will read it also forums, social media etc..
=== Programming
If you want to do some programming and don't know where to start please get in contact with us directly.
The short version is: clone the git, change the code, create a git patch or point me to your public git.
=== Translations
Patroneo is very easy to translate with the help of the Qt-Toolchain, without any need for programming.
The easiest way is to contact the developers and they will setup the new language.
However, here are the complete instructions for doing a translation completely on your own and integrating it into the program.
The program is split in two parts. A shared "template" between the Laborejo Software Suite and the actual program.
The process is the same for both parts, but needs to be done in different directories:
`template/qtgui`and plain `/qtgui`, relative to the root directory, where the <shortname> executable is.
Everytime you see "template/qtgui" below you can substitute that with just "qtgui" to translate the other part of Patroneo.
You can add a new language like this:
* Open a terminal and navigate to template/qtgui/resources/translations
* Edit the file `config.pro` with a text editor
** Append the name of your language in the last line, in the form `XY.ts`, where XY is the language code.
** Make sure to leave a space between the individual languages entries.
* Run `sh update.sh` in the same directory
** The program has now generated a new `.ts` file in the same directory.
* Start Qt Linguist with `linguist-qt5` (may be named differently) and open your newly generated file
* Select your "Target Language" and use the program to create a translation
* Send us the `.ts` file, such as by e-mail to info@laborejo.org (see below for more contact options)
You can also incorporate the translation into Patroneo for testing purposes. This requires rudimentary Python knowledge.
* Run the "Release" option in QtLinguists "File" menu. It creates a `.qm` file in the same directory as your `.ts` file.
* Edit `template/qtgui/resources/resources.qrc` and duplicate the line `<file>translations/de.qm</file>` but change it to your new .qm file.
* run `sh buildresources.sh`
* Edit `engine/config.py`: add your language to the line that begins with "supportedLanguages" like this: `{"German": "de.qm", "Esperanto: "eo.qm"}`
** To find out your language string (German, Esperanto etc.) open the `python3` interpreter in a terminal and run the following command:
** `from PyQt5 import QtCore;QtCore.QLocale().languageToString(QtCore.QLocale().language())`
To test the new translation you can either run the program normally, if your system is set to that language. Alternatively start <shortname> via the terminal:
* `LANGUAGE=de_DE.UTF-8 ./<shortname> -V --save /dev/null`

342
documentation/german.adoc

@ -0,0 +1,342 @@
:Author: Laborejo Software Suite
:Version: 1.1
:iconfont-remote!:
:!webfonts:
////
This documentation is licensed under the Creative Commons Attribution-ShareAlike 4.0 International License.
To view a copy of this license, visit http://creativecommons.org/licenses/by-sa/4.0/ or send a
letter to Creative Commons, PO Box 1866, Mountain View, CA 94042, USA.
A copy of the license has been provided in the file documentation/LICENSE.
////
////
https://powerman.name/doc/asciidoc
https://asciidoctor.org/docs/user-manual/
////
:sectnums:
:toc: left
:toc-title: Inhaltsverzeichnis
:toclevels: 3
= Patroneo
== Benutzung
Schön, dass du dich für Patroneo entschieden hast. Patroneo ist ein leicht zu bedienender "Sequencer", also ein Programm, dass digitale "Noten" an Softwareinstrumente, wie Synthesizer und Sampler, schickt.
"Patroneo" heißt "Muster" auf Esperanto. Das kommt daher, dass man hier nicht einzelne Noten hintereinander setzt sondern ganze Takte baut, die man dann beliebig oft an beliebigen Stellen wiederholen - oder auslassen - kann.
== Bedienung
Im folgenden wird erklärt, wie Patroneo bedient wird.
Das Programm wird fast ausschließlich mit der Maus bedient. Du benötigst zwingend drei Maustasten und ein Mausrad. Meistens ist das Mausrad selbst die mittlere Maustaste, und man kann es herunterdrücken.
Wir ermutigen dich, viel zu experimentieren. Sehr oft ensteht gute Musik wenn Benutzer Programme nicht nur so benutzt haben, wie es eigentlich angedacht war.
=== Schnellstart
Um die wichtigsten Funktionen und Arbeitsabläufe kennenzulernen ist dieses Video erstellt worden.
video::patroneo-quickstart-german.mp4[width=500]
Oder auf Youtube
video::mr-_d9gw0Xw[youtube, width=500]
=== Grundlagen
Patroneo organisiert seine Musik in Spuren, die Takte enthalten. Alle Takte einer Spur spielen das selbe "Muster", dass durch eine Abfolge von "Schritten" Musik erzeugt.
Die Spur ist durch JACK mit einem Instrument verbunden, Patroneo selbst erzeugt also keine Klänge.
Drückt man Play läuft das Stück von links nach rechts durch. Immer wenn ein Takt im Formeditor markiert ist wird das Muster gespielt.
Möchte man verschiedene Muster vom gleichen Instrument hören so erstellt man mehrere Spuren für das gleiche Zielinstrument.
Die Auswahl der Töne pro Muster ist frei wählbar. Man kann normale Tonleitern / Skalen nehmen oder auch beliebige Töne in belieber Reihenfolge setzen. Ändert man die Skala nachträglich, dann klingt das Muster auch direkt anders, ohne das man Töne neu ein- und ausschalten muss.
Das Speichern und Laden deines Projektes wird durch den Non Session Manager erledigt. Dort befindet sich ein "Save" Knopf.
=== Tastatursteuerung
Patroneo kann prinzipiell mit der Maus bedient werden. Die Tastatur ist nur für wenige Funktionen dringend nötig, etwa um Spurnamen zu ändern oder um Halbtontransposition einzustellen. Allerdings macht die Tastatur manche Arbeitsabläufe schneller und bequemer.
.Shortcuts
* Leertaste: Start und Pause der Wiedergabe.
* L: aktuelle Taktpositionen in Schleife spielen.
* Backspace ("Rückwärts löschen"): Wiedergabe an den Anfang des Stückes setzen.
== Beschreibung der grafischen Oberfläche und ihrer Funktionen
Benutze die Suchfunktion deines Browsers um nach den einzelnen Buchstaben wie [B] und deren Erläuterung zu suchen.
image::overview-german.png[Screenshot mit Beschriftung, link="overview-german.png"]
Patroneo besteht aus drei Teilen: Der Werkzeugleiste, dem Form-Editor und dem Takt- oder Mustereditor. Zwischen Form- und Mustereditor befindet sich ein *[L] Verschiebegriff*, den man mit der linken Maustaste anklicken und bei gedrückter Taste hoch oder runter schieben kann um dem einen oder anderen Bereich mehr Platz zu geben.
=== Werkzeugleiste
Die *[A] Werkzeugleiste* kombiniert verschiedene Befehle mit Eigenschaften des gesamten Stückes.
*[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.
*[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.
*[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.
*[I] Wiedergabe* sind drei Knöpfe zur Wiedergabe. Von links nach rechts:
* Play / Pause. Drücken um die Musik abzuspielen oder an der momentanen Stelle anzuhalten. Man kann auch die Leertaste drücken.
* 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.
=== Form-Editor
Im *[B] Form-Editor* erstellt man die Stuktur eines Stückes. Dazu schaltet man die Takte in jeder Spur beliebig ein und aus. Man kann sich z.B. ein Schlagzeug vorstellen, dass drei Takte gleich spielt und jeden vierten Takt einen "Break" macht. In Patroneo braucht man dazu zwei Spuren. Dieses "3+1" Muster kann man auf dem Bild z.B. im dritten Abschnitt (Takt 17 bis 24) in der orangen Bassspur sehen. +
Auch ganze Teile (z.B. Strophe und Refrain) werden durch verschiedene Spuren abgedeckt. Um das Erschaffen von verwandten Spuren so bequem wie möglich zu machen existiert der "Klon" Befehl (s. Buchstabe D).
Es ist möglich im Bereich der Takte zu zoomen. Hierzu hält man die *STRG* Taste gedrückt und dreht das Mausrad hoch oder runter. Bitte darauf achten, dass der Mauszeiger tatsächlich über den Takten steht, und nicht etwa bei den Spurnamen oder auf der Zeitleiste.
*[Z] Zeitleiste*: ein Klick mit der linken Maustaste setzt die Wiedergabeposition, auch im laufenden Betrieb. +
Außerdem kann man hier die Taktgruppen (nicht zu verwechseln mit Gruppierung im Muster, s. Buchstabe H) sehen und einstellen. Hält man sich mit dem Mauszeiger im Bereich der Zeitleiste auf kann man die Gruppen mit dem Mausrad verkleinern oder vergrößern. Die Taktgruppen haben nicht nur organisatorische Funktion sondern werden auch als Maßeinheit benutzt, wenn man ganze Taktbereiche löschen oder hinzufügen möchte (s. Buchstabe K).
*[J] Spurnamen*. Hier kann man Spuren verschieben, umbennen, ihnen eine andere Farbe geben und mehr:
* Ein einfacher Klick mit der linken Maustaste auf einen Namen wählt eine Spur aus, ohne etwas zu verändern. Dies ist die beste Möglichkeit um eine Spur einfach nur anzusehen. (Ein Klick auf den Taktbereich verändert sofort einen Takt!)
* Der Doppelpfeil ganz links kann benutzt werden um Spuren hoch und runter zu schieben, um sie zu organisieren. Es hat keine Auswirkung auf den Klang oder die JACK Verbindung. Zum Verschieben mit der linken Maustaste auf den Pfeil klicken, gedrückt halten und die Maus hoch und runter bewegen.
* Das farbige Quadrat zeigt die derzeitige Farbe. Ein linker Mausklick öffnet die Farbauswahl.
* Spurnamen können jederzeit geändert werden indem man einen Doppelklick mit der linken Maustaste auf sie macht. Die Enter-Taste oder ein Mausklick in einen anderen Bereich des Programmes schließen das Umbennen ab. Die JACK Verbindung bleibt beim Umbenennen erhalten. +
Es ist eine gute Angewohnheit Spuren auf einem Einzelbuchstaben oder eine Zahl enden zu lassen. Diese werden beim "Klonen" benutzt um eine Variante des Namens zu bilden. Siehe dazu unser Bild oben.
* Ein Klick mit der rechten Maustaste auf einen Namen öffnet das Kontextmenü einer Spur. Hier kann man
** Alle Takte ein- oder ausschalten (gilt nur für die sichtbaren Takte)
** Die sichtbaren Takte umkehren oder invertieren: Aus wird zu An und umgekehrt.
** Die Spur klonen (gleiche Funktion wie in der Werkzeugleiste)
** Die Spur endgültig und unwiederbringlich löschen
** Die Taktabfolge einer anderen Spur auf die ausgewählte projizieren. Bereits gesetzte Takte bleiben hierbei erhalten. Benutzt man diese Funktion von einer leeren Spur aus erhält man praktisch "Spur kopieren".
Nun endlich die *[K] Spur* selbst. Ein Linksklick auf einen Takt schaltet diesen ein oder wieder aus. Mehrere Takte in Folge kann man ein- und ausschalten indem man die linke Maustaste nach dem Klicken gedrückt hält und die Maus nach links oder rechts bewegt.
Ein Rechtsklick auf einen bestimmten Takt öffnet ein Kontextmenü: Neue Takte in allen Spuren(!) an dieser Position einfügen oder Takte aus allen Spuren löschen. Die Anzahl der Takte ergibt sich aus der derzeitigen Taktgruppeneinstellung aus der Zeitleiste (s. Buchstabe Z). +
Diese Funktionen sind besonders nachvollziehbar wenn man sie auf den jeweils ersten Takt einer Gruppe anwendet (nach dem weißen Strich). Man kann so neue "Teile" einfügen oder einen gesamten Teil löschen. +
Eine gute Methode ist es auch die Gruppengröße für diese Funktionen kurz zu verändern und anschließend direkt wieder zurückzusetzen.
*[X] Halbtontransposition* wird eingstellt indem man die SHIFT Taste gedrückt hält und dann das Mausrad über einem aktivierten Takt hoch oder runter dreht. Im Takt selbst zeigt sich ein kleiner Schriftzug, z.B. +5h. Fünf Halbtöne aufwärts; aus C wird F, aus Midinote 60 wird 65. Die Transposition gilt nur für den jeweiligen Takt und ist im Muster selbst (s.u.) nicht zu sehen. Schaltet man den Takt aus (und wieder ein) ist die Transposition gelöscht.
*[Y] Skalentransposition*. Es wird empfohlen sich erst mit dem Muster und seiner Skala bzw. Tonleiter vertraut zu machen (s. Buchstaben O bis R). Wieder da? Gut, so gehts: +
Hält man den Mauszeiger über einen aktivierten Takt kann man mit dem Mausrad hoch oder runter die Transposition, basierend auf der Skala, einstellen. Die Beschriftung zeigt an um wieviele Schritte nach oben oder unten (-6s bis +6s) dieser Takt verschoben ist. Schaltet man den Takt aus verschwindet auch die Transposition wieder. Im Muster selbst (s.u.) ist nicht zu sehen ob ein Takt transponiert ist oder nicht.
Man kann sich das so vorstellen, dass die Schritte im Muster hinter den Kulissen in den Reihen hoch oder runter geschoben werden. Welcher Ton auch immer in dieser Reihe eingestellt ist wird gespielt. Bei einer normalen Tonleiter ist das musikalisch leicht nachvollziehbar: Die Töne werden in der Tonleiter hoch- oder runtergeschoben. +
Wenn die Skala allerdings frei eingestellt wurde ergeben sich unintuitive Möglichkeiten; "Hoch und Runter" in Bezug auf Tonhöhen verlieren dann evtl. ihre Bedeutung. Denkbar ist, dass man zwei verzahnte Tonleiter im Muster benutzt und durch Skalen-Transposition +1 zwischen diesen hin und herschaltet. Oder gar völlig verschiedene Töne benutzt, so dass nur der Rhythmus gleich bleibt.
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!
=== Muster-Editor
Der *[C] Muster-Editor* ermöglicht das eigentliche Komponieren. Dazu setzt man die Töne, auch "Schritte" genannt, um einen Takt zu bilden. Das Muster ist genau so lang wie ein Takt und wird von links nach rechts abgespielt. Man hat dabei einige Möglichkeiten zur klanglichen Gestaltung, die nun erklärt werden.
Das Muster ist immer so lang wie man in der Werkzeugleiste (s. Buchstabe H) eingestellt hat. Es werden niemals gesetzte Schritte gelöscht! Macht man die Takte kürzer werden Töne "zu weit rechts" lediglich ignoriert. Sie sind wieder zu sehen sobald man die Takte wieder länger macht.
Ist das Muster größer als der Bildschirm anzuzeigen vermag kann man entweder die Scrollleisten benutzen oder zoomen. Hierzu hält man die *STRG* Taste gedrückt und dreht das Mausrad hoch oder runter.
Zu oberst sieht man die momentan *[M] Aktivierte Spur*, bzw. das zur Spur gehörige Muster.
Das Muster selbst ist in Reihen und Spalten angelegt. Die Reihen symbolisieren die (einstellbaren) Tonhöhen, die Spalten zeigen deren rhythmische Abfolge und Position im Takt.
==== Länge und Lautstärke
Ein *[S] Schritt* ist ein graues bzw. farbiges Kästchen. Grau bedeutet Pause, farbig bedeutet *[T] Klingender Ton*. Ein klick mit der linken Maustaste schaltet die Schritte an und aus. +
Ein Rechtsklick öffnet das Kontextmenü. Hier kann man alle (gerade sichtbaren) Schritte einschalten, ausschalten oder die gesetzen Schritte tauschen; Aus An wird Aus und umgekehrt. Hierbei gehen alle Lautstärke Informationen (s.u.) verloren.
Alle Schritte sind grundsätzlich gleich lang. *[V] Besondere Tonlängen* sind aber auch möglich: Hält man die linke Maustaste gedrückt, nachdem man einen Schritt aktiviert hat kann man mit einer Bewegung nach links oder rechts den Ton verkürzen oder verlängern. Es muss mindestens die Hälfte der Länge sein. Ein Ton ist höchstens so lang wie der Takt selbst.
Man kann soviele Schritte hintereinander oder gleichzeitig einschalten wie man möchte. Somit lassen sich auch *[W] Akkorde* bilden.
Schritte können unterschiedliche *[U] Lautstärken* haben. Dazu benutzt Patroneo die sogenannte Midi Velocity. Hält man den Mauszeiger über einen aktivierten Schritt kann man durch Drehung des Mausrades diesen Ton leiser oder lauter machen. Die Lautstärken werden als Zahlen zwischen 1 und 127 angezeigt. Möchte man alle Lautstärken auf einmal sehen kann man mit dem Mausrad (mittlere Maustaste) in den freien Bereich links oder rechts des Musters klicken. Zusätzlich sieht ein Schritt umso durchsichtiger aus je leiser er ist. Schaltet man den Schritt an und aus wird die Lautstärke wieder auf den Normalwert gesetzt. Dieser ergibt sich aus der Durchschnittslautstärke aller Töne dieses Musters. +
Um alle Töne eines Musters leiser oder lauter zu machen kann man die *[M] Velocity* Knöpfe benutzen. Klickt man diese an ändert sich die Lautstärke um je 1. Hält man allerdings den Mauszeiger über einen Knopf und dreht das Mausrad ändert sich die Velocity um je 10! Dabei ist es egal über welchem Velocity Knopf (plus oder minus) man schwebt.
==== Tonhöhen, Skala und Tonleiter
Klicke mit der mittleren Maustaste auf einen Schritt um den Ton zu hören, den dieser abspielt. Hiermit kannst du schonmal "vorhören", bevor du dich entscheidest einen Ton zu setzen. Tipp: Halte die mittlere Maustaste gedrückt und fahre mit der Maus über die Schritte auf und ab.
Welche tatsächliche Tonhöhe abgespielt wird ("Midi Key") entscheidet die *[R] Skala*, teilweise auch Tonleiter genannt. Patroneo arbeitet immer mit Achtstufigen Skalen. Im Normallfall handelt es sich hierbei tatsächlich um eine Tonleiter: Sieben verschiedene Töne und oben drauf der oktavierte Grundton.
Solche normalen *[Q] Tonleitern* kann man direkt auswählen. So z.B. etwa Dur, Moll, verschiedene sogenannte "Kirchentonleitern", aber auch die Blues Töne oder chromatische Reihen (z.B. um Schlagzeug-Software anzusteuern). +
Wählt man aus der Liste eine Tonleiter aus so wird diese auf der untersten Reihe gebildet. In der Regel ist dies auch der tiefste Ton. Auf unserem Bild ist dies Ton 60 / C4, links unten. Man muss also zuerst den Grundton direkt auswählen und anschließend eine *[Q] Tonleiter* auswählen.
Um sowohl den Grundton als auch die gesamte Skala nachträglch in ihrer Tonhöhe zu verändern gibt es vier Knöpfe:
* *[O] Halbton* Plus oder Minus verschiebt die ganze Skala nach oben oder unten um je einen Halbton. Dies ist nicht zu verwechseln mit der nur zeitweisen Transposition aus dem Spureditor (s. Buchstabe X). Man spricht hier auch von destruktiver Veränderung, da man die Werte selbst dauerhaft ändert.
* *[P] Oktave* Plus oder Minus verschiebt direkt um eine ganze Oktave. Man könnte auch 12 mal auf den Halbtonknopf drücken. Kann man aber auch lassen.
Wie in der Skalentransposition (s. Buchstabe Y) bereits beschrieben ist es aber auch möglich selbst jeden beliebigen Wert zwischen 0 und 127 in die *[R] Felder der Skala* einzutragen. Die Töne müssen weder musikalisch sinnvolle Abstände haben, noch müssen sie aufsteigend oder absteigend sortiert sein.
==== Schatten
Oft möchte man zu einer existierenden Spur noch weitere Töne in einem anderen Muster setzen. Eine zweite Stimme, Frage/Antwort-Technik etc.
Als Hilfe gibt es die Möglichkeit sich andere Spuren als *[2] Schatten* anzeigen zu lassen. Dazu einfach mit der mittleren Maustaste auf die Spur klicken, die man sehen möchte. Das geht nur im Taktbereich, nicht auf den Spurnamen oder auf der Zeitleiste.
Du kannst so viele Schatten anzeigen, bist du die Übersicht verlierst. Alle Schatten verschwinden sobald die ausgewählte Spur wechselt.
=== Gruppierung im Muster
Die Gruppierung gehört zur Taktart.
Wie bereits oben beschrieben stellt *Schritte pro Takt* die Länge des Musters ein. Patroneo startet mit 8 Schritten pro Takt bei einem neuen Projekt (s. Bild). Ganz rechts ist eine Auswahlliste, die bei einem neuen Projekt auf "Viertel" steht. Man startet also mit einem traditionellen 8/4 Takt.
Durch das Feld *gruppiert in je* kann man nun die Schritte in Gruppen zusammenfassen, wobei jede Gruppe so lang ist wie in der Auswahlliste angegeben. Damit kann man seine Taktart weiter unterteilen. Der "Beat", also das Tempo, orientiert sich dabei an den Hauptschlägen, der jeweils erste Schritt einer Gruppe.
.Beispiele
* Ein 4/4 Takt mit Achtelnoten als kleinste Rhythmuseinheit
** 8 Schritte pro Takt / Gruppiert in je 2 / Jede Gruppe eine Viertel
* Ein 4/4 mit Triolen als kleinste Rhythmuseinheit ("Swing")
** 9 Schritte / Gruppiert zu 3 / Gruppe ergibt Viertel
* Ein 12/8 Takt
** 12 Schritte / Gruppiert zu 1 / Gruppe ergibt Achtel
* Ein 8/4 Takt mit Sechzehntelnoten
** 32 Schritte / Gruppiert zu 4 / Gruppe ergibt Viertel
Normalesweise stellt man die Taktart relativ am Anfang eines neuen Kompositionsprozesses ein. Es kommt jedoch immer mal wieder vor, dass man kleinere Rhythmuswerte braucht, als man anfangs dachte. Wenn man einfach den Wert der Gruppierung erhöht erhält man zwar mehr Unterteilungen, die Anzahl der Schritte bleibt jedoch gleich. Ebenso bleiben die Noten genau in der "Spalte" stehen, in der sie vorher standen. In anderen Worten: die Musik wird anders klingen. Insgesamt wird auch der Takt kürzer, da die gleiche Anzahl von Schritten nun auf kürzere Schritte verteilt wird.
Patroneo bietet deswegen die Funktion *[3] Gruppierung Umwandeln*, um die bestehende Taktstruktur zu verändern und bereits gesetzte Schritte so zu skalieren, dass die Musik gleich klingt.
Klickt man auf den Knopf in der Werkzeugleiste öffnet sich ein kleines Dialogfenster, in dem man die gewünschte Gruppierung eingeben kann. Außerdem ist es möglich einzustellen, was passieren soll, wenn das Umwandeln aus musikalischen Gründen nicht komplett funktionieren würde (s.u.).
Oft ist ein Umwandeln problemlos möglich:
* Wird die Gruppierung von `1` auf einen höheren Wert gesetzt funktioniert es immer
* Wird die Gruppierung von `2` auf `4` gesetzt funktioniert es immer
Bei allen anderen Umgruppierungen kommt es darauf an, ob die vorhandenen Töne nach dem Umwandeln zwischen dem neuen Raster liegen oder nicht. Der erstere Fall ist nicht möglich und du musst dich entscheiden:
.Reaktion auf Fehler. Falls unmöglich:
* Nichts machen (Voreinstellung)
** Der Vorgang wird abgebrochen, alles bleibt wie vorher.
* Falsche Schritte löschen
** Alles was zwischen dem Raster herauskommen würde wird gelöscht bzw. verworfen.
* Falsche Schritte mit einbinden
** Unmögliche Positionen werden auf die nächstmögliche Position geschoben. Dies führt in jedem Fall dazu, dass die Musik nun anders klingt. Meist werden dadurch mehrere Noten übereinander geschoben und bilden Akkorde.
Mit ein wenig Erfahrung wird man abschätzen können, was man braucht.
== Installation und Start
Patroneo ist exklusiv für Linux. Am besten installierst du Patroneo über deinen Paketmanager.
Falls es dort nicht vorhanden ist, oder nur in einer veralteten Version, bitte deine Linuxdistribution Patroneo bereitzustellen.
Falls in den Paketquellen vorhanden bitte direkt bei "<shortname> im Non Session Manager starten" weiterlesen.
Falls nicht kann man Patroneo auch selbst "bauen".
.Abhängigkeiten*
* Eine Liste der Abhängigkeit befindet sich in der README.md
* Kompilieren und Installieren geht entweder mit einem Releasedownload oder mit der Git-Version:
** Lade von https://www.laborejo.org/downloads die aktuelle Version herunter und entpacke sie.
** `git clone https://laborejo.org/<shortname>.git`
* Wechsele in das neue Verzeichnis und benutze diese Befehle:
*`./configure --prefix=/usr`
** Das Standardprefix is /usr/local
* `make`
* `sudo make install`
.<shortname> im Non Session Manager (NSM) starten
* Starte `non-session-manager`
* Knopf `New`, gib einen Namen für dein Musikstück ein.
* Knopf `Add Client to Session`, gib hier `<shortname>` ein, kleingeschrieben.
* Nochmal Add Client, diesmal `jackpatch`.
* Füge beliebige kompatible Programme hinzu, z.B. Synthesizer.
** Siehe auch das NSM Handbuch: http://non.tuxfamily.org/nsm/
** Und die Liste der NSM kompatiblen Programme: http://non.tuxfamily.org/wiki/ApplicationsSupportingNsm
In der Datei README.md befinden sich weitere Möglichkeiten <shortname> zu starten. Diese sind zum Musikmachen nicht praktikabel,
aber nützlich für Tests und Entwicklung.
== Helfen und Entwicklung
Du kannst Patroneo in vielen Art helfen: Testen und Fehler melden, übersetzen, marketing, anderen Nutzern helfen und schließlich programmieren.
=== Testen und Programmfehler
Falls du einen Fehler im Programm entdeckst (oder es zu langsam läuft) melde dich bitte bei auf eine Art und Weise, die dir am besten passt.
.Kontaktmöglichkeiten
* Webseite: https://www.laborejo.org
* E-Mail: info@laborejo.org
* IRC: #laborejo auf dem Server irc.freenode.org
* Wenn du die Gelegenheit siehst und weist, dass ein Entwickler es lesen wird meinetwegen auch Foren, Socialmedia etc.
== Entwicklung
Falls du an der Entwicklung interessiert bist melde dich am besten direkt bei uns (s.o.)
Kurzversion: clone git, programmieren, einen git-patch erstellen oder uns deine git URL zukommen lassen.
=== Übersetzungen
Patroneo ist mit Hilfe der Qt-Toolchain sehr einfach zu übersetzen, ohne, dass man dafür Programmieren muss.
Die einfachste Variante ist es einfach die Entwickler anzusprechen und sie werden die neue Sprache einrichten.
Hier ist dennoch die komplette Anleitung, um eine Übersetzung komplett alleine anzufertigen und in das Programm einzubinden.
* Öffne ein Terminal und navigiere ins Patroneo Verzeichnis
* Im Patroneo Verzeichnis: `cd gui/translations`
* Bearbeite die Datei `config.pro` mit einem Texteditor
** Hänge in der 2. Zeile den Namen deiner Sprache an, in der Form `XY.ts`, wobei XY der Sprachcode ist.
** Achte darauf ein Leerzeichen zwischen den einzelnen Sprachen zu lassen
* Führe `pylupdate5 config.pro` aus.
** Das Programm hat nun eine neue `.ts` Datei im `translations` Verzeichnis generiert
* Starte Qt Linguist mit `linguist-qt5` (kann evtl. anders heißen) und öffne von dort deine neu generierte Datei
* Wähle deine "Target Language", also Zielsprache, aus und benutze das Programm um eine Übersetzung anzufertigen
* Sende uns die .ts Datei, z.B. per E-Mail an info@laborejo.org (s.u bei Bugs und Programmfehler für mehr Kontaktmöglichkeiten)
Die Übersetzung kannst du auch selbst, zum Testen, in Patroneo einbinden. Dafür sind rudimentäre Python Kentnisse nötig.
* Im Qt Linguist "Datei" Menü ist eine "Release" Option. Das erstellt eine `.qm` Datei im gleichen Verzeichnis wie deine `.ts` Datei.
* Öffne die `patroneo` Starterdatei im Texteditor
** Scrolle nach ganz unten, dort wird die Sprache eingestellt.
** Um deinen Sprachstring herauszufinden (German, Esperanto etc.) entferne die # Raute aus der bereits vorhandenen Zeile `#print (language)`. Starte NSM aus einem Terminal, starte Patroneo und der Sprachstring wird dort ausgegeben (man muss ein bischen suchen)
** Am Ende der Datei ist ein Dictionary `supportedLanguages`. Füge deine Sprache hinzu. z.B. `{"German":"de.qm", "Esperanto:"eo.qm"}`
=== Übersetzungen
Patroneo ist mit Hilfe der Qt-Toolchain sehr einfach zu übersetzen, ohne, dass man dafür Programmieren muss.
Die einfachste Variante ist es einfach die Entwickler anzusprechen und sie werden die neue Sprache einrich
Hier ist dennoch die komplette Anleitung, um eine Übersetzung komplett alleine anzufertigen und in das Programm einzubinden.
Das Programm ist in zwei Teile aufgeteilt: Ein gemeinsames "Template" (für alle Laborejo Software Suit Programme) sowie das eigentliche Programm.
Der Übersetzungsprozess ist der gleiche für beide Teile, man muss ihn jedoch in unterschiedlichen Verzeichnissen durchführen:
`template/qtgui` und nur `/qtgui`, relativ zum Stammverzeichnis, wo sich die ausführbare Datei <shortname> befindet.
Jedes "template/qtgui" hier kann durch nur "qtgui" ersetzt werden um den zweiten Teil zu übersetzen.
So fügt man eine neue Sprache hinzu:
* Öffne ein Terminal und navigiere zu template/qtgui/resources/translations
* Bearbeite die Datei `config.pro` in einem Texteditor.
** Hänge in der letzten Zeile den Namen deiner Sprache an, in der Form `XY.ts`, wobei XY der Sprachcode ist.
** Achte darauf ein Leerzeichen zwischen den einzelnen Sprachen zu lassen
* Führe `sh update.sh` im selben Verzeichnis aus.
** Das Programm hat nun eine neue `.ts`-Datei im Verzeichnis erstellt.
* Starte Qt Linguist mit `linguist-qt5` (kann evtl. anders heißen) und öffne von dort deine neu generierte Datei
* Wähle deine "Target Language", also Zielsprache, aus und benutze das Programm um eine Übersetzung anzufertigen
* Sende uns die .ts Datei, z.B. per E-Mail an info@laborejo.org (s.u bei Bugs und Programmfehler für mehr Kontaktmöglichkeiten)
Die Übersetzung kannst du auch selbst, zum Testen, in Patroneo einbinden. Dafür sind rudimentäre Python Kentnisse nötig.
* Im Qt Linguist "Datei" Menü ist eine "Release" Option. Das erstellt eine `.qm` Datei im gleichen Verzeichnis wie deine `.ts` Datei.
* Bearbeite `template/qtgui/resources/resources.qrc` kopiere die Zeile `<file>translations/de.qm</file>` , aber änder das Länderkürzel zu deinem neuen.
* Führe `sh buildresources.sh` aus
* Bearbeite `engine/config.py`: Füge deine Sprache hinzu. z.B. `{"German":"de.qm", "Esperanto:"eo.qm"}`
** Um deinen Sprachstring herauszufinden öffne den `python3`-Interpreter im Terminal und führe aus:
** `from PyQt5 import QtCore;QtCore.QLocale().languageToString(QtCore.QLocale().language())`
Um deine neue Übersetzung zu testen starte dein Programm, falls dein System bereits auf diese Sprache eingstellt ist. Ansonsten starte <shortname> mit diesem Befehl vom Terminal aus:
* `LANGUAGE=de_DE.UTF-8 ./<shortname> -V --save /dev/null`

5
documentation/index.adoc

@ -1,5 +1,5 @@
:Author: Nils Hilbricht
:Version: 1.0
:Author: Laborejo Software Suite
:Version: 1.1
:iconfont-remote!:
:!webfonts:
@ -10,7 +10,6 @@ letter to Creative Commons, PO Box 1866, Mountain View, CA 94042, USA.
A copy of the license has been provided in the file documentation/LICENSE.
////
////
https://powerman.name/doc/asciidoc
https://asciidoctor.org/docs/user-manual/

324
documentation/out/english.html

@ -5,7 +5,8 @@
<!--[if IE]><meta http-equiv="X-UA-Compatible" content="IE=edge"><![endif]-->
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta name="generator" content="Asciidoctor 1.5.8">
<title>Patroneo User Manual</title>
<meta name="author" content="Laborejo Software Suite">
<title>Patroneo</title>
<style>
/* Asciidoctor default stylesheet | MIT License | http://asciidoctor.org */
/* Uncomment @import statement below to use as custom stylesheet */
@ -431,36 +432,41 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b
</head>
<body class="article toc2 toc-left">
<div id="header">
<h1>Patroneo</h1>
<div class="details">
<span id="author" class="author">Laborejo Software Suite</span><br>
</div>
<div id="toc" class="toc2">
<div id="toctitle">Table of Contents</div>
<ul class="sectlevel1">
<li><a href="#_patroneo_user_manual">1. Patroneo User Manual</a></li>
<li><a href="#_installation_and_starting">2. Installation and Starting</a></li>
<li><a href="#_how_to_use_patroneo">3. How to use Patroneo</a>
<li><a href="#_usage">1. Usage</a></li>
<li><a href="#_how_to_use_patroneo">2. How to use Patroneo</a>
<ul class="sectlevel2">
<li><a href="#_quick_start">3.1. Quick Start</a></li>
<li><a href="#_basic_principles">3.2. Basic Principles</a></li>
<li><a href="#_keyboard_controls">3.3. Keyboard Controls</a></li>
<li><a href="#_quick_start">2.1. Quick Start</a></li>
<li><a href="#_basic_principles">2.2. Basic Principles</a></li>
<li><a href="#_keyboard_controls">2.3. Keyboard Controls</a></li>
</ul>
</li>
<li><a href="#_description_of_the_graphical_user_interface_and_its_functions">4. Description of the graphical user interface and its functions</a>
<li><a href="#_description_of_the_graphical_user_interface_and_its_functions">3. Description of the graphical user interface and its functions</a>
<ul class="sectlevel2">
<li><a href="#_toolbar">4.1. Toolbar</a></li>
<li><a href="#_form_editor">4.2. Form Editor</a></li>
<li><a href="#_pattern_editor">4.3. Pattern Editor</a>
<li><a href="#_toolbar">3.1. Toolbar</a></li>
<li><a href="#_form_editor">3.2. Form Editor</a></li>
<li><a href="#_pattern_editor">3.3. Pattern Editor</a>
<ul class="sectlevel3">
<li><a href="#_duration_and_volume">4.3.1. Duration and Volume</a></li>
<li><a href="#_pitches_and_scales">4.3.2. Pitches and Scales</a></li>
<li><a href="#_shadows">4.3.3. Shadows</a></li>
<li><a href="#_duration_and_volume">3.3.1. Duration and Volume</a></li>
<li><a href="#_pitches_and_scales">3.3.2. Pitches and Scales</a></li>
<li><a href="#_shadows">3.3.3. Shadows</a></li>
</ul>
</li>
<li><a href="#_grouping_in_the_pattern">4.4. Grouping in the Pattern</a></li>
<li><a href="#_grouping_in_the_pattern">3.4. Grouping in the Pattern</a></li>
</ul>
</li>
<li><a href="#_development">5. Development</a>
<li><a href="#_installation_and_start">4. Installation and Start</a></li>
<li><a href="#_help_and_development">5. Help and Development</a>
<ul class="sectlevel2">
<li><a href="#_translations">5.1. Translations</a></li>
<li><a href="#_bugs">5.2. Bugs</a></li>
<li><a href="#_testing_and_reporting_errors">5.1. Testing and Reporting Errors</a></li>
<li><a href="#_programming">5.2. Programming</a></li>
<li><a href="#_translations">5.3. Translations</a></li>
</ul>
</li>
</ul>
@ -468,7 +474,7 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b
</div>
<div id="content">
<div class="sect1">
<h2 id="_patroneo_user_manual">1. Patroneo User Manual</h2>
<h2 id="_usage">1. Usage</h2>
<div class="sectionbody">
<div class="paragraph">
<p>We are happy you chose Patroneo. Patroneo is an easy-to-use sequencer, a program that sends digital "notes" to software instruments such as synthesizers and samplers.</p>
@ -479,82 +485,7 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b
</div>
</div>
<div class="sect1">
<h2 id="_installation_and_starting">2. Installation and Starting</h2>
<div class="sectionbody">
<div class="paragraph">
<p>Patroneo is exclusive for Linux. The best way to install Patroneo is to use your package manager. If it is not there, or only in an outdated version, please ask your Linux distribution to provide a recent version.</p>
</div>
<div class="paragraph">
<p>If available in the package repository, please continue reading directly at "Start Patroneo from Non Session Manager".
If not, you can build Patroneo yourself.</p>
</div>
<div class="ulist">
<div class="title">Dependencies</div>
<ul>
<li>
<p>First install the packages Python3, PyQt5, Nuitka and GCC.</p>
</li>
<li>
<p>And these audio packages: Jack Audio Connection Kit, QJackCtl (or something else to establish Jack connections), Non Session Manager</p>
</li>
<li>
<p>Build and Install:</p>
<div class="ulist">
<ul>
<li>
<p>Download the latest version from <a href="https://www.laborejo.org/downloads" class="bare">https://www.laborejo.org/downloads</a> and extract it.</p>
</li>
<li>
<p>Cd into the new directory and use these commands:</p>
</li>
<li>
<p><code>./configure</code></p>
</li>
<li>
<p><code>make</code></p>
</li>
<li>
<p><code>sudo make install</code></p>
</li>
</ul>
</div>
</li>
</ul>
</div>
<div class="ulist">
<div class="title">Start Patroneo from Non Session Manager (NSM)</div>
<ul>
<li>
<p>Run <code>non-session-manager</code></p>
</li>
<li>
<p>Press the <code>New</code> button, and enter a name for your piece of music.</p>
</li>
<li>
<p>Press the <code>Add Client to Session</code> button, enter <code>patroneo</code> here, in lower case.</p>
</li>
<li>
<p>Add Client again, this time <code>jackpatch</code>.</p>
</li>
<li>
<p>Add any compatible programs, e.g. synthesizers.</p>
<div class="ulist">
<ul>
<li>
<p>See the list of NSM compatible programs: <a href="http://non.tuxfamily.org/wiki/ApplicationsSupportingNsm" class="bare">http://non.tuxfamily.org/wiki/ApplicationsSupportingNsm</a></p>
</li>
<li>
<p>And the NSM manual: <a href="http://non.tuxfamily.org/nsm/" class="bare">http://non.tuxfamily.org/nsm/</a></p>
</li>
</ul>
</div>
</li>
</ul>
</div>
</div>
</div>
<div class="sect1">
<h2 id="_how_to_use_patroneo">3. How to use Patroneo</h2>
<h2 id="_how_to_use_patroneo">2. How to use Patroneo</h2>
<div class="sectionbody">
<div class="paragraph">
<p>The following explains how to use Patroneo.</p>
@ -566,7 +497,7 @@ If not, you can build Patroneo yourself.</p>
<p>We encourage you to experiment a lot. Very often good music is created when users have not only used programs as it was intended.</p>
</div>
<div class="sect2">
<h3 id="_quick_start">3.1. Quick Start</h3>
<h3 id="_quick_start">2.1. Quick Start</h3>
<div class="paragraph">
<p>To get to know the most important functions and workflows, this video has been created.</p>
</div>
@ -587,7 +518,7 @@ Your browser does not support the video tag.
</div>
</div>
<div class="sect2">
<h3 id="_basic_principles">3.2. Basic Principles</h3>
<h3 id="_basic_principles">2.2. Basic Principles</h3>
<div class="paragraph">
<p>Patroneo organizes its music in tracks that contain measures. All measures of a track play the same "pattern" that creates music through a sequence of "steps".</p>
</div>
@ -608,7 +539,7 @@ Your browser does not support the video tag.
</div>
</div>
<div class="sect2">
<h3 id="_keyboard_controls">3.3. Keyboard Controls</h3>
<h3 id="_keyboard_controls">2.3. Keyboard Controls</h3>
<div class="paragraph">
<p>In principle, Patroneo can be operated with the mouse. The keyboard is needed for only a few functions, such as changing track names or setting half-tone transposition. However, the keyboard makes some workflows faster and more convenient.</p>
</div>
@ -630,7 +561,7 @@ Your browser does not support the video tag.
</div>
</div>
<div class="sect1">
<h2 id="_description_of_the_graphical_user_interface_and_its_functions">4. Description of the graphical user interface and its functions</h2>
<h2 id="_description_of_the_graphical_user_interface_and_its_functions">3. Description of the graphical user interface and its functions</h2>
<div class="sectionbody">
<div class="paragraph">
<p>Use your browser&#8217;s search function to locate the individual letters like [B] and their explanation.</p>
@ -644,7 +575,7 @@ Your browser does not support the video tag.
<p>Patroneo consists of three parts: The Toolbar, the Form Editor, and the Pattern Editor. Between form- and pattern editor there is a <strong>[L] Handle</strong> which you can grab with the left mouse button and move it up or down to give more space to one or the other area.</p>
</div>
<div class="sect2">
<h3 id="_toolbar">4.1. Toolbar</h3>
<h3 id="_toolbar">3.1. Toolbar</h3>
<div class="paragraph">
<p>The <strong>[A] Toolbar</strong> combines various commands with properties of the entire piece.</p>
</div>
@ -682,7 +613,7 @@ If the checkbox is activated, the specified tempo is considered to be beats per
</div>
</div>
<div class="sect2">
<h3 id="_form_editor">4.2. Form Editor</h3>
<h3 id="_form_editor">3.2. Form Editor</h3>
<div class="paragraph">
<p>In the <strong>[B] Form Editor</strong> you create the structure of a piece. To do this, the measures in each track can be switched on and off as desired. One can imagine, for example, a drum set that plays three bars in a row and makes a "break" every fourth bar. For this common drum technique you need two tracks. In the screenshot this "3+1" pattern can be seen in the third section (bars 17 to 24) in the orange bass track.<br>
Whole parts (e.g. verse and chorus) are implemented by using different tracks. To make the creation of related tracks as comfortable as possible, the "clone" command exists (see letter D).</p>
@ -758,7 +689,7 @@ However, if the scale is chosen freely, there are non-intuitive outcomes; "up an
</div>
</div>
<div class="sect2">
<h3 id="_pattern_editor">4.3. Pattern Editor</h3>
<h3 id="_pattern_editor">3.3. Pattern Editor</h3>
<div class="paragraph">
<p>The <strong>[C] Pattern Editor</strong> is used for composing. The tones, also called "steps", are used to form a measure. The pattern is exactly as long as a measure and is played from left to right. There are several possibilities for tonal arrangement, which are now explained.</p>
</div>
@ -775,7 +706,7 @@ However, if the scale is chosen freely, there are non-intuitive outcomes; "up an
<p>The pattern itself is arranged in rows and columns. The rows symbolise the (adjustable) pitches, the columns show their rhythmic sequence and position in time.</p>
</div>
<div class="sect3">
<h4 id="_duration_and_volume">4.3.1. Duration and Volume</h4>
<h4 id="_duration_and_volume">3.3.1. Duration and Volume</h4>
<div class="paragraph">
<p>A <strong>[S] Step</strong> is a grey or coloured box. Grey means pause, coloured means <strong>[T] Sounding Tone</strong>. A click with the left mouse button switches the steps on and off.<br>
A right click opens the context menu. Here you can switch all (currently visible) steps on, off or invert all: Off On becomes Off and vice versa. All volume information (see below) will be lost.</p>
@ -794,7 +725,7 @@ A right click opens the context menu. Here you can switch all (currently visible
</div>
</div>
<div class="sect3">
<h4 id="_pitches_and_scales">4.3.2. Pitches and Scales</h4>
<h4 id="_pitches_and_scales">3.3.2. Pitches and Scales</h4>
<div class="paragraph">
<p>Click with the middle mouse button on a step to hear the sound it plays. This allows you to "pre-listen" before you decide to set a note. Tip: Hold down the middle mouse button and move the mouse up and down the steps.</p>
</div>
@ -823,7 +754,7 @@ If you select a scale from the list, it will be built upon the bottom row. As a
</div>
</div>
<div class="sect3">
<h4 id="_shadows">4.3.3. Shadows</h4>
<h4 id="_shadows">3.3.3. Shadows</h4>
<div class="paragraph">
<p>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 <strong>[2] Shadows</strong>. Just click with the middle mouse button on the track you want to see. This is only possible in the measure area, not on the track name or on the timeline.</p>
@ -834,7 +765,7 @@ To help you, it is possible to display other tracks as <strong>[2] Shadows</stro
</div>
</div>
<div class="sect2">
<h3 id="_grouping_in_the_pattern">4.4. Grouping in the Pattern</h3>
<h3 id="_grouping_in_the_pattern">3.4. Grouping in the Pattern</h3>
<div class="paragraph">
<p>Grouping is part of the time signature.</p>
</div>
@ -956,119 +887,228 @@ To help you, it is possible to display other tracks as <strong>[2] Shadows</stro
</div>
</div>
<div class="sect1">
<h2 id="_development">5. Development</h2>
<h2 id="_installation_and_start">4. Installation and Start</h2>
<div class="sectionbody">
<div class="paragraph">
<p>The further development of Patroneo will consist of improvements in the areas of stability and program performance.
New functions are not categorically excluded, but are only possible after long-term observation of user behaviour.</p>
<p>Patroneo is exclusive for Linux. The best way to install is to use your package manager.
If it is not there, or only in an outdated version, please ask your Linux distribution to provide a recent version.</p>
</div>
<div class="sect2">
<h3 id="_translations">5.1. Translations</h3>
<div class="paragraph">
<p>Patroneo is very easy to translate with the help of the Qt-Toolchain, without any need for programming.
The easiest way is to contact the developers and they will setup the new language.</p>
</div>
<div class="paragraph">
<p>However, here are the complete instructions for doing a translation completely on your own and integrating it into the program.</p>
<p>If available in the package repository, please continue reading directly at "Start &lt;shortname&gt; from Non Session Manager".
If not, you can build Patroneo yourself.</p>
</div>
<div class="ulist">
<div class="title">Build and Install</div>
<ul>
<li>
<p>Open a terminal and navigate to the Patroneo directory</p>
<p>Please check the supplied README.md for dependencies.</p>
</li>
<li>
<p>In the Patroneo directory: <code>cd gui/translations</code></p>
<p>You can download a release or clone the git version</p>
<div class="ulist">
<ul>
<li>
<p>Download the latest version from <a href="https://www.laborejo.org/downloads" class="bare">https://www.laborejo.org/downloads</a> and extract it.</p>
</li>
<li>
<p>Edit the file <code>config.pro</code> with a text editor</p>
<p><code>git clone <a href="https://laborejo.org/&lt;shortname&gt;.git" class="bare">https://laborejo.org/&lt;shortname&gt;.git</a></code></p>
</li>
</ul>
</div>
</li>
<li>
<p>Change into the new directory and use these commands:</p>
</li>
<li>
<p><code>./configure --prefix=/usr</code></p>
<div class="ulist">
<ul>
<li>
<p>Append the name of your language in the 2nd line, in the form <code>tXY.ts</code>, where XY is the language code.</p>
<p>The default prefix is /usr/local</p>
</li>
</ul>
</div>
</li>
<li>
<p>Make sure to leave a space between the individual languages entries.</p>
<p><code>make</code></p>
</li>
<li>
<p><code>sudo make install</code></p>
</li>
</ul>
</div>
<div class="ulist">
<div class="title">Start &lt;shortname&gt; from Non Session Manager (NSM)</div>
<ul>
<li>
<p>Run <code>non-session-manager</code></p>
</li>
<li>
<p>Press the <code>New</code> button, and enter a name for your piece of music.</p>
</li>
<li>
<p>Press the <code>Add Client to Session</code> button, enter <code>&lt;shortname&gt;</code> here, in lower case.</p>
</li>
<li>
<p>Add Client again, this time <code>jackpatch</code>.</p>
</li>
<li>
<p>Run <code>pylupdate5 config.pro</code></p>
<p>Add any compatible programs, e.g. synthesizers.</p>
<div class="ulist">
<ul>
<li>
<p>The program has now generated a new <code>.ts</code> file in the <code>translations</code> subdirectory</p>
<p>See the list of NSM compatible programs: <a href="http://non.tuxfamily.org/wiki/ApplicationsSupportingNsm" class="bare">http://non.tuxfamily.org/wiki/ApplicationsSupportingNsm</a></p>
</li>
<li>
<p>And the NSM manual: <a href="http://non.tuxfamily.org/nsm/" class="bare">http://non.tuxfamily.org/nsm/</a></p>
</li>
</ul>
</div>
</li>
</ul>
</div>
<div class="paragraph">
<p>Please read README.md for other ways of starting &lt;shortname&gt;, which are impractical for actual use but can
be helpful for testing and development.</p>
</div>
</div>
</div>
<div class="sect1">
<h2 id="_help_and_development">5. Help and Development</h2>
<div class="sectionbody">
<div class="paragraph">
<p>You can help Patroneo in several ways: Testing and reporting errors, translating, marketing, support, programming and more.</p>
</div>
<div class="sect2">
<h3 id="_testing_and_reporting_errors">5.1. Testing and Reporting Errors</h3>
<div class="paragraph">
<p>If you find a bug in the program (or it runs too slow) please contact us in a way that suits you best.
We are thankful for any help.</p>
</div>
<div class="ulist">
<div class="title">How to contact us</div>
<ul>
<li>
<p>Start Qt Linguist with <code>linguist-qt5</code> (may be named differently) and open your newly generated file</p>
<p>Website: <a href="https://www.laborejo.org" class="bare">https://www.laborejo.org</a></p>
</li>
<li>
<p>Select your "Target Language" and use the program to create a translation</p>
<p>E-Mail: <a href="mailto:info@laborejo.org">info@laborejo.org</a></p>
</li>
<li>
<p>IRC: #laborejo on server irc.freenode.org</p>
</li>
<li>
<p>Send us the.ts file, such as by e-mail to <a href="mailto:info@laborejo.org">info@laborejo.org</a> (see below for more contact options)</p>
<p>If you see the opportunity and know that a developer will read it also forums, social media etc..</p>
</li>
</ul>
</div>
</div>
<div class="sect2">
<h3 id="_programming">5.2. Programming</h3>
<div class="paragraph">
<p>You can also incorporate the translation into Patroneo for testing purposes. This requires rudimentary Python knowledge.</p>
<p>If you want to do some programming and don&#8217;t know where to start please get in contact with us directly.
The short version is: clone the git, change the code, create a git patch or point me to your public git.</p>
</div>
</div>
<div class="sect2">
<h3 id="_translations">5.3. Translations</h3>
<div class="paragraph">
<p>Patroneo is very easy to translate with the help of the Qt-Toolchain, without any need for programming.
The easiest way is to contact the developers and they will setup the new language.</p>
</div>
<div class="paragraph">
<p>However, here are the complete instructions for doing a translation completely on your own and integrating it into the program.
The program is split in two parts. A shared "template" between the Laborejo Software Suite and the actual program.</p>
</div>
<div class="paragraph">
<p>The process is the same for both parts, but needs to be done in different directories:
<code>template/qtgui`and plain `/qtgui</code>, relative to the root directory, where the &lt;shortname&gt; executable is.</p>
</div>
<div class="paragraph">
<p>Everytime you see "template/qtgui" below you can substitute that with just "qtgui" to translate the other part of Patroneo.</p>
</div>
<div class="paragraph">
<p>You can add a new language like this:</p>
</div>
<div class="ulist">
<ul>
<li>
<p>In the Qt Linguist "File" menu is a "Release" option. This creates a <code>.qm</code> file in the same directory as your <code>.ts</code> file.</p>
<p>Open a terminal and navigate to template/qtgui/resources/translations</p>
</li>
<li>
<p>Open the <code>patroneo</code> starter file in your text editor</p>
<p>Edit the file <code>config.pro</code> with a text editor</p>
<div class="ulist">
<ul>
<li>
<p>Scroll down to the bottom to set the language.</p>
<p>Append the name of your language in the last line, in the form <code>XY.ts</code>, where XY is the language code.</p>
</li>
<li>
<p>To find out your language string (German, Esperanto etc.) remove the # hash from the existing line <code>#print (language)</code>. Start NSM from a terminal, start Patroneo and the language string will be printed there (you have to search a bit)</p>
<p>Make sure to leave a space between the individual languages entries.</p>
</li>
</ul>
</div>
</li>
<li>
<p>At the end of the file is a dictionary <code>supportedLanguages</code>. Add your language. For example <code>{"German": "de.qm", "Esperanto: "eo.qm"}</code></p>
<p>Run <code>sh update.sh</code> in the same directory</p>
<div class="ulist">
<ul>
<li>
<p>The program has now generated a new <code>.ts</code> file in the same directory.</p>
</li>
</ul>
</div>
</li>
<li>
<p>Start Qt Linguist with <code>linguist-qt5</code> (may be named differently) and open your newly generated file</p>
</li>
<li>
<p>Select your "Target Language" and use the program to create a translation</p>
</li>
<li>
<p>Send us the <code>.ts</code> file, such as by e-mail to <a href="mailto:info@laborejo.org">info@laborejo.org</a> (see below for more contact options)</p>
</li>
</ul>
</div>
</div>
<div class="sect2">
<h3 id="_bugs">5.2. Bugs</h3>
<div class="paragraph">
<p>If you find a bug in the program (or it runs too slow) please contact us in a way that suits you best.</p>
<p>You can also incorporate the translation into Patroneo for testing purposes. This requires rudimentary Python knowledge.</p>
</div>
<div class="ulist">
<div class="title">How to contact us</div>
<ul>
<li>
<p>Website: <a href="https://www.laborejo.org" class="bare">https://www.laborejo.org</a></p>
<p>Run the "Release" option in QtLinguists "File" menu. It creates a <code>.qm</code> file in the same directory as your <code>.ts</code> file.</p>
</li>
<li>
<p>E-Mail: <a href="mailto:info@laborejo.org">info@laborejo.org</a></p>
<p>Edit <code>template/qtgui/resources/resources.qrc</code> and duplicate the line <code>&lt;file&gt;translations/de.qm&lt;/file&gt;</code> but change it to your new .qm file.</p>
</li>
<li>
<p>IRC: #laborejo on server irc.freenode.org</p>
<p>run <code>sh buildresources.sh</code></p>
</li>
<li>
<p>Edit <code>engine/config.py</code>: add your language to the line that begins with "supportedLanguages" like this: <code>{"German": "de.qm", "Esperanto: "eo.qm"}</code></p>
<div class="ulist">
<ul>
<li>
<p>To find out your language string (German, Esperanto etc.) open the <code>python3</code> interpreter in a terminal and run the following command:</p>
</li>
<li>
<p>If you see the opportunity and know that a developer will read it also forums, Facebook etc..</p>
<p><code>from PyQt5 import QtCore;QtCore.QLocale().languageToString(QtCore.QLocale().language())</code></p>
</li>
</ul>
</div>
</li>
</ul>
</div>
<div class="paragraph">
<p>To test the new translation you can either run the program normally, if your system is set to that language. Alternatively start &lt;shortname&gt; via the terminal:
* <code>LANGUAGE=de_DE.UTF-8 ./&lt;shortname&gt; -V --save /dev/null</code></p>
</div>
</div>
</div>
</div>
</div>
<div id="footer">
<div id="footer-text">
Last updated 2019-01-02 22:07:03 +0100
Last updated 2019-01-26 18:51:50 +0100
</div>
</div>
</body>

365
documentation/out/german.html

@ -5,7 +5,8 @@
<!--[if IE]><meta http-equiv="X-UA-Compatible" content="IE=edge"><![endif]-->
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta name="generator" content="Asciidoctor 1.5.8">
<title>Patroneo Bedienungsanleitung</title>
<meta name="author" content="Laborejo Software Suite">
<title>Patroneo</title>
<style>
/* Asciidoctor default stylesheet | MIT License | http://asciidoctor.org */
/* Uncomment @import statement below to use as custom stylesheet */
@ -431,36 +432,45 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b
</head>
<body class="article toc2 toc-left">
<div id="header">
<h1>Patroneo</h1>
<div class="details">
<span id="author" class="author">Laborejo Software Suite</span><br>
</div>
<div id="toc" class="toc2">
<div id="toctitle">Inhaltsverzeichnis</div>
<ul class="sectlevel1">
<li><a href="#_patroneo_bedienungsanleitung">1. Patroneo Bedienungsanleitung</a></li>
<li><a href="#_installation_und_start">2. Installation und Start</a></li>
<li><a href="#_bedienung">3. Bedienung</a>
<li><a href="#_benutzung">1. Benutzung</a></li>
<li><a href="#_bedienung">2. Bedienung</a>
<ul class="sectlevel2">
<li><a href="#_schnellstart">3.1. Schnellstart</a></li>
<li><a href="#_grundlagen">3.2. Grundlagen</a></li>
<li><a href="#_tastatursteuerung">3.3. Tastatursteuerung</a></li>
<li><a href="#_schnellstart">2.1. Schnellstart</a></li>
<li><a href="#_grundlagen">2.2. Grundlagen</a></li>
<li><a href="#_tastatursteuerung">2.3. Tastatursteuerung</a></li>
</ul>
</li>
<li><a href="#_beschreibung_der_grafischen_oberfläche_und_ihrer_funktionen">4. Beschreibung der grafischen Oberfläche und ihrer Funktionen</a>
<li><a href="#_beschreibung_der_grafischen_oberfläche_und_ihrer_funktionen">3. Beschreibung der grafischen Oberfläche und ihrer Funktionen</a>
<ul class="sectlevel2">
<li><a href="#_werkzeugleiste">4.1. Werkzeugleiste</a></li>
<li><a href="#_form_editor">4.2. Form-Editor</a></li>
<li><a href="#_muster_editor">4.3. Muster-Editor</a>
<li><a href="#_werkzeugleiste">3.1. Werkzeugleiste</a></li>
<li><a href="#_form_editor">3.2. Form-Editor</a></li>
<li><a href="#_muster_editor">3.3. Muster-Editor</a>
<ul class="sectlevel3">
<li><a href="#_länge_und_lautstärke">4.3.1. Länge und Lautstärke</a></li>
<li><a href="#_tonhöhen_skala_und_tonleiter">4.3.2. Tonhöhen, Skala und Tonleiter</a></li>
<li><a href="#_schatten">4.3.3. Schatten</a></li>
<li><a href="#_länge_und_lautstärke">3.3.1. Länge und Lautstärke</a></li>
<li><a href="#_tonhöhen_skala_und_tonleiter">3.3.2. Tonhöhen, Skala und Tonleiter</a></li>
<li><a href="#_schatten">3.3.3. Schatten</a></li>
</ul>
</li>
<li><a href="#_gruppierung_im_muster">3.4. Gruppierung im Muster</a></li>
</ul>
</li>
<li><a href="#_gruppierung_im_muster">4.4. Gruppierung im Muster</a></li>
<li><a href="#_installation_und_start">4. Installation und Start</a></li>
<li><a href="#_helfen_und_entwicklung">5. Helfen und Entwicklung</a>
<ul class="sectlevel2">
<li><a href="#_testen_und_programmfehler">5.1. Testen und Programmfehler</a></li>
</ul>
</li>
<li><a href="#_entwicklung">5. Entwicklung</a>
<li><a href="#_entwicklung">6. Entwicklung</a>
<ul class="sectlevel2">
<li><a href="#_übersetzungen">5.1. Übersetzungen</a></li>
<li><a href="#_bugs_und_programmfehler">5.2. Bugs und Programmfehler</a></li>
<li><a href="#_übersetzungen">6.1. Übersetzungen</a></li>
<li><a href="#_übersetzungen_2">6.2. Übersetzungen</a></li>
</ul>
</li>
</ul>
@ -468,7 +478,7 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b
</div>
<div id="content">
<div class="sect1">
<h2 id="_patroneo_bedienungsanleitung">1. Patroneo Bedienungsanleitung</h2>
<h2 id="_benutzung">1. Benutzung</h2>
<div class="sectionbody">
<div class="paragraph">
<p>Schön, dass du dich für Patroneo entschieden hast. Patroneo ist ein leicht zu bedienender "Sequencer", also ein Programm, dass digitale "Noten" an Softwareinstrumente, wie Synthesizer und Sampler, schickt.</p>
@ -479,84 +489,7 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b
</div>
</div>
<div class="sect1">
<h2 id="_installation_und_start">2. Installation und Start</h2>
<div class="sectionbody">
<div class="paragraph">
<p>Patroneo ist exklusiv für Linux. Am besten installierst du Patroneo über deinen Paketmanager. Falls es dort nicht vorhanden ist, oder nur in einer veralteten Version, bitte deine Linuxdistribution Patroneo bereitzustellen.</p>
</div>
<div class="paragraph">
<p>Falls in den Paketquellen vorhanden bitte direkt bei "Patroneo im Non Session Manager starten" weiterlesen.</p>
</div>
<div class="paragraph">
<p>Falls nicht kann man Patroneo auch selbst "bauen".</p>
</div>
<div class="ulist">
<div class="title">Abhängigkeiten</div>
<ul>
<li>
<p>Installiere zunächst die Pakete Python3, PyQt5, Nuitka und GCC.</p>
</li>
<li>
<p>Und diese Audiopakete: Jack Audio Connection Kit, QJackCtl (oder etwas anderes um Jack Verbindungen herzustellen), Non Session Manager</p>
</li>
<li>
<p>Kompilieren und Installieren:</p>
<div class="ulist">
<ul>
<li>
<p>Lade von <a href="https://www.laborejo.org/downloads" class="bare">https://www.laborejo.org/downloads</a> die aktuelle Version herunter und entpacke sie.</p>
</li>
<li>
<p>Wechsele in das neue Verzeichnis und benutze diese Befehle:</p>
</li>
<li>
<p><code>./configure</code></p>
</li>
<li>
<p><code>make</code></p>
</li>
<li>
<p><code>sudo make install</code></p>
</li>
</ul>
</div>
</li>
</ul>
</div>
<div class="ulist">
<div class="title">Patroneo im Non Session Manager (NSM) starten</div>
<ul>
<li>
<p>Starte <code>non-session-manager</code></p>
</li>
<li>
<p>Knopf <code>New</code>, gib einen Namen für dein Musikstück ein.</p>
</li>
<li>
<p>Knopf <code>Add Client to Session</code>, gib hier <code>patroneo</code> ein, kleingeschrieben.</p>
</li>
<li>
<p>Nochmal Add Client, diesmal <code>jackpatch</code>.</p>
</li>
<li>
<p>Füge beliebige kompatible Programme hinzu, z.B. Synthesizer.</p>
<div class="ulist">
<ul>
<li>
<p>Siehe auch das NSM Handbuch: <a href="http://non.tuxfamily.org/nsm/" class="bare">http://non.tuxfamily.org/nsm/</a></p>
</li>
<li>
<p>Und die Liste der NSM kompatiblen Programme: <a href="http://non.tuxfamily.org/wiki/ApplicationsSupportingNsm" class="bare">http://non.tuxfamily.org/wiki/ApplicationsSupportingNsm</a></p>
</li>
</ul>
</div>
</li>
</ul>
</div>
</div>
</div>
<div class="sect1">
<h2 id="_bedienung">3. Bedienung</h2>
<h2 id="_bedienung">2. Bedienung</h2>
<div class="sectionbody">
<div class="paragraph">
<p>Im folgenden wird erklärt, wie Patroneo bedient wird.</p>
@ -568,7 +501,7 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b
<p>Wir ermutigen dich, viel zu experimentieren. Sehr oft ensteht gute Musik wenn Benutzer Programme nicht nur so benutzt haben, wie es eigentlich angedacht war.</p>
</div>
<div class="sect2">
<h3 id="_schnellstart">3.1. Schnellstart</h3>
<h3 id="_schnellstart">2.1. Schnellstart</h3>
<div class="paragraph">
<p>Um die wichtigsten Funktionen und Arbeitsabläufe kennenzulernen ist dieses Video erstellt worden.</p>
</div>
@ -589,7 +522,7 @@ Your browser does not support the video tag.
</div>
</div>
<div class="sect2">
<h3 id="_grundlagen">3.2. Grundlagen</h3>
<h3 id="_grundlagen">2.2. Grundlagen</h3>
<div class="paragraph">
<p>Patroneo organisiert seine Musik in Spuren, die Takte enthalten. Alle Takte einer Spur spielen das selbe "Muster", dass durch eine Abfolge von "Schritten" Musik erzeugt.</p>
</div>
@ -610,7 +543,7 @@ Your browser does not support the video tag.
</div>
</div>
<div class="sect2">
<h3 id="_tastatursteuerung">3.3. Tastatursteuerung</h3>
<h3 id="_tastatursteuerung">2.3. Tastatursteuerung</h3>
<div class="paragraph">
<p>Patroneo kann prinzipiell mit der Maus bedient werden. Die Tastatur ist nur für wenige Funktionen dringend nötig, etwa um Spurnamen zu ändern oder um Halbtontransposition einzustellen. Allerdings macht die Tastatur manche Arbeitsabläufe schneller und bequemer.</p>
</div>
@ -632,7 +565,7 @@ Your browser does not support the video tag.
</div>
</div>
<div class="sect1">
<h2 id="_beschreibung_der_grafischen_oberfläche_und_ihrer_funktionen">4. Beschreibung der grafischen Oberfläche und ihrer Funktionen</h2>
<h2 id="_beschreibung_der_grafischen_oberfläche_und_ihrer_funktionen">3. Beschreibung der grafischen Oberfläche und ihrer Funktionen</h2>
<div class="sectionbody">
<div class="paragraph">
<p>Benutze die Suchfunktion deines Browsers um nach den einzelnen Buchstaben wie [B] und deren Erläuterung zu suchen.</p>
@ -646,7 +579,7 @@ Your browser does not support the video tag.
<p>Patroneo besteht aus drei Teilen: Der Werkzeugleiste, dem Form-Editor und dem Takt- oder Mustereditor. Zwischen Form- und Mustereditor befindet sich ein <strong>[L] Verschiebegriff</strong>, den man mit der linken Maustaste anklicken und bei gedrückter Taste hoch oder runter schieben kann um dem einen oder anderen Bereich mehr Platz zu geben.</p>
</div>
<div class="sect2">
<h3 id="_werkzeugleiste">4.1. Werkzeugleiste</h3>
<h3 id="_werkzeugleiste">3.1. Werkzeugleiste</h3>
<div class="paragraph">
<p>Die <strong>[A] Werkzeugleiste</strong> kombiniert verschiedene Befehle mit Eigenschaften des gesamten Stückes.</p>
</div>
@ -684,7 +617,7 @@ Aktiviert man den Haken so gilt das angegebene Tempo als Schläge pro Minute. Ei
</div>
</div>
<div class="sect2">
<h3 id="_form_editor">4.2. Form-Editor</h3>
<h3 id="_form_editor">3.2. Form-Editor</h3>
<div class="paragraph">
<p>Im <strong>[B] Form-Editor</strong> erstellt man die Stuktur eines Stückes. Dazu schaltet man die Takte in jeder Spur beliebig ein und aus. Man kann sich z.B. ein Schlagzeug vorstellen, dass drei Takte gleich spielt und jeden vierten Takt einen "Break" macht. In Patroneo braucht man dazu zwei Spuren. Dieses "3+1" Muster kann man auf dem Bild z.B. im dritten Abschnitt (Takt 17 bis 24) in der orangen Bassspur sehen.<br>
Auch ganze Teile (z.B. Strophe und Refrain) werden durch verschiedene Spuren abgedeckt. Um das Erschaffen von verwandten Spuren so bequem wie möglich zu machen existiert der "Klon" Befehl (s. Buchstabe D).</p>
@ -760,7 +693,7 @@ Wenn die Skala allerdings frei eingestellt wurde ergeben sich unintuitive Mögli
</div>
</div>
<div class="sect2">
<h3 id="_muster_editor">4.3. Muster-Editor</h3>
<h3 id="_muster_editor">3.3. Muster-Editor</h3>
<div class="paragraph">
<p>Der <strong>[C] Muster-Editor</strong> ermöglicht das eigentliche Komponieren. Dazu setzt man die Töne, auch "Schritte" genannt, um einen Takt zu bilden. Das Muster ist genau so lang wie ein Takt und wird von links nach rechts abgespielt. Man hat dabei einige Möglichkeiten zur klanglichen Gestaltung, die nun erklärt werden.</p>
</div>
@ -777,7 +710,7 @@ Wenn die Skala allerdings frei eingestellt wurde ergeben sich unintuitive Mögli
<p>Das Muster selbst ist in Reihen und Spalten angelegt. Die Reihen symbolisieren die (einstellbaren) Tonhöhen, die Spalten zeigen deren rhythmische Abfolge und Position im Takt.</p>
</div>
<div class="sect3">
<h4 id="_länge_und_lautstärke">4.3.1. Länge und Lautstärke</h4>
<h4 id="_länge_und_lautstärke">3.3.1. Länge und Lautstärke</h4>
<div class="paragraph">
<p>Ein <strong>[S] Schritt</strong> ist ein graues bzw. farbiges Kästchen. Grau bedeutet Pause, farbig bedeutet <strong>[T] Klingender Ton</strong>. Ein klick mit der linken Maustaste schaltet die Schritte an und aus.<br>
Ein Rechtsklick öffnet das Kontextmenü. Hier kann man alle (gerade sichtbaren) Schritte einschalten, ausschalten oder die gesetzen Schritte tauschen; Aus An wird Aus und umgekehrt. Hierbei gehen alle Lautstärke Informationen (s.u.) verloren.</p>
@ -796,7 +729,7 @@ Ein Rechtsklick öffnet das Kontextmenü. Hier kann man alle (gerade sichtbaren)
</div>
</div>
<div class="sect3">
<h4 id="_tonhöhen_skala_und_tonleiter">4.3.2. Tonhöhen, Skala und Tonleiter</h4>
<h4 id="_tonhöhen_skala_und_tonleiter">3.3.2. Tonhöhen, Skala und Tonleiter</h4>
<div class="paragraph">
<p>Klicke mit der mittleren Maustaste auf einen Schritt um den Ton zu hören, den dieser abspielt. Hiermit kannst du schonmal "vorhören", bevor du dich entscheidest einen Ton zu setzen. Tipp: Halte die mittlere Maustaste gedrückt und fahre mit der Maus über die Schritte auf und ab.</p>
</div>
@ -825,7 +758,7 @@ Wählt man aus der Liste eine Tonleiter aus so wird diese auf der untersten Reih
</div>
</div>
<div class="sect3">
<h4 id="_schatten">4.3.3. Schatten</h4>
<h4 id="_schatten">3.3.3. Schatten</h4>
<div class="paragraph">
<p>Oft möchte man zu einer existierenden Spur noch weitere Töne in einem anderen Muster setzen. Eine zweite Stimme, Frage/Antwort-Technik etc.
Als Hilfe gibt es die Möglichkeit sich andere Spuren als <strong>[2] Schatten</strong> anzeigen zu lassen. Dazu einfach mit der mittleren Maustaste auf die Spur klicken, die man sehen möchte. Das geht nur im Taktbereich, nicht auf den Spurnamen oder auf der Zeitleiste.</p>
@ -836,7 +769,7 @@ Als Hilfe gibt es die Möglichkeit sich andere Spuren als <strong>[2] Schatten</
</div>
</div>
<div class="sect2">
<h3 id="_gruppierung_im_muster">4.4. Gruppierung im Muster</h3>
<h3 id="_gruppierung_im_muster">3.4. Gruppierung im Muster</h3>
<div class="paragraph">
<p>Die Gruppierung gehört zur Taktart.</p>
</div>
@ -958,14 +891,130 @@ Als Hilfe gibt es die Möglichkeit sich andere Spuren als <strong>[2] Schatten</
</div>
</div>
<div class="sect1">
<h2 id="_entwicklung">5. Entwicklung</h2>
<h2 id="_installation_und_start">4. Installation und Start</h2>
<div class="sectionbody">
<div class="paragraph">
<p>Die weitere Entwicklung Patroneos besteht aus der Verbesserung in den Bereichen Stabilität und Programmgeschwindigkeit.
Neue Funktionen werden zwar nicht kategorisch ausgeschlossen, sind aber erst nach Langzeitbeobachtung des Nutzerverhaltens möglich.</p>