Skip to content
Snippets Groups Projects
Commit a5fca667 authored by Christian Bager Bach Houmann's avatar Christian Bager Bach Houmann
Browse files

docs: document note creation and timestamp features

parent 2bdb2d4f
No related branches found
No related tags found
No related merge requests found
PodNotes can create notes from templates. These templates can contain certain syntax, which will be expanded to metadata about the podcast episode you are listening to.
To use templates, you can use the `Create podcast note` Obsidian command.
This requires you to have defined a template for both the file path and note text.
## File path
This template will be used to create the file path for the note. You can use the following syntax:
- `{{title}}`: The title of the podcast episode.
- `{{podcast}}`: The name of the podcast.
Both syntax items will be formatted such that it is safe to use in a file path.
This means the following characters will be removed: `\ , # % & / { } * < > $ ' " : @ ‣ | ?`.
## Note template
This template will be used to create the note text. You can use the following syntax:
- `{{title}}`: The title of the podcast episode.
- `{{description}}`: The description of the podcast episode.
- You can use `{{description:> }}` to prepend each new line with a `>` (to put the entire description in a blockquote).
- `{{podcast}}`: The name of the podcast.
- `{{url}}`: The URL of the podcast episode.
- `{{date}}`: The publish date of the podcast episode.
- You can use `{{date:format}}` to specify a custom [Moment.js](https://momentjs.com) format. E.g. `{{date:YYYY-MM-DD}}`.
- `{{artwork}}`: The URL of the podcast artwork. If no artwork is found, an empty string will be used.
Timestamps can be created with the `Capture Timestamp` Obsidian command.
This will make PodNotes capture the current playback time to the active note, in the format given in the plugin settings.
## Settings
For timestamps, you can use the following format strings:
- `{{time}}`: The current playback time. Default format is `HH:mm:ss`.
- `{{linktime}}`: The current playback time, formatted as a link to the current episode. Default format is `HH:mm:ss`.
Both of these allow for custom formatting.
By using `{{time:format}}` or `{{linktime:format}}`, you can specify a custom [Moment.js](https://momentjs.com) format.
For example, you might use `{{time:H\h mm\m ss\s}}` to get the time in the format `0h 20m 37s`.
......@@ -4,6 +4,12 @@ edit_uri: edit/master/docs/docs
nav:
- Home: index.md
- Podcasts: podcasts.md
- 'Notes':
- Timestamps: timestamps.md
- Templates: templates.md
- Advanced:
- API: api.md
- Usage with QuickAdd: QuickAdd.md
theme:
name: material
palette:
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment