From 556acc0d46b4b6a95db662d14495789b06b813d4 Mon Sep 17 00:00:00 2001 From: Nathaniel Landau Date: Sun, 12 Mar 2023 14:08:44 -0400 Subject: [PATCH] docs: include move metadata in documentation --- README.md | 8 ++++++++ src/obsidian_metadata/cli.py | 13 +++++++++++-- 2 files changed, 19 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index c5c2b2b..2503f10 100644 --- a/README.md +++ b/README.md @@ -60,6 +60,7 @@ Once installed, run `obsidian-metadata` in your terminal to enter an interactive - **List notes in scope**: List notes that will be processed. **Add Metadata**: Add new metadata to your vault. + When adding a new key to inline metadata, the `insert location` value in the config file will specify where in the note it will be inserted. - **Add new metadata to the frontmatter** @@ -78,7 +79,14 @@ When adding a new key to inline metadata, the `insert location` value in the con - **Delete a value from a key** - **Delete an inline tag** +**Move Inline Metadata**: Move inline metadata to a specified location with a note + +- **Move to Top**: Move all inline metadata beneath the frontmatter +- **Move to After Title**: Move all inline metadata beneath the first markdown header +- **Move to Bottom**: Move all inline metadata to the bottom of the note + **Transpose Metadata**: Move metadata from inline to frontmatter or the reverse. + When transposing to inline metadata, the `insert location` value in the config file will specify where in the note it will be inserted. - **Transpose all metadata** - Moves all frontmatter to inline metadata, or the reverse diff --git a/src/obsidian_metadata/cli.py b/src/obsidian_metadata/cli.py index ed2b7d7..599e613 100644 --- a/src/obsidian_metadata/cli.py +++ b/src/obsidian_metadata/cli.py @@ -135,13 +135,22 @@ def main( • Delete a value from a key • Delete an inline tag + [bold underline]Move Inline Metadata[/] + Move inline metadata to a specified location with a note + + • Move to Top - Move all inline metadata beneath the frontmatter + • Move to After Title* - Move all inline metadata beneath the first markdown header + • Move to Bottom - Move all inline metadata to the bottom of the note + [bold underline]Transpose Metadata[/] - Move metadata from inline to frontmatter or the reverse. + Move metadata from inline to frontmatter or the reverse. When transposing to inline metadata, + the `insert location` value in the config file will specify where in the + note it will be inserted. • Transpose all metadata - Moves all frontmatter to inline metadata, or the reverse • Transpose key - Transposes a specific key and all it's values - • Transpose value- Transpose a specific key:value pair + • Transpose value - Transpose a specific key:value pair [bold underline]Review Changes[/] Prior to committing changes, review all changes that will be made.