mirror of
https://github.com/zadam/trilium.git
synced 2026-05-06 10:17:21 +02:00
docs(user): update note revisions to new layout
This commit is contained in:
Elian Doran
BIN
apps/server/src/assets/doc_notes/en/User Guide/User Guide/Basic Concepts and Features/Notes/1_Note Revisions_image.png
generated
vendored
Normal file
BIN
apps/server/src/assets/doc_notes/en/User Guide/User Guide/Basic Concepts and Features/Notes/1_Note Revisions_image.png
generated
vendored
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 927 B |
BIN
apps/server/src/assets/doc_notes/en/User Guide/User Guide/Basic Concepts and Features/Notes/2_Note Revisions_image.png
generated
vendored
Normal file
BIN
apps/server/src/assets/doc_notes/en/User Guide/User Guide/Basic Concepts and Features/Notes/2_Note Revisions_image.png
generated
vendored
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 356 KiB |
@@ -1,13 +1,113 @@
|
||||
<figure class="image">
|
||||
<img style="aspect-ratio:2089/1515;" src="2_Note Revisions_image.png"
|
||||
width="2089" height="1515">
|
||||
</figure>
|
||||
<p>Trilium supports seamless versioning of notes by storing snapshots ("revisions")
|
||||
of notes at regular intervals.</p>
|
||||
<h2>Note Revisions Snapshot Interval</h2>
|
||||
<h2>Displaying the revisions</h2>
|
||||
<ul>
|
||||
<li>On the <a class="reference-link" href="#root/pOsGYCXsbNQG/gh7bpGYxajRS/Vc8PjrjAGuOp/_help_IjZS7iK5EXtb">New Layout</a>,
|
||||
press the <a href="#root/pOsGYCXsbNQG/gh7bpGYxajRS/Vc8PjrjAGuOp/_help_8YBEPzcpUgxw">note context menu</a> and
|
||||
select <em>Note revisions…</em>
|
||||
</li>
|
||||
<li>On the old layout, press directly the
|
||||
<img class="image_resized" style="aspect-ratio:27/25;width:2.32%;"
|
||||
src="1_Note Revisions_image.png" width="27" height="25">button in the <a class="reference-link" href="#root/pOsGYCXsbNQG/gh7bpGYxajRS/Vc8PjrjAGuOp/_help_8YBEPzcpUgxw">Note buttons</a> area.</li>
|
||||
</ul>
|
||||
<h2>Interaction</h2>
|
||||
<aside class="admonition note">
|
||||
<p>This documentation matches the redesign of the note revisions dialog on
|
||||
v0.103.0, older versions have a similar dialog but with some differences.</p>
|
||||
</aside>
|
||||
<ul>
|
||||
<li>The full list of revisions are displayed on the left in reverse chronological
|
||||
order.
|
||||
<ul>
|
||||
<li>The revisions are grouped by the date the revision was taken.</li>
|
||||
<li
|
||||
>This list does not contain the <em>current state</em> of the note, so it
|
||||
is possible to have notes with no revisions/snapshots saved.</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li>The icon of a revision indicates the <em>source</em> of that revision (e.g.
|
||||
a
|
||||
<img class="image_resized" style="aspect-ratio:20/21;width:2.49%;" src="Note Revisions_image.png"
|
||||
width="20" height="21">icon for a manually saved revision).</li>
|
||||
<li>Pressing the […] on the top-right of the dialog displays multiple options,
|
||||
including:
|
||||
<ul>
|
||||
<li>Saving a new revision now.</li>
|
||||
<li>Checking the interval and limit for this note (see below).</li>
|
||||
<li>Deleting all the revisions of this note.</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li>For supported notes (text, code), changes are highlighted. This behavior
|
||||
can be toggled via the <em>Highlight changes</em> at the top of the dialog.
|
||||
<ul>
|
||||
<li>The highlighted changes are relative to the <strong>current state of the note</strong>,
|
||||
not to the revision prior to this one.</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li>For any given revision, the buttons on the top-right allow operating on
|
||||
it:
|
||||
<ul>
|
||||
<li>Deleting the revision.</li>
|
||||
<li>Downloading the revision locally.</li>
|
||||
<li>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.</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
<h2>Named revisions</h2>
|
||||
<p>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.</p>
|
||||
<ul>
|
||||
<li>
|
||||
<p>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.</p>
|
||||
</li>
|
||||
<li>
|
||||
<p>Clicking on the edit button near the name of the revision allows it to
|
||||
be changed.</p>
|
||||
</li>
|
||||
</ul>
|
||||
<h2>When revisions are saved</h2>
|
||||
<p>Revisions are saved:</p>
|
||||
<ul>
|
||||
<li>Automatically at a fixed interval. This behavior can be configured (see
|
||||
below).</li>
|
||||
<li>Manually, by:
|
||||
<ul>
|
||||
<li>Going to the press the <a href="#root/pOsGYCXsbNQG/gh7bpGYxajRS/Vc8PjrjAGuOp/_help_8YBEPzcpUgxw">note context menu</a> and
|
||||
select <em>Save revision.</em>
|
||||
</li>
|
||||
<li>Using the <em>Force Save Revision</em> <a href="#root/pOsGYCXsbNQG/gh7bpGYxajRS/_help_A9Oc6YKKc65v">keyboard shortcut</a>.</li>
|
||||
<li
|
||||
>In the <em>Revisions</em> dialog, pressing the […] button in the top-right
|
||||
and selecting <em>Save a revision now</em>.</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
<p>Additionally, revisions can also come from somewhere else, and this is
|
||||
indicated via the icon of the revision:</p>
|
||||
<ul>
|
||||
<li>Generated externally, by <a class="reference-link" href="#root/pOsGYCXsbNQG/tC7s2alapj8V/_help_pgxEVkzLl1OP">ETAPI (REST API)</a>.</li>
|
||||
<li
|
||||
>A modification created by <a class="reference-link" href="#root/pOsGYCXsbNQG/_help_GBBMSlVSOIGP">AI</a>.</li>
|
||||
<li
|
||||
>A revision is restored, causing the existing note content to be saved
|
||||
as a revision to prevent potential data loss.</li>
|
||||
</ul>
|
||||
<h4>Snapshot interval</h4>
|
||||
<p>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.</p>
|
||||
<p>To turn off note versioning for a particular note (or subtree), add
|
||||
<p>To turn off note versioning for a particular note (or sub-tree), add
|
||||
<code
|
||||
spellcheck="false">disableVersioning</code> <a href="#root/_help_zEY4DaJG4YT5">label</a>to the note.</p>
|
||||
<h2>Note Revision Snapshots Limit</h2>
|
||||
spellcheck="false">disableVersioning</code> <a href="#root/_help_zEY4DaJG4YT5">label</a> to the note.</p>
|
||||
<h4>Maximum revisions</h4>
|
||||
<p>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 <code spellcheck="false">versioningLimit=X</code> label.</p>
|
||||
<p>The note limit will not take effect immediately; it will only apply when
|
||||
the note is modified.</p>
|
||||
<p>You can click the <strong>Erase excess revision snapshots now</strong> button
|
||||
to apply the changes immediately.</p>
|
||||
<p>Note revisions can be accessed through the button on the right of ribbon
|
||||
toolbar.</p>
|
||||
<p>
|
||||
<img src="Note Revisions_note-revisi.png">
|
||||
</p>
|
||||
<p>You can click the <em>Erase excess revision snapshots now</em> button to
|
||||
apply the changes immediately.</p>
|
||||
BIN
apps/server/src/assets/doc_notes/en/User Guide/User Guide/Basic Concepts and Features/Notes/Note Revisions_image.png
generated
vendored
Normal file
BIN
apps/server/src/assets/doc_notes/en/User Guide/User Guide/Basic Concepts and Features/Notes/Note Revisions_image.png
generated
vendored
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 548 B |
Binary file not shown.
|
Before Width: | Height: | Size: 140 KiB |
52
apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Markdown.html
generated
vendored
52
apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Markdown.html
generated
vendored
@@ -32,38 +32,46 @@
|
||||
<p>The following features are supported by Trilium's Markdown format and
|
||||
will show up in the preview pane:</p>
|
||||
<ul>
|
||||
<li>All standard and GitHub-flavored syntax (basic formatting, tables, blockquotes)</li>
|
||||
<li
|
||||
>Code blocks with syntax highlight (e.g. <code spellcheck="false">```js</code>)
|
||||
and automatic syntax highlight</li>
|
||||
<li><a class="reference-link" href="#root/_help_NwBbFdNZ9h7O">Block quotes & admonitions</a>
|
||||
</li>
|
||||
<li><a class="reference-link" href="#root/_help_YfYAtQBcfo5V">Math Equations</a>
|
||||
</li>
|
||||
<li><a class="reference-link" href="#root/_help_s1aBHPd79XYj">Mermaid Diagrams</a> using
|
||||
<li>
|
||||
<p>All standard and GitHub-flavored syntax (basic formatting, tables, blockquotes)</p>
|
||||
</li>
|
||||
<li>
|
||||
<p>Code blocks with syntax highlight (e.g. <code spellcheck="false">```js</code>)
|
||||
and automatic syntax highlight</p>
|
||||
</li>
|
||||
<li>
|
||||
<p><a class="reference-link" href="#root/_help_NwBbFdNZ9h7O">Block quotes & admonitions</a>
|
||||
</p>
|
||||
</li>
|
||||
<li>
|
||||
<p><a class="reference-link" href="#root/_help_YfYAtQBcfo5V">Math Equations</a>
|
||||
</p>
|
||||
</li>
|
||||
<li>
|
||||
<p><a class="reference-link" href="#root/_help_s1aBHPd79XYj">Mermaid Diagrams</a> using
|
||||
<code
|
||||
spellcheck="false">```mermaid</code>
|
||||
</li>
|
||||
<li>
|
||||
<p><a class="reference-link" href="#root/_help_nBAXQFj20hS1">Include Note</a> (no
|
||||
builtin Markdown syntax, but HTML syntax works just fine):</p><pre><code class="language-text-x-trilium-auto"><section class="include-note" data-note-id="vJDjQm0VK8Na" data-box-size="expandable">
|
||||
</p>
|
||||
</li>
|
||||
<li>
|
||||
<p><a class="reference-link" href="#root/_help_nBAXQFj20hS1">Include Note</a> (no
|
||||
builtin Markdown syntax, but HTML syntax works just fine):</p><pre><code class="language-text-x-trilium-auto"><section class="include-note" data-note-id="vJDjQm0VK8Na" data-box-size="expandable">
|
||||
&nbsp;
|
||||
</section>n</code></pre>
|
||||
</li>
|
||||
<li>
|
||||
<p><a class="reference-link" href="#root/_help_hrZ1D00cLbal">Internal (reference) links</a> via
|
||||
its HTML syntax, or through a <em>Wikilinks</em>-like format (only
|
||||
<a
|
||||
class="reference-link" href="#root/_help_m1lbrzyKDaRB">Note ID</a>):</p><pre><code class="language-text-x-trilium-auto">[[Hg8TS5ZOxti6]]</code></pre>
|
||||
</li>
|
||||
</li>
|
||||
<li>
|
||||
<p><a class="reference-link" href="#root/_help_hrZ1D00cLbal">Internal (reference) links</a> via
|
||||
its HTML syntax, or through a <em>Wikilinks</em>-like format (only
|
||||
<a
|
||||
class="reference-link" href="#root/_help_m1lbrzyKDaRB">Note ID</a>):</p><pre><code class="language-text-x-trilium-auto">[[Hg8TS5ZOxti6]]</code></pre>
|
||||
</li>
|
||||
</ul>
|
||||
<h2>Creating Markdown notes</h2>
|
||||
<p>There are two ways to create a Markdown note:</p>
|
||||
<ol>
|
||||
<li>Create a new note (e.g. in the <a class="reference-link" href="#root/_help_oPVyFC7WL2Lp">Note Tree</a>)
|
||||
and select the type <em>Markdown</em>, just like all the other note types.</li>
|
||||
<li
|
||||
>Create a note of type <a class="reference-link" href="#root/_help_6f9hih2hXXZk">Code</a> and
|
||||
<li>Create a note of type <a class="reference-link" href="#root/_help_6f9hih2hXXZk">Code</a> and
|
||||
select as the language either <em>Markdown</em> or <em>GitHub-Flavored Markdown</em>.
|
||||
This maintains compatibility with your existing notes prior to the introduction
|
||||
of this feature.</li>
|
||||
|
||||
@@ -1,5 +1,5 @@
|
||||
# Documentation
|
||||
There are multiple types of documentation for Trilium:<img class="image-style-align-right" src="api/images/BZVD2exxpGnn/Documentation_image.png" width="205" height="162">
|
||||
There are multiple types of documentation for Trilium:<img class="image-style-align-right" src="api/images/88cjtiwxfR49/Documentation_image.png" width="205" height="162">
|
||||
|
||||
* The _User Guide_ represents the user-facing documentation. This documentation can be browsed by users directly from within Trilium, by pressing <kbd>F1</kbd>.
|
||||
* The _Developer's Guide_ represents a set of Markdown documents that present the internals of Trilium, for developers.
|
||||
|
||||
57
docs/User Guide/!!!meta.json
vendored
57
docs/User Guide/!!!meta.json
vendored
@@ -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"
|
||||
}
|
||||
]
|
||||
},
|
||||
|
||||
BIN
docs/User Guide/User Guide/Basic Concepts and Features/Notes/1_Note Revisions_image.png
vendored
Normal file
BIN
docs/User Guide/User Guide/Basic Concepts and Features/Notes/1_Note Revisions_image.png
vendored
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 927 B |
BIN
docs/User Guide/User Guide/Basic Concepts and Features/Notes/2_Note Revisions_image.png
vendored
Normal file
BIN
docs/User Guide/User Guide/Basic Concepts and Features/Notes/2_Note Revisions_image.png
vendored
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 356 KiB |
@@ -1,20 +1,66 @@
|
||||
# Note Revisions
|
||||
<figure class="image"><img style="aspect-ratio:2089/1515;" src="2_Note Revisions_image.png" width="2089" height="1515"></figure>
|
||||
|
||||
Trilium supports seamless versioning of notes by storing snapshots ("revisions") of notes at regular intervals.
|
||||
|
||||
## Note Revisions Snapshot Interval
|
||||
## Displaying the revisions
|
||||
|
||||
Time interval of taking note snapshot is configurable in the Options -> Other dialog. This provides a tradeoff between more revisions and more data to store.
|
||||
* On the <a class="reference-link" href="../UI%20Elements/New%20Layout.md">New Layout</a>, press the [note context menu](../UI%20Elements/Note%20buttons.md) and select _Note revisions…_
|
||||
* On the old layout, press directly the <img class="image_resized" style="aspect-ratio:27/25;width:2.32%;" src="1_Note Revisions_image.png" width="27" height="25"> button in the <a class="reference-link" href="../UI%20Elements/Note%20buttons.md">Note buttons</a> 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 <img class="image_resized" style="aspect-ratio:20/21;width:2.49%;" src="Note Revisions_image.png" width="20" height="21"> 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 <a class="reference-link" href="../../Advanced%20Usage/ETAPI%20(REST%20API).md">ETAPI (REST API)</a>.
|
||||
* A modification created by <a class="reference-link" href="../../AI.md">AI</a>.
|
||||
* 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.
|
||||
|
||||
|
||||
You can click the _Erase excess revision snapshots now_ button to apply the changes immediately.
|
||||
BIN
docs/User Guide/User Guide/Basic Concepts and Features/Notes/Note Revisions_image.png
vendored
Normal file
BIN
docs/User Guide/User Guide/Basic Concepts and Features/Notes/Note Revisions_image.png
vendored
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 548 B |
Binary file not shown.
|
Before Width: | Height: | Size: 140 KiB |
Reference in New Issue
Block a user