diff --git a/public/screenshots/de/plugins/obsidian.png b/public/screenshots/de/plugins/obsidian.png index 0f1a1c6..0c6a8d4 100644 Binary files a/public/screenshots/de/plugins/obsidian.png and b/public/screenshots/de/plugins/obsidian.png differ diff --git a/public/screenshots/de/plugins/obsidian.webp b/public/screenshots/de/plugins/obsidian.webp index e33fcef..ee87e3b 100644 Binary files a/public/screenshots/de/plugins/obsidian.webp and b/public/screenshots/de/plugins/obsidian.webp differ diff --git a/public/screenshots/en/plugins/obsidian.png b/public/screenshots/en/plugins/obsidian.png index 0f1a1c6..9e16a71 100644 Binary files a/public/screenshots/en/plugins/obsidian.png and b/public/screenshots/en/plugins/obsidian.png differ diff --git a/public/screenshots/en/plugins/obsidian.webp b/public/screenshots/en/plugins/obsidian.webp index e33fcef..7ce2d8d 100644 Binary files a/public/screenshots/en/plugins/obsidian.webp and b/public/screenshots/en/plugins/obsidian.webp differ diff --git a/src/content/addons/de/obsidian.mdx b/src/content/addons/de/obsidian.mdx index bcc2827..08b7eca 100644 --- a/src/content/addons/de/obsidian.mdx +++ b/src/content/addons/de/obsidian.mdx @@ -2,16 +2,17 @@ slug: obsidian name: Obsidian author: TypeWhisper -version: 1.0.0 +version: 1.1.0 icon: Gem brandLogo: obsidian -description: Speichere Transkriptionen direkt in deinem Obsidian Vault mit automatischer Erkennung, Daily Notes und Frontmatter-Unterstützung. +description: Speichere Transkriptionen als anpassbare Markdown-Notizen in deinem Obsidian-Vault, auf Wunsch mit YAML-Frontmatter, Tagesnotizen, Auto-Export und Live-Sync. categories: - action platforms: - mac - windows source: bundled +minAppVersion: 1.6.0 apiDocsUrl: https://obsidian.md sourceUrl: https://github.com/TypeWhisper/typewhisper-mac/tree/main/TypeWhisperPluginSDK/Plugins/ObsidianPlugin sourceUrls: @@ -19,32 +20,226 @@ sourceUrls: windows: https://github.com/TypeWhisper/typewhisper-win/tree/main/plugins/TypeWhisper.Plugin.Obsidian --- -## Über +## Überblick -Das Obsidian Plugin ermöglicht es dir, Transkriptionen direkt in deinem Obsidian Vault zu speichern. Es funktioniert als Action Plugin, das automatisch den Speicherort deines Vaults erkennt und Notizen aus Spracheingaben erstellt. Es unterstützt Daily Notes Integration, YAML Frontmatter und konfigurierbare Dateinamensvorlagen. +Das Obsidian-Plugin speichert TypeWhisper-Transkriptionen als normale Markdown-Dateien direkt in einem Ordner deines Vaults. Du kannst einzelne Notizen über ein Workflow-Action-Ziel erstellen oder mit **Auto-Export** jede abgeschlossene Transkription automatisch ablegen. -## Features +Version `1.1.0` erweitert die macOS-Version um frei konfigurierbare Markdown-Notizvorlagen, zusätzliche Metadaten und Live-Sync für spätere Korrekturen im TypeWhisper-Verlauf. Sie benötigt TypeWhisper `1.6.0` oder neuer auf macOS. -- Automatische Vault-Erkennung -- Konfigurierbarer Unterordner für Transkriptionen -- Dateinamensvorlagen mit Platzhaltern: `{{DATE}}`, `{{TIME}}`, `{{APP}}`, `{{LANG}}` -- Daily-Note-Modus - Transkriptionen an die heutige Daily Note anhängen -- YAML Frontmatter mit Metadaten (Datum, Sprache, Quell-App) -- Auto-Export - jede Transkription automatisch speichern ohne manuellen Auslöser +Quellen: [macOS-Plugin-Code](https://github.com/TypeWhisper/typewhisper-mac/tree/main/TypeWhisperPluginSDK/Plugins/ObsidianPlugin), [Implementierungs-PR #1089](https://github.com/TypeWhisper/typewhisper-mac/pull/1089) -## Konfiguration +Der grundlegende Ablauf ist: -- **Vault-Pfad** - Wird automatisch von Obsidian erkannt oder manuell festgelegt. -- **Unterordner** - Optionaler Unterordner innerhalb des Vaults für Transkriptionen. -- **Dateinamensvorlage** - Passe Dateinamen mit den Platzhaltern `{{DATE}}`, `{{TIME}}`, `{{APP}}`, `{{LANG}}` an. -- **Daily Note** - Transkriptionen an die heutige Daily Note anhängen statt separate Dateien zu erstellen. -- **Frontmatter** - YAML Frontmatter mit Metadaten zu jeder Notiz hinzufügen. -- **Auto-Export** - Jede Transkription automatisch in Obsidian speichern. +`Diktat → optionale Workflow-Aufbereitung → Obsidian-Action oder Auto-Export → Markdown-Datei im Vault` + +## Plattformen und Versionen + +| Plattform | Version | Funktionsumfang | +| --- | --- | --- | +| macOS | `1.1.0` | Notiz- und Dateinamensvorlagen, Tagesnotizen, YAML-Frontmatter, Auto-Export und Live-Sync. Erfordert TypeWhisper `1.6.0` oder neuer. | +| Windows | `1.0.0` | Vault-Auswahl, Unterordner, einfache Dateinamensvorlage, Tagesnotiz-Modus und automatisch erzeugtes YAML-Frontmatter. Notizvorlagen, Auto-Export und Live-Sync aus `1.1.0` sind dort noch nicht verfügbar. | + +Der Screenshot oben zeigt die aktuelle macOS-Konfiguration von Version `1.1.0`. Die folgenden Abschnitte beschreiben diesen Funktionsumfang; die Abweichungen unter Windows stehen in der Plattformtabelle. ## Einrichtung -1. Öffne TypeWhisper Einstellungen > Plugins -2. Finde das Obsidian Plugin und wähle deinen Vault (automatisch erkannt oder manuell durchsuchen) -3. Konfiguriere Unterordner und Dateinamensvorlage nach deinen Wünschen -4. Aktiviere optional den Daily-Note-Modus und YAML Frontmatter -5. Verwende Obsidian als Ziel-Aktion in deinen benutzerdefinierten Prompts +1. Öffne **Einstellungen > Integrationen** in TypeWhisper und öffne die Konfiguration von **Obsidian**. +2. Wähle einen erkannten Vault aus. Falls er nicht in der Liste erscheint, wähle **Durchsuchen ...** und öffne den Vault-Ordner manuell. +3. Lege optional einen **Unterordner** fest. Der Standard `TypeWhisper` speichert Notizen beispielsweise unter `/TypeWhisper/`. +4. Entscheide dich zwischen einzelnen Notizen und dem **Tagesnotiz-Modus**. +5. Passe Dateiname, Notizvorlage, Frontmatter und Tags an. +6. Wähle anschließend, ob du gezielt über das Action-Ziel **Save to Obsidian** exportieren oder **Auto-Export** für jede Transkription aktivieren möchtest. + +Das Plugin erstellt den konfigurierten Unterordner bei Bedarf. Bei einzelnen Notizen verhindert es Überschreiben durch nummerierte Dateinamen wie `Notiz 1.md`, wenn ein Name bereits existiert. + +## Zwei Wege zum Export + +### Gezielter Export über einen Workflow + +Verwende ein Action-Ziel, wenn nur bestimmte Diktate in Obsidian landen oder zuvor von einem LLM strukturiert werden sollen: + +1. Erstelle unter **Einstellungen > Workflows** einen eigenen Workflow. +2. Kopiere die **Workflow-Anweisung** aus den Obsidian-Einstellungen oder schreibe eine eigene. +3. Wähle **Save to Obsidian** als **Action-Ziel**. +4. Weise dem Workflow einen manuellen Kurzbefehl oder passende Regeln zu. + +Die mitgelieferte Anweisung bereinigt das Diktat und gibt nur Obsidian-kompatibles Markdown aus. Da der Workflow ein Action-Ziel verwendet, wird sein Ergebnis als Notiz gespeichert und nicht zusätzlich in die aktive App eingefügt. Weitere Details zu Auslösern, Regeln und Action-Zielen findest du in der [Workflow-Dokumentation](/de/docs/mac/workflows/). + +### Automatischer Export + +Aktiviere **Auto-Export**, um jede abgeschlossene Transkription in den gewählten Vault zu schreiben. Das eignet sich als vollständiges Sprachjournal oder Archiv. Wenn dieselbe Transkription bereits über das Workflow-Action-Ziel exportiert wurde, ordnet Version `1.1.0` den Abschluss der vorhandenen Notiz zu, statt durch Auto-Export eine zweite Datei anzulegen. + +## Dateinamen + +Die Standardvorlage lautet: + +```text +{{DATE}} {{TIME}} {{APP}} +``` + +So entsteht beispielsweise `2026-08-10 17-23-52 Safari.md`. Die Vorschau in den Plugin-Einstellungen zeigt den aktuellen Namen vor dem Export. + +| Platzhalter | Ergebnis | +| --- | --- | +| `{{DATE}}` | Datum im Format `YYYY-MM-DD` | +| `{{TIME}}` | Uhrzeit im dateisicheren Format `HH-MM-SS` | +| `{{APP}}` | Name der aktiven App, zum Beispiel `Safari` | +| `{{LANGUAGE}}` | Erkannte Sprache, zum Beispiel `de` oder `en` | + +Für Obsidian- und Dateisystem-kompatible Namen entfernt das Plugin unzulässige Zeichen wie `/`, `:`, `*`, `?`, `"`, `<`, `>`, `|`, `[` und `]`. + +## Notizvorlagen + +Die **Notizvorlage** bestimmt den vollständigen Markdown-Inhalt einer einzelnen Notiz. Der Standard `{{TRANSCRIPT}}` speichert nur das fertig verarbeitete Transkript. Du kannst Überschriften, Obsidian-Callouts, Links und Metadaten direkt in die Vorlage aufnehmen. + +| Platzhalter | Inhalt | +| --- | --- | +| `{{TRANSCRIPT}}` | Fertiges, gegebenenfalls durch den Workflow aufbereitetes Transkript | +| `{{RAW_TRANSCRIPT}}` | Ursprüngliches Transkript vor der Workflow-Aufbereitung | +| `{{DATE}}` | Aufnahmedatum als `YYYY-MM-DD` | +| `{{TIME}}` | Aufnahmezeit als `HH-MM-SS` | +| `{{APP}}` | Aktive App | +| `{{LANGUAGE}}` | Erkannte Sprache | +| `{{URL}}` | Aktive URL, wenn die Quell-App sie bereitstellt | +| `{{ENGINE}}` | Verwendete Transkriptions-Engine | +| `{{MODEL}}` | Verwendetes Modell, falls vorhanden | +| `{{DURATION}}` | Aufnahmedauer in Sekunden mit einer Nachkommastelle | +| `{{WORDS}}` | Anzahl der Wörter im fertigen Transkript | + +Nicht verfügbare optionale Metadaten werden als leerer Wert eingesetzt. Bei einem Workflow-Export können Engine, Modell und Dauer erst mit dem Abschlussereignis vorliegen; mit aktiviertem Live-Sync ergänzt das Plugin diese Daten in derselben Notiz. + +## Beispiele + +### 1. Strukturierte Besprechungsnotiz + +Dateiname: + +```text +{{DATE}} Meeting +``` + +Notizvorlage: + +```markdown +# Meeting vom {{DATE}} + +{{TRANSCRIPT}} + +--- +Quelle: {{APP}} +Dauer: {{DURATION}} Sekunden · {{WORDS}} Wörter +``` + +Kombiniere diese Vorlage mit einem Workflow, der das Diktat in die Abschnitte **Zusammenfassung**, **Entscheidungen** und **Aufgaben** gliedert. Das Workflow-Ergebnis ersetzt `{{TRANSCRIPT}}`; `{{RAW_TRANSCRIPT}}` bleibt verfügbar, wenn du zusätzlich das ursprüngliche Diktat archivieren möchtest. + +### 2. Recherche-Notiz mit Quelle + +Dateiname: + +```text +{{DATE}} {{APP}} Recherche +``` + +Notizvorlage: + +```markdown +# Recherche + +{{TRANSCRIPT}} + +> [!info] Quelle +> {{URL}} + +Sprache: `{{LANGUAGE}}` · Engine: `{{ENGINE}}` +``` + +Wenn die aktive App keine URL an TypeWhisper übermittelt, bleibt `{{URL}}` leer. + +### 3. Fertiges und ursprüngliches Transkript vergleichen + +```markdown +# Überarbeitete Notiz + +{{TRANSCRIPT}} + +
+Ursprüngliches Diktat + +{{RAW_TRANSCRIPT}} + +
+``` + +Das ist nützlich, wenn ein Workflow Füllwörter entfernt oder gesprochenen Text neu strukturiert, du aber den Rohtext in derselben Datei behalten möchtest. + +## YAML-Frontmatter + +Mit **YAML-Frontmatter** ergänzt das Plugin am Dateianfang Obsidian Properties. Je nach verfügbarem Kontext können Datum, App, Bundle-ID, URL, Sprache, Engine, Modell, Dauer, Wortzahl, Verarbeitungsschritte und deine Tags enthalten sein. + +Beispiel: + +```yaml +--- +date: 2026-08-10T15:23:52Z +app: "Safari" +bundleId: "com.apple.Safari" +url: "https://example.com/article" +language: "de" +engine: "parakeet" +model: "TDT" +duration: 42.5 +words: 118 +tags: + - "typewhisper" + - "recherche" +--- +``` + +Tags werden in den Einstellungen kommasepariert eingegeben. Das Frontmatter steht zusätzlich vor deiner Notizvorlage; du musst es daher nicht selbst in die Vorlage schreiben. + +## Tagesnotiz-Modus + +Im **Tagesnotiz-Modus** erstellt das Plugin nicht für jedes Diktat eine neue Datei. Es hängt alle Einträge an eine gemeinsame Datei an, standardmäßig `YYYY-MM-DD.md`. + +Für neue Einträge stehen vier Anhangsformate zur Verfügung: + +| Format | Vorlage | Ergebnis | +| --- | --- | --- | +| Zeitstempelabschnitt | `## {{TIME}}` + `{{TEXT}}` | Jeder Eintrag erhält eine Überschrift wie `## 17:23`; Abschnitte werden durch eine horizontale Linie getrennt. | +| Einfach anhängen | `{{TEXT}}` | Fügt den fertigen Text als eigenen Absatz an. | +| Aufzählung | `- {{TEXT}}` | Fügt jeden Eintrag als Listenpunkt an. | +| Benutzerdefiniert | Eigene Vorlage | Unterstützt `{{TEXT}}`, `{{TIME}}`, `{{DATE}}`, `{{APP}}`, `{{LANGUAGE}}` und `{{URL}}`. | + +Beispiel für ein Quelljournal: + +```markdown +### {{TIME}} · {{APP}} + +{{TEXT}} + +Quelle: {{URL}} +``` + +Frontmatter wird beim Erstellen einer neuen Tagesdatei einmalig geschrieben. Eine allgemeine Tagesdatei wie `{{DATE}}.md` erhält bewusst keine app-spezifischen Properties; enthält ihr Dateiname `{{APP}}`, können diese Metadaten ergänzt werden. + +## Live-Sync für Verlaufskorrekturen + +**Verlaufsänderungen live synchronisieren** ist standardmäßig aktiviert und gilt nur für einzelne Notizen. Wenn du das zugehörige Transkript später im TypeWhisper-Verlauf korrigierst, schreibt das Plugin dieselbe Markdown-Datei mit dem aktualisierten Text und den aktuellen Metadaten neu. Die Zuordnung bleibt über App- und Plugin-Neustarts erhalten. + +Beachte dabei: + +- Die Datei wird aus der konfigurierten Notizvorlage neu erzeugt. Manuelle Änderungen an dieser Datei in Obsidian können deshalb überschrieben werden. +- Der Tagesnotiz-Modus bleibt absichtlich append-only; Live-Sync ist dort deaktiviert, damit eine Korrektur nicht den falschen Abschnitt verändert. +- Das Plugin verfolgt höchstens die neuesten 500 Zuordnungen und entfernt Zuordnungen nach 30 Tagen. +- Aktualisiert werden nur vorhandene Markdown-Dateien innerhalb des aktuell konfigurierten Vaults. Dateien außerhalb des Vaults werden nicht verändert. + +Wenn du exportierte Notizen anschließend hauptsächlich in Obsidian weiterbearbeitest, deaktiviere Live-Sync, um diese Änderungen zu schützen. + +## Empfohlene Konfigurationen + +| Ziel | Einstellungen | +| --- | --- | +| Nur ausgewählte, aufbereitete Notizen | Auto-Export aus; eigener Workflow mit Action-Ziel **Save to Obsidian**; Live-Sync an | +| Vollständiges Transkriptionsarchiv | Auto-Export an; einzelne Notizen; Dateiname `{{DATE}} {{TIME}} {{APP}}` | +| Laufendes Sprachjournal | Auto-Export an; Tagesnotiz-Modus an; Zeitstempelabschnitt oder Aufzählung | +| Notizen nach dem Export manuell in Obsidian pflegen | Einzelne Notizen; Live-Sync aus | diff --git a/src/content/addons/en/obsidian.mdx b/src/content/addons/en/obsidian.mdx index 978346a..8565122 100644 --- a/src/content/addons/en/obsidian.mdx +++ b/src/content/addons/en/obsidian.mdx @@ -2,16 +2,17 @@ slug: obsidian name: Obsidian author: TypeWhisper -version: 1.0.0 +version: 1.1.0 icon: Gem brandLogo: obsidian -description: Save transcriptions directly to your Obsidian vault with auto-detection, daily notes, and frontmatter support. +description: Save transcriptions as customizable Markdown notes in your Obsidian vault, with optional YAML frontmatter, daily notes, auto-export, and live sync. categories: - action platforms: - mac - windows source: bundled +minAppVersion: 1.6.0 apiDocsUrl: https://obsidian.md sourceUrl: https://github.com/TypeWhisper/typewhisper-mac/tree/main/TypeWhisperPluginSDK/Plugins/ObsidianPlugin sourceUrls: @@ -19,32 +20,226 @@ sourceUrls: windows: https://github.com/TypeWhisper/typewhisper-win/tree/main/plugins/TypeWhisper.Plugin.Obsidian --- -## About +## Overview -The Obsidian plugin lets you save transcriptions directly into your Obsidian vault. It works as an Action Plugin that automatically detects your vault location and creates notes from voice input. Supports daily notes integration, YAML frontmatter, and configurable file naming templates. +The Obsidian plugin saves TypeWhisper transcriptions as regular Markdown files directly inside a folder in your vault. You can create selected notes through a workflow action target or enable **Auto-Export** to save every completed transcription automatically. -## Features +Version `1.1.0` adds fully configurable Markdown note templates, additional metadata, and live sync for later corrections in TypeWhisper History to the macOS plugin. It requires TypeWhisper `1.6.0` or newer on macOS. -- Automatic vault detection -- Configurable subfolder for transcriptions -- Filename templates with placeholders: `{{DATE}}`, `{{TIME}}`, `{{APP}}`, `{{LANG}}` -- Daily Note mode - append transcriptions to today's daily note -- YAML frontmatter with metadata (date, language, source app) -- Auto-export - automatically save every transcription without manual trigger +Sources: [macOS plugin source](https://github.com/TypeWhisper/typewhisper-mac/tree/main/TypeWhisperPluginSDK/Plugins/ObsidianPlugin), [implementation PR #1089](https://github.com/TypeWhisper/typewhisper-mac/pull/1089) -## Configuration +The basic flow is: -- **Vault Path** - Auto-detected from Obsidian or set manually. -- **Subfolder** - Optional subfolder within the vault for transcriptions. -- **Filename Template** - Customize filenames using `{{DATE}}`, `{{TIME}}`, `{{APP}}`, `{{LANG}}` placeholders. -- **Daily Note** - Append transcriptions to today's daily note instead of creating separate files. -- **Frontmatter** - Add YAML frontmatter with metadata to each note. -- **Auto-Export** - Automatically save every transcription to Obsidian. +`Dictation → optional workflow processing → Obsidian action or Auto-Export → Markdown file in the vault` + +## Platforms and Versions + +| Platform | Version | Features | +| --- | --- | --- | +| macOS | `1.1.0` | Note and filename templates, daily notes, YAML frontmatter, auto-export, and live sync. Requires TypeWhisper `1.6.0` or newer. | +| Windows | `1.0.0` | Vault selection, subfolder, basic filename template, daily note mode, and automatically generated YAML frontmatter. The `1.1.0` note template, auto-export, and live sync features are not available there yet. | + +The screenshot above shows the current macOS configuration for version `1.1.0`. The following sections describe that feature set; the Windows differences are listed in the platform table. ## Setup -1. Open TypeWhisper Settings > Plugins -2. Find the Obsidian plugin and select your vault (auto-detected or browse manually) -3. Configure subfolder and filename template to your preference -4. Optionally enable Daily Note mode and YAML frontmatter -5. Use Obsidian as a target action in your custom prompts +1. Open **Settings > Integrations** in TypeWhisper and open the **Obsidian** configuration. +2. Select a detected vault. If it does not appear in the list, choose **Browse...** and select the vault folder manually. +3. Optionally set a **Subfolder**. The `TypeWhisper` default saves notes under `/TypeWhisper/`, for example. +4. Choose between individual notes and **Daily Note Mode**. +5. Customize the filename, note template, frontmatter, and tags. +6. Decide whether to export selected dictations through the **Save to Obsidian** action target or enable **Auto-Export** for every transcription. + +The plugin creates the configured subfolder when needed. For individual notes, it avoids overwriting existing files by adding a number such as `Note 1.md` when a filename already exists. + +## Two Ways to Export + +### Selected Export Through a Workflow + +Use an action target when only selected dictations should go to Obsidian or when an LLM should structure them first: + +1. Create a Custom Workflow under **Settings > Workflows**. +2. Copy the **Workflow Instruction** from the Obsidian settings or write your own. +3. Select **Save to Obsidian** as the **Action Target**. +4. Assign a manual shortcut or suitable workflow rules. + +The included instruction cleans up the dictation and returns only Obsidian-compatible Markdown. Because the workflow uses an action target, its result is saved as a note instead of also being inserted into the foreground app. See the [Workflows guide](/en/docs/mac/workflows/) for triggers, matching rules, and action targets. + +### Automatic Export + +Enable **Auto-Export** to write every completed transcription into the selected vault. This works well for a complete voice journal or archive. If the same transcription was already exported through the workflow action target, version `1.1.0` associates the completion with the existing note instead of creating a second file through Auto-Export. + +## Filenames + +The default template is: + +```text +{{DATE}} {{TIME}} {{APP}} +``` + +This produces a filename such as `2026-08-10 17-23-52 Safari.md`. The preview in the plugin settings shows the current result before export. + +| Placeholder | Result | +| --- | --- | +| `{{DATE}}` | Date in `YYYY-MM-DD` format | +| `{{TIME}}` | Time in filename-safe `HH-MM-SS` format | +| `{{APP}}` | Active app name, such as `Safari` | +| `{{LANGUAGE}}` | Detected language, such as `de` or `en` | + +To keep names compatible with Obsidian and the file system, the plugin removes invalid characters such as `/`, `:`, `*`, `?`, `"`, `<`, `>`, `|`, `[` and `]`. + +## Note Templates + +The **Note Template** controls the complete Markdown body of each individual note. The `{{TRANSCRIPT}}` default saves only the final processed transcript. You can include headings, Obsidian callouts, links, and metadata directly in the template. + +| Placeholder | Content | +| --- | --- | +| `{{TRANSCRIPT}}` | Final transcript, including any workflow processing | +| `{{RAW_TRANSCRIPT}}` | Original transcript before workflow processing | +| `{{DATE}}` | Recording date as `YYYY-MM-DD` | +| `{{TIME}}` | Recording time as `HH-MM-SS` | +| `{{APP}}` | Active app | +| `{{LANGUAGE}}` | Detected language | +| `{{URL}}` | Active URL when the source app provides it | +| `{{ENGINE}}` | Transcription engine used | +| `{{MODEL}}` | Model used, when available | +| `{{DURATION}}` | Recording duration in seconds with one decimal place | +| `{{WORDS}}` | Word count of the final transcript | + +Unavailable optional metadata is replaced with an empty value. For a workflow action export, the engine, model, and duration may only become available with the completion event; with live sync enabled, the plugin adds them to the same note. + +## Examples + +### 1. Structured Meeting Note + +Filename: + +```text +{{DATE}} Meeting +``` + +Note template: + +```markdown +# Meeting on {{DATE}} + +{{TRANSCRIPT}} + +--- +Source: {{APP}} +Duration: {{DURATION}} seconds · {{WORDS}} words +``` + +Combine this template with a workflow that structures the dictation into **Summary**, **Decisions**, and **Action Items**. The workflow result replaces `{{TRANSCRIPT}}`; `{{RAW_TRANSCRIPT}}` remains available if you also want to preserve the original dictation. + +### 2. Research Note with a Source + +Filename: + +```text +{{DATE}} {{APP}} Research +``` + +Note template: + +```markdown +# Research + +{{TRANSCRIPT}} + +> [!info] Source +> {{URL}} + +Language: `{{LANGUAGE}}` · Engine: `{{ENGINE}}` +``` + +If the active app does not provide a URL to TypeWhisper, `{{URL}}` remains empty. + +### 3. Compare the Final and Original Transcript + +```markdown +# Edited Note + +{{TRANSCRIPT}} + +
+Original dictation + +{{RAW_TRANSCRIPT}} + +
+``` + +This is useful when a workflow removes filler words or restructures spoken text but you still want to keep the raw transcript in the same file. + +## YAML Frontmatter + +With **YAML Frontmatter** enabled, the plugin adds Obsidian Properties at the beginning of the file. Depending on the available context, they can include date, app, bundle ID, URL, language, engine, model, duration, word count, processing steps, and your tags. + +Example: + +```yaml +--- +date: 2026-08-10T15:23:52Z +app: "Safari" +bundleId: "com.apple.Safari" +url: "https://example.com/article" +language: "en" +engine: "parakeet" +model: "TDT" +duration: 42.5 +words: 118 +tags: + - "typewhisper" + - "research" +--- +``` + +Enter tags as a comma-separated list in the settings. Frontmatter is added before your note template, so you do not need to include it in the template yourself. + +## Daily Note Mode + +In **Daily Note Mode**, the plugin does not create a new file for every dictation. It appends all entries to one shared file, named `YYYY-MM-DD.md` by default. + +Four append formats are available for new entries: + +| Format | Template | Result | +| --- | --- | --- | +| Timestamp section | `## {{TIME}}` + `{{TEXT}}` | Gives each entry a heading such as `## 17:23`; sections are separated by a horizontal rule. | +| Plain append | `{{TEXT}}` | Adds the final text as its own paragraph. | +| Bullet list | `- {{TEXT}}` | Adds each entry as a list item. | +| Custom | Your own template | Supports `{{TEXT}}`, `{{TIME}}`, `{{DATE}}`, `{{APP}}`, `{{LANGUAGE}}`, and `{{URL}}`. | + +Example source journal: + +```markdown +### {{TIME}} · {{APP}} + +{{TEXT}} + +Source: {{URL}} +``` + +Frontmatter is written once when a new daily file is created. A generic daily file such as `{{DATE}}.md` intentionally omits app-specific properties; when its filename includes `{{APP}}`, that metadata can be included. + +## Live Sync for History Edits + +**Live Sync History Edits** is enabled by default and applies to individual notes only. When you later correct the related transcript in TypeWhisper History, the plugin rewrites the same Markdown file with the updated text and metadata. The association survives app and plugin restarts. + +Keep these details in mind: + +- The file is regenerated from the configured note template. Manual changes to that file in Obsidian may therefore be overwritten. +- Daily Note Mode intentionally remains append-only; live sync is disabled there so a correction cannot modify the wrong section. +- The plugin tracks at most the latest 500 associations and removes associations after 30 days. +- Only existing Markdown files inside the currently configured vault are updated. Files outside the vault are never changed. + +If you mainly continue editing exported notes in Obsidian, disable live sync to protect those changes. + +## Recommended Configurations + +| Goal | Settings | +| --- | --- | +| Only selected, processed notes | Auto-Export off; Custom Workflow with **Save to Obsidian** action target; live sync on | +| Complete transcription archive | Auto-Export on; individual notes; filename `{{DATE}} {{TIME}} {{APP}}` | +| Continuous voice journal | Auto-Export on; Daily Note Mode on; timestamp section or bullet list | +| Maintain notes manually in Obsidian after export | Individual notes; live sync off |