Browse Source

update docs for new version number

master
Nils 3 years ago
parent
commit
64372c5ece
  1. 2
      README.md
  2. 38
      documentation/english.adoc
  3. 9
      documentation/english.part.adoc
  4. 42
      documentation/german.adoc
  5. 11
      documentation/german.part.adoc
  6. 57
      documentation/out/english.html
  7. 61
      documentation/out/german.html
  8. 2
      engine/config.py

2
README.md

@ -1,5 +1,5 @@
[//]: # (Generated 2020-06-19T21:39:08.076003. Changes belong into template/documentation/readme.template)
[//]: # (Generated 2020-06-27T13:09:50.220857. Changes belong into template/documentation/readme.template)
#Fluajho
Program version 1.5

38
documentation/english.adoc

@ -46,15 +46,6 @@ instruments that can be assigned to 16 MIDI channels. Finally connect external s
Laborejo, Patroneo or Vico, through JACK-Midi to play the instruments.
=== Quick Start
To get to know the most important functions and workflows, this video has been created.
video::https://www.laborejo.org/documentation/patroneo/fluajho-quickstart-english.mp4[width=500]
Or as Youtube Mirror
video::hiEgjT3aG-M[youtube, width=500]
=== Basic Principles
@ -81,16 +72,14 @@ Use your browser's search function to locate the individual letters like [B] and
image::overview-english.png[Screenshot with Captions, link="overview-english.png"]
The *[A] File* menu contains only one command: "sf2 Soundfont load" (keyboard shortcut: Ctrl+O).
The *[A] File* menu contains "sf2 Soundfont load" (keyboard shortcut: Ctrl+O).
Only one soundfont can be loaded at a time. If you want to use several different soundfonts at
once, just start Fluajho several times.
once, just start Fluajho several times. Saving and Closing is also here.
It is also possible to load an .sf2 through drag & drop from your file manager into the Fluajho
window.
*[B]* is the name of the currently loaded file.
The option *[C] Ignore MIDI Bank and Program Messages* only allows instrument changes via the
The option *[B] Ignore MIDI Bank and Program Messages* only allows instrument changes via the
graphical user interface. It ignores all messages coming in via the JACK Midi connection.
This is sometimes necessary if you are dealing with midi hardware, like keyboards, which send bank
@ -98,23 +87,30 @@ and program changes at startup and break our settings. You can also activate thi
you have set all instruments, because a program change unfortunately happens faster than one would
think.
The option *[C] Play test sound after selecting a program* can be activated to hear some played
notes right choosing a different instrument through the program change dropdown [G]. The test signal
is *not* played when changing an instrument through an external midi signal.
Channels are numbered *[D] Channel N* . MIDI supports exactly 16 channels, there is no adjustment
possible. More channels of the same soundfont can be obtained by simply starting another Fluajho
instance.
instance. Next to the channel is a small rectangle that lights up if MIDI is coming in.
You can click with your middle mouse button (scroll wheel) on a channel to hear a short test
melody. This enables you to quickly prelisten an instrument.
*Play Test [E]* plays some test notes after a click. This can be used even if option [C] is not
currently activated.
The current *[E] Bank* is always displayed as a number. You can choose them from the drop down
The current *[F] Bank* is always displayed as a number. You can choose them from the drop down
list. Only the banks, which actually exist in the current sf2 are listed.
The current *[F] Program* is the instrument. It is displayed with its MIDI number and actual name.
The current *[G] Program* is the instrument. It is displayed with its MIDI number and actual name.
Only the programs present in the sf2 are displayed.+ However, the soundfonts are often wrong in
that they display more instruments than they actually have. In this case you will hear a more or
less random (existing) instrument instead.
There is no internal way to *close* Fluajho. If you use the function of your window manager like
[X], Alt+F4 etc. the graphical user interface is only hidden.
If you run Fluajho under Session Management, as intended, tere is no internal way to *close* it.
If you use the function of your window manager like [X], Alt+F4 etc. the graphical user interface
is only hidden.
To really close Fluajho you can use Argodejo (New Session Manager). Here you can
also restore visibility by showing the GUI again.

9
documentation/english.part.adoc

@ -1,12 +1,3 @@
=== Quick Start
To get to know the most important functions and workflows, this video has been created.
video::https://www.laborejo.org/documentation/patroneo/fluajho-quickstart-english.mp4[width=500]
Or as Youtube Mirror
video::hiEgjT3aG-M[youtube, width=500]
=== Basic Principles

42
documentation/german.adoc

@ -27,6 +27,7 @@ https://asciidoctor.org/docs/user-manual/
// Don't write in the empty line above line. It will be interpreted as author html tag
Für Programmversion 1.5
== Benutzung
Schön, dass Sie sich für Fluajho entschieden haben. Fluajho ist ein Sampler für sf2 Soundfonts. Dies
@ -45,16 +46,6 @@ klar umrissenen Anwendungsfall geschrieben: Ein .sf2 im New Session Manager (Arg
das Soundfont im Sessionverzeichnis mit abzuspeichern. Das ermöglicht es die Session zu
archivieren, etwa als Backup oder um sie weiterzugeben.
=== Schnellstart
Um die wichtigsten Funktionen und Arbeitsabläufe kennenzulernen ist dieses Video erstellt worden.
video::https://www.laborejo.org/documentation/fluajho/fluajho-quickstart-german.mp4[width=500]
Oder auf Youtube
video::glb7McL-gJk[youtube, width=500]
=== Grundlagen
Fluajho läd genau ein `.sf2` Soundfont. Ein Soundfont kann mehrere Instrumente enthalten, davon
@ -82,16 +73,15 @@ Erläuterung zu suchen.
image::overview-german.png[Screenshot mit Beschriftung, link="overview-german.png"]
Im *[A] Datei* Menü befindet sich nur der Befehl "sf2 Soundfont laden" (Tastaturkürzel: Strg+O). Es
Im *[A] Datei* Menü befindet sich der Befehl "sf2 Soundfont laden" (Tastaturkürzel: Strg+O). Es
kann jeweils nur ein Soundfont zur gleichen Zeit geladen werden. Möchten Sie mehrere verschiedene
Soundfonts auf einmal benutzen starten Sie Fluajho einfach mehrmals.
Soundfonts auf einmal benutzen starten Sie Fluajho einfach mehrmals. Außerdem findet sich hier
Speichern und Beenden.
Es ist ebenfalls möglich ein .sf2 mit Drag&Drop aus einem Dateimanager irgendwo in das
Fluajhofenster zu ziehen.
Bei *[B]* steht der Name der momentan geladenen Datei.
Die Option *[C] Ignoriere MIDI Bank und Program Nachrichten* lässt nur noch Instrumentenänderungen
Die Option *[B] Ignoriere MIDI Bank und Program Nachrichten* lässt nur noch Instrumentenänderungen
über die grafische Benutzeroberfläche zu. Sie ignoriert alle Nachrichten, die über die JACK Midi
Verbindung herein kommen.
@ -101,17 +91,22 @@ Option aber auch einfach so aktivieren um auf der sicheren Seite zu sein. Sobald
Instrumente eingestellt haben sperren Sie die Änderungen, denn ein Programm-Change passiert leider
schneller als man denkt.
Die Kanäle sind mit *[D] Channel* durchnummeriert. MIDI unterstützt genau 16 Kanäle, hier gibt es
Die Option *[C] Spiele Klangtest nach Programmauswahl* kann aktiviert werden um direkt nach einer
Änderung des Instruments über die Programmauswahlbox[G] zu hören wie dieses klingt. Das Testsignal
wird *nicht* gespielt wenn Änderungen über MIDI gemacht werden.
Die Kanäle *[D] Channel* sind fest durchnummeriert. MIDI unterstützt genau 16 Kanäle, hier gibt es
keine Einstellmöglichkeit. Mehr Kanäle mit dem gleichen Soundfont erhält man, indem man Fluajho
einfach noch einmal startet.
einfach noch einmal startet. Nebem dem Kanal befindet sich ein kleines Kästchen, dass bei
Midiaktivität aufleuchtet.
Ein Klick mit der mittleren Maustaste (Scrollrad) auf einen Kanal spielt eine kurze Testmelodie ab,
damit man auf die schnelle ein ausgewähltes Instrument vorhören kann.
Der *Klangest [E]* spielt durch einen Klick eine kurze Tonfolge ab. Das kann auch benutzt werden,
wenn der Haken bei [C] nicht gesetzt ist.
Die aktuelle *[E] Bank* wird immer als Nummer angezeigt. Man kann sie durch Auswahl in der Liste
Die aktuelle *[F] Bank* wird immer als Nummer angezeigt. Man kann sie durch Auswahl in der Liste
ändern. Es werden nur die Bänke angezgeit, die im aktuellen sf2 vorhanden sind.
Das aktuelle *[F] Program* ist das tatsächliche Instrument. Es wird mit seiner MIDI Nummer und
Das aktuelle *[G] Programm* ist das tatsächliche Instrument. Es wird mit seiner MIDI Nummer und
seinem tatsächlichen Name angezeigt. Es werden nur die Programme angezeigt, die im aktuellen sf2
vorhanden sind.
@ -119,8 +114,9 @@ Oft sind die Soundfonts allerdings falsch, indem sie mehr Instrumente anzeigen,
als sie tatsächlich haben. In diesem Fall wird man statt dessen irgend ein anderes (vorhandenes)
Instrument hören.
Es gibt keine interne Möglichkeit Fluajho zu *schließen*. Benutzt man die Funktion seinen
Fenstermanagers wie [X], Alt+F4 etc. wird die grafische Oberfläche lediglich versteckt.
Wenn Fluajho, wie angedacht, unter Session Management (Argodejo) läuft gibt keine interne Möglichkeit
es zu *schließen*. Benutzt man die Funktion seinen Fenstermanagers wie [X], Alt+F4 etc. wird die
grafische Oberfläche lediglich versteckt.
Um Fluajho wirklich zu schließen kann man Argodejo (New Session Manager) benutzen. Hier kann man
auch die Sichtbarkeit wieder herstellen, indem man auf den *GUI* Knopf klickt.

11
documentation/german.part.adoc

@ -1,3 +1,4 @@
== Benutzung
Schön, dass Sie sich für Fluajho entschieden haben. Fluajho ist ein Sampler für sf2 Soundfonts. Dies
@ -16,16 +17,6 @@ klar umrissenen Anwendungsfall geschrieben: Ein .sf2 im New Session Manager (Arg
das Soundfont im Sessionverzeichnis mit abzuspeichern. Das ermöglicht es die Session zu
archivieren, etwa als Backup oder um sie weiterzugeben.
=== Schnellstart
Um die wichtigsten Funktionen und Arbeitsabläufe kennenzulernen ist dieses Video erstellt worden.
video::https://www.laborejo.org/documentation/fluajho/fluajho-quickstart-german.mp4[width=500]
Oder auf Youtube
video::glb7McL-gJk[youtube, width=500]
=== Grundlagen
Fluajho läd genau ein `.sf2` Soundfont. Ein Soundfont kann mehrere Instrumente enthalten, davon

57
documentation/out/english.html

@ -447,8 +447,7 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b
<ul class="sectlevel1">
<li><a href="#_introduction">1. Introduction</a>
<ul class="sectlevel2">
<li><a href="#_quick_start">1.1. Quick Start</a></li>
<li><a href="#_basic_principles">1.2. Basic Principles</a></li>
<li><a href="#_basic_principles">1.1. Basic Principles</a></li>
</ul>
</li>
<li><a href="#_description_of_the_graphical_user_interface_and_its_functions">2. Description of the graphical user interface and its functions</a></li>
@ -494,28 +493,7 @@ instruments that can be assigned to 16 MIDI channels. Finally connect external s
Laborejo, Patroneo or Vico, through JACK-Midi to play the instruments.</p>
</div>
<div class="sect2">
<h3 id="_quick_start">1.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>
<div class="videoblock">
<div class="content">
<video src="https://www.laborejo.org/documentation/patroneo/fluajho-quickstart-english.mp4" width="500" controls>
Your browser does not support the video tag.
</video>
</div>
</div>
<div class="paragraph">
<p>Or as Youtube Mirror</p>
</div>
<div class="videoblock">
<div class="content">
<iframe width="500" src="https://www.youtube.com/embed/hiEgjT3aG-M?rel=0" frameborder="0" allowfullscreen></iframe>
</div>
</div>
</div>
<div class="sect2">
<h3 id="_basic_principles">1.2. Basic Principles</h3>
<h3 id="_basic_principles">1.1. Basic Principles</h3>
<div class="paragraph">
<p>Fluajho loads exactly one <code>.sf2</code> soundfont. A soundfont can contain several instruments, of which
up to 16 can be used simultaneously.</p>
@ -554,19 +532,16 @@ a "Save" button.</p>
</div>
</div>
<div class="paragraph">
<p>The <strong>[A] File</strong> menu contains only one command: "sf2 Soundfont load" (keyboard shortcut: Ctrl+O).
<p>The <strong>[A] File</strong> menu contains "sf2 Soundfont load" (keyboard shortcut: Ctrl+O).
Only one soundfont can be loaded at a time. If you want to use several different soundfonts at
once, just start Fluajho several times.</p>
once, just start Fluajho several times. Saving and Closing is also here.</p>
</div>
<div class="paragraph">
<p>It is also possible to load an .sf2 through drag &amp; drop from your file manager into the Fluajho
window.</p>
</div>
<div class="paragraph">
<p><strong>[B]</strong> is the name of the currently loaded file.</p>
</div>
<div class="paragraph">
<p>The option <strong>[C] Ignore MIDI Bank and Program Messages</strong> only allows instrument changes via the
<p>The option <strong>[B] Ignore MIDI Bank and Program Messages</strong> only allows instrument changes via the
graphical user interface. It ignores all messages coming in via the JACK Midi connection.</p>
</div>
<div class="paragraph">
@ -576,27 +551,33 @@ you have set all instruments, because a program change unfortunately happens fas
think.</p>
</div>
<div class="paragraph">
<p>The option <strong>[C] Play test sound after selecting a program</strong> can be activated to hear some played
notes right choosing a different instrument through the program change dropdown [G]. The test signal
is <strong>not</strong> played when changing an instrument through an external midi signal.</p>
</div>
<div class="paragraph">
<p>Channels are numbered <strong>[D] Channel N</strong> . MIDI supports exactly 16 channels, there is no adjustment
possible. More channels of the same soundfont can be obtained by simply starting another Fluajho
instance.</p>
instance. Next to the channel is a small rectangle that lights up if MIDI is coming in.</p>
</div>
<div class="paragraph">
<p>You can click with your middle mouse button (scroll wheel) on a channel to hear a short test
melody. This enables you to quickly prelisten an instrument.</p>
<p><strong>Play Test [E]</strong> plays some test notes after a click. This can be used even if option [C] is not
currently activated.</p>
</div>
<div class="paragraph">
<p>The current <strong>[E] Bank</strong> is always displayed as a number. You can choose them from the drop down
<p>The current <strong>[F] Bank</strong> is always displayed as a number. You can choose them from the drop down
list. Only the banks, which actually exist in the current sf2 are listed.</p>
</div>
<div class="paragraph">
<p>The current <strong>[F] Program</strong> is the instrument. It is displayed with its MIDI number and actual name.
<p>The current <strong>[G] Program</strong> is the instrument. It is displayed with its MIDI number and actual name.
Only the programs present in the sf2 are displayed.+ However, the soundfonts are often wrong in
that they display more instruments than they actually have. In this case you will hear a more or
less random (existing) instrument instead.</p>
</div>
<div class="paragraph">
<p>There is no internal way to <strong>close</strong> Fluajho. If you use the function of your window manager like
[X], Alt+F4 etc. the graphical user interface is only hidden.</p>
<p>If you run Fluajho under Session Management, as intended, tere is no internal way to <strong>close</strong> it.
If you use the function of your window manager like [X], Alt+F4 etc. the graphical user interface
is only hidden.</p>
</div>
<div class="paragraph">
<p>To really close Fluajho you can use Argodejo (New Session Manager). Here you can
@ -823,7 +804,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-06-19 21:39:08 +0200
Last updated 2020-06-27 13:09:50 +0200
</div>
</div>
</body>

61
documentation/out/german.html

@ -448,8 +448,7 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b
<li><a href="#_benutzung">1. Benutzung</a>
<ul class="sectlevel2">
<li><a href="#_anwendungszweck_und_zielgruppe">1.1. Anwendungszweck und Zielgruppe</a></li>
<li><a href="#_schnellstart">1.2. Schnellstart</a></li>
<li><a href="#_grundlagen">1.3. Grundlagen</a></li>
<li><a href="#_grundlagen">1.2. Grundlagen</a></li>
</ul>
</li>
<li><a href="#_beschreibung_der_grafischen_oberfläche_und_ihrer_funktionen">2. Beschreibung der grafischen Oberfläche und ihrer Funktionen</a></li>
@ -500,28 +499,7 @@ archivieren, etwa als Backup oder um sie weiterzugeben.</p>
</div>
</div>
<div class="sect2">
<h3 id="_schnellstart">1.2. Schnellstart</h3>
<div class="paragraph">
<p>Um die wichtigsten Funktionen und Arbeitsabläufe kennenzulernen ist dieses Video erstellt worden.</p>
</div>
<div class="videoblock">
<div class="content">
<video src="https://www.laborejo.org/documentation/fluajho/fluajho-quickstart-german.mp4" width="500" controls>
Your browser does not support the video tag.
</video>
</div>
</div>
<div class="paragraph">
<p>Oder auf Youtube</p>
</div>
<div class="videoblock">
<div class="content">
<iframe width="500" src="https://www.youtube.com/embed/glb7McL-gJk?rel=0" frameborder="0" allowfullscreen></iframe>
</div>
</div>
</div>
<div class="sect2">
<h3 id="_grundlagen">1.3. Grundlagen</h3>
<h3 id="_grundlagen">1.2. Grundlagen</h3>
<div class="paragraph">
<p>Fluajho läd genau ein <code>.sf2</code> Soundfont. Ein Soundfont kann mehrere Instrumente enthalten, davon
können bis zu 16 gleichzeitig benutzt werden.</p>
@ -562,19 +540,17 @@ Erläuterung zu suchen.</p>
</div>
</div>
<div class="paragraph">
<p>Im <strong>[A] Datei</strong> Menü befindet sich nur der Befehl "sf2 Soundfont laden" (Tastaturkürzel: Strg+O). Es
<p>Im <strong>[A] Datei</strong> Menü befindet sich der Befehl "sf2 Soundfont laden" (Tastaturkürzel: Strg+O). Es
kann jeweils nur ein Soundfont zur gleichen Zeit geladen werden. Möchten Sie mehrere verschiedene
Soundfonts auf einmal benutzen starten Sie Fluajho einfach mehrmals.</p>
Soundfonts auf einmal benutzen starten Sie Fluajho einfach mehrmals. Außerdem findet sich hier
Speichern und Beenden.</p>
</div>
<div class="paragraph">
<p>Es ist ebenfalls möglich ein .sf2 mit Drag&amp;Drop aus einem Dateimanager irgendwo in das
Fluajhofenster zu ziehen.</p>
</div>
<div class="paragraph">
<p>Bei <strong>[B]</strong> steht der Name der momentan geladenen Datei.</p>
</div>
<div class="paragraph">
<p>Die Option <strong>[C] Ignoriere MIDI Bank und Program Nachrichten</strong> lässt nur noch Instrumentenänderungen
<p>Die Option <strong>[B] Ignoriere MIDI Bank und Program Nachrichten</strong> lässt nur noch Instrumentenänderungen
über die grafische Benutzeroberfläche zu. Sie ignoriert alle Nachrichten, die über die JACK Midi
Verbindung herein kommen.</p>
</div>
@ -586,20 +562,26 @@ Instrumente eingestellt haben sperren Sie die Änderungen, denn ein Programm-Cha
schneller als man denkt.</p>
</div>
<div class="paragraph">
<p>Die Kanäle sind mit <strong>[D] Channel</strong> durchnummeriert. MIDI unterstützt genau 16 Kanäle, hier gibt es
<p>Die Option <strong>[C] Spiele Klangtest nach Programmauswahl</strong> kann aktiviert werden um direkt nach einer
Änderung des Instruments über die Programmauswahlbox[G] zu hören wie dieses klingt. Das Testsignal
wird <strong>nicht</strong> gespielt wenn Änderungen über MIDI gemacht werden.</p>
</div>
<div class="paragraph">
<p>Die Kanäle <strong>[D] Channel</strong> sind fest durchnummeriert. MIDI unterstützt genau 16 Kanäle, hier gibt es
keine Einstellmöglichkeit. Mehr Kanäle mit dem gleichen Soundfont erhält man, indem man Fluajho
einfach noch einmal startet.</p>
einfach noch einmal startet. Nebem dem Kanal befindet sich ein kleines Kästchen, dass bei
Midiaktivität aufleuchtet.</p>
</div>
<div class="paragraph">
<p>Ein Klick mit der mittleren Maustaste (Scrollrad) auf einen Kanal spielt eine kurze Testmelodie ab,
damit man auf die schnelle ein ausgewähltes Instrument vorhören kann.</p>
<p>Der <strong>Klangest [E]</strong> spielt durch einen Klick eine kurze Tonfolge ab. Das kann auch benutzt werden,
wenn der Haken bei [C] nicht gesetzt ist.</p>
</div>
<div class="paragraph">
<p>Die aktuelle <strong>[E] Bank</strong> wird immer als Nummer angezeigt. Man kann sie durch Auswahl in der Liste
<p>Die aktuelle <strong>[F] Bank</strong> wird immer als Nummer angezeigt. Man kann sie durch Auswahl in der Liste
ändern. Es werden nur die Bänke angezgeit, die im aktuellen sf2 vorhanden sind.</p>
</div>
<div class="paragraph">
<p>Das aktuelle <strong>[F] Program</strong> ist das tatsächliche Instrument. Es wird mit seiner MIDI Nummer und
<p>Das aktuelle <strong>[G] Programm</strong> ist das tatsächliche Instrument. Es wird mit seiner MIDI Nummer und
seinem tatsächlichen Name angezeigt. Es werden nur die Programme angezeigt, die im aktuellen sf2
vorhanden sind.</p>
</div>
@ -609,8 +591,9 @@ als sie tatsächlich haben. In diesem Fall wird man statt dessen irgend ein ande
Instrument hören.</p>
</div>
<div class="paragraph">
<p>Es gibt keine interne Möglichkeit Fluajho zu <strong>schließen</strong>. Benutzt man die Funktion seinen
Fenstermanagers wie [X], Alt+F4 etc. wird die grafische Oberfläche lediglich versteckt.</p>
<p>Wenn Fluajho, wie angedacht, unter Session Management (Argodejo) läuft gibt keine interne Möglichkeit
es zu <strong>schließen</strong>. Benutzt man die Funktion seinen Fenstermanagers wie [X], Alt+F4 etc. wird die
grafische Oberfläche lediglich versteckt.</p>
</div>
<div class="paragraph">
<p>Um Fluajho wirklich zu schließen kann man Argodejo (New Session Manager) benutzen. Hier kann man
@ -843,7 +826,7 @@ Ansonsten starten Sie fluajho mit diesem Befehl, Sprachcode ändern, vom Termina
</div>
<div id="footer">
<div id="footer-text">
Last updated 2020-06-19 21:39:08 +0200
Last updated 2020-06-27 13:09:50 +0200
</div>
</div>
</body>

2
engine/config.py

@ -21,7 +21,7 @@ METADATA={
#release announcements, entries in software directories etc.
"tagline" : 'SF2 soundfont sample player for JACK based on Fluidsynth.',
"version" : "1.5",
"version" : "1.6",
"year" : "2020",
"author" : "Laborejo Software Suite",
"url" : "https://www.laborejo.org/fluajho",

Loading…
Cancel
Save