Benutzer-Werkzeuge

Webseiten-Werkzeuge


nutzerhandbuch

Unterschiede

Hier werden die Unterschiede zwischen zwei Versionen angezeigt.

Link zu dieser Vergleichsansicht

Beide Seiten der vorigen Revision Vorhergehende Überarbeitung
Nächste Überarbeitung
Vorhergehende Überarbeitung
nutzerhandbuch [29.05.2015 10:24]
martin [Vorbereitung]
nutzerhandbuch [11.08.2021 10:15] (aktuell)
Zeile 5: Zeile 5:
 ==== Vorbereitung ==== ==== Vorbereitung ====
  
-Um alle Funktionalitäten von Tingeltangel vollständig nutzen zu können, werden ein paar zusätzliche externe Tools benötigt.+Um alle Funktionalitäten von Tingeltangel vollständig nutzen zu können, werden ein paar zusätzliche externe Tools und ein Internetzugang benötigt.
  
-//**MP3 Playback**//+//**Java (JRE) (wird immer benötigt)**//
  
-Um aus Tingeltangel MP3s wiederzugeben muss "mpg123" installiert sein. Das Windows 64 Bit Binary bekommt man [[http://www.mpg123.de/download/win64/?V=1&O=D|hier]], die 32 Bit Variante [[http://www.mpg123.de/download/win32/?V=1&O=D|hier]]. Linuxnutzer können mpg123 über Ihr zentrales Distributionsrepository installieren.+Damit Tingeltangel funktioniert muss eine "Java Runtime Environment (**JRE**)" installiert sein. Windowsnutzer können die [[http://www.oracle.com/technetwork/java/javase/downloads/index.html|JRE]] hier herunterladen. Linuxnutzer installieren eine JRE über Ihr Distributionsrepository.
  
-<color red>+Auf allen Betriebsystemen muss die Umgebungsvariable "JAVA_HOME" gesetzt sein und "JAVA_HOME/bin" muss der Umgebungsvariable "PATH" hinzugefügt werden. Eine Anleitung dazu findet man [[http://help.adobe.com/de_DE/enterpriseplatform/10.0/InstallSolution/WS0b373c8e7f652f14-288f6da412ff737e785-7ffe.html|hier]]. 
 + 
 +//**MP3 Playback (wird ab Version 0.2 nicht mehr benötigt)**// 
 + 
 +Um aus Tingeltangel MP3s wiederzugeben muss "mpg123" installiert sein. Das Windows 64 Bit Binary bekommt man [[http://www.mpg123.de/download/win64/?V=1&O=D|hier]], die 32 Bit Variante [[http://www.mpg123.de/download/win32/?V=1&O=D|hier]]. Linuxnutzer können mpg123 über Ihr zentrales Distributionsrepository installieren.
  
-//**Text-To-Speach (TTS)**//+//**Text-To-Speach (TTS) <color red>[nicht in der Version 0.1-beta1 enthalten]</color>**//
  
 Um die "Text-To-Speach" Funktionalität nutzen zu können, muss "eSpeak" und "lame" installiert sein. Um die "Text-To-Speach" Funktionalität nutzen zu können, muss "eSpeak" und "lame" installiert sein.
  
-Das Windows eSpeak-Binary bekommt man [[http://espeak.sourceforge.net/download.html|hier]]. Linuxnutzer können "mpg123" über Ihr zentrales Distributionsrepository installieren.+Das Windows eSpeak-Binary bekommt man [[http://espeak.sourceforge.net/download.html|hier]]. Linuxnutzer können "eSpeak" über Ihr zentrales Distributionsrepository installieren.
  
 Das Windows lame-Binary bekommt man [[http://www.rarewares.org/mp3-lame-bundle.php|hier]]. Linuxnutzer können "lame" über Ihr zentrales Distributionsrepository installieren. Das Windows lame-Binary bekommt man [[http://www.rarewares.org/mp3-lame-bundle.php|hier]]. Linuxnutzer können "lame" über Ihr zentrales Distributionsrepository installieren.
  
-//**besseres Text-To-Speach (mbrola)**//+//**besseres Text-To-Speach (mbrola) <color red>[nicht in der Version 0.1-beta1 enthalten]</color>**//
  
 Für eine bessere Sprachausgabe sollte man zusätzlich zu "eSpeak" auch "mbrola" inclusive der Sprachpakete installieren. Binarys für verschiedenen Betriebssysteme und die Sprachpakete findet man [[http://tcts.fpms.ac.be/synthesis/mbrola/mbrcopybin.html|hier]]. Für eine bessere Sprachausgabe sollte man zusätzlich zu "eSpeak" auch "mbrola" inclusive der Sprachpakete installieren. Binarys für verschiedenen Betriebssysteme und die Sprachpakete findet man [[http://tcts.fpms.ac.be/synthesis/mbrola/mbrcopybin.html|hier]].
Zeile 29: Zeile 33:
   - kopieren der Datei "de1-980227/de1/de1" (die Datei ohne Dateiendung) nach "{Pfad zu eSpeak}\espeak-data\mbrola"   - kopieren der Datei "de1-980227/de1/de1" (die Datei ohne Dateiendung) nach "{Pfad zu eSpeak}\espeak-data\mbrola"
  
-</color>+//**yaml-Import (Tiptoi-Stift)** <color red>[nicht in der Version 0.1-beta1 enthalten]</color>//
  
-==== Installation ====+Um die "yaml-Import" Funktionalität nutzen zu können, muss "avconv" installiert sein.
  
-<color red>fehlt!</color>+Das Windows avconv-Binary bekommt man [[http://sourceforge.net/projects/avconv/|hier]]. Linuxnutzer können "avconv" über Ihr zentrales Distributionsrepository installieren. 
 + 
 + 
 +==== Installation & Start ==== 
 + 
 +Die heruntergeladene ZIP-Datei kann an einem beliebigen Ort entpackt werden. 
 + 
 +Zum starten der GUI klickt man unter Windows auf "Tingeltangel.bat". Unter Linux startet man "Tingeltangel.sh".
  
 ===== Ting-el-Tangel GUI ===== ===== Ting-el-Tangel GUI =====
Zeile 44: Zeile 55:
   - eine freie MID auswählen (am besten eine ab 9000)   - eine freie MID auswählen (am besten eine ab 9000)
   - Im Fenster "Eigenschaften" können nun die Buchdaten angepasst werden (Die Felder "Version", "unbekannter Wert" und "Datum" sollten nicht geändert werden)   - Im Fenster "Eigenschaften" können nun die Buchdaten angepasst werden (Die Felder "Version", "unbekannter Wert" und "Datum" sollten nicht geändert werden)
-  - Im Fenster "Index" auf das + Zeichen klicken+  - Im Fenster "Index" auf das "+Zeichen klicken
   - nun können die einzelnen Bucheinträge (OIDs) erstellt werden   - nun können die einzelnen Bucheinträge (OIDs) erstellt werden
  
 //**Eintrag erstellen**// //**Eintrag erstellen**//
  
-<color red>fehlt!</color>+Nachdem man in der Tabelle im "Index"-Fenster, rechts neben der gewünschten OID (Ting-ID), doppelt auf das Feld "Typ" klickt, kann man seinen Eintragstyp auswählen.
  
-//**Buch speichern**//+Um ein MP3 hinzuzufügen duppelt auf das Feld "Dateiname TTS" klicken und ein MP3 auswählen. Bei einem TTS-Eintrag (Text-To-Speech) öffnet sich nach einem Doppelklick 
 +auf das Feld "Dateiname TTS" das ein Dialog indem man den Text eingeben und ein paar Sprach-Parameter angeben kann. Mit den Typen "Skript" und "Skript (Unterprogramm)" 
 +können Skripte (dynamische Inhalte, Spiele, ...) erstellt werden.
  
-<color red>fehlt!</color> 
 ==== Buch importieren (ouf-Datei vorhanden) ==== ==== Buch importieren (ouf-Datei vorhanden) ====
  
-<color red>fehlt!</color>+Im Menü "Buch"->"Importieren"->"manuell" auswählen. Nun muss eine ouf-Datei angegeben werden. Alle anderen Dateien (txt, src, png) sind optional. Falls diese vorhanden sind, kann es sehr nützlich sein diese ebenfalls mit anzugeben. Folgende Daten werden aus den optionalen Dateien extrahiert: 
 + 
 +^ Datei ^ Daten ^ 
 +| txt | Bucheigenschaften | 
 +| src | Kommentare und original Quellcode (fehlt die src-Datei werden die Skripte aus der ouf-Datei dekompiliert) | 
 +| png | Das Buch-Logo |
  
 ==== Buch importieren (ouf-Datei fehlt, src-Datei vorhanden) ==== ==== Buch importieren (ouf-Datei fehlt, src-Datei vorhanden) ====
  
-<color red>fehlt!</color>+Es ist auch möglich ein Buch nur aufgrund seiner src-Datei zu importieren. Einträge vom Typ MP3 haben dann keine Daten. Diese müssen 
 +nachträglich per Hand eingefügt werden. 
  
 ==== tiptoi Buch importieren (yaml-Datei) ==== ==== tiptoi Buch importieren (yaml-Datei) ====
Zeile 68: Zeile 87:
 ==== Das Repository ==== ==== Das Repository ====
  
-<color red>fehlt!</color>+Das "Repository" bezeichnet die lokale Kopie aller offiziellen Bücher. Im Menü "Fenster"->"Repository" kann der Repository-Manager geöffnet werden. Ein doppelklick auf ein Buch 
 +lädt dieses vom Ting-Server herunter. Heruntergeladene Bücher werden grün hinterlegt.
  
 ==== MP3s extrahieren ==== ==== MP3s extrahieren ====
  
-<color red>fehlt!</color>+Im Menü "Buch"->"Importieren"->"Repository" auswählen. Danach kann ein Buch zum Import selektiert werden. Nachdem das Buch importiert ist, kann man die MP3s aus dem Verzeichniss "{Pfad zum Benutzerverzeichniss}\Dokumente\tingeltangel\books\{Buch ID (MID)}\audio" (unter Windows) oder "~/.tingeltangel/books/{Buch ID (MID)}/audio" herauskopieren. Die MP3s sind nach ihren Ting-IDs (OIDs) benannt.
  
-==== Buch auf den Stift kopieren (offizielles Buch) ==== 
  
-<color red>fehlt!</color> 
  
-==== Buch generieren und auf den Stift kopieren (selbstgemachtes Buch) ==== +===== Command Line Interface =====
- +
-<color red>fehlt!</color> +
- +
-==== Stift in den Debug-Modus versetzen ==== +
- +
-<color red>fehlt!</color> +
- +
-===== Command Line Interface [EXPERIMENTELL] =====+
  
 Windows: Windows:
- Tingeltangel.bat [<Kommando> [<Optionen>]]+ java -jar target\tingeltangel-XXX-jar-with-dependencies.jar [<Kommando> [<Optionen>]]
 Linux: Linux:
- Tingeltangel.sh [<Kommando> [<Optionen>]]+ java -jar target/tingeltangel-XXX-jar-with-dependencies.jar [<Kommando> [<Optionen>]]
   
 Wenn kein Kommando gegeben ist, wird die GUI gestartet. Wenn kein Kommando gegeben ist, wird die GUI gestartet.
  
-==== Kommandos ==== +Mittels
- assemble -i <Eingabedatei> +
- Erstellt aus einer yaml-Datei eine ouf-Datei. +
- Optionen: +
- -i <Eingabedatei>: setzt den Namen der Eingabedatei +
- +
- oid-code -i <Eingabedatei> +
- Erstellt zu einer yaml-Datei passende OID-Codes. +
- Optionen: +
- -i <Eingabedatei>: setzt den Namen der Eingabedatei +
- +
- generate-raw-code [-w <Breite>] [-f <Dateiformat>] -c <Code-ID> [-r <Auflösung>] [-o <Ausgabedatei>] [-h <Höhe>+
- Erzeugt ein png oder eps von der gegebenen Code-ID +
- Optionen: +
- -w <Breite>: Breite im mm (default: 100) +
- -f <Dateiformat>: setzt das Ausgabedateiformat. png oder eps. (default: png) +
- -c <Code-ID>: die Code-ID +
- -r <Auflösung>: setzt die Ausgabeauflösung. 600 für 600dpi oder 1200 für 1200dpi. (default: 1200) +
- -o <Ausgabedatei>: setzt den Namen der Ausgabedatei (default: <Code-ID>_raw_<Auflösung>.<Dateiformat>+
- -h <Höhe>: Höhe im mm (default: 100)+
  
- help + java -jar target\tingeltangel-XXX-jar-with-dependencies.jar help
- zeigt diese Hilfe an+
  
- books-update +bzw.
- Aktualisiert die Buchliste+
  
- generate-code [-w <Breite>] [-f <Dateiformat>-t <Ting-ID> [-r <Auflösung>] [-o <Ausgabedatei>] [-h <Höhe>+ java -jar target/tingeltangel-XXX-jar-with-dependencies.jar help
- Erzeugt ein png oder eps von der gegebenen Ting-ID +
- Optionen: +
- -w <Breite>: Breite im mm (default: 100) +
- -f <Dateiformat>: setzt das Ausgabedateiformatpng oder eps. (default: png) +
- -t <Ting-ID>: die Ting-ID +
- -r <Auflösung>: setzt die Ausgabeauflösung. 600 für 600dpi oder 1200 für 1200dpi. (default: 1200) +
- -o <Ausgabedatei>: setzt den Namen der Ausgabedatei (default: <Ting-ID>_<Auflösung>.<Dateiformat>+
- -h <Höhe>: Höhe im mm (default: 100)+
  
- import [-t <txt-Datei>] -b <Buch-Verzeichniss> [-s <src-Datei>] -o <ouf-Datei> +wird eine Liste der bekannten Kommandos ausgegeben.
- Importiert ein Buch aus einer ouf-Datei +
- Optionen: +
- -t <txt-Datei>: die zu importierende txt-Datei +
- -b <Buch-Verzeichniss>: setzt das (existierende) Zielverzeichniss im dem Buch gespeichert werden soll +
- -s <src-Datei>: die zu importierende src-Datei +
- -o <ouf-Datei>: die zu importierende ouf-Datei+
  
- books-scan 
- Aktualisiert die gesammte Buchliste (Vorsicht: kann viel Zeit beanspruchen) 
nutzerhandbuch.1432895068.txt.gz · Zuletzt geändert: 11.08.2021 10:15 (Externe Bearbeitung)