Patroneo/template/documentation/german.adoc.template

:Author: <author>
:Version: <version>
: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

= <name>

// Don't write in the empty line above line. It will be interpreted as author html tag
Für Programmversion <version>

<manual>


== Installation und Start

<name> ist exklusiv für Linux. Am besten installieren Sie <name> über deinen Paketmanager.
Falls es dort nicht vorhanden ist, oder nur in einer veralteten Version, bitten sie ihre 
Linuxdistribution <name> bereitzustellen.

Falls in den Paketquellen vorhanden bitte direkt bei "<shortName> im Non Session Manager starten" weiterlesen.
Falls nicht kann man <name> 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://git.laborejo.org/lss/<shortName>.git`
* Wechseln Sie in das neue Verzeichnis und benutzen diese Befehle:
*`./configure --prefix=/usr`
  ** Das Standardprefix is /usr/local
* `make`
* `sudo make install`

.<shortName> im Non Session Manager (NSM) starten
* Starten Sie `non-session-manager`
* Knopf `New`, geben Sie einen Namen für das Musikstück ein.
* Knopf `Add Client to Session`, geben Sie hier `<shortName>` ein, kleingeschrieben.
* Nochmal Add Client, diesmal `jackpatch`.
* Fügen Sie 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
Sie können <name> auf viele Arten und Weisen helfen: Testen und Fehler melden, übersetzen, marketing,
anderen Nutzern helfen und schließlich programmieren.

=== Testen und Programmfehler
Falls Sie einen Fehler im Programm entdecken (oder es zu langsam läuft) melden Sie diese bitte auf
eine Art und Weise, die ihnen am besten passt.

.Kontaktmöglichkeiten
* Bugs und Probleme melden: https://www.laborejo.org/bugs
* Webseite: https://www.laborejo.org
* E-Mail: info@laborejo.org
* Wenn Sie die Gelegenheiten sehen und wissen, dass ein Entwickler es lesen wird sind auch Foren, Socialmedia etc. möglich.

== Entwicklung
Falls Sie an der Entwicklung interessiert sind, melden Sie sich am besten direkt bei uns (s.o.)
Kurzversion: clone git, programmieren, einen git-patch erstellen oder uns eine git URL zukommen lassen.

=== Übersetzungen
<name> 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" 
(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:

* Öffnen Sie ein Terminal und navigieren zu template/qtgui/resources/translations
* Bearbeiten Sie die Datei `config.pro` in einem Texteditor.
  ** Hängem Sie in der letzten Zeile den Namen der neuen Sprache an, in der Form `XY.ts`, wobei XY der Sprachcode ist.
  ** Achten Sie bitte darauf ein Leerzeichen zwischen den einzelnen Sprachen zu lassen
* Führen Sie `sh update.sh` im selben Verzeichnis aus.
  ** Das Programm hat nun eine neue `.ts`-Datei im Verzeichnis erstellt.
* Starten Sie Qt Linguist mit `linguist-qt5` (kann evtl. anders heißen) und öffnen von dort die neu generierte Datei.
* Wählen Sie die "Target Language", also Zielsprache, aus und benutzen das Programm um eine Übersetzung anzufertigen.
* Senden Sie uns bitte 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 können Sie 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 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"}` 
  ** 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())`


Um die neue Übersetzung zu testen starten Sie das Programm, falls ihr System bereits auf diese
Sprache eingstellt ist.
Ansonsten starten Sie <shortName> mit diesem Befehl, Sprachcode ändern, vom Terminal aus:

* `LANGUAGE=de_DE.UTF-8 ./<shortName> -V`