Browse Source

Update documentation

Former-commit-id: 08f2a144caad380b6050b12d31034828a6f2e980
master
Nils 4 years ago
parent
commit
9eb6762e8c
  1. 170
      documentation/english.adoc
  2. 196
      documentation/german.adoc
  3. 5
      documentation/index.adoc
  4. 303
      documentation/out/english.html
  5. 342
      documentation/out/german.html

170
documentation/english.adoc

@ -0,0 +1,170 @@
: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
= Fluajho
== Usage
We are happy you chose Fluajho. Fluajho is a sampler for sf2 soundfonts. This is a legacy file format for making MIDI signals audible through virtual instruments.
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.
"Fluajho" (with jh as in pleasure) means fluid in Esperanto. Behind the scenes the "Fluidsynth" software library is at work.
=== Purpose and target audience
There are many soundfont samplers for Linux, most of them based on fluidsynth. Fluajho was written for a clearly defined use case: Load an .sf2 in the Non Session Manager 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.
=== Quick Start
To get to know the most important functions and workflows, this video has been created.
video::fluajho-quickstart-english.mp4[width=500]
Or as Youtube Mirror
video::hiEgjT3aG-M[youtube, width=500]
=== Basic Principles
Fluajho loads exactly one `.sf2` soundfont. A soundfont can contain several instruments, of which up to 16 can be used simultaneously.
Each of the instruments can be loaded into one MIDI channel. To do this, first select a bank in a channel (Bank 0 if in doubt) and then a program.
On the first launch a small standard soundfont is loaded, which is General Midi (GM) compatible.
Fluajho itself has no option to play notes. To control the sounds, you send MIDI data to our input port via JACK. The channel is a property of the midi signal and is already selected in the sequencer.
Each channel has two separate audio outputs in JACK: Left and Right.
Saving and loading your project is done by the Non Session Manager. There you will find a "Save" button.
== 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"]
The *[A] File* menu contains only one command: "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.+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 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 and program changes at startup and break our settings.
You can also activate this option as soon as you have set all instruments, because a program change unfortunately happens faster than one would think.
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.
The current *[E] 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. 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.+
To really close Fluajho you can click on the *STOP* icon in the Non Session Manager. Here you can also restore visibility by clicking on the *GUI* button.+
The current visibility setting is saved. This is because you normally only spend a relatively short time loading a soundfont. Afterwards, the window would only get in the way.
== Installation and Start
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 <shortname> from Non Session Manager".
If not, you can build Fluajho 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 Fluajho 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
Fluajho 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 Fluajho.
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`

196
documentation/german.adoc

@ -0,0 +1,196 @@
: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
= Fluajho
== Benutzung
Schön, dass du dich für Fluajho entschieden hast. Fluajho ist ein Sampler für sf2 Soundfonts. Dies ist ein altes Dateiformat um MIDI-Signale durch virtuelle Instrumente hörbar zu machen.
Du kannst jeweils eine Soundfontdatei pro Fluajho-Instanz laden, was bedeutet das aus dieser Datei jeweils 16 Instrumente gleichzeitig in MIDI Kanäle eingeordnet werden können.
"Fluajho" (mit jh wie in Jalousie) heißt Flüssigkeit auf Esperanto. Denn im Hintergrund Programmes 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 Non Session Manager laden und 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::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 können bis zu 16 gleichzeitig benutzt werden.
Jeweils ein Instrument kann in je einen MIDI Kanal geladen werden. Dazu wählt man in einem Kanal zuerst eine Bank aus (im Zweifelsfall Bank 0) und dann ein Programm.
Beim ersten Aufruf wird ein kleines Standard Soundfont geladen, welches General Midi (GM) kompatibel ist.
Fluajho selbst hat keine Möglichkeit Noten abzuspielen. Um die Klänge anzusteuern, sendet man per JACK Mididaten in unseren Eingangsport. Der Kanal ist eine Eigenschaft des Midisignals und wird bereits im Sequencer ausgewählt.
Jeder Kanal hat zwei eigenene Audioausgänge in JACK: Links und Rechts.
Das Speichern und Laden deines Projektes wird durch den Non Session Manager erledigt. Dort befindet sich ein "Save" Knopf.
== 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"]
Im *[A] Datei* Menü befindet sich nur der Befehl "sf2 Soundfont laden" (Tastaturkürzel: Strg+O). Es kann jeweils nur ein Soundfont zur gleichen Zeit geladen werden. Möchtest du mehrere verschiedene Soundfonts auf einmal benutzen starte Fluajho einfach mehrmals.+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 über die grafische Benutzeroberfläche zu. Sie ignoriert alle Nachrichten, die über die JACK Midi Verbindung herein kommen.+
Das ist manchmal nötig, wenn man es mit Midi-Hardware, wie Keyboards, zu tun hat die beim Start Bank- und Programchanges schicken und damit unsere Einstellungen kaputt machen.
Du kannst diese Option aber auch einfach so aktivieren sobald du alle Instrumente eingestellt hast, 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 keine Einstellmöglichkeit. Mehr Kanäle mit dem gleichen Soundfont erhält man, indem man Fluajho einfach noch einmal startet.
Die aktuelle *[E] 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 seinem tatsächlichen Name angezeigt. Es werden nur die Programme angezeigt, die im aktuellen sf2 vorhanden sind.+
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.+
Um Fluajho wirklich zu schließen kann man im Non Session Manager auf das *STOP* Icon klicken. 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 nur relativ kurze Zeit damit verbringt ein Soundfont zu laden. Anschließend wäre das Fenster nur im Weg.
== Installation und Start
Fluajho ist exklusiv für Linux. Am besten installierst du Fluajho über deinen Paketmanager.
Falls es dort nicht vorhanden ist, oder nur in einer veralteten Version, bitte deine Linuxdistribution Fluajho bereitzustellen.
Falls in den Paketquellen vorhanden bitte direkt bei "<shortname> im Non Session Manager starten" weiterlesen.
Falls nicht kann man Fluajho 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 Fluajho 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
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.
* Ö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
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 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/

303
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>Fluajho User Manual</title>
<meta name="author" content="Laborejo Software Suite">
<title>Fluajho</title>
<style>
/* Asciidoctor default stylesheet | MIT License | http://asciidoctor.org */
/* Uncomment @import statement below to use as custom stylesheet */
@ -431,26 +432,27 @@ 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>Fluajho</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="#_fluajho_user_manual">1. Fluajho User Manual</a>
<li><a href="#_usage">1. Usage</a>
<ul class="sectlevel2">
<li><a href="#_purpose_and_target_audience">1.1. Purpose and target audience</a></li>
<li><a href="#_quick_start">1.2. Quick Start</a></li>
<li><a href="#_basic_principles">1.3. Basic Principles</a></li>
</ul>
</li>
<li><a href="#_installation_and_starting">2. Installation and Starting</a></li>
<li><a href="#_how_to_use_fluajho">3. How to use Fluajho</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>
</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>
<li><a href="#_development">5. Development</a>
<li><a href="#_description_of_the_graphical_user_interface_and_its_functions">2. Description of the graphical user interface and its functions</a></li>
<li><a href="#_installation_and_start">3. Installation and Start</a></li>
<li><a href="#_help_and_development">4. 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">4.1. Testing and Reporting Errors</a></li>
<li><a href="#_programming">4.2. Programming</a></li>
<li><a href="#_translations">4.3. Translations</a></li>
</ul>
</li>
</ul>
@ -458,7 +460,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="_fluajho_user_manual">1. Fluajho User Manual</h2>
<h2 id="_usage">1. Usage</h2>
<div class="sectionbody">
<div class="paragraph">
<p>We are happy you chose Fluajho. Fluajho is a sampler for sf2 soundfonts. This is a legacy file format for making MIDI signals audible through virtual instruments.</p>
@ -475,94 +477,8 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b
<p>There are many soundfont samplers for Linux, most of them based on fluidsynth. Fluajho was written for a clearly defined use case: Load an .sf2 in the Non Session Manager 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>
</div>
</div>
<div class="sect1">
<h2 id="_installation_and_starting">2. Installation and Starting</h2>
<div class="sectionbody">
<div class="paragraph">
<p>Fluajho is exclusive for Linux. The best way to install Fluajho 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 Fluajho from Non Session Manager".
If not, you can build Fluajho 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 Fluajho 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>fluajho</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>
<li>
<p>To save Fluajho, use the <code>Save</code> button in NSM.</p>
</li>
</ul>
</div>
</div>
</div>
<div class="sect1">
<h2 id="_how_to_use_fluajho">3. How to use Fluajho</h2>
<div class="sectionbody">
<div class="paragraph">
<p>The following explains how to use Fluajho.</p>
</div>
<div class="sect2">
<h3 id="_quick_start">3.1. Quick Start</h3>
<h3 id="_quick_start">1.2. Quick Start</h3>
<div class="paragraph">
<p>To get to know the most important functions and workflows, this video has been created.</p>
</div>
@ -583,7 +499,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">1.3. 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>
</div>
@ -606,7 +522,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">2. 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>
@ -645,119 +561,228 @@ The current visibility setting is saved. This is because you normally only spend
</div>
</div>
<div class="sect1">
<h2 id="_development">5. Development</h2>
<h2 id="_installation_and_start">3. Installation and Start</h2>
<div class="sectionbody">
<div class="paragraph">
<p>The further development of Fluajho 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>
</div>
<div class="sect2">
<h3 id="_translations">5.1. Translations</h3>
<div class="paragraph">
<p>Fluajho 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>
<p>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.</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 Fluajho yourself.</p>
</div>
<div class="ulist">
<div class="title">Build and Install</div>
<ul>
<li>
<p>Open a terminal and navigate to the Fluajho directory</p>
<p>Please check the supplied README.md for dependencies.</p>
</li>
<li>
<p>In the Fluajho 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>XY.ts</code>, where XY is the language code.</p>
<p>The default prefix is /usr/local</p>
</li>
</ul>
</div>
</li>
<li>
<p><code>make</code></p>
</li>
<li>
<p>Make sure to leave a space between the individual languages entries.</p>
<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">4. Help and Development</h2>
<div class="sectionbody">
<div class="paragraph">
<p>You can help Fluajho in several ways: Testing and reporting errors, translating, marketing, support, programming and more.</p>
</div>
<div class="sect2">
<h3 id="_testing_and_reporting_errors">4.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">4.2. Programming</h3>
<div class="paragraph">
<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">4.3. Translations</h3>
<div class="paragraph">
<p>Fluajho 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 Fluajho.</p>
</div>
<div class="paragraph">
<p>You can also incorporate the translation into Fluajho for testing purposes. This requires rudimentary Python knowledge.</p>
<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>fluajho</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 Fluajho 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>In the file <code>engine/constants.py</code> 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:06:27 +0100
Last updated 2019-01-26 18:51:45 +0100
</div>
</div>
</body>

342
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>Fluajho Bedienungsanleitung</title>
<meta name="author" content="Laborejo Software Suite">
<title>Fluajho</title>
<style>
/* Asciidoctor default stylesheet | MIT License | http://asciidoctor.org */
/* Uncomment @import statement below to use as custom stylesheet */
@ -431,26 +432,31 @@ 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>Fluajho</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="#_fluajho_bedienungsanleitung">1. Fluajho Bedienungsanleitung</a>
<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>
</ul>
</li>
<li><a href="#_installation_und_start">2. Installation und Start</a></li>
<li><a href="#_bedienung">3. Bedienung</a>
<li><a href="#_beschreibung_der_grafischen_oberfläche_und_ihrer_funktionen">2. Beschreibung der grafischen Oberfläche und ihrer Funktionen</a></li>
<li><a href="#_installation_und_start">3. Installation und Start</a></li>
<li><a href="#_helfen_und_entwicklung">4. Helfen und Entwicklung</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="#_testen_und_programmfehler">4.1. Testen und Programmfehler</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>
<li><a href="#_entwicklung">5. 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_2">5.2. Übersetzungen</a></li>
</ul>
</li>
</ul>
@ -458,7 +464,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="_fluajho_bedienungsanleitung">1. Fluajho Bedienungsanleitung</h2>
<h2 id="_benutzung">1. Benutzung</h2>
<div class="sectionbody">
<div class="paragraph">
<p>Schön, dass du dich für Fluajho entschieden hast. Fluajho ist ein Sampler für sf2 Soundfonts. Dies ist ein altes Dateiformat um MIDI-Signale durch virtuelle Instrumente hörbar zu machen.</p>
@ -475,96 +481,8 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b
<p>Es gibt viele Soundfontsampler für Linux, die meisten auf Fluidsynthbasis. Fluajho wurde für einen klar umrissenen Anwendungsfall geschrieben: Ein .sf2 im Non Session Manager 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>
</div>
</div>
</div>
<div class="sect1">
<h2 id="_installation_und_start">2. Installation und Start</h2>
<div class="sectionbody">
<div class="paragraph">
<p>Fluajho ist exklusiv für Linux. Am besten installierst du es über deinen Paketmanager. Falls es dort nicht vorhanden ist, oder nur in einer veralteten Version, bitte deine Linuxdistribution Fluajho bereitzustellen.</p>
</div>
<div class="paragraph">
<p>Falls in den Paketquellen vorhanden bitte direkt bei "Fluajho im Non Session Manager starten" weiterlesen.</p>
</div>
<div class="paragraph">
<p>Falls nicht kann man Fluajho 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">Fluajho 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>fluajho</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. Sequencer.</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>
<li>
<p>Um Fluajho zu speichern benutzte den <code>Save</code>-Knopf in NSM.</p>
</li>
</ul>
</div>
</div>
</div>
<div class="sect1">
<h2 id="_bedienung">3. Bedienung</h2>
<div class="sectionbody">
<div class="paragraph">
<p>Im folgenden wird erklärt, wie Fluajho bedient wird.</p>
</div>
<div class="sect2">
<h3 id="_schnellstart">3.1. Schnellstart</h3>
<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>
@ -585,7 +503,7 @@ Your browser does not support the video tag.
</div>
</div>
<div class="sect2">
<h3 id="_grundlagen">3.2. Grundlagen</h3>
<h3 id="_grundlagen">1.3. 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>
</div>
@ -608,7 +526,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">2. 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>
@ -647,11 +565,127 @@ Die momentane Sichtbarkeitseinstellung wird gespeichert. Das hat den Grund, dass
</div>
</div>
<div class="sect1">
<h2 id="_installation_und_start">3. Installation und Start</h2>
<div class="sectionbody">
<div class="paragraph">
<p>Fluajho ist exklusiv für Linux. Am besten installierst du Fluajho über deinen Paketmanager.
Falls es dort nicht vorhanden ist, oder nur in einer veralteten Version, bitte deine Linuxdistribution Fluajho bereitzustellen.</p>
</div>
<div class="paragraph">
<p>Falls in den Paketquellen vorhanden bitte direkt bei "&lt;shortname&gt; im Non Session Manager starten" weiterlesen.
Falls nicht kann man Fluajho auch selbst "bauen".</p>
</div>
<div class="ulist">
<div class="title">Abhängigkeiten*</div>
<ul>
<li>
<p>Eine Liste der Abhängigkeit befindet sich in der README.md</p>
</li>
<li>
<p>Kompilieren und Installieren geht entweder mit einem Releasedownload oder mit der Git-Version:</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><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>Wechsele in das neue Verzeichnis und benutze diese Befehle:
*<code>./configure --prefix=/usr</code></p>
<div class="ulist">
<ul>
<li>
<p>Das Standardprefix is /usr/local</p>
</li>
</ul>
</div>
</li>
<li>
<p><code>make</code></p>
</li>
<li>
<p><code>sudo make install</code></p>
</li>
</ul>
</div>
<div class="ulist">
<div class="title">&lt;shortname&gt; 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>&lt;shortname&gt;</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 class="paragraph">
<p>In der Datei README.md befinden sich weitere Möglichkeiten &lt;shortname&gt; zu starten. Diese sind zum Musikmachen nicht praktikabel,
aber nützlich für Tests und Entwicklung.</p>
</div>
</div>
</div>
<div class="sect1">
<h2 id="_helfen_und_entwicklung">4. Helfen und Entwicklung</h2>
<div class="sectionbody">
<div class="paragraph">
<p>Du kannst Fluajho in vielen Art helfen: Testen und Fehler melden, übersetzen, marketing, anderen Nutzern helfen und schließlich programmieren.</p>
</div>
<div class="sect2">
<h3 id="_testen_und_programmfehler">4.1. Testen und Programmfehler</h3>
<div class="paragraph">
<p>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.</p>
</div>
<div class="ulist">
<div class="title">Kontaktmöglichkeiten</div>
<ul>
<li>
<p>Webseite: <a href="https://www.laborejo.org" class="bare">https://www.laborejo.org</a></p>
</li>
<li>
<p>E-Mail: <a href="mailto:info@laborejo.org">info@laborejo.org</a></p>
</li>
<li>
<p>IRC: #laborejo auf dem Server irc.freenode.org</p>
</li>
<li>
<p>Wenn du die Gelegenheit siehst und weist, dass ein Entwickler es lesen wird meinetwegen auch Foren, Socialmedia etc.</p>
</li>
</ul>
</div>
</div>
</div>
</div>
<div class="sect1">
<h2 id="_entwicklung">5. Entwicklung</h2>
<div class="sectionbody">
<div class="paragraph">
<p>Die weitere Entwicklung Fluajhos 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>
<p>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.</p>
</div>
<div class="sect2">
<h3 id="_übersetzungen">5.1. Übersetzungen</h3>
@ -665,10 +699,10 @@ Die einfachste Variante ist es einfach die Entwickler anzusprechen und sie werde
<div class="ulist">
<ul>
<li>
<p>Öffne ein Terminal und navigiere ins Fluajho Verzeichnis</p>
<p>Öffne ein Terminal und navigiere ins Patroneo Verzeichnis</p>
</li>
<li>
<p>Im Fluajho Verzeichnis: <code>cd gui/translations</code></p>
<p>Im Patroneo Verzeichnis: <code>cd gui/translations</code></p>
</li>
<li>
<p>Bearbeite die Datei <code>config.pro</code> mit einem Texteditor</p>
@ -705,7 +739,7 @@ Die einfachste Variante ist es einfach die Entwickler anzusprechen und sie werde
</ul>
</div>
<div class="paragraph">
<p>Die Übersetzung kannst du auch selbst, zum Testen, in Fluajho einbinden. Dafür sind rudimentäre Python Kentnisse nötig.</p>
<p>Die Übersetzung kannst du auch selbst, zum Testen, in Patroneo einbinden. Dafür sind rudimentäre Python Kentnisse nötig.</p>
</div>
<div class="ulist">
<ul>
@ -713,17 +747,17 @@ Die einfachste Variante ist es einfach die Entwickler anzusprechen und sie werde
<p>Im Qt Linguist "Datei" Menü ist eine "Release" Option. Das erstellt eine <code>.qm</code> Datei im gleichen Verzeichnis wie deine <code>.ts</code> Datei.</p>
</li>
<li>
<p>Öffne die <code>fluajho</code> Starterdatei im Texteditor</p>
<p>Öffne die <code>patroneo</code> Starterdatei im Texteditor</p>
<div class="ulist">
<ul>
<li>
<p>Scrolle nach ganz unten, dort wird die Sprache eingestellt.</p>
</li>
<li>
<p>Um deinen Sprachstring herauszufinden (German, Esperanto etc.) entferne die # Raute aus der bereits vorhandenen Zeile <code>#print (language)</code>. Starte NSM aus einem Terminal, starte Fluajho und der Sprachstring wird dort ausgegeben (man muss ein bischen suchen)</p>
<p>Um deinen Sprachstring herauszufinden (German, Esperanto etc.) entferne die # Raute aus der bereits vorhandenen Zeile <code>#print (language)</code>. Starte NSM aus einem Terminal, starte Patroneo und der Sprachstring wird dort ausgegeben (man muss ein bischen suchen)</p>
</li>
<li>
<p>In der Datei <code>engine/constants.py</code> ist ein Dictionary <code>supportedLanguages</code>. Füge deine Sprache hinzu. z.B. <code>{"German":"de.qm", "Esperanto:"eo.qm"}</code></p>
<p>Am Ende der Datei ist ein Dictionary <code>supportedLanguages</code>. Füge deine Sprache hinzu. z.B. <code>{"German":"de.qm", "Esperanto:"eo.qm"}</code></p>
</li>
</ul>
</div>
@ -732,24 +766,100 @@ Die einfachste Variante ist es einfach die Entwickler anzusprechen und sie werde
</div>
</div>
<div class="sect2">
<h3 id="_bugs_und_programmfehler">5.2. Bugs und Programmfehler</h3>
<h3 id="_übersetzungen_2">5.2. Übersetzungen</h3>
<div class="paragraph">
<p>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 einrich</p>
</div>
<div class="paragraph">
<p>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.</p>
</div>
<div class="paragraph">
<p>Der Übersetzungsprozess ist der gleiche für beide Teile, man muss ihn jedoch in unterschiedlichen Verzeichnissen durchführen:
<code>template/qtgui</code> und nur <code>/qtgui</code>, relativ zum Stammverzeichnis, wo sich die ausführbare Datei &lt;shortname&gt; befindet.</p>
</div>
<div class="paragraph">
<p>Jedes "template/qtgui" hier kann durch nur "qtgui" ersetzt werden um den zweiten Teil zu übersetzen.</p>
</div>
<div class="paragraph">
<p>Falls du einen Fehler im Programm entdeckst (oder es zu langsam läuft) melde dich bitte bei auf die Art und Weise, die dir am besten passt.</p>
<p>So fügt man eine neue Sprache hinzu:</p>
</div>
<div class="ulist">
<div class="title">Kontaktmöglichkeiten</div>
<ul>
<li>
<p>Webseite: <a href="https://www.laborejo.org" class="bare">https://www.laborejo.org</a></p>
<p>Öffne ein Terminal und navigiere zu template/qtgui/resources/translations</p>
</li>
<li>
<p>E-Mail: <a href="mailto:info@laborejo.org">info@laborejo.org</a></p>
<p>Bearbeite die Datei <code>config.pro</code> in einem Texteditor.</p>
<div class="ulist">
<ul>
<li>
<p>Hänge in der letzten Zeile den Namen deiner Sprache an, in der Form <code>XY.ts</code>, wobei XY der Sprachcode ist.</p>
</li>
<li>
<p>IRC: #laborejo auf dem Server irc.freenode.org</p>
<p>Achte darauf ein Leerzeichen zwischen den einzelnen Sprachen zu lassen</p>
</li>
</ul>
</div>
</li>
<li>
<p>Führe <code>sh update.sh</code> im selben Verzeichnis aus.</p>
<div class="ulist">
<ul>
<li>
<p>Das Programm hat nun eine neue <code>.ts</code>-Datei im Verzeichnis erstellt.</p>
</li>
</ul>
</div>
</li>
<li>
<p>Starte Qt Linguist mit <code>linguist-qt5</code> (kann evtl. anders heißen) und öffne von dort deine neu generierte Datei</p>
</li>
<li>
<p>Wähle deine "Target Language", also Zielsprache, aus und benutze das Programm um eine Übersetzung anzufertigen</p>
</li>
<li>
<p>Sende uns die .ts Datei, z.B. per E-Mail an <a href="mailto:info@laborejo.org">info@laborejo.org</a> (s.u bei Bugs und Programmfehler für mehr Kontaktmöglichkeiten)</p>
</li>
</ul>
</div>
<div class="paragraph">
<p>Die Übersetzung kannst du auch selbst, zum Testen, in Patroneo einbinden. Dafür sind rudimentäre Python Kentnisse nötig.</p>
</div>
<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 deine <code>.ts</code> Datei.</p>
</li>
<li>
<p>Bearbeite <code>template/qtgui/resources/resources.qrc</code> kopiere die Zeile <code>&lt;file&gt;translations/de.qm&lt;/file&gt;</code> , aber änder das Länderkürzel zu deinem neuen.</p>
</li>
<li>
<p>Führe <code>sh buildresources.sh</code> aus</p>
</li>
<li>
<p>Bearbeite <code>engine/config.py</code>: Füge deine Sprache hinzu. z.B. <code>{"German":"de.qm", "Esperanto:"eo.qm"}</code></p>
<div class="ulist">
<ul>
<li>
<p>Um deinen Sprachstring herauszufinden öffne den <code>python3</code>-Interpreter im Terminal und führe aus:</p>
</li>
<li>
<p><code>from PyQt5 import QtCore;QtCore.QLocale().languageToString(QtCore.QLocale().language())</code></p>
</li>
</ul>
</div>
</li>
</ul>
</div>
<div class="paragraph">
<p>Um deine neue Übersetzung zu testen starte dein Programm, falls dein System bereits auf diese Sprache eingstellt ist. Ansonsten starte &lt;shortname&gt; mit diesem Befehl vom Terminal aus:</p>
</div>
<div class="ulist">
<ul>
<li>
<p>Wenn du die Gelegenheit siehst und weist, dass ein Entwickler es lesen wird meinetwegen auch Foren, Facebook etc.</p>
<p><code>LANGUAGE=de_DE.UTF-8 ./&lt;shortname&gt; -V --save /dev/null</code></p>
</li>
</ul>
</div>
@ -759,7 +869,7 @@ Die einfachste Variante ist es einfach die Entwickler anzusprechen und sie werde
</div>
<div id="footer">
<div id="footer-text">
Last updated 2019-01-02 22:06:33 +0100
Last updated 2019-01-26 18:51:45 +0100
</div>
</div>
</body>

Loading…
Cancel
Save