Skip to content

Commit 5c2e7f9

Browse files
author
luginf
committed
more precisions
1 parent d07fa97 commit 5c2e7f9

4 files changed

Lines changed: 23 additions & 3 deletions

File tree

snippets/README.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,18 @@ Insert reusable text snippets into your notes via a selection dialog.
77
- **Scripting › Insert snippet** — choose a snippet from the list and insert it at the cursor
88
- **Scripting › Manage snippets** — add, edit, or delete snippets
99

10+
You can also link those actions to a custom shortcut.
11+
12+
13+
## Actions
14+
15+
One toolbar button is registered:
16+
17+
| Button | Action |
18+
| ----------- | ---------------------------------------------------------------------------- |
19+
| **Snippet** | choose a snippet from the list and insert it at the cursor
20+
21+
1022
## Placeholders
1123

1224
Placeholders are replaced at insertion time.

snippets/info.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
"authors": ["@luginf"],
77
"platforms": ["linux", "macos", "windows"],
88
"minAppVersion": "26.4.11",
9-
"description": "Insert and manage reusable text snippets.\n\n<b>Usage</b>\nYou can create templates of reusable text snippets with 'Manage Snippets'. Then add them to your notes with 'insert snippets'. \nYou can also use placeholders ($CURRENT_YEAR, $CURRENT_DATE, $UUID...) which will be replaced at insertion time.",
9+
"description": "Insert and manage reusable text snippets.\n\n<b>Usage</b>\nYou can create templates of reusable text snippets from the custom actions menu 'Manage Snippets'. Then add them to your notes with 'insert snippets' from the same menu. \nYou can also use placeholders ($CURRENT_YEAR, $CURRENT_DATE, $UUID...) which will be replaced at insertion time.",
1010
"resources": [
1111
"InsertSnippetDialog.qml",
1212
"ManageSnippetsDialog.qml",

zettelkasten/README.md

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,14 @@ In the Zettelkasten method, each note carries a **permanent unique ID** embedded
88

99
This script implements that principle inside QOwnNotes using the native `[[filename|id]]` wiki-link format.
1010

11+
## Usage
12+
13+
- **Scripting › Insert Zettelkasten ID** — Insert a new unique ZK ID at the cursor position
14+
- **Scripting › insert Zettelkasten link** — Open a searchable dialog to pick a note and insert a `[[filename\|id]]` link
15+
- **Scripting › Repair Zettelkasten links** — can all notes and repair every link whose filename is out of date
16+
17+
You can also link those actions to a custom shortcut.
18+
1119
## Link format
1220

1321
```
@@ -19,7 +27,7 @@ This script implements that principle inside QOwnNotes using the native `[[filen
1927

2028
## Actions
2129

22-
Three toolbar buttons are registered:
30+
Three toolbar buttons are registered, following the custom actions listed above:
2331

2432
| Button | Action |
2533
| ----------- | ---------------------------------------------------------------------------- |

zettelkasten/info.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,6 @@
66
"authors": ["@luginf"],
77
"platforms": ["linux", "macos", "windows"],
88
"minAppVersion": "26.4.11",
9-
"description": "Generates configurable note IDs and inserts links supporting those IDs using the Zettelkasten method. \n\n<b>Usage</b>\nSelect 'Insert Zettelkasten ID' from the menu will create a unique ID into your file. You can configure the ID pattern to your liking in the script options, using an ECMAScript regeg. \nThen you can insert from an other document a link to the first one, using the 'insert Zettelkasten link' from the menu. You can select the correct link using a filter from filename or the ID, and it will create a [[filename|ID]] wiki-links to notes. The detection pattern has also to be configured into the plugin options, to match the ID generation (the default option will match the preconfigured ID pattern anyway).",
9+
"description": "Generates configurable note IDs and inserts links supporting those IDs using the Zettelkasten method. \n\n<b>Usage</b>\nSelect 'Insert Zettelkasten ID' from the custom actions menu will create a unique ID into your file. You can configure the ID pattern to your liking in the script options, using an ECMAScript regeg. \nThen you can insert from an other document a link to the first one, using the 'insert Zettelkasten link' from the custom actions menu. You can select the correct link using a filter from filename or the ID, and it will create a [[filename|ID]] wiki-links to notes. The detection pattern has also to be configured into the plugin options, to match the ID generation (the default option will match the preconfigured ID pattern anyway).\nIf you later rename your note, using from the custom actions menu 'Repair Zettelkasten links' will automatically search and rename every link whose filename is out of date, based on the correct ID.",
1010
"resources": ["ZkLinkDialog.qml"]
1111
}

0 commit comments

Comments
 (0)