diff --git a/docs/src/content/docs/QuickAdd.md b/docs/src/content/docs/QuickAdd.md index 0f87a271..2da90265 100644 --- a/docs/src/content/docs/QuickAdd.md +++ b/docs/src/content/docs/QuickAdd.md @@ -9,6 +9,24 @@ Build your own capture and note workflows with the [QuickAdd](https://quickadd.o Install and enable QuickAdd from **Settings → Community plugins** first. +## Capture with QuickAdd + +Set a QuickAdd choice in PodNotes, and each capture runs it instead of inserting the timestamp at your cursor. The choice decides where the timestamp goes. Every capture runs it: **PodNotes: Capture Timestamp**, **PodNotes: Capture Last 10 Seconds**, **PodNotes: Capture Last 20 Seconds**, the player's capture buttons, and the headset or lock-screen capture. You need QuickAdd 2.33.0 or later. + +To add each timestamp to the end of a `## Notes` section in the episode's note: + +1. In **Settings → PodNotes**, under **Notes**, select **Create** next to **QuickAdd choice**. +2. Play an episode. +3. Run **PodNotes: Capture Timestamp**. + +**Create** adds a Capture choice named **Podcast capture** to QuickAdd, and you can change it there like any other choice. When the episode's note doesn't exist yet, the first capture creates it with only the `## Notes` heading and the timestamp. To start from your episode note template, create the note with **PodNotes: Create episode note** first. + +To use a choice you built yourself, select **Choose...** and pick it. In the choice, `{{VALUE:timestamp}}` is the text a capture inserts without QuickAdd. [Capture values](/QuickAdd/#capture-values) lists the others. + +PodNotes shows no **Undo** for these captures, because QuickAdd writes the text. A Capture choice shows QuickAdd's own notice. When QuickAdd can't run the choice, the capture writes nothing, and a notice says what to do: install, enable, or update QuickAdd, or choose another choice. To capture at your cursor again, select **Clear**, the x next to the choice. + +QuickAdd's API docs describe how PodNotes picks, looks up, and runs a choice, under [Choice Execution](https://quickadd.obsidian.guide/docs/QuickAddAPI/#choice-execution), and how **Create** imports one, under [Packages](https://quickadd.obsidian.guide/docs/QuickAddAPI/#packages). + ## Capture a timestamp with a comment A Capture choice, with no macro, writes a timestamp link and your comment on a new line below the cursor: @@ -184,3 +202,22 @@ For another provider: 19. Select **Summarize episode**. The AI Assistant puts the model's answer in `{{VALUE:output}}`, which only the later commands of the same macro can read. QuickAdd's [AI Assistant docs](https://quickadd.obsidian.guide/docs/AIAssistant/) describe the model and output settings. + +## Reference + +### Capture values + +A choice that a capture runs reads these values as `{{VALUE:}}`: + +| Name | Value | +| --- | --- | +| `timestamp` | The text a capture inserts without QuickAdd, from **Timestamp template**. For a range, the range. | +| `time` | The playback position as the player shows it, such as `12:34`. For a range, `12:24-12:34`. | +| `seconds` | The position in whole seconds. For a range, its start. | +| `link` | The `obsidian://podnotes` link that plays the episode from that position. | +| `episode` | The episode title. | +| `podcast` | The podcast name. | +| `url` | The episode's URL, as `{{url}}` writes it in a note. | +| `episodeNote` | The path of the episode's note, from **Episode note path**. | + +A value PodNotes doesn't have is empty, and QuickAdd doesn't ask for it. No value contains a private feed's address. `link` is empty for an episode PodNotes can't link to. diff --git a/docs/src/content/docs/commands.md b/docs/src/content/docs/commands.md index 84b997c7..05f0dcef 100644 --- a/docs/src/content/docs/commands.md +++ b/docs/src/content/docs/commands.md @@ -79,7 +79,7 @@ If another episode's file already exists at that path, the download fails. See [ Inserts a timestamp, formatted by **Timestamp template**, at the cursor of the note you are editing. If you are not editing a note, it goes to the note you edited last, if that note is still open in editing view. Otherwise, it goes to the end of the episode's note. See [Choose where a timestamp goes](/timestamps/#choose-where-a-timestamp-goes). The default format is `- {{linktime}}` with a space at the end. It makes a list item with a timestamp link. -After each capture, a notice says where the timestamp went and offers **Undo**. See [Undo a capture](/timestamps/#undo-a-capture). +After each capture, a notice says where the timestamp went and offers **Undo**. With **QuickAdd choice** set, the choice decides where it goes, and there is no **Undo**. See [Undo a capture](/timestamps/#undo-a-capture). Obsidian always lists the command, so you can add it to the mobile toolbar before you play anything. Without a loaded episode, it shows "Play an episode to capture". See [Capture timestamps](/timestamps/). ## Capture Last 10 Seconds / Capture Last 20 Seconds diff --git a/docs/src/content/docs/settings.md b/docs/src/content/docs/settings.md index 967a2858..9ff23df7 100644 --- a/docs/src/content/docs/settings.md +++ b/docs/src/content/docs/settings.md @@ -34,6 +34,7 @@ These settings decide what the previous-track and next-track buttons of a headse | --- | --- | --- | | **Timestamp template** | `- {{linktime}}` with a space at the end | Sets the text each capture inserts. While an episode is loaded, the setting shows the result for it. Its time tag also sets the times in transcripts that feeds publish. See [Capture timestamps](/timestamps/). | | **Timestamp offset (s)** | 0 | Subtracts this many seconds from each capture, to make up for reaction time. | +| **QuickAdd choice** | None | Runs this QuickAdd choice for each capture, instead of inserting the timestamp. **Choose...** picks one of your QuickAdd choices, and **Create** adds a ready-made one. See [Capture with QuickAdd](/QuickAdd/#capture-with-quickadd). | | **Episode note path** | `PodNotes/{{podcast}}/{{title}}.md` | Sets where PodNotes creates episode notes, and shows the path for one of your episodes. See [Create episode notes](/notes/). | | **Episode note template** | [The default episode note template](/templates/#default-episode-note-template) | Sets the content of a new episode note. | | **Podcast note path** | `PodNotes/Podcasts/{{podcast}}.md` | Sets where PodNotes creates the note for a whole podcast. See [Create a podcast note](/notes/#create-a-podcast-note). | diff --git a/docs/src/content/docs/timestamps.md b/docs/src/content/docs/timestamps.md index 5aa08ea1..760af3df 100644 --- a/docs/src/content/docs/timestamps.md +++ b/docs/src/content/docs/timestamps.md @@ -38,6 +38,8 @@ The capture commands work from anywhere, so you can capture while you browse epi 2. The note you edited last, at its cursor, if it is still open in editing view. A capture from the PodNotes view, or from a headset, usually goes here. 3. The end of the episode's note, found as [How PodNotes finds a note](/notes/#how-podnotes-finds-a-note) describes. If PodNotes finds none, it creates the note, without opening it. For a note created before PodNotes 2.22.0 that you renamed or moved, PodNotes then creates a second note. Creating the note needs **Episode note path** and **Episode note template**. +To choose where every capture goes, such as under a heading in the episode note, set **QuickAdd choice**. See [Capture with QuickAdd](/QuickAdd/#capture-with-quickadd). + ## Capture from a hotkey, the toolbar, or a headset To capture from a hotkey: