+
+Trilium supports seamless versioning of notes by storing snapshots ("revisions") of notes at regular intervals.
-
button in the Note buttons area.
icon for a manually saved revision).Named revisions are a new feature of Trilium v0.103.0 which allows adding + a short description of what the changes in the snapshot contain.
+The name of the revision is displayed underneath the time of the revision + in the sidebar, as well as at the top of the dialog where it is displayed + in full.
+Clicking on the edit button near the name of the revision allows it to + be changed.
+Revisions are saved:
+Additionally, revisions can also come from somewhere else, and this is + indicated via the icon of the revision:
+Time interval of taking note snapshot is configurable in the Options -> - Other dialog. This provides a tradeoff between more revisions and more + Other dialog. This provides a trade-off between more revisions and more data to store.
-To turn off note versioning for a particular note (or subtree), add +
To turn off note versioning for a particular note (or sub-tree), add
disableVersioning labelto the note.
The limit on the number of note snapshots can be configured in the Options
-> Other dialog. The note revision snapshot number limit refers to the
maximum number of revisions that can be saved for each note. Where -1 means
@@ -15,10 +115,5 @@
for a single note through the versioningLimit=X label.
The note limit will not take effect immediately; it will only apply when the note is modified.
-You can click the Erase excess revision snapshots now button - to apply the changes immediately.
-Note revisions can be accessed through the button on the right of ribbon - toolbar.
-
- 
-
You can click the Erase excess revision snapshots now button to + apply the changes immediately.
\ No newline at end of file diff --git a/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Basic Concepts and Features/Notes/Note Revisions_image.png b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Basic Concepts and Features/Notes/Note Revisions_image.png new file mode 100644 index 0000000000..3839f0a1e8 Binary files /dev/null and b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Basic Concepts and Features/Notes/Note Revisions_image.png differ diff --git a/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Basic Concepts and Features/Notes/Note Revisions_note-revisi.png b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Basic Concepts and Features/Notes/Note Revisions_note-revisi.png deleted file mode 100644 index de3f17b0e4..0000000000 Binary files a/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Basic Concepts and Features/Notes/Note Revisions_note-revisi.png and /dev/null differ diff --git a/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Markdown.html b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Markdown.html index 9d06e36996..be12436732 100644 --- a/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Markdown.html +++ b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Markdown.html @@ -32,38 +32,46 @@The following features are supported by Trilium's Markdown format and will show up in the preview pane:
```js)
- and automatic syntax highlightAll standard and GitHub-flavored syntax (basic formatting, tables, blockquotes)
+Code blocks with syntax highlight (e.g. ```js)
+ and automatic syntax highlight
Mermaid Diagrams using
```mermaid
-
Include Note (no - builtin Markdown syntax, but HTML syntax works just fine):
<section class="include-note" data-note-id="vJDjQm0VK8Na" data-box-size="expandable">
+
+ Include Note (no + builtin Markdown syntax, but HTML syntax works just fine):
<section class="include-note" data-note-id="vJDjQm0VK8Na" data-box-size="expandable">
</section>nInternal (reference) links via - its HTML syntax, or through a Wikilinks-like format (only - Note ID):
[[Hg8TS5ZOxti6]]Internal (reference) links via + its HTML syntax, or through a Wikilinks-like format (only + Note ID):
[[Hg8TS5ZOxti6]]There are two ways to create a Markdown note:
+There are multiple types of documentation for Trilium:
* The _User Guide_ represents the user-facing documentation. This documentation can be browsed by users directly from within Trilium, by pressing F1.
* The _Developer's Guide_ represents a set of Markdown documents that present the internals of Trilium, for developers.
diff --git a/docs/User Guide/!!!meta.json b/docs/User Guide/!!!meta.json
index caa6550464..aeda15c94d 100644
--- a/docs/User Guide/!!!meta.json
+++ b/docs/User Guide/!!!meta.json
@@ -4539,18 +4539,69 @@
"value": "bx bx-history",
"isInheritable": false,
"position": 30
+ },
+ {
+ "type": "relation",
+ "name": "internalLink",
+ "value": "IjZS7iK5EXtb",
+ "isInheritable": false,
+ "position": 40
+ },
+ {
+ "type": "relation",
+ "name": "internalLink",
+ "value": "8YBEPzcpUgxw",
+ "isInheritable": false,
+ "position": 50
+ },
+ {
+ "type": "relation",
+ "name": "internalLink",
+ "value": "pgxEVkzLl1OP",
+ "isInheritable": false,
+ "position": 70
+ },
+ {
+ "type": "relation",
+ "name": "internalLink",
+ "value": "GBBMSlVSOIGP",
+ "isInheritable": false,
+ "position": 80
+ },
+ {
+ "type": "relation",
+ "name": "internalLink",
+ "value": "A9Oc6YKKc65v",
+ "isInheritable": false,
+ "position": 90
}
],
"format": "markdown",
"dataFileName": "Note Revisions.md",
"attachments": [
{
- "attachmentId": "1TA1nUFZzprY",
- "title": "note-revisions.png",
+ "attachmentId": "BHquVQR30ess",
+ "title": "image.png",
"role": "image",
"mime": "image/png",
"position": 10,
- "dataFileName": "Note Revisions_note-revisi.png"
+ "dataFileName": "Note Revisions_image.png"
+ },
+ {
+ "attachmentId": "eoYsKZfMMvlg",
+ "title": "image.png",
+ "role": "image",
+ "mime": "image/png",
+ "position": 10,
+ "dataFileName": "1_Note Revisions_image.png"
+ },
+ {
+ "attachmentId": "w1kmtyCISdjQ",
+ "title": "image.png",
+ "role": "image",
+ "mime": "image/png",
+ "position": 10,
+ "dataFileName": "2_Note Revisions_image.png"
}
]
},
diff --git a/docs/User Guide/User Guide/Basic Concepts and Features/Notes/1_Note Revisions_image.png b/docs/User Guide/User Guide/Basic Concepts and Features/Notes/1_Note Revisions_image.png
new file mode 100644
index 0000000000..10b64a944c
Binary files /dev/null and b/docs/User Guide/User Guide/Basic Concepts and Features/Notes/1_Note Revisions_image.png differ
diff --git a/docs/User Guide/User Guide/Basic Concepts and Features/Notes/2_Note Revisions_image.png b/docs/User Guide/User Guide/Basic Concepts and Features/Notes/2_Note Revisions_image.png
new file mode 100644
index 0000000000..cdaf1cef60
Binary files /dev/null and b/docs/User Guide/User Guide/Basic Concepts and Features/Notes/2_Note Revisions_image.png differ
diff --git a/docs/User Guide/User Guide/Basic Concepts and Features/Notes/Note Revisions.md b/docs/User Guide/User Guide/Basic Concepts and Features/Notes/Note Revisions.md
index f359e9e8aa..1d44e22ffd 100644
--- a/docs/User Guide/User Guide/Basic Concepts and Features/Notes/Note Revisions.md
+++ b/docs/User Guide/User Guide/Basic Concepts and Features/Notes/Note Revisions.md
@@ -1,20 +1,66 @@
# Note Revisions
+ button in the Note buttons area.
-To turn off note versioning for a particular note (or subtree), add `disableVersioning` [label](../../Advanced%20Usage/Attributes.md)to the note.
+## Interaction
-## Note Revision Snapshots Limit
+> [!NOTE]
+> This documentation matches the redesign of the note revisions dialog on v0.103.0, older versions have a similar dialog but with some differences.
+
+* The full list of revisions are displayed on the left in reverse chronological order.
+ * The revisions are grouped by the date the revision was taken.
+ * This list does not contain the _current state_ of the note, so it is possible to have notes with no revisions/snapshots saved.
+* The icon of a revision indicates the _source_ of that revision (e.g. a icon for a manually saved revision).
+* Pressing the \[…\] on the top-right of the dialog displays multiple options, including:
+ * Saving a new revision now.
+ * Checking the interval and limit for this note (see below).
+ * Deleting all the revisions of this note.
+* For supported notes (text, code), changes are highlighted. This behavior can be toggled via the _Highlight changes_ at the top of the dialog.
+ * The highlighted changes are relative to the **current state of the note**, not to the revision prior to this one.
+* For any given revision, the buttons on the top-right allow operating on it:
+ * Deleting the revision.
+ * Downloading the revision locally.
+ * Restoring the revision, which replaces the current content of the note with the one from the revision. Another revision is saved containing the current content of the note.
+
+## Named revisions
+
+Named revisions are a new feature of Trilium v0.103.0 which allows adding a short description of what the changes in the snapshot contain.
+
+* The name of the revision is displayed underneath the time of the revision in the sidebar, as well as at the top of the dialog where it is displayed in full.
+* Clicking on the edit button near the name of the revision allows it to be changed.
+
+## When revisions are saved
+
+Revisions are saved:
+
+* Automatically at a fixed interval. This behavior can be configured (see below).
+* Manually, by:
+ * Going to the press the [note context menu](../UI%20Elements/Note%20buttons.md) and select _Save revision._
+ * Using the _Force Save Revision_ [keyboard shortcut](../Keyboard%20Shortcuts.md).
+ * In the _Revisions_ dialog, pressing the \[…\] button in the top-right and selecting _Save a revision now_.
+
+Additionally, revisions can also come from somewhere else, and this is indicated via the icon of the revision:
+
+* Generated externally, by ETAPI (REST API).
+* A modification created by AI.
+* A revision is restored, causing the existing note content to be saved as a revision to prevent potential data loss.
+
+#### Snapshot interval
+
+Time interval of taking note snapshot is configurable in the Options -> Other dialog. This provides a trade-off between more revisions and more data to store.
+
+To turn off note versioning for a particular note (or sub-tree), add `disableVersioning` [label](../../Advanced%20Usage/Attributes.md) to the note.
+
+#### Maximum revisions
The limit on the number of note snapshots can be configured in the Options -> Other dialog. The note revision snapshot number limit refers to the maximum number of revisions that can be saved for each note. Where -1 means no limit, 0 means delete all revisions. You can set the maximum revisions for a single note through the `versioningLimit=X` label.
The note limit will not take effect immediately; it will only apply when the note is modified.
-You can click the **Erase excess revision snapshots now** button to apply the changes immediately.
-
-Note revisions can be accessed through the button on the right of ribbon toolbar.
-
-
\ No newline at end of file
+You can click the _Erase excess revision snapshots now_ button to apply the changes immediately.
\ No newline at end of file
diff --git a/docs/User Guide/User Guide/Basic Concepts and Features/Notes/Note Revisions_image.png b/docs/User Guide/User Guide/Basic Concepts and Features/Notes/Note Revisions_image.png
new file mode 100644
index 0000000000..3839f0a1e8
Binary files /dev/null and b/docs/User Guide/User Guide/Basic Concepts and Features/Notes/Note Revisions_image.png differ
diff --git a/docs/User Guide/User Guide/Basic Concepts and Features/Notes/Note Revisions_note-revisi.png b/docs/User Guide/User Guide/Basic Concepts and Features/Notes/Note Revisions_note-revisi.png
deleted file mode 100644
index de3f17b0e4..0000000000
Binary files a/docs/User Guide/User Guide/Basic Concepts and Features/Notes/Note Revisions_note-revisi.png and /dev/null differ