Update docs with preferences (#602)

chidiwilliams · Sep 19, 2023 · a3b5489 · a3b5489
1 parent 775bb4a
commit a3b5489
Show file tree

Hide file tree

Showing 5 changed files with 50 additions and 25 deletions.
diff --git 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
@@ -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
@@ -0,0 +1,2 @@
+label: Usage
+position: 3
diff --git a/docs/docs/usage/file_import.md 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 → docs/docs/usage/live_recording.md b/docs/docs/usage.md → 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.