From a3b54891e8c403d28b7bf2d86443ad310d2d1b51 Mon Sep 17 00:00:00 2001 From: Chidi Williams Date: Tue, 19 Sep 2023 20:53:56 +0100 Subject: [PATCH] Update docs with preferences (#602) --- docs/docs/cli.md | 2 +- docs/docs/preferences.md | 25 +++++++++++++++++++ docs/docs/usage/_category_.yml | 2 ++ docs/docs/usage/file_import.md | 21 ++++++++++++++++ .../{usage.md => usage/live_recording.md} | 25 +------------------ 5 files changed, 50 insertions(+), 25 deletions(-) create mode 100644 docs/docs/preferences.md create mode 100644 docs/docs/usage/_category_.yml create mode 100644 docs/docs/usage/file_import.md rename docs/docs/{usage.md => usage/live_recording.md} (78%) diff --git a/docs/docs/cli.md b/docs/docs/cli.md index 325a4976d..09ae94f9f 100644 --- a/docs/docs/cli.md +++ b/docs/docs/cli.md @@ -1,6 +1,6 @@ --- title: CLI -sidebar_position: 4 +sidebar_position: 5 --- ## Commands diff --git a/docs/docs/preferences.md b/docs/docs/preferences.md new file mode 100644 index 000000000..13dcbf1f1 --- /dev/null +++ b/docs/docs/preferences.md @@ -0,0 +1,25 @@ +--- +title: Preferences +sidebar_position: 4 +--- + +Open the Preferences window from the Menu bar, or click `Ctrl/Cmd + ,`. + +## General Preferences + +### Default export file name + +Sets the default export file name for file transcriptions. For +example, a value of `{{ input_file_name }} ({{ task }}d on {{ date_time }})` will save TXT exports +as `Input Filename (transcribed on 19-Sep-2023 20-39-25).txt` by default. + +Available variables: + +| Key | Description | Example | +|-------------------|-------------------------------------------|------------------------------------------------------------------| +| `input_file_name` | File name of the imported file | `audio` (e.g. if the imported file path was `/path/to/audio.wav` | +| `task` | Transcription task | `transcribe`, `translate` | +| `language` | Language code | `en`, `fr`, `yo`, etc. | +| `model_type` | Model type | `Whisper`, `Whisper.cpp`, `Faster Whisper`, etc. | +| `model_size` | Model size | `tiny`, `base`, `small`, `medium`, `large`, etc. | +| `date_time` | Export time (format: `%d-%b-%Y %H-%M-%S`) | `19-Sep-2023 20-39-25` | diff --git a/docs/docs/usage/_category_.yml b/docs/docs/usage/_category_.yml new file mode 100644 index 000000000..388ecf9dc --- /dev/null +++ b/docs/docs/usage/_category_.yml @@ -0,0 +1,2 @@ +label: Usage +position: 3 diff --git a/docs/docs/usage/file_import.md b/docs/docs/usage/file_import.md new file mode 100644 index 000000000..39a28ec52 --- /dev/null +++ b/docs/docs/usage/file_import.md @@ -0,0 +1,21 @@ +--- +title: File Import +--- + +To import a file: + +- Click Import Media File on the File menu (or the '+' icon on the toolbar, or **Command/Ctrl + O**). +- Choose an audio or video file. +- Select a task, language, and the model settings. +- Click Run. +- When the transcription status shows 'Completed', double-click on the row (or select the row and click the '⤢' icon) to + open the transcription. + +| Field | Options | Default | Description | +|--------------------|---------------------|---------|----------------------------------------------------------------------------------------------------------------------------------------------------------| +| Export As | "TXT", "SRT", "VTT" | "TXT" | Export file format | +| Word-Level Timings | Off / On | Off | If checked, the transcription will generate a separate subtitle line for each word in the audio. Enabled only when "Export As" is set to "SRT" or "VTT". | + +(See the [Live Recording section](#live-recording) for more information about the task, language, and quality settings.) + +[![Media File Import on Buzz](https://cdn.loom.com/sessions/thumbnails/cf263b099ac3481082bb56d19b7c87fe-with-play.gif)](https://www.loom.com/share/cf263b099ac3481082bb56d19b7c87fe "Media File Import on Buzz") diff --git a/docs/docs/usage.md b/docs/docs/usage/live_recording.md similarity index 78% rename from docs/docs/usage.md rename to docs/docs/usage/live_recording.md index 10a21b166..baa1b1f1e 100644 --- a/docs/docs/usage.md +++ b/docs/docs/usage/live_recording.md @@ -1,30 +1,7 @@ --- -title: Usage -sidebar_position: 3 +title: Live Recording --- -## File import - -To import a file: - -- Click Import Media File on the File menu (or the '+' icon on the toolbar, or **Command/Ctrl + O**). -- Choose an audio or video file. -- Select a task, language, and the model settings. -- Click Run. -- When the transcription status shows 'Completed', double-click on the row (or select the row and click the '⤢' icon) to - open the transcription. - -| Field | Options | Default | Description | -|--------------------|---------------------|---------|----------------------------------------------------------------------------------------------------------------------------------------------------------| -| Export As | "TXT", "SRT", "VTT" | "TXT" | Export file format | -| Word-Level Timings | Off / On | Off | If checked, the transcription will generate a separate subtitle line for each word in the audio. Enabled only when "Export As" is set to "SRT" or "VTT". | - -(See the [Live Recording section](#live-recording) for more information about the task, language, and quality settings.) - -[![Media File Import on Buzz](https://cdn.loom.com/sessions/thumbnails/cf263b099ac3481082bb56d19b7c87fe-with-play.gif)](https://www.loom.com/share/cf263b099ac3481082bb56d19b7c87fe "Media File Import on Buzz") - -## Live recording - To start a live recording: - Select a recording task, language, quality, and microphone.