Browse Source

update documentation and images

master
Nils 2 years ago
parent
commit
f3217132ce
  1. 16
      README.md
  2. 12
      documentation/english.adoc
  3. 4
      documentation/english.part.adoc
  4. 6
      documentation/fluajho.1
  5. 14
      documentation/german.adoc
  6. 8
      documentation/german.part.adoc
  7. 4
      documentation/manpageinclude.h2m
  8. 14
      documentation/out/english.html
  9. 16
      documentation/out/german.html
  10. 2
      engine/config.py

16
README.md

@ -1,5 +1,5 @@
[//]: # (Generated 2020-07-19T13:50:41.764639. Changes belong into template/documentation/readme.template)
[//]: # (Generated 2020-07-24T13:17:50.705959. Changes belong into template/documentation/readme.template)
#Fluajho
Program version 1.6.1
@ -13,7 +13,7 @@ is still in moderate use today.
Why does Fluajho exist? There are many soundfont players for Linux,
most of them even based on Fluidsynth. Fluajho was written for a clearly defined use case:
Load an .sf2 in the New Session Manager (Argodejo) and save the soundfont in the session directory.
Load an .sf2 in the New Session Manager (Agordejo) and save the soundfont in the session directory.
This makes it possible to archive the session, for example as a backup or to share it.
You can load one soundfont file per Fluajho instance. Each instance holds 16 of the soundfonts
@ -57,7 +57,7 @@ It is possible to clone a git repository.
### Environment:
* Jack Audio Connection Kit must be running
* Argodejo / New Session Manager ("NSM")
* Agordejo / New Session Manager ("NSM")
## Build
./configure --prefix=/usr/local
@ -72,15 +72,15 @@ system as you want.
We make no distinction if you installed Fluajho yourself or through the distributions package-manager.
The differences are: With or without Argodejo, with or without sound, installed or from the source dir.
The differences are: With or without Agordejo, with or without sound, installed or from the source dir.
### Installed , running through Argodejo (New Session Manager) (recommended)
Starting Fluajho through Argodejo after you installed fluajho system-wide
is the recommended and only supported way. Start argodejo and load or create a new
### Installed , running through Agordejo (New Session Manager) (recommended)
Starting Fluajho through Agordejo after you installed fluajho system-wide
is the recommended and only supported way. Start agordejo and load or create a new
session. Then use the program launcher to add `fluajho`.
It should appear with an icon in the list and open its GUI.
### Installed without Argodejo
### Installed without Agordejo
If you start fluajho directly it will present you with a dialog to choose your session directory.
You can also start fluajho from a terminal (or create a starter script).

12
documentation/english.adoc

@ -38,7 +38,7 @@ is still in moderate use today.
Why does Fluajho exist? There are many soundfont players for Linux,
most of them even based on Fluidsynth. Fluajho was written for a clearly defined use case:
Load an .sf2 in the New Session Manager (Argodejo) and save the soundfont in the session directory.
Load an .sf2 in the New Session Manager (Agordejo) and save the soundfont in the session directory.
This makes it possible to archive the session, for example as a backup or to share it.
You can load one soundfont file per Fluajho instance. Each instance holds 16 of the soundfonts
@ -63,7 +63,7 @@ sequencer.
Each channel has two separate audio outputs in JACK: Left and Right.
Saving and loading your project is done by the New Session Manager (Argodejo). There you will find
Saving and loading your project is done by the New Session Manager (Agordejo). There you will find
a "Save" button.
== Description of the graphical user interface and its functions
@ -112,7 +112,7 @@ If you run Fluajho under Session Management, as intended, tere is no internal wa
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
To really close Fluajho you can use Agordejo (New Session Manager). Here you can
also restore visibility by showing the GUI again.
The current visibility setting is saved. This is because you normally only spend a relatively short
@ -124,7 +124,7 @@ time loading a soundfont. Afterwards, the window would only get in the way.
Fluajho 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 fluajho from Argodejo / New Session Manager".
If available in the package repository, please continue reading directly at "Start fluajho from Agordejo / New Session Manager".
If not, you can build Fluajho yourself.
.Build and Install
@ -138,8 +138,8 @@ If not, you can build Fluajho yourself.
* `make`
* `sudo make install`
.Start fluajho from Argodejo (New Session Manager, NSM)
* Run `argodejo`
.Start fluajho from Agordejo (New Session Manager, NSM)
* Run `agordejo`
* Press the `New` button, and enter a name for your piece of music.
* Use the launcher to add `fluajho` to the session.
* Add any compatible programs, e.g. synthesizers.

4
documentation/english.part.adoc

@ -15,7 +15,7 @@ sequencer.
Each channel has two separate audio outputs in JACK: Left and Right.
Saving and loading your project is done by the New Session Manager (Argodejo). There you will find
Saving and loading your project is done by the New Session Manager (Agordejo). There you will find
a "Save" button.
== Description of the graphical user interface and its functions
@ -64,7 +64,7 @@ If you run Fluajho under Session Management, as intended, tere is no internal wa
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
To really close Fluajho you can use Agordejo (New Session Manager). Here you can
also restore visibility by showing the GUI again.
The current visibility setting is saved. This is because you normally only spend a relatively short

6
documentation/fluajho.1

@ -17,7 +17,7 @@ show program's version number and exit
.TP
\fB\-s\fR DIRECTORY, \fB\-\-save\fR DIRECTORY
Use this directory to save. Will be created or loaded
from if already present. Deactivates Argodejo/NewSession\-Manager support.
from if already present. Deactivates Agordejo/NewSession\-Manager support.
.TP
\fB\-p\fR, \fB\-\-profiler\fR
(Development) Run the python profiler and produce a
@ -42,14 +42,14 @@ is still in moderate use today.
Why does Fluajho exist? There are many soundfont players for Linux,
most of them even based on Fluidsynth. Fluajho was written for a clearly defined use case:
Load an .sf2 in the New Session Manager (Argodejo) and save the soundfont in the session directory.
Load an .sf2 in the New Session Manager (Agordejo) and save the soundfont in the session directory.
This makes it possible to archive the session, for example as a backup or to share it.
You can load one soundfont file per Fluajho instance. Each instance holds 16 of the soundfonts
instruments that can be assigned to 16 MIDI channels. Finally connect external sequencers, such as
Laborejo, Patroneo or Vico, through JACK-Midi to play the instruments.
.SH EXAMPLES
Start fluajho through NSM, e.g. through Argodejo. This will take care of all
Start fluajho through NSM, e.g. through Agordejo. This will take care of all
settings and save directories.
Other modes of operations, mostly for testing, are:

14
documentation/german.adoc

@ -42,7 +42,7 @@ arbeitet die Programmbibliothek "Fluidsynth".
=== Anwendungszweck und Zielgruppe
Es gibt viele Soundfontsampler für Linux, die meisten auf Fluidsynthbasis. Fluajho wurde für einen
klar umrissenen Anwendungsfall geschrieben: Ein .sf2 im New Session Manager (Argodejo) laden und
klar umrissenen Anwendungsfall geschrieben: Ein .sf2 im New Session Manager (Agordejo) laden und
das Soundfont im Sessionverzeichnis mit abzuspeichern. Das ermöglicht es die Session zu
archivieren, etwa als Backup oder um sie weiterzugeben.
@ -63,7 +63,7 @@ bereits im Sequencer ausgewählt.
Jeder Kanal hat zwei eigenene Audioausgänge in JACK: Links und Rechts.
Das Speichern und Laden ihres Projektes wird durch den New Session Manager (Argodejo) erledigt.
Das Speichern und Laden ihres Projektes wird durch den New Session Manager (Agordejo) erledigt.
Dort befindet sich ein "Save" Knopf.
== Beschreibung der grafischen Oberfläche und ihrer Funktionen
@ -114,11 +114,11 @@ 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.
Wenn Fluajho, wie angedacht, unter Session Management (Argodejo) läuft gibt keine interne Möglichkeit
Wenn Fluajho, wie angedacht, unter Session Management (Agordejo) 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
Um Fluajho wirklich zu schließen kann man Agordejo (New Session Manager) benutzen. Hier kann man
auch die Sichtbarkeit wieder herstellen, indem man auf den *GUI* Knopf klickt.
Die momentane Sichtbarkeitseinstellung wird gespeichert. Das hat den Grund, dass man normalerweise
@ -133,7 +133,7 @@ Fluajho ist exklusiv für Linux. Am besten installieren Sie Fluajho über deinen
Falls es dort nicht vorhanden ist, oder nur in einer veralteten Version, bitten sie ihre
Linuxdistribution Fluajho bereitzustellen.
Falls in den Paketquellen vorhanden bitte direkt bei "fluajho in Argodejo (New Session Manager)" weiterlesen.
Falls in den Paketquellen vorhanden bitte direkt bei "fluajho in Agordejo (New Session Manager)" weiterlesen.
Falls nicht kann man Fluajho auch selbst "bauen".
.Abhängigkeiten*
@ -147,8 +147,8 @@ Falls nicht kann man Fluajho auch selbst "bauen".
* `make`
* `sudo make install`
.fluajho im Argodejo (New Session Manager, NSM) starten
* Starten Sie `argodejo`
.fluajho im Agordejo (New Session Manager, NSM) starten
* Starten Sie `agordejo`
* Erstellen Sie eine neue Session, geben Sie einen Namen für das Musikstück ein.
* Benutzen Sie den Launcher um `fluajho` hinzuzufügen.
* Fügen Sie beliebige kompatible Programme hinzu, z.B. Synthesizer.

8
documentation/german.part.adoc

@ -13,7 +13,7 @@ arbeitet die Programmbibliothek "Fluidsynth".
=== Anwendungszweck und Zielgruppe
Es gibt viele Soundfontsampler für Linux, die meisten auf Fluidsynthbasis. Fluajho wurde für einen
klar umrissenen Anwendungsfall geschrieben: Ein .sf2 im New Session Manager (Argodejo) laden und
klar umrissenen Anwendungsfall geschrieben: Ein .sf2 im New Session Manager (Agordejo) laden und
das Soundfont im Sessionverzeichnis mit abzuspeichern. Das ermöglicht es die Session zu
archivieren, etwa als Backup oder um sie weiterzugeben.
@ -34,7 +34,7 @@ bereits im Sequencer ausgewählt.
Jeder Kanal hat zwei eigenene Audioausgänge in JACK: Links und Rechts.
Das Speichern und Laden ihres Projektes wird durch den New Session Manager (Argodejo) erledigt.
Das Speichern und Laden ihres Projektes wird durch den New Session Manager (Agordejo) erledigt.
Dort befindet sich ein "Save" Knopf.
== Beschreibung der grafischen Oberfläche und ihrer Funktionen
@ -85,11 +85,11 @@ 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.
Wenn Fluajho, wie angedacht, unter Session Management (Argodejo) läuft gibt keine interne Möglichkeit
Wenn Fluajho, wie angedacht, unter Session Management (Agordejo) 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
Um Fluajho wirklich zu schließen kann man Agordejo (New Session Manager) benutzen. Hier kann man
auch die Sichtbarkeit wieder herstellen, indem man auf den *GUI* Knopf klickt.
Die momentane Sichtbarkeitseinstellung wird gespeichert. Das hat den Grund, dass man normalerweise

4
documentation/manpageinclude.h2m

@ -12,7 +12,7 @@ is still in moderate use today.
Why does Fluajho exist? There are many soundfont players for Linux,
most of them even based on Fluidsynth. Fluajho was written for a clearly defined use case:
Load an .sf2 in the New Session Manager (Argodejo) and save the soundfont in the session directory.
Load an .sf2 in the New Session Manager (Agordejo) and save the soundfont in the session directory.
This makes it possible to archive the session, for example as a backup or to share it.
You can load one soundfont file per Fluajho instance. Each instance holds 16 of the soundfonts
@ -29,7 +29,7 @@ Laborejo Software Suite
https://www.laborejo.org/
[examples]
Start fluajho through NSM, e.g. through Argodejo. This will take care of all
Start fluajho through NSM, e.g. through Agordejo. This will take care of all
settings and save directories.
Other modes of operations, mostly for testing, are:

14
documentation/out/english.html

@ -484,7 +484,7 @@ host/player for Linux. Behind the scenes the Fluidsynth library is at work, henc
<div class="paragraph">
<p>Why does Fluajho exist? There are many soundfont players for Linux,
most of them even based on Fluidsynth. Fluajho was written for a clearly defined use case:
Load an .sf2 in the New Session Manager (Argodejo) and save the soundfont in the session directory.
Load an .sf2 in the New Session Manager (Agordejo) and save the soundfont in the session directory.
This makes it possible to archive the session, for example as a backup or to share it.</p>
</div>
<div class="paragraph">
@ -514,7 +514,7 @@ sequencer.</p>
<p>Each channel has two separate audio outputs in JACK: Left and Right.</p>
</div>
<div class="paragraph">
<p>Saving and loading your project is done by the New Session Manager (Argodejo). There you will find
<p>Saving and loading your project is done by the New Session Manager (Agordejo). There you will find
a "Save" button.</p>
</div>
</div>
@ -580,7 +580,7 @@ If you use the function of your window manager like [X], Alt+F4 etc. the graphic
is only hidden.</p>
</div>
<div class="paragraph">
<p>To really close Fluajho you can use Argodejo (New Session Manager). Here you can
<p>To really close Fluajho you can use Agordejo (New Session Manager). Here you can
also restore visibility by showing the GUI again.</p>
</div>
<div class="paragraph">
@ -597,7 +597,7 @@ time loading a soundfont. Afterwards, the window would only get in the way.</p>
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 fluajho from Argodejo / New Session Manager".
<p>If available in the package repository, please continue reading directly at "Start fluajho from Agordejo / New Session Manager".
If not, you can build Fluajho yourself.</p>
</div>
<div class="ulist">
@ -641,10 +641,10 @@ If not, you can build Fluajho yourself.</p>
</ul>
</div>
<div class="ulist">
<div class="title">Start fluajho from Argodejo (New Session Manager, NSM)</div>
<div class="title">Start fluajho from Agordejo (New Session Manager, NSM)</div>
<ul>
<li>
<p>Run <code>argodejo</code></p>
<p>Run <code>agordejo</code></p>
</li>
<li>
<p>Press the <code>New</code> button, and enter a name for your piece of music.</p>
@ -804,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-07-19 13:50:41 +0200
Last updated 2020-07-24 13:17:50 +0200
</div>
</div>
</body>

16
documentation/out/german.html

@ -493,7 +493,7 @@ arbeitet die Programmbibliothek "Fluidsynth".</p>
<h3 id="_anwendungszweck_und_zielgruppe">1.1. Anwendungszweck und Zielgruppe</h3>
<div class="paragraph">
<p>Es gibt viele Soundfontsampler für Linux, die meisten auf Fluidsynthbasis. Fluajho wurde für einen
klar umrissenen Anwendungsfall geschrieben: Ein .sf2 im New Session Manager (Argodejo) laden und
klar umrissenen Anwendungsfall geschrieben: Ein .sf2 im New Session Manager (Agordejo) laden und
das Soundfont im Sessionverzeichnis mit abzuspeichern. Das ermöglicht es die Session zu
archivieren, etwa als Backup oder um sie weiterzugeben.</p>
</div>
@ -521,7 +521,7 @@ bereits im Sequencer ausgewählt.</p>
<p>Jeder Kanal hat zwei eigenene Audioausgänge in JACK: Links und Rechts.</p>
</div>
<div class="paragraph">
<p>Das Speichern und Laden ihres Projektes wird durch den New Session Manager (Argodejo) erledigt.
<p>Das Speichern und Laden ihres Projektes wird durch den New Session Manager (Agordejo) erledigt.
Dort befindet sich ein "Save" Knopf.</p>
</div>
</div>
@ -591,12 +591,12 @@ als sie tatsächlich haben. In diesem Fall wird man statt dessen irgend ein ande
Instrument hören.</p>
</div>
<div class="paragraph">
<p>Wenn Fluajho, wie angedacht, unter Session Management (Argodejo) läuft gibt keine interne Möglichkeit
<p>Wenn Fluajho, wie angedacht, unter Session Management (Agordejo) 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
<p>Um Fluajho wirklich zu schließen kann man Agordejo (New Session Manager) benutzen. Hier kann man
auch die Sichtbarkeit wieder herstellen, indem man auf den <strong>GUI</strong> Knopf klickt.</p>
</div>
<div class="paragraph">
@ -615,7 +615,7 @@ Falls es dort nicht vorhanden ist, oder nur in einer veralteten Version, bitten
Linuxdistribution Fluajho bereitzustellen.</p>
</div>
<div class="paragraph">
<p>Falls in den Paketquellen vorhanden bitte direkt bei "fluajho in Argodejo (New Session Manager)" weiterlesen.
<p>Falls in den Paketquellen vorhanden bitte direkt bei "fluajho in Agordejo (New Session Manager)" weiterlesen.
Falls nicht kann man Fluajho auch selbst "bauen".</p>
</div>
<div class="ulist">
@ -657,10 +657,10 @@ Falls nicht kann man Fluajho auch selbst "bauen".</p>
</ul>
</div>
<div class="ulist">
<div class="title">fluajho im Argodejo (New Session Manager, NSM) starten</div>
<div class="title">fluajho im Agordejo (New Session Manager, NSM) starten</div>
<ul>
<li>
<p>Starten Sie <code>argodejo</code></p>
<p>Starten Sie <code>agordejo</code></p>
</li>
<li>
<p>Erstellen Sie eine neue Session, geben Sie einen Namen für das Musikstück ein.</p>
@ -826,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-07-19 13:50:41 +0200
Last updated 2020-07-24 13:17:50 +0200
</div>
</div>
</body>

2
engine/config.py

@ -56,7 +56,7 @@ is still in moderate use today.
Why does Fluajho exist? There are many soundfont players for Linux,
most of them even based on Fluidsynth. Fluajho was written for a clearly defined use case:
Load an .sf2 in the New Session Manager (Argodejo) and save the soundfont in the session directory.
Load an .sf2 in the New Session Manager (Agordejo) and save the soundfont in the session directory.
This makes it possible to archive the session, for example as a backup or to share it.
You can load one soundfont file per Fluajho instance. Each instance holds 16 of the soundfonts

Loading…
Cancel
Save