Browse Source

Update documentation and info files

master
Nils 9 months ago
parent
commit
ce090b7f4a
  1. 1
      CHANGELOG
  2. 20
      README.md
  3. 2
      configure
  4. 20
      documentation/english.adoc
  5. 28
      documentation/fluajho.1
  6. 21
      documentation/german.adoc
  7. 4
      documentation/index.adoc
  8. 22
      documentation/manpageinclude.h2m
  9. 23
      documentation/out/english.html
  10. 17
      documentation/out/german.html
  11. 2
      documentation/out/index.html

1
CHANGELOG

@ -9,6 +9,7 @@ External contributors notice at the end of the line: (LastName, FirstName / nick
Fluajho is now complete. All further updates will be maintenance and bugfixes.
The save file (and therefore NSM Sessions) format is now permanently stable.
This CHANGELOG is now available through the programs help menu directly.
Icons are now send to JACK Metadata.
Improvement on the codebase to make future maintenance easier.

20
README.md

@ -1,8 +1,8 @@
[//]: # (Generated 2021-11-12T18:03:52.345205. Changes belong into template/documentation/readme.template)
[//]: # (Generated 2022-01-03T01:10:17.035367. Changes belong into template/documentation/readme.template)
#Fluajho
Program version 1.7.0
Program version 1.7.1
![Screenshot](https://git.laborejo.org/lss/Fluajho/raw/branch/master/documentation/screenshot.png "Screenshot")
@ -12,17 +12,27 @@ Program version 1.7.0
"Fluajho" (with jh as in pleasure) means fluid in Esperanto. It is a simple sf2 soundfont
host/player for Linux. Behind the scenes the Fluidsynth library is at work, hence the name.
This program is feature-complete with version 1.7.1 in 2022.
Further releases will be limited to maintenance and fixing problems.
.sf2 is an old file format for making MIDI signals audible through virtual instruments, although it
is still in moderate use today.
Why does Fluajho exist? There are many soundfont players for Linux,
Why does Fluajho exist? There are already 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 (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.
If you already have a DAW, host or plugin that reliably saves soundfont files together with the
session you do not need Fluajho.
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.
instruments that can be assigned to 16 MIDI channels. All access to MIDI parameters like Volume or
Pan needs to be done via midi control changes.
Finally connect external sequencers, such as Laborejo or Patroneo, through JACK-Midi to play the
instruments. There is only one JACK-Midi input but each of the 16 midi channels has it's own stereo
JACK audio output. Additionally there is a stereo mix output pair.
This README is just a short introduction. Consult the manual (see below) for more information.

2
configure

@ -1,6 +1,6 @@
#!/bin/bash
program=fluajho
cboxconfigure="--without-libsmf"
version=1.7.0
version=1.7.1
. template/configure.template #. is the posix compatible version of source

20
documentation/english.adoc

@ -1,5 +1,5 @@
:Author: Laborejo Software Suite
:Version: 1.7.0
:Version: 1.7.1
:iconfont-remote!:
:!webfonts:
@ -25,7 +25,7 @@ https://asciidoctor.org/docs/user-manual/
= Fluajho
// Don't write in the empty line above line. It will be interpreted as author html tag
For program version 1.7.0
For program version 1.7.1
== Introduction
@ -33,17 +33,27 @@ For program version 1.7.0
"Fluajho" (with jh as in pleasure) means fluid in Esperanto. It is a simple sf2 soundfont
host/player for Linux. Behind the scenes the Fluidsynth library is at work, hence the name.
This program is feature-complete with version 1.7.1 in 2022.
Further releases will be limited to maintenance and fixing problems.
.sf2 is an old file format for making MIDI signals audible through virtual instruments, although it
is still in moderate use today.
Why does Fluajho exist? There are many soundfont players for Linux,
Why does Fluajho exist? There are already 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 (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.
If you already have a DAW, host or plugin that reliably saves soundfont files together with the
session you do not need Fluajho.
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.
instruments that can be assigned to 16 MIDI channels. All access to MIDI parameters like Volume or
Pan needs to be done via midi control changes.
Finally connect external sequencers, such as Laborejo or Patroneo, through JACK-Midi to play the
instruments. There is only one JACK-Midi input but each of the 16 midi channels has it's own stereo
JACK audio output. Additionally there is a stereo mix output pair.

28
documentation/fluajho.1

@ -1,13 +1,13 @@
.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.48.5.
.TH FLUAJHO "1" "November 2021" "Fluajho 1.7.0" "User Commands"
.TH FLUAJHO "1" "January 2022" "Fluajho 1.7.1" "User Commands"
.SH NAME
Fluajho - SF2 soundfont sample player for JACK based on Fluidsynth.
.SH DESCRIPTION
usage: fluajho [\-h] [\-v] [\-s DIRECTORY] [\-p] [\-m] [\-V]
.PP
Fluajho \- Version 1.7.0 \- Copyright 2021 by Laborejo Software Suite \-
Fluajho \- Version 1.7.1 \- Copyright 2022 by Laborejo Software Suite \-
https://www.laborejo.org/fluajho
.SS "optional arguments:"
.SS "options:"
.TP
\fB\-h\fR, \fB\-\-help\fR
show this help message and exit
@ -37,32 +37,42 @@ what the program is doing.
"Fluajho" (with jh as in pleasure) means fluid in Esperanto. It is a simple sf2 soundfont
host/player for Linux. Behind the scenes the Fluidsynth library is at work, hence the name.
This program is feature-complete with version 1.7.1 in 2022.
Further releases will be limited to maintenance and fixing problems.
.sf2 is an old file format for making MIDI signals audible through virtual instruments, although it
is still in moderate use today.
Why does Fluajho exist? There are many soundfont players for Linux,
Why does Fluajho exist? There are already 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 (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.
If you already have a DAW, host or plugin that reliably saves soundfont files together with the
session you do not need Fluajho.
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.
instruments that can be assigned to 16 MIDI channels. All access to MIDI parameters like Volume or
Pan needs to be done via midi control changes.
Finally connect external sequencers, such as Laborejo or Patroneo, through JACK-Midi to play the
instruments. There is only one JACK-Midi input but each of the 16 midi channels has it's own stereo
JACK audio output. Additionally there is a stereo mix output pair.
.SH EXAMPLES
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:
Run without session management and save in /tmp.
Run without session management and save in /tmp.
fluajho --save /tmp
Run without audio and midi. Skips all JACK checks. Used to just look at the GUI, e.g. to make screenshots
fluajho --mute
fluajho --mute
.SH "REPORTING BUGS"
https://www.laborejo.org/bugs
.SH COPYRIGHT
Fluajho 1.7.0 - Copyright 2021
Fluajho 1.7.1 - Copyright 2022
Laborejo Software Suite
https://www.laborejo.org/
.SH "SEE ALSO"

21
documentation/german.adoc

@ -1,5 +1,5 @@
:Author: Laborejo Software Suite
:Version: 1.7.0
:Version: 1.7.1
:iconfont-remote!:
:!webfonts:
@ -25,7 +25,7 @@ https://asciidoctor.org/docs/user-manual/
= Fluajho
// Don't write in the empty line above line. It will be interpreted as author html tag
Für Programmversion 1.7.0
Für Programmversion 1.7.1
== Benutzung
@ -130,19 +130,19 @@ Weg.
== Installation und Start
Fluajho ist exklusiv für Linux. Am besten installieren Sie Fluajho über deinen Paketmanager.
Falls es dort nicht vorhanden ist, oder nur in einer veralteten Version, bitten sie ihre
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 Agordejo (New Session Manager)" weiterlesen.
Falls nicht kann man Fluajho auch selbst "bauen".
.Abhängigkeiten*
.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:
** Laden Sie von https://www.laborejo.org/downloads die aktuelle Version herunter und entpacken Sie sie.
** Laden Sie von https://www.laborejo.org/downloads die aktuelle Version herunter und entpacken Sie sie.
** `git clone https://git.laborejo.org/lss/fluajho.git`
* Wechseln Sie in das neue Verzeichnis und benutzen diese Befehle:
*`./configure --prefix=/usr`
** `./configure --prefix=/usr`
** Das Standardprefix is /usr/local
* `make`
* `sudo make install`
@ -178,8 +178,8 @@ Kurzversion: clone git, programmieren, einen git-patch erstellen oder uns eine g
Fluajho 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. Das Programm ist in zwei Teile aufgeteilt: Ein gemeinsames "Template"
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
@ -204,9 +204,10 @@ So fügt man eine neue Sprache hinzu:
Die Übersetzung können Sie auch selbst, zum Testen, 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 die `.ts` Datei.* Bearbeiten Sie `template/qtgui/resources/resources.qrc` und kopieren die Zeile `<file>translations/de.qm</file>` . Dabei das Länderkürzel zum Neuen ändern.
* Im Qt Linguist "Datei" Menü ist eine "Release" Option. Das erstellt eine `.qm` Datei im gleichen Verzeichnis wie die `.ts` Datei.
* Bearbeiten Sie `template/qtgui/resources/resources.qrc` und kopieren die Zeile `<file>translations/de.qm</file>` . Dabei das Länderkürzel zum Neuen ändern.
* Führen Sie `sh buildresources.sh` aus
* Bearbeiten Sie `engine/config.py`: Die neue Sprache hinzufügen. z.B. `{"German":"de.qm", "Esperanto:"eo.qm"}`
* Bearbeiten Sie `engine/config.py`: Die neue Sprache hinzufügen. z.B. `{"German":"de.qm", "Esperanto:"eo.qm"}`
** Um den Sprachstring herauszufinden öffnen Sie den `python3`-Interpreter im Terminal und führen aus:
** `from PyQt5 import QtCore;QtCore.QLocale().languageToString(QtCore.QLocale().language())`

4
documentation/index.adoc

@ -1,5 +1,5 @@
:Author: Laborejo Software Suite
:Version: 1.7.0
:Version: 1.7.1
:iconfont-remote!:
:!webfonts:
@ -21,7 +21,7 @@ https://asciidoctor.org/docs/user-manual/
== Fluajho Multi-Language Documentation
image::logo.png["logo", 320, 180]
For program version 1.7.0
For program version 1.7.1
This site is part of the https://www.laborejo.org[Laborejo Software Suite]

22
documentation/manpageinclude.h2m

@ -7,24 +7,34 @@ Fluajho - SF2 soundfont sample player for JACK based on Fluidsynth.
"Fluajho" (with jh as in pleasure) means fluid in Esperanto. It is a simple sf2 soundfont
host/player for Linux. Behind the scenes the Fluidsynth library is at work, hence the name.
This program is feature-complete with version 1.7.1 in 2022.
Further releases will be limited to maintenance and fixing problems.
.sf2 is an old file format for making MIDI signals audible through virtual instruments, although it
is still in moderate use today.
Why does Fluajho exist? There are many soundfont players for Linux,
Why does Fluajho exist? There are already 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 (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.
If you already have a DAW, host or plugin that reliably saves soundfont files together with the
session you do not need Fluajho.
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.
instruments that can be assigned to 16 MIDI channels. All access to MIDI parameters like Volume or
Pan needs to be done via midi control changes.
Finally connect external sequencers, such as Laborejo or Patroneo, through JACK-Midi to play the
instruments. There is only one JACK-Midi input but each of the 16 midi channels has it's own stereo
JACK audio output. Additionally there is a stereo mix output pair.
[Reporting bugs]
https://www.laborejo.org/bugs
[copyright]
Fluajho 1.7.0 - Copyright 2021
Fluajho 1.7.1 - Copyright 2022
Laborejo Software Suite
https://www.laborejo.org/
@ -34,11 +44,11 @@ settings and save directories.
Other modes of operations, mostly for testing, are:
Run without session management and save in /tmp.
Run without session management and save in /tmp.
fluajho --save /tmp
Run without audio and midi. Skips all JACK checks. Used to just look at the GUI, e.g. to make screenshots
fluajho --mute
fluajho --mute
[see also]
The full documentation for Fluajho is maintained as a multi-lingual html site to your systems doc-dir.

23
documentation/out/english.html

@ -467,7 +467,7 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b
<div id="preamble">
<div class="sectionbody">
<div class="paragraph">
<p>For program version 1.7.0</p>
<p>For program version 1.7.1</p>
</div>
</div>
</div>
@ -479,19 +479,32 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b
host/player for Linux. Behind the scenes the Fluidsynth library is at work, hence the name.</p>
</div>
<div class="paragraph">
<p>This program is feature-complete with version 1.7.1 in 2022.
Further releases will be limited to maintenance and fixing problems.</p>
</div>
<div class="paragraph">
<div class="title">sf2 is an old file format for making MIDI signals audible through virtual instruments, although it</div>
<p>is still in moderate use today.</p>
</div>
<div class="paragraph">
<p>Why does Fluajho exist? There are many soundfont players for Linux,
<p>Why does Fluajho exist? There are already 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 (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">
<p>If you already have a DAW, host or plugin that reliably saves soundfont files together with the
session you do not need Fluajho.</p>
</div>
<div class="paragraph">
<p>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.</p>
instruments that can be assigned to 16 MIDI channels. All access to MIDI parameters like Volume or
Pan needs to be done via midi control changes.</p>
</div>
<div class="paragraph">
<p>Finally connect external sequencers, such as Laborejo or Patroneo, through JACK-Midi to play the
instruments. There is only one JACK-Midi input but each of the 16 midi channels has it&#8217;s own stereo
JACK audio output. Additionally there is a stereo mix output pair.</p>
</div>
<div class="sect2">
<h3 id="_basic_principles">1.1. Basic Principles</h3>
@ -805,7 +818,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 2021-11-12 18:03:52 +0100
Last updated 2022-01-03 01:10:17 +0100
</div>
</div>
</body>

17
documentation/out/german.html

@ -471,7 +471,7 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b
<div id="preamble">
<div class="sectionbody">
<div class="paragraph">
<p>Für Programmversion 1.7.0</p>
<p>Für Programmversion 1.7.1</p>
</div>
</div>
</div>
@ -620,7 +620,7 @@ Linuxdistribution Fluajho bereitzustellen.</p>
Falls nicht kann man Fluajho auch selbst "bauen".</p>
</div>
<div class="ulist">
<div class="title">Abhängigkeiten*</div>
<div class="title">Abhängigkeiten</div>
<ul>
<li>
<p>Eine Liste der Abhängigkeit befindet sich in der README.md</p>
@ -639,11 +639,13 @@ Falls nicht kann man Fluajho auch selbst "bauen".</p>
</div>
</li>
<li>
<p>Wechseln Sie in das neue Verzeichnis und benutzen diese Befehle:
*<code>./configure --prefix=/usr</code></p>
<p>Wechseln Sie in das neue Verzeichnis und benutzen diese Befehle:</p>
<div class="ulist">
<ul>
<li>
<p><code>./configure --prefix=/usr</code></p>
</li>
<li>
<p>Das Standardprefix is /usr/local</p>
</li>
</ul>
@ -789,7 +791,10 @@ Python Kentnisse nötig.</p>
<div class="ulist">
<ul>
<li>
<p>Im Qt Linguist "Datei" Menü ist eine "Release" Option. Das erstellt eine <code>.qm</code> Datei im gleichen Verzeichnis wie die <code>.ts</code> Datei.* Bearbeiten Sie <code>template/qtgui/resources/resources.qrc</code> und kopieren die Zeile <code>&lt;file&gt;translations/de.qm&lt;/file&gt;</code> . Dabei das Länderkürzel zum Neuen ändern.</p>
<p>Im Qt Linguist "Datei" Menü ist eine "Release" Option. Das erstellt eine <code>.qm</code> Datei im gleichen Verzeichnis wie die <code>.ts</code> Datei.</p>
</li>
<li>
<p>Bearbeiten Sie <code>template/qtgui/resources/resources.qrc</code> und kopieren die Zeile <code>&lt;file&gt;translations/de.qm&lt;/file&gt;</code> . Dabei das Länderkürzel zum Neuen ändern.</p>
</li>
<li>
<p>Führen Sie <code>sh buildresources.sh</code> aus</p>
@ -827,7 +832,7 @@ Ansonsten starten Sie fluajho mit diesem Befehl, Sprachcode ändern, vom Termina
</div>
<div id="footer">
<div id="footer-text">
Last updated 2021-11-12 18:03:52 +0100
Last updated 2022-01-03 01:10:17 +0100
</div>
</div>
</body>

2
documentation/out/index.html

@ -449,7 +449,7 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b
</div>
</div>
<div class="paragraph">
<p>For program version 1.7.0</p>
<p>For program version 1.7.1</p>
</div>
<div class="paragraph">
<p>This site is part of the <a href="https://www.laborejo.org">Laborejo Software Suite</a></p>

Loading…
Cancel
Save