"Benutzung" und "Weitere Optionen"

Author: kaixxx

assets/_custom.scss

@@ -112,3 +112,14 @@ h6 {
   font-weight: inherit;
   color: var(--body-heading-color);
 }
+
+.book-menu-toc {
+  margin: 0.25rem 0 0.5rem 0.5rem;
+  font-size: var(--font-size-smallest);
+}
+.book-menu-toc nav a {
+  padding: 0.2em 0;
+}
+.book-menu-toc nav a::before {
+  content: "> ";
+}

content/_index.md

@@ -8,6 +8,12 @@ bookToC: false
 
 Dies ist die offizielle Websseite der Open-Source-Software noScribe ([GitHub](https://github.com/kaixxx/noScribe)). 
 
+{{% hint warning %}} 
+Achtung: Jemand hat die Domain noscribe(punkt)ai registriert und versucht dort, kostenplfichtige Transkriptionsdienste zu verkaufen. Ich habe damit nichts zu tun. Das echte noScribe ist kostenlos und wird es immer bleiben. 
+{{% /hint %}}
+
+## Was ist noScribe?
+
 - **Kostenlos & frei verfügbar** ([GPL‑3.0](https://www.gnu.org/licenses/gpl-3.0.html))
 - **Keine Cloud**, alles bleibt auf dem eigenen Computer 
 - **Hochwertige Transkripte** basierend auf [Whisper von OpenAI](https://github.com/openai/whisper) und [Pyannote von Hervé Bredin](https://github.com/pyannote/pyannote-audio)

content/docs/benutzung.md

@@ -6,72 +6,66 @@ weight: 20
 
 # Benutzung
 
-## Usage
+## Einstellungen
 
-### Settings
+<img src="/img/noScribe_settings.png" alt="noScribe Einstellungen" style="width: 20em; height: auto; float: left; margin: 0 1.5rem 1rem 0;">
 
-![noScribe Einstellungen](/img/noScribe_settings.png)
+- **Audiodatei wählen:** Unterstützt werden nahezu alle Audio‑ und Videoformate. Im Dialog können auch mehrere Dateien gewählt werden. Diese werden dann nacheinander abgearbeitet. 
+- **Transkript speichern unter:** Standard ist `.html` (kompatibel mit dem Editor). Optional `.txt` für Klartext oder `.vtt` für Untertitel sowie die Weiterarbeit in [EXMARaLDA](https://exmaralda.org/). Wenn mehrere Dateien auf einmal verarbeitet werden, kann hier nur der Ausgabeordner gewählt werden. Die Benennung der Ausgabedateien erfolgt dann automatisch.  
+- **Start/Stop:** Zeitbereich im Format `hh:mm:ss`, ideal zum Testen kürzerer Ausschnitte.
+- **Sprache:** Sprache auswählen oder „Auto“ zur Erkennung bzw. „Multilingual“ für mehrere Sprachen in derselben Aufnahme (experimentell).
+- **Qualität:** „Precise“ liefert die besten Ergebnisse und ist für fast alle Anwendungszwecke die beste Wahl. „Fast“ ist etwas schneller und vor allem für ältere Rechner gedacht. Es erfordert mehr Nachkorrektur.
+- **Pausen markieren:** Wenn gewählt, werden Sprechpausen als Punkte in Klammern markiert, jeweils ein Punkt pro Sekunde Pause. Optional ab 1/2/3 Sekunden.
+- **Sprechererkennung:** Wenn bekannt, Anzahl der Sprecher:innen wählen, das macht die Erkennung robuster. Ansonsten „Auto“ für die automatische Erkennung oder „None“, um diesen Schritt ganz zu überspringen.
+- **Überlappende Sprache:** Gleichzeitiges Sprechen wird mit `// Sprecher:in: Einwurf //` markiert (experimentell).
+- **Füllworte:** Wenn gewählt, werden Füllwörter und unvollständige Worte/Sätze nach Möglichkeit mittranskribiert, sonst nicht. Achtung: Dies ist eher eine 'Empfehlung' ann das KI-Modell, kein harter Ja/Nein-Schalter. 
+- **Zeitstempel:** Fügt einen Zeitstempel im Format `[hh:mm:ss] alle 60 Sekunden oder bei Sprecher:innenwechsel in den Text ein (gut für MAXQDA).
+- **Start** beginnt den Transkriptionsprozess. Wenn bereits ein Prozess läuft, können trotzdem neue in Auftrag gegeben werden. Diese werden dann in die [Warteschlange](#warteschlange) eingereiht und erledigt, sobald sie an der Reihe sind.   
 
-- **Audiodatei auswählen:** Unterstützt werden nahezu alle Audio‑ und Videoformate.
-- **Ausgabedatei:** Standard ist `.html` (kompatibel mit dem Editor). Optional `.vtt` für Untertitel oder `.txt` als Klartext.
-- **Start/Stop:** Zeitbereich im Format `hh:mm:ss`, ideal zum Testen einzelner Ausschnitte.
-- **Sprache:** „Auto“ zur Erkennung oder „Multilingual“ für mehrere Sprachen (experimentell).
-- **Qualität:** „Precise“ liefert die besten Ergebnisse, „Fast“ ist schneller und erfordert mehr Nachkorrektur.
-- **Pausen markieren:** Stille wird als Punkte in Klammern markiert, optional ab 1/2/3 Sekunden.
-- **Sprechererkennung:** Anzahl der Sprecher wählen oder „Auto“. „None“ beschleunigt, liefert aber keinen Sprecherwechsel.
-- **Überlappende Sprache:** Markierung mit `//` (experimentell).
-- **Disfluencies:** Füllwörter und Satzabbrüche nach Möglichkeit mittranskribieren.
-- **Zeitstempel:** Optional alle 60 Sekunden oder bei Sprecherwechsel.
+<div style="clear: both;"></div>
 
-### Transcription process
+## Warteschlange
 
-- **Start** beginnt, **Cancel** bricht ab.
-- Eine Stunde Audio kann mehrere Stunden Rechenzeit benötigen.
-- Fortschritt erscheint in der Statuszeile, Log‑Ausgaben im Hauptfenster.
-- Zwischenspeicherung erfolgt automatisch.
-- Ergebnisse sollten immer im Editor geprüft werden.
+![Ansicht Warteschlange](/img/queue.png)
 
-### Batch transcription
+Der Tab „Warteschlange“ zeigt eine Liste aller Aufträge in der aktuellen Sitzung, ihren aktuellen Status und Fortschritt. Die Aufträge werden einer nach dem anderen abgearbeitet.  
 
-![Batch Queue](/img/queue.png)
+**Aktionen für Aufträge:**
 
-- Der Tab „Queue“ zeigt alle Jobs, Status und Fortschritt.
-- Neue Jobs werden in eine Warteschlange gestellt.
-- Mehrere Dateien lassen sich in einem Durchgang auswählen.
+- `X` löscht oder bricht den Auftrag ab.
+- `✔` öffnet das Ergebnis im Editor (auch bei Fehlern, sofern ein unvollständiges Transkript vorhanden ist).
+- `⟲` startet einen Job erneut (bei Fehlern/Abbruch).
 
-Job‑Buttons:
+Mit dem „Abbrechen“ Button unten rechts kann die gesamte Warteschlange beendet werden. 
 
-- `X` löscht oder bricht Jobs ab.
-- `✔` öffnet das Ergebnis im Editor (auch bei Fehlern).
-- `⟲` startet einen Job neu (bei Fehlern/Abbruch).
+## Der noScribe Editor
 
-## noScribe Edit
+Der Editor ist ein wichtiger Bestandteil von noScribe. Er dient zur Kontrolle und Korrektur der Transkripte. Das ist auch bei den besten KI-Modellen leider immer noch dringend erforderlich. 
 
 ![noScribe Editor](/img/noScribe_Editor.png)
 
-noScribeEdit ist der Editor zur Korrektur der Transkripte.
+Die wichtigste Funktion: **Ctrl+Space** (Mac: `^Space`) oder der **orangene Button** starten das Audio an der aktuellen Cursorposition. Die Textauswahl folgt der Audioaufnahme. Zum Editieren einfach an beliebiger Stelle in den Text klicken oder mit den Pfeiltasten navigieren.
 
-- **Ctrl+Space** (Mac: `^Space`) startet/stoppt Audio an der Cursorposition.
-- Die Auswahl folgt dem Audio; zum Editieren einfach klicken oder mit den Pfeiltasten navigieren.
-- Abspieltempo anpassen (z. B. 100%).
-- Sprechernamen per Suchen/Ersetzen ändern.
-- Zoom‑Funktion über Plus/Minus.
-- Typische Editor‑Shortcuts funktionieren (Speichern, Suchen, Rückgängig usw.).
+Sonstige Funktionen in der Toolbar: 
+- In dem **Kombinationsfeld ("100%")** kann man das Abspieltempo erhöhen/reduzieren.
+- Mit der **Lupe** wird ein Suchen/Ersetzen-Dialog aufgerufen. Das ist sehr hilfreich, um beispielsweise die Namen der Sprecher:innen zu ändern.
+- **Plus/Minus:** Zoom‑Funktion
+- Außerdem gibt es **typische Editor-Funktionen** um Dateien zu öffnen, Text zu kopieren oder zu formatieren. Auch die üblichen Tastenkombinationen (bspw. Strg+C zum Kopieren) funktionieren. Alle Funktionen sind auch über die Menüs erreichbar. Leider ist die Oberfläche des Editors aktuell nicht übersetzt. 
 
-Quellcode: https://github.com/kaixxx/noScribeEditor
+Der noScribe Editor ist eige eigenständige App, die auch unabhängig vom Hauptprogramm verwendet werden kann. 
 
-## Factors Influencing the Quality of the Transcription
+Quellcode: https://github.com/kaixxx/noScribeEditor
 
-- Gute Aufnahmequalität (klare Stimmen, wenig Störgeräusche) ist entscheidend.
-- Die Qualität variiert je nach Sprache; einige Sprachen sind deutlich besser unterstützt.
-- Dialekte werden oft erkannt, benötigen aber mehr Nacharbeit.
+## Typische Probleme KI-gestützter Transkriptionen
 
-## Known Issues
+KI-gestützte Spracherkennung hat in den letzten Jahren enorme Fortschritte gemacht. Trotzdem gibt es typische Probleme, Fehler und Einschränkungen, auf die man achten sollte:  
 
-- Fehlerhafte Transkriptionen und Sprecherzuordnung sind möglich – eine Prüfung ist notwendig.
-- Das Modell kann in seltenen Fällen halluzinieren (insbesondere in stillen Passagen).
-- Eigennamen und Begriffe werden häufiger falsch erkannt.
-- Wiederholte Textschleifen sind möglich; in diesem Fall kürzere Abschnitte transkribieren.
-- Multilinguale Audios sind experimentell und können Übersetzungen enthalten.
-- Nonverbale Ausdrücke (Lachen etc.) fehlen und müssen ergänzt werden.
-- Bei langen Audios kann Interpunktion/Kapitalisierung verloren gehen.
+- Nonverbale Ausdrücke wie Lachen, Seufzen, etc. werden nicht erfasst und müssen manuell ergänzt werden.
+- Gleichzeitiges Sprechen und interaktiv sehr dichte Passagen bspw. in Gruppendiskussionen sind  eine Herausforderung für das KI-Modell. Hier gehen auch teils Inhalte verloren oder werden falschen Personen zugeordnet.
+- Teils werden mehr Sprecher:innen erkannt, als tatsächlich anwesend waren. Hier hilft es, die korrekte Zahl vorher bei "Sprecher:in erkennen" anzugeben. 
+- Ungewöhnliche Namen von Personen oder Organisationen, Slangausdrücke oder Wörter aus anderen Sprachen werden oft falsch geschrieben, teils fast lautsprachlich. Hier kann Suchen & Ersetzen im noScribe Editor helfen.
+- Wie andere KI-Sprachmodelle kann auch das hier verwendete Modell Whisper manchmal "halluzinieren", also Worte oder Satzteile hinzufügen, die zwar inhaltlich passend erscheinen, tatsächlich aber nicht gesagt wurden - siehe diese [Studie der Cornell University](https://facctconference.org/static/papers24/facct24-111.pdf) zum Thema.
+- Selten können sich fortwährend wiederholende Textschleifen entstehen, ähnlich einer defekten Schallplatte. In diesem Fall kürzere Abschnitte mit leichter Überlappung transkribieren und manuell aneinanderfügen.
+- Eine Mischung mehrerer Sprachen in derselben Aufnahme kann dazu führen, dass das KI-Modell übersetzt statt wortgetreu zu transkribieren. 
+- Bei langen Audios kann die Interpunktion/Kapitalisierung verloren gehen. Auch hier kann eine Aufteilung des Transkripts möglicherweise helfen, oder man verwendet das Transkriptionsmodell "faster-whisper-large-v2", das weniger anfällig für dieses Problem ist. Es muss allerdings zunächst [installiert werden.](/docs/erweiterte-optionen/#andere-transkriptionsmodelle-nutzen).
+- Die Qualität des Ergebnisses hängt stark von der Sprache ab. Westliche Sprachen werden generell sehr gut unterstützt, auch kleinere wie bspw. Niederländisch. Gut ist auch die Unterstützung für Koreanisch, Chinesisch (Mandarin), oder Indonesisch. Dagegen werden andere, ebenfalls große Sprachen wie bspw. Persisch, Panjabi oder Tamil nur sehr fehlerhaft transkribiert. Dies ist ein klarer Fall von KI-Bias, in dem sich die ökonomischen Interessen von OpenAI spiegeln, die das Whisper-Modell trainiert haben. Hier findet man eine eine Übersicht zu [typischen Fehlerraten in verschiedenen Sprachen](https://github.com/openai/whisper?tab=readme-ov-file#available-models-and-languages). Siehe auch [dieses Paper](https://doi.org/10.1145/3576915.3624380) für einen Vergleich verscheidener Transkriptionsmodelle und deren Fehlerraten.

content/docs/download-installation.md

@@ -8,7 +8,8 @@ weight: 10
 
 **Aktuelle Version:** 0.7
 
-Alle Downloads liegen auf SWITCHdrive.ch, einer Datasharing-Plattform für Schweizer Hochschulen. Der Quellcode ist auf [GitHub](https://github.com/kaixxx/noScribe) verfügbar, auch für den [noScribe Editor](https://github.com/kaixxx/noScribeEditor).
+Alle Installationsdateien liegen auf SWITCHdrive.ch, einer sicheren Datasharing-Plattform für Schweizer Hochschulen. 
+Der Quellcode ist auf [GitHub](https://github.com/kaixxx/noScribe) verfügbar, auch für den [noScribe Editor](https://github.com/kaixxx/noScribeEditor).
 
 {{< button href="#windows" >}}Installation Windows{{< /button >}}
 {{< button href="#macos" >}}Installation macOS{{< /button >}}

content/docs/erweiterte-optionen.md

@@ -6,38 +6,51 @@ weight: 30
 
 # Erweiterte Optionen
 
-## Advanced Options
+### Skripting
 
-- **CLI‑Modus:** `noScribe.exe --help` zeigt Optionen; `--no-gui` ist für Skripting geeignet.
-- **Konfiguration:** Nach dem ersten Start liegt `config.yml` im Benutzerprofil:
+Seit Version 0.7 hat noScribe auch ein Kommandozeileninterface und kann so in eigene Skripte eingebunden werden. `noScribe.exe --help` zeigt die verfügbaren Optionen. Mit der Option `--no-gui` wird das Hauptfenster unterdrückt und noScribe läuft vollständig im Kommandozeilenmodus.
+
+### Konfiguration 
+
+Nach dem ersten Start liegt die Datei `config.yml` im Benutzer:innenprofil:
   - Windows: `C:\Users\<username>\AppData\Local\noScribe\noScribe\config.yml`
   - macOS: `~/Library/Application Support/noscribe/config.yml`
   - Linux: `~/.config/noScribe/config.yml`
-  Dort lassen sich u. a. UI‑Sprache und Modellparameter anpassen.
-- **Logs:** Im gleichen Profilverzeichnis existiert ein Ordner `log` mit detaillierten Transkript‑Logs.
 
-## Eigene Modelle (Whisper)
+Dort lassen sich u.a. die Sprache der Oberfläche und weitere Optionen anpassen. Achtung: Diese Datei nur bearbeiten, wenn noScribe nicht geöffnet ist. Sonst werden die Änderungen wieder überschrieben.
+
+### Logs 
 
-Kurzfassung der Schritte:
+Im gleichen Profilverzeichnis existiert ein Ordner `log` mit detaillierten Informationen zu jedem Transkript - gut für die Fehlersuche.
 
-1. In noScribe **Model > Add AI model...** öffnen.
-2. Pro Modell einen **eigenen Unterordner** anlegen (Ordnername = Modellname im UI).
-3. **Nur Faster‑Whisper/CTranslate2‑Modelle** werden unterstützt.
-4. Dateien in den Ordner legen (typisch: `config.json`, `model.bin`, `preprocessor_config.json`, `tokenizer.json`, `vocabulary.json`).
+## Spezielle Transkriptionsmodelle nutzen
 
-Pfade:
+NoScribe kommt mit zwei Transkriptionsmodellen (precise/fast), die beide auf *Whisper V3 turbo* basieren. Es können aber auch andere Whisper-Modelle genutzt werden, die bspw. besser auf bestimmte Sprachen abgestimmt sind. 
 
-- **Windows:** `C:\Users\<username>\AppData\Local\noScribe\noScribe\whisper_models\`
-- **macOS:** `~/Library/Application Support/noscribe/whisper_models/`
-- **Linux:** TODO: Pfad ergänzen.
+**Installation:**
 
-Hinweise:
+1. In noScribe unter *Modell* die Liste aufklappen und *KI-Modelle hinzufügen* auswählen. Es öffnet sich der Ordner `whisper_models` im noScribe Konfigurationsordner (Pfade siehe oben).
+2. Pro Modell einen *eigenen Unterordner* anlegen. Der Name dieses Unterordners ist dann später auch der Modellname, der in noScribe angezeigt wird.
+3. Alle zu diesem Modell gehörenden Dateien in diesen Ordner legen (typisch: `config.json`, `model.bin`, `preprocessor_config.json`, `tokenizer.json`, `vocabulary.json`).
+4. Jetzt sollte das neue Modell als zusätzliche Auswahl in noScribe unter *Modelle* erscheinen. 
 
+**Hinweise:**
+
+- Es werden nur Modelle im *Faster‑Whisper* bzw. *CTranslate2*-Format unterstützt. Modelle im originalen Whisper-Format von OpenAI können [konvertiert werden.](https://github.com/SYSTRAN/faster-whisper?tab=readme-ov-file#model-conversion)
 - Manche Downloads enthalten `ctranslate2_`‑Präfixe – diese entfernen (z. B. `ctranslate2_vocabulary.json` → `vocabulary.json`).
-- Für das deutsche Modell wird zusätzlich `tokenizer.json` aus dem Whisper‑v3‑Repository benötigt.
 
-Quelle:
-https://github.com/kaixxx/noScribe/wiki/Add-custom-Whisper-models-for-transcription
+**Modelle:** 
+
+- Das **offizielle Faster-Whisper-Repository** (15 Modelle): https://huggingface.co/Systran Hier gibt es auch Whisper-v2-Modell, das bis zur Version 0.5 von noScribe Standard war und immer noch von einigen bevorzugt wird, auch wenn es deutlich langsamer ist. Die rein englischen Modelle (mit der Endung „.en“) sind ebenfalls interessant, da sie deutlich schneller laufen.
+- **Eine für Französisch angepasste Version von Whisper V3**: https://huggingface.co/bofenghuang/whisper-large-v3-french/tree/main/ctranslate2 (Wenn die heruntergeladenen Dateien das Präfix „ctranslate2_“ haben, dieses bitte entfernen.
+- **Eine für Deutsch optimierte Version von Whisper V3** (meine Erfahrung: nur geringfügige Verbesserungen bei der Transkriptionsqualität, aber weniger Präzision bei der Pausenerkennung und der Identifizierung von überlappenden Sprachsequenzen): https://huggingface.co/aseifert/faster-whisper-large-v3-turbo-german/tree/main Sie benötigen außerdem die Datei `tokenizer.json` aus dem ursprünglichen Whisper V3-Repository: https://huggingface.co/Systran/faster-whisper-large-v3/tree/main
+
+Weitere Modelle findet man auf [huggingface](https://huggingface.co/). Suchen Sie nach „faster-whisper” und der gewünschten Sprache (oder nur nach „whisper”, um Modelle zu finden, die konvertiert werden können). 
+
+Ich verwende diese Version von Whisper V3 Turbo als „präzises” Modell: https://huggingface.co/mobiuslabsgmbh/faster-whisper-large-v3-turbo
+
+**Wenn Sie ein gutes neues Modell gefunden haben, teilen Sie es bitte in dieser Diskussion: https://github.com/kaixxx/noScribe/discussions/132**.
+
 
 ## Development and Contribution
 

layouts/partials/docs/menu-filetree.html

@@ -0,0 +1,74 @@
+{{ $bookSection := default "docs" .Site.Params.BookSection }}
+{{ if eq $bookSection "*" }}
+  {{ $bookSection = "/" }}{{/* Backward compatibility */}}
+{{ end }}
+
+{{ with .Site.GetPage $bookSection }}
+  {{ template "book-section-children" (dict "Section" . "CurrentPage" $) }}
+{{ end }}
+
+{{ define "book-section-children" }}{{/* (dict "Section" .Section "CurrentPage" .CurrentPage) */}}
+  <ul>
+    {{ range (where .Section.Pages "Params.bookHidden" "ne" true) }}
+      {{ if .IsSection }}
+        <li {{- if .Params.BookFlatSection }} class="book-section-flat" {{ end -}}>
+          {{ template "book-page-link" (dict "Page" . "CurrentPage" $.CurrentPage) }}
+          {{ template "book-section-children" (dict "Section" . "CurrentPage" $.CurrentPage) }}
+        </li>
+      {{ else if and .IsPage .Content }}
+        <li>
+          {{ template "book-page-link" (dict "Page" . "CurrentPage" $.CurrentPage) }}
+        </li>
+      {{ end }}
+    {{ end }}
+  </ul>
+{{ end }}
+
+{{ define "book-page-link" }}{{/* (dict "Page" .Page "CurrentPage" .CurrentPage) */}}
+  {{ $current := eq .CurrentPage .Page }}
+  {{ $ancestor := .Page.IsAncestor .CurrentPage }}
+
+  {{ if .Page.Params.BookCollapseSection }}
+    <input type="checkbox" id="section-{{ md5 .Page }}" class="toggle" {{ if or $current $ancestor }}checked{{ end }} />
+    <label for="section-{{ md5 .Page }}" class="flex">
+      <a {{ if .Page.Content }}href="{{ .Page.RelPermalink }}"{{ else }}role="button"{{ end }} class="{{ if $current }}active{{ end }}">
+        {{ template "book-icon-title" .Page -}}
+      </a>
+      <img src="{{ partial "docs/icon" "chevron-right" }}" class="book-icon" alt="{{ partial "docs/text/i18n" "Expand" }}" />
+    </label>
+  {{ else if .Page.Params.BookHref }}
+    <a href="{{ .Page.Params.BookHref }}" class="{{ if $current }}active{{ end }}" target="_blank" rel="noopener">
+      {{ template "book-icon-title" .Page -}}
+    </a>
+  {{ else if .Page.Content }}
+    <a href="{{ .Page.RelPermalink }}" class="{{ if $current }}active{{ end }}">
+      {{ template "book-icon-title" .Page -}}
+    </a>
+  {{ else }}
+    <a>
+      {{ template "book-icon-title" .Page -}}
+    </a>
+  {{ end }}
+
+  {{ if and $current .Page.Content }}
+    {{ template "book-page-toc" (dict "Page" .Page) }}
+  {{ end }}
+{{ end }}
+
+{{ define "book-page-toc" }}
+  {{ $toc := .Page.TableOfContents }}
+  {{ if and (ne .Page.Params.bookToC false) (ne $toc "<nav id=\"TableOfContents\"></nav>") }}
+    {{ $toc = replace $toc "id=\"TableOfContents\"" "class=\"book-menu-toc-list\"" }}
+    {{ $toc = replaceRE "(?s)</a>\\s*<ul>.*?</ul>" "</a>" $toc }}
+    <div class="book-menu-toc">
+      {{ $toc | safeHTML }}
+    </div>
+  {{ end }}
+{{ end }}
+
+{{ define "book-icon-title" }}
+{{- with .Page.Params.BookIcon -}}
+  <img src="{{ partial "docs/icon" . }}" class="book-icon" alt="{{ partial "docs/text/i18n" . }}" />
+{{- end -}}
+{{- partial "docs/title" .Page -}}
+{{ end }}