mirror of
https://github.com/TriliumNext/Notes.git
synced 2025-07-27 10:02:59 +08:00
docs(guide): premium features
This commit is contained in:
Elian Doran
parent
45a446d0f6
commit
2c87721953
2
apps/server/src/assets/doc_notes/en/User Guide/!!!meta.json
generated
vendored
2
apps/server/src/assets/doc_notes/en/User Guide/!!!meta.json
generated
vendored
File diff suppressed because one or more lines are too long
52
apps/server/src/assets/doc_notes/en/User Guide/User Guide/Advanced Usage/Sharing.html
generated
vendored
52
apps/server/src/assets/doc_notes/en/User Guide/User Guide/Advanced Usage/Sharing.html
generated
vendored
@ -6,7 +6,8 @@ class="image">
|
|||||||
<img style="aspect-ratio:1144/660;" src="Sharing_image.png" width="1144"
|
<img style="aspect-ratio:1144/660;" src="Sharing_image.png" width="1144"
|
||||||
height="660">
|
height="660">
|
||||||
</figure>
|
</figure>
|
||||||
<h2>Features, interaction and limitations</h2>
|
|
||||||
|
<h2>Features, interaction and limitations</h2>
|
||||||
<ul>
|
<ul>
|
||||||
<li>Searching by note title.</li>
|
<li>Searching by note title.</li>
|
||||||
<li>Automatic dark/light mode based on the user's browser settings.</li>
|
<li>Automatic dark/light mode based on the user's browser settings.</li>
|
||||||
@ -34,7 +35,7 @@ class="image">
|
|||||||
</thead>
|
</thead>
|
||||||
<tbody>
|
<tbody>
|
||||||
<tr>
|
<tr>
|
||||||
<th><a class="reference-link" href="#root/pOsGYCXsbNQG/KSZ04uQ2D1St/_help_iPIMuisry3hd">Text</a>
|
<th><a class="reference-link" href="#root/_help_iPIMuisry3hd">Text</a>
|
||||||
</th>
|
</th>
|
||||||
<td>
|
<td>
|
||||||
<ul>
|
<ul>
|
||||||
@ -52,7 +53,7 @@ class="image">
|
|||||||
</td>
|
</td>
|
||||||
</tr>
|
</tr>
|
||||||
<tr>
|
<tr>
|
||||||
<th><a class="reference-link" href="#root/pOsGYCXsbNQG/KSZ04uQ2D1St/_help_6f9hih2hXXZk">Code</a>
|
<th><a class="reference-link" href="#root/_help_6f9hih2hXXZk">Code</a>
|
||||||
</th>
|
</th>
|
||||||
<td>
|
<td>
|
||||||
<ul>
|
<ul>
|
||||||
@ -66,27 +67,27 @@ class="image">
|
|||||||
</td>
|
</td>
|
||||||
</tr>
|
</tr>
|
||||||
<tr>
|
<tr>
|
||||||
<th><a class="reference-link" href="#root/pOsGYCXsbNQG/KSZ04uQ2D1St/_help_m523cpzocqaD">Saved Search</a>
|
<th><a class="reference-link" href="#root/_help_m523cpzocqaD">Saved Search</a>
|
||||||
</th>
|
</th>
|
||||||
<td colspan="2">Not supported.</td>
|
<td>Not supported.</td>
|
||||||
</tr>
|
</tr>
|
||||||
<tr>
|
<tr>
|
||||||
<th><a class="reference-link" href="#root/pOsGYCXsbNQG/KSZ04uQ2D1St/_help_iRwzGnHPzonm">Relation Map</a>
|
<th><a class="reference-link" href="#root/_help_iRwzGnHPzonm">Relation Map</a>
|
||||||
</th>
|
</th>
|
||||||
<td colspan="2">Not supported.</td>
|
<td>Not supported.</td>
|
||||||
</tr>
|
</tr>
|
||||||
<tr>
|
<tr>
|
||||||
<th><a class="reference-link" href="#root/pOsGYCXsbNQG/KSZ04uQ2D1St/_help_bdUJEHsAPYQR">Note Map</a>
|
<th><a class="reference-link" href="#root/_help_bdUJEHsAPYQR">Note Map</a>
|
||||||
</th>
|
</th>
|
||||||
<td colspan="2">Not supported.</td>
|
<td>Not supported.</td>
|
||||||
</tr>
|
</tr>
|
||||||
<tr>
|
<tr>
|
||||||
<th><a class="reference-link" href="#root/pOsGYCXsbNQG/KSZ04uQ2D1St/_help_HcABDtFCkbFN">Render Note</a>
|
<th><a class="reference-link" href="#root/_help_HcABDtFCkbFN">Render Note</a>
|
||||||
</th>
|
</th>
|
||||||
<td colspan="2">Not supported.</td>
|
<td>Not supported.</td>
|
||||||
</tr>
|
</tr>
|
||||||
<tr>
|
<tr>
|
||||||
<th><a class="reference-link" href="#root/pOsGYCXsbNQG/KSZ04uQ2D1St/_help_GTwFsgaA0lCt">Book</a>
|
<th><a class="reference-link" href="#root/_help_GTwFsgaA0lCt">Book</a>
|
||||||
</th>
|
</th>
|
||||||
<td>
|
<td>
|
||||||
<ul>
|
<ul>
|
||||||
@ -100,7 +101,7 @@ class="image">
|
|||||||
</td>
|
</td>
|
||||||
</tr>
|
</tr>
|
||||||
<tr>
|
<tr>
|
||||||
<th><a class="reference-link" href="#root/pOsGYCXsbNQG/KSZ04uQ2D1St/_help_s1aBHPd79XYj">Mermaid Diagrams</a>
|
<th><a class="reference-link" href="#root/_help_s1aBHPd79XYj">Mermaid Diagrams</a>
|
||||||
</th>
|
</th>
|
||||||
<td>
|
<td>
|
||||||
<ul>
|
<ul>
|
||||||
@ -114,7 +115,7 @@ class="image">
|
|||||||
</td>
|
</td>
|
||||||
</tr>
|
</tr>
|
||||||
<tr>
|
<tr>
|
||||||
<th><a class="reference-link" href="#root/pOsGYCXsbNQG/KSZ04uQ2D1St/_help_grjYqerjn243">Canvas</a>
|
<th><a class="reference-link" href="#root/_help_grjYqerjn243">Canvas</a>
|
||||||
</th>
|
</th>
|
||||||
<td>
|
<td>
|
||||||
<ul>
|
<ul>
|
||||||
@ -128,12 +129,12 @@ class="image">
|
|||||||
</td>
|
</td>
|
||||||
</tr>
|
</tr>
|
||||||
<tr>
|
<tr>
|
||||||
<th><a class="reference-link" href="#root/pOsGYCXsbNQG/KSZ04uQ2D1St/_help_1vHRoWCEjj0L">Web View</a>
|
<th><a class="reference-link" href="#root/_help_1vHRoWCEjj0L">Web View</a>
|
||||||
</th>
|
</th>
|
||||||
<td colspan="2">Not supported.</td>
|
<td>Not supported.</td>
|
||||||
</tr>
|
</tr>
|
||||||
<tr>
|
<tr>
|
||||||
<th><a class="reference-link" href="#root/pOsGYCXsbNQG/KSZ04uQ2D1St/_help_gBbsAeiuUxI5">Mind Map</a>
|
<th><a class="reference-link" href="#root/_help_gBbsAeiuUxI5">Mind Map</a>
|
||||||
</th>
|
</th>
|
||||||
<td>The diagram is displayed as a vector image.</td>
|
<td>The diagram is displayed as a vector image.</td>
|
||||||
<td>
|
<td>
|
||||||
@ -143,12 +144,12 @@ class="image">
|
|||||||
</td>
|
</td>
|
||||||
</tr>
|
</tr>
|
||||||
<tr>
|
<tr>
|
||||||
<th><a class="reference-link" href="#root/pOsGYCXsbNQG/KSZ04uQ2D1St/_help_81SGnPGMk7Xc">Geo Map</a>
|
<th><a class="reference-link" href="#root/_help_81SGnPGMk7Xc">Geo Map</a>
|
||||||
</th>
|
</th>
|
||||||
<td colspan="2">Not supported.</td>
|
<td>Not supported.</td>
|
||||||
</tr>
|
</tr>
|
||||||
<tr>
|
<tr>
|
||||||
<th><a class="reference-link" href="#root/pOsGYCXsbNQG/KSZ04uQ2D1St/_help_W8vYD3Q1zjCR">File</a>
|
<th><a class="reference-link" href="#root/_help_W8vYD3Q1zjCR">File</a>
|
||||||
</th>
|
</th>
|
||||||
<td>Basic interaction (downloading the file).</td>
|
<td>Basic interaction (downloading the file).</td>
|
||||||
<td>
|
<td>
|
||||||
@ -183,9 +184,11 @@ class="image">
|
|||||||
<img src="Sharing_share-single-note.png" alt="Share Note">
|
<img src="Sharing_share-single-note.png" alt="Share Note">
|
||||||
</p>
|
</p>
|
||||||
</li>
|
</li>
|
||||||
<li><strong>Access the Shared Note</strong>: The link provided will open the
|
<li>
|
||||||
note in your browser. If your server is not configured with a public IP,
|
<p><strong>Access the Shared Note</strong>: The link provided will open the
|
||||||
the URL will refer to <code>localhost (127.0.0.1)</code>.</li>
|
note in your browser. If your server is not configured with a public IP,
|
||||||
|
the URL will refer to <code>localhost (127.0.0.1)</code>.</p>
|
||||||
|
</li>
|
||||||
</ol>
|
</ol>
|
||||||
<h2>Sharing a Note Subtree</h2>
|
<h2>Sharing a Note Subtree</h2>
|
||||||
<p>When you share a note, you actually share the entire subtree of notes
|
<p>When you share a note, you actually share the entire subtree of notes
|
||||||
@ -337,7 +340,8 @@ for (const attr of parentNote.attributes) {
|
|||||||
</tbody>
|
</tbody>
|
||||||
</table>
|
</table>
|
||||||
</figure>
|
</figure>
|
||||||
<h2>Credits</h2>
|
|
||||||
|
<h2>Credits</h2>
|
||||||
<p>Since v0.95.0, a new theme was introduced (and enabled by default) which
|
<p>Since v0.95.0, a new theme was introduced (and enabled by default) which
|
||||||
greatly improves the visual aspect of the Share feature, as well as its
|
greatly improves the visual aspect of the Share feature, as well as its
|
||||||
functionality (such as mobile support, dark/light mode, collapsible tree,
|
functionality (such as mobile support, dark/light mode, collapsible tree,
|
||||||
|
|||||||
@ -24,6 +24,7 @@
|
|||||||
</tbody>
|
</tbody>
|
||||||
</table>
|
</table>
|
||||||
</figure>
|
</figure>
|
||||||
|
|
||||||
<h2>By adding an attribute to the note</h2>
|
<h2>By adding an attribute to the note</h2>
|
||||||
<p>Simply add the <code>#shareRaw</code> attribute and the note will always
|
<p>Simply add the <code>#shareRaw</code> attribute and the note will always
|
||||||
be rendered <em>raw</em> when accessed from the share URL.</p>
|
be rendered <em>raw</em> when accessed from the share URL.</p>
|
||||||
|
|||||||
@ -146,6 +146,8 @@
|
|||||||
<li><code>#publicationYear %= '19[0-9]{2}'</code>: Use the '%=' operator to
|
<li><code>#publicationYear %= '19[0-9]{2}'</code>: Use the '%=' operator to
|
||||||
match a regular expression (regex). This feature has been available since
|
match a regular expression (regex). This feature has been available since
|
||||||
Trilium 0.52.</li>
|
Trilium 0.52.</li>
|
||||||
|
<li><code>note.content %= '\\d{2}:\\d{2} (PM|AM)'</code>: Find notes that
|
||||||
|
mention a time. Backslashes in a regex must be escaped.</li>
|
||||||
</ul>
|
</ul>
|
||||||
<h3>Advanced Use Cases</h3>
|
<h3>Advanced Use Cases</h3>
|
||||||
<ul>
|
<ul>
|
||||||
|
|||||||
22
apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Text.html
generated
vendored
22
apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Text.html
generated
vendored
@ -142,18 +142,32 @@ class="table">
|
|||||||
</td>
|
</td>
|
||||||
<td>
|
<td>
|
||||||
<ul>
|
<ul>
|
||||||
<li>Indentation</li>
|
<li>Indentation
|
||||||
<li>Markdown import</li>
|
<ul>
|
||||||
|
<li>Markdown import</li>
|
||||||
|
</ul>
|
||||||
|
</li>
|
||||||
<li><a class="reference-link" href="#root/_help_2x0ZAX9ePtzV">Cut to subnote</a>
|
<li><a class="reference-link" href="#root/_help_2x0ZAX9ePtzV">Cut to subnote</a>
|
||||||
</li>
|
</li>
|
||||||
</ul>
|
</ul>
|
||||||
</td>
|
</td>
|
||||||
</tr>
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td><a class="reference-link" href="#root/pOsGYCXsbNQG/KSZ04uQ2D1St/iPIMuisry3hd/_help_gLt3vA97tMcp">Premium features</a>
|
||||||
|
</td>
|
||||||
|
<td>
|
||||||
|
<ul>
|
||||||
|
<li><a class="reference-link" href="#root/pOsGYCXsbNQG/KSZ04uQ2D1St/iPIMuisry3hd/gLt3vA97tMcp/_help_ZlN4nump6EbW">Slash Commands</a>
|
||||||
|
</li>
|
||||||
|
<li><a class="reference-link" href="#root/pOsGYCXsbNQG/tC7s2alapj8V/_help_KC1HB96bqqHX">Templates</a>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
</td>
|
||||||
|
</tr>
|
||||||
</tbody>
|
</tbody>
|
||||||
</table>
|
</table>
|
||||||
</figure>
|
</figure>
|
||||||
|
<h2>Read-Only vs. Editing Mode</h2>
|
||||||
<h2>Read-Only vs. Editing Mode</h2>
|
|
||||||
<p>Text notes are usually opened in edit mode. However, they may open in
|
<p>Text notes are usually opened in edit mode. However, they may open in
|
||||||
read-only mode if the note is too big or the note is explicitly marked
|
read-only mode if the note is too big or the note is explicitly marked
|
||||||
as read-only. For more information, see <a class="reference-link"
|
as read-only. For more information, see <a class="reference-link"
|
||||||
|
|||||||
17
apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Text/Premium features.html
generated
vendored
Normal file
17
apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Text/Premium features.html
generated
vendored
Normal file
@ -0,0 +1,17 @@
|
|||||||
|
<p>The text editor we are using for <a class="reference-link" href="#root/pOsGYCXsbNQG/KSZ04uQ2D1St/_help_iPIMuisry3hd">Text</a> notes
|
||||||
|
is called CKEditor and it's a commercial product. The core components are
|
||||||
|
open-source, however they <a href="https://ckeditor.com/docs/trial/latest/index.html">offer quite a few features</a> that
|
||||||
|
require a commercial license in order to be used.</p>
|
||||||
|
<p>We have reached out to the CKEditor team in order to obtain a license
|
||||||
|
in order to have some of these extra features and they have agreed, based
|
||||||
|
on a signed agreement.</p>
|
||||||
|
<h2>How the license works</h2>
|
||||||
|
|
||||||
|
<p>The license key is stored in the application and it enables the use of
|
||||||
|
the previously described premium features. The license key has an expiration
|
||||||
|
date which means that the features can become disabled if using an older
|
||||||
|
version of the application for extended periods of time.</p>
|
||||||
|
<h2>Can I opt out of these features?</h2>
|
||||||
|
|
||||||
|
<p>At this moment there is no way to disable this features, apart from manually
|
||||||
|
modifying the source code. If this is a problem, <a href="#root/pOsGYCXsbNQG/BgmBlOIl72jZ/_help_wy8So3yZZlH9">let us know</a>.</p>
|
||||||
BIN
apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Text/Premium features/1_Text Snippets_image.png
generated
vendored
Normal file
BIN
apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Text/Premium features/1_Text Snippets_image.png
generated
vendored
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 377 B |
35
apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Text/Premium features/Slash Commands.html
generated
vendored
Normal file
35
apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Text/Premium features/Slash Commands.html
generated
vendored
Normal file
@ -0,0 +1,35 @@
|
|||||||
|
<figure class="image image-style-align-right">
|
||||||
|
<img style="aspect-ratio:419/571" src="Slash Commands_image.png" width="419"
|
||||||
|
height="571" />
|
||||||
|
</figure>
|
||||||
|
<aside class="admonition note">
|
||||||
|
<p>This is a premium feature of the editor we are using (CKEditor) and we
|
||||||
|
benefit from it thanks to an written agreement with the team. See <a class="reference-link"
|
||||||
|
href="#root/_help_gLt3vA97tMcp">Premium features</a> for more information.</p>
|
||||||
|
</aside>
|
||||||
|
<p>Slash commands is a feature of <a class="reference-link" href="#root/pOsGYCXsbNQG/KSZ04uQ2D1St/_help_iPIMuisry3hd">Text</a> notes
|
||||||
|
which allows easily accessing commonly used commands simply by using the
|
||||||
|
keyboard, without having to remember dedicated <a class="reference-link"
|
||||||
|
href="#root/pOsGYCXsbNQG/gh7bpGYxajRS/_help_A9Oc6YKKc65v">Keyboard Shortcuts</a>.</p>
|
||||||
|
<h2>Interaction</h2>
|
||||||
|
|
||||||
|
<ul>
|
||||||
|
<li>As the name suggests, to trigger the slash commands simply press the <kbd>/</kbd> key
|
||||||
|
to trigger it. Note that this can be anywhere in a paragraph as long as
|
||||||
|
it's not part of the word, if it doesn't show up simply press a space and
|
||||||
|
press the <kbd>/</kbd> key again.</li>
|
||||||
|
<li>Use <kbd>↑</kbd> and <kbd>↓</kbd> keys to navigate between options.</li>
|
||||||
|
<li>By default, the full list of commands is displayed.</li>
|
||||||
|
<li>To search by title or description, simply start typing for an action.</li>
|
||||||
|
<li>To trigger an action, press the <kbd>Enter</kbd> key.</li>
|
||||||
|
</ul>
|
||||||
|
<h2>Integration with other features</h2>
|
||||||
|
|
||||||
|
<p>Apart from the common set of commands, some features are specially integrated
|
||||||
|
with the slash commands:</p>
|
||||||
|
<ul>
|
||||||
|
<li>For <a href="#root/pOsGYCXsbNQG/KSZ04uQ2D1St/iPIMuisry3hd/_help_NwBbFdNZ9h7O">admonitions</a>,
|
||||||
|
each admonition type (e.g. note, tip) will be individually displayed.</li>
|
||||||
|
<li>Every <a class="reference-link" href="#root/_help_pwc194wlRzcH">Text Snippets</a> will
|
||||||
|
also appear individually, making it easy to insert them.</li>
|
||||||
|
</ul>
|
||||||
BIN
apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Text/Premium features/Slash Commands_image.png
generated
vendored
Normal file
BIN
apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Text/Premium features/Slash Commands_image.png
generated
vendored
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 38 KiB |
56
apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Text/Premium features/Text Snippets.html
generated
vendored
Normal file
56
apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Text/Premium features/Text Snippets.html
generated
vendored
Normal file
@ -0,0 +1,56 @@
|
|||||||
|
<figure class="image image-style-align-right">
|
||||||
|
<img style="aspect-ratio:265/108" src="Text Snippets_image.png" width="265"
|
||||||
|
height="108" />
|
||||||
|
</figure>
|
||||||
|
<aside class="admonition note">
|
||||||
|
<p>This is a premium feature of the editor we are using (CKEditor) and we
|
||||||
|
benefit from it thanks to an written agreement with the team. See <a class="reference-link"
|
||||||
|
href="#root/_help_gLt3vA97tMcp">Premium features</a> for more information.</p>
|
||||||
|
</aside>
|
||||||
|
<p>Text Snippets are closely related to <a class="reference-link" href="#root/pOsGYCXsbNQG/tC7s2alapj8V/_help_KC1HB96bqqHX">Templates</a>,
|
||||||
|
but instead of defining the content of an entire note, text snippets are
|
||||||
|
pieces of formatted text that can easily be inserted in a text note.</p>
|
||||||
|
<h2>Creating a text snippet</h2>
|
||||||
|
|
||||||
|
<p>In the <a class="reference-link" href="#root/pOsGYCXsbNQG/gh7bpGYxajRS/Vc8PjrjAGuOp/_help_oPVyFC7WL2Lp">Note Tree</a>: </p>
|
||||||
|
<ol>
|
||||||
|
<li>Right click a note where to place the text snippet.</li>
|
||||||
|
<li>Select <em>Insert child note</em>.</li>
|
||||||
|
<li>Select <em>Text snippet</em>.</li>
|
||||||
|
</ol>
|
||||||
|
<p>Afterwards, simply type in the content of the note the desired text. The
|
||||||
|
text can be formatted in the same manner as a normal text note.</p>
|
||||||
|
<p>The title of the note will become the title of the template. Optionally,
|
||||||
|
a description can be added in the <a class="reference-link" href="#root/pOsGYCXsbNQG/tC7s2alapj8V/zEY4DaJG4YT5/_help_OFXdgB2nNk1F">Promoted Attributes</a> section.</p>
|
||||||
|
<h2>Inserting a snippet</h2>
|
||||||
|
|
||||||
|
<p>Once a snippet is created, there are two options to insert it:</p>
|
||||||
|
<ol>
|
||||||
|
<li>From the <a class="reference-link" href="#root/pOsGYCXsbNQG/KSZ04uQ2D1St/iPIMuisry3hd/_help_nRhnJkTT8cPs">Formatting toolbar</a>,
|
||||||
|
by looking for the
|
||||||
|
<img src="1_Text Snippets_image.png" width="19" height="19"
|
||||||
|
/>button.</li>
|
||||||
|
<li>Using <a class="reference-link" href="#root/_help_ZlN4nump6EbW">Slash Commands</a>:
|
||||||
|
<ol>
|
||||||
|
<li>To look for a specific template, start typing the name of the template
|
||||||
|
(its title).</li>
|
||||||
|
<li>To look for all the templates, type <code>template</code>.</li>
|
||||||
|
</ol>
|
||||||
|
</li>
|
||||||
|
</ol>
|
||||||
|
<aside class="admonition tip">
|
||||||
|
<p>A newly created snippet doesn't appear? Generally it takes up to a few
|
||||||
|
seconds to refresh the list of templates once you make a change.</p>
|
||||||
|
<p>If this doesn't happen, <a href="#root/pOsGYCXsbNQG/BgmBlOIl72jZ/_help_s8alTXmpFR61">reload the application</a> and
|
||||||
|
<a
|
||||||
|
href="#root/pOsGYCXsbNQG/BgmBlOIl72jZ/_help_wy8So3yZZlH9">report the issue</a>to us. </p>
|
||||||
|
</aside>
|
||||||
|
<h2>Limitations</h2>
|
||||||
|
|
||||||
|
<ul>
|
||||||
|
<li>Whenever a snippet is created, deleted or its title/description are modified,
|
||||||
|
all the open text notes will need to be refreshed. This causes a slight
|
||||||
|
flash for usually under a second, but it can cause some discomfort.</li>
|
||||||
|
<li>Unlike <a class="reference-link" href="#root/pOsGYCXsbNQG/tC7s2alapj8V/_help_KC1HB96bqqHX">Templates</a>,
|
||||||
|
the snippets cannot be limited to a particular <a href="#root/pOsGYCXsbNQG/gh7bpGYxajRS/wArbEsdSae6g/_help_9sRHySam5fXb">workspace</a>.</li>
|
||||||
|
</ul>
|
||||||
BIN
apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Text/Premium features/Text Snippets_image.png
generated
vendored
Normal file
BIN
apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Text/Premium features/Text Snippets_image.png
generated
vendored
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 6.2 KiB |
2
docs/Release Notes/!!!meta.json
vendored
2
docs/Release Notes/!!!meta.json
vendored
@ -1,6 +1,6 @@
|
|||||||
{
|
{
|
||||||
"formatVersion": 2,
|
"formatVersion": 2,
|
||||||
"appVersion": "0.94.1",
|
"appVersion": "0.95.0",
|
||||||
"files": [
|
"files": [
|
||||||
{
|
{
|
||||||
"isClone": false,
|
"isClone": false,
|
||||||
|
|||||||
432
docs/User Guide/!!!meta.json
vendored
432
docs/User Guide/!!!meta.json
vendored
@ -1,6 +1,6 @@
|
|||||||
{
|
{
|
||||||
"formatVersion": 2,
|
"formatVersion": 2,
|
||||||
"appVersion": "0.94.1",
|
"appVersion": "0.95.0",
|
||||||
"files": [
|
"files": [
|
||||||
{
|
{
|
||||||
"isClone": false,
|
"isClone": false,
|
||||||
@ -5009,6 +5009,27 @@
|
|||||||
"value": "",
|
"value": "",
|
||||||
"isInheritable": false,
|
"isInheritable": false,
|
||||||
"position": 40
|
"position": 40
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"type": "relation",
|
||||||
|
"name": "internalLink",
|
||||||
|
"value": "gLt3vA97tMcp",
|
||||||
|
"isInheritable": false,
|
||||||
|
"position": 190
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"type": "relation",
|
||||||
|
"name": "internalLink",
|
||||||
|
"value": "ZlN4nump6EbW",
|
||||||
|
"isInheritable": false,
|
||||||
|
"position": 200
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"type": "relation",
|
||||||
|
"name": "internalLink",
|
||||||
|
"value": "KC1HB96bqqHX",
|
||||||
|
"isInheritable": false,
|
||||||
|
"position": 210
|
||||||
}
|
}
|
||||||
],
|
],
|
||||||
"format": "markdown",
|
"format": "markdown",
|
||||||
@ -6692,6 +6713,233 @@
|
|||||||
}
|
}
|
||||||
]
|
]
|
||||||
},
|
},
|
||||||
|
{
|
||||||
|
"isClone": false,
|
||||||
|
"noteId": "gLt3vA97tMcp",
|
||||||
|
"notePath": [
|
||||||
|
"pOsGYCXsbNQG",
|
||||||
|
"KSZ04uQ2D1St",
|
||||||
|
"iPIMuisry3hd",
|
||||||
|
"gLt3vA97tMcp"
|
||||||
|
],
|
||||||
|
"title": "Premium features",
|
||||||
|
"notePosition": 190,
|
||||||
|
"prefix": null,
|
||||||
|
"isExpanded": false,
|
||||||
|
"type": "text",
|
||||||
|
"mime": "text/html",
|
||||||
|
"attributes": [
|
||||||
|
{
|
||||||
|
"type": "relation",
|
||||||
|
"name": "internalLink",
|
||||||
|
"value": "iPIMuisry3hd",
|
||||||
|
"isInheritable": false,
|
||||||
|
"position": 10
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"type": "relation",
|
||||||
|
"name": "internalLink",
|
||||||
|
"value": "wy8So3yZZlH9",
|
||||||
|
"isInheritable": false,
|
||||||
|
"position": 10
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"type": "label",
|
||||||
|
"name": "iconClass",
|
||||||
|
"value": "bx bx-star",
|
||||||
|
"isInheritable": false,
|
||||||
|
"position": 10
|
||||||
|
}
|
||||||
|
],
|
||||||
|
"format": "markdown",
|
||||||
|
"dataFileName": "Premium features.md",
|
||||||
|
"attachments": [],
|
||||||
|
"dirFileName": "Premium features",
|
||||||
|
"children": [
|
||||||
|
{
|
||||||
|
"isClone": false,
|
||||||
|
"noteId": "ZlN4nump6EbW",
|
||||||
|
"notePath": [
|
||||||
|
"pOsGYCXsbNQG",
|
||||||
|
"KSZ04uQ2D1St",
|
||||||
|
"iPIMuisry3hd",
|
||||||
|
"gLt3vA97tMcp",
|
||||||
|
"ZlN4nump6EbW"
|
||||||
|
],
|
||||||
|
"title": "Slash Commands",
|
||||||
|
"notePosition": 10,
|
||||||
|
"prefix": null,
|
||||||
|
"isExpanded": false,
|
||||||
|
"type": "text",
|
||||||
|
"mime": "text/html",
|
||||||
|
"attributes": [
|
||||||
|
{
|
||||||
|
"type": "relation",
|
||||||
|
"name": "internalLink",
|
||||||
|
"value": "gLt3vA97tMcp",
|
||||||
|
"isInheritable": false,
|
||||||
|
"position": 10
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"type": "relation",
|
||||||
|
"name": "internalLink",
|
||||||
|
"value": "iPIMuisry3hd",
|
||||||
|
"isInheritable": false,
|
||||||
|
"position": 10
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"type": "relation",
|
||||||
|
"name": "internalLink",
|
||||||
|
"value": "A9Oc6YKKc65v",
|
||||||
|
"isInheritable": false,
|
||||||
|
"position": 10
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"type": "relation",
|
||||||
|
"name": "internalLink",
|
||||||
|
"value": "NwBbFdNZ9h7O",
|
||||||
|
"isInheritable": false,
|
||||||
|
"position": 10
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"type": "relation",
|
||||||
|
"name": "internalLink",
|
||||||
|
"value": "pwc194wlRzcH",
|
||||||
|
"isInheritable": false,
|
||||||
|
"position": 20
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"type": "label",
|
||||||
|
"name": "iconClass",
|
||||||
|
"value": "bx bx-menu",
|
||||||
|
"isInheritable": false,
|
||||||
|
"position": 10
|
||||||
|
}
|
||||||
|
],
|
||||||
|
"format": "markdown",
|
||||||
|
"dataFileName": "Slash Commands.md",
|
||||||
|
"attachments": [
|
||||||
|
{
|
||||||
|
"attachmentId": "WUCwfWz4wTwf",
|
||||||
|
"title": "image.png",
|
||||||
|
"role": "image",
|
||||||
|
"mime": "image/png",
|
||||||
|
"position": 10,
|
||||||
|
"dataFileName": "Slash Commands_image.png"
|
||||||
|
}
|
||||||
|
]
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"isClone": false,
|
||||||
|
"noteId": "pwc194wlRzcH",
|
||||||
|
"notePath": [
|
||||||
|
"pOsGYCXsbNQG",
|
||||||
|
"KSZ04uQ2D1St",
|
||||||
|
"iPIMuisry3hd",
|
||||||
|
"gLt3vA97tMcp",
|
||||||
|
"pwc194wlRzcH"
|
||||||
|
],
|
||||||
|
"title": "Text Snippets",
|
||||||
|
"notePosition": 20,
|
||||||
|
"prefix": null,
|
||||||
|
"isExpanded": false,
|
||||||
|
"type": "text",
|
||||||
|
"mime": "text/html",
|
||||||
|
"attributes": [
|
||||||
|
{
|
||||||
|
"type": "relation",
|
||||||
|
"name": "internalLink",
|
||||||
|
"value": "gLt3vA97tMcp",
|
||||||
|
"isInheritable": false,
|
||||||
|
"position": 10
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"type": "relation",
|
||||||
|
"name": "internalLink",
|
||||||
|
"value": "KC1HB96bqqHX",
|
||||||
|
"isInheritable": false,
|
||||||
|
"position": 10
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"type": "relation",
|
||||||
|
"name": "internalLink",
|
||||||
|
"value": "oPVyFC7WL2Lp",
|
||||||
|
"isInheritable": false,
|
||||||
|
"position": 10
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"type": "relation",
|
||||||
|
"name": "internalLink",
|
||||||
|
"value": "OFXdgB2nNk1F",
|
||||||
|
"isInheritable": false,
|
||||||
|
"position": 10
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"type": "relation",
|
||||||
|
"name": "internalLink",
|
||||||
|
"value": "nRhnJkTT8cPs",
|
||||||
|
"isInheritable": false,
|
||||||
|
"position": 10
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"type": "relation",
|
||||||
|
"name": "internalLink",
|
||||||
|
"value": "ZlN4nump6EbW",
|
||||||
|
"isInheritable": false,
|
||||||
|
"position": 10
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"type": "relation",
|
||||||
|
"name": "internalLink",
|
||||||
|
"value": "s8alTXmpFR61",
|
||||||
|
"isInheritable": false,
|
||||||
|
"position": 10
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"type": "relation",
|
||||||
|
"name": "internalLink",
|
||||||
|
"value": "wy8So3yZZlH9",
|
||||||
|
"isInheritable": false,
|
||||||
|
"position": 10
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"type": "relation",
|
||||||
|
"name": "internalLink",
|
||||||
|
"value": "9sRHySam5fXb",
|
||||||
|
"isInheritable": false,
|
||||||
|
"position": 10
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"type": "label",
|
||||||
|
"name": "iconClass",
|
||||||
|
"value": "bx bx-align-left",
|
||||||
|
"isInheritable": false,
|
||||||
|
"position": 10
|
||||||
|
}
|
||||||
|
],
|
||||||
|
"format": "markdown",
|
||||||
|
"dataFileName": "Text Snippets.md",
|
||||||
|
"attachments": [
|
||||||
|
{
|
||||||
|
"attachmentId": "1hG8Yw0DTTxr",
|
||||||
|
"title": "image.png",
|
||||||
|
"role": "image",
|
||||||
|
"mime": "image/png",
|
||||||
|
"position": 10,
|
||||||
|
"dataFileName": "Text Snippets_image.png"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"attachmentId": "DlisV0iJLVec",
|
||||||
|
"title": "image.png",
|
||||||
|
"role": "image",
|
||||||
|
"mime": "image/png",
|
||||||
|
"position": 10,
|
||||||
|
"dataFileName": "1_Text Snippets_image.png"
|
||||||
|
}
|
||||||
|
]
|
||||||
|
}
|
||||||
|
]
|
||||||
|
},
|
||||||
{
|
{
|
||||||
"isClone": false,
|
"isClone": false,
|
||||||
"noteId": "BFvAtE74rbP6",
|
"noteId": "BFvAtE74rbP6",
|
||||||
@ -6702,7 +6950,7 @@
|
|||||||
"BFvAtE74rbP6"
|
"BFvAtE74rbP6"
|
||||||
],
|
],
|
||||||
"title": "Table of contents",
|
"title": "Table of contents",
|
||||||
"notePosition": 190,
|
"notePosition": 200,
|
||||||
"prefix": null,
|
"prefix": null,
|
||||||
"isExpanded": false,
|
"isExpanded": false,
|
||||||
"type": "text",
|
"type": "text",
|
||||||
@ -6760,7 +7008,7 @@
|
|||||||
"NdowYOC1GFKS"
|
"NdowYOC1GFKS"
|
||||||
],
|
],
|
||||||
"title": "Tables",
|
"title": "Tables",
|
||||||
"notePosition": 200,
|
"notePosition": 210,
|
||||||
"prefix": null,
|
"prefix": null,
|
||||||
"isExpanded": false,
|
"isExpanded": false,
|
||||||
"type": "text",
|
"type": "text",
|
||||||
@ -9145,38 +9393,122 @@
|
|||||||
{
|
{
|
||||||
"type": "relation",
|
"type": "relation",
|
||||||
"name": "internalLink",
|
"name": "internalLink",
|
||||||
"value": "WOcw2SLH6tbX",
|
"value": "iPIMuisry3hd",
|
||||||
"isInheritable": false,
|
"isInheritable": false,
|
||||||
"position": 10
|
"position": 10
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
"type": "relation",
|
"type": "relation",
|
||||||
"name": "internalLink",
|
"name": "internalLink",
|
||||||
"value": "bwZpz2ajCEwO",
|
"value": "6f9hih2hXXZk",
|
||||||
"isInheritable": false,
|
"isInheritable": false,
|
||||||
"position": 20
|
"position": 20
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
"type": "relation",
|
"type": "relation",
|
||||||
"name": "internalLink",
|
"name": "internalLink",
|
||||||
"value": "6f9hih2hXXZk",
|
"value": "m523cpzocqaD",
|
||||||
"isInheritable": false,
|
"isInheritable": false,
|
||||||
"position": 30
|
"position": 30
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
"type": "relation",
|
"type": "relation",
|
||||||
"name": "internalLink",
|
"name": "internalLink",
|
||||||
"value": "Wy267RK4M69c",
|
"value": "iRwzGnHPzonm",
|
||||||
"isInheritable": false,
|
"isInheritable": false,
|
||||||
"position": 40
|
"position": 40
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
"type": "relation",
|
"type": "relation",
|
||||||
"name": "internalLink",
|
"name": "internalLink",
|
||||||
"value": "Qjt68inQ2bRj",
|
"value": "bdUJEHsAPYQR",
|
||||||
"isInheritable": false,
|
"isInheritable": false,
|
||||||
"position": 50
|
"position": 50
|
||||||
},
|
},
|
||||||
|
{
|
||||||
|
"type": "relation",
|
||||||
|
"name": "internalLink",
|
||||||
|
"value": "HcABDtFCkbFN",
|
||||||
|
"isInheritable": false,
|
||||||
|
"position": 60
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"type": "relation",
|
||||||
|
"name": "internalLink",
|
||||||
|
"value": "GTwFsgaA0lCt",
|
||||||
|
"isInheritable": false,
|
||||||
|
"position": 70
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"type": "relation",
|
||||||
|
"name": "internalLink",
|
||||||
|
"value": "s1aBHPd79XYj",
|
||||||
|
"isInheritable": false,
|
||||||
|
"position": 80
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"type": "relation",
|
||||||
|
"name": "internalLink",
|
||||||
|
"value": "grjYqerjn243",
|
||||||
|
"isInheritable": false,
|
||||||
|
"position": 90
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"type": "relation",
|
||||||
|
"name": "internalLink",
|
||||||
|
"value": "1vHRoWCEjj0L",
|
||||||
|
"isInheritable": false,
|
||||||
|
"position": 100
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"type": "relation",
|
||||||
|
"name": "internalLink",
|
||||||
|
"value": "gBbsAeiuUxI5",
|
||||||
|
"isInheritable": false,
|
||||||
|
"position": 110
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"type": "relation",
|
||||||
|
"name": "internalLink",
|
||||||
|
"value": "81SGnPGMk7Xc",
|
||||||
|
"isInheritable": false,
|
||||||
|
"position": 120
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"type": "relation",
|
||||||
|
"name": "internalLink",
|
||||||
|
"value": "W8vYD3Q1zjCR",
|
||||||
|
"isInheritable": false,
|
||||||
|
"position": 130
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"type": "relation",
|
||||||
|
"name": "internalLink",
|
||||||
|
"value": "WOcw2SLH6tbX",
|
||||||
|
"isInheritable": false,
|
||||||
|
"position": 140
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"type": "relation",
|
||||||
|
"name": "internalLink",
|
||||||
|
"value": "bwZpz2ajCEwO",
|
||||||
|
"isInheritable": false,
|
||||||
|
"position": 150
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"type": "relation",
|
||||||
|
"name": "internalLink",
|
||||||
|
"value": "Wy267RK4M69c",
|
||||||
|
"isInheritable": false,
|
||||||
|
"position": 160
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"type": "relation",
|
||||||
|
"name": "internalLink",
|
||||||
|
"value": "Qjt68inQ2bRj",
|
||||||
|
"isInheritable": false,
|
||||||
|
"position": 170
|
||||||
|
},
|
||||||
{
|
{
|
||||||
"type": "label",
|
"type": "label",
|
||||||
"name": "shareAlias",
|
"name": "shareAlias",
|
||||||
@ -9190,90 +9522,6 @@
|
|||||||
"value": "bx bx-share-alt",
|
"value": "bx bx-share-alt",
|
||||||
"isInheritable": false,
|
"isInheritable": false,
|
||||||
"position": 30
|
"position": 30
|
||||||
},
|
|
||||||
{
|
|
||||||
"type": "relation",
|
|
||||||
"name": "internalLink",
|
|
||||||
"value": "iPIMuisry3hd",
|
|
||||||
"isInheritable": false,
|
|
||||||
"position": 60
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"type": "relation",
|
|
||||||
"name": "internalLink",
|
|
||||||
"value": "m523cpzocqaD",
|
|
||||||
"isInheritable": false,
|
|
||||||
"position": 70
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"type": "relation",
|
|
||||||
"name": "internalLink",
|
|
||||||
"value": "iRwzGnHPzonm",
|
|
||||||
"isInheritable": false,
|
|
||||||
"position": 80
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"type": "relation",
|
|
||||||
"name": "internalLink",
|
|
||||||
"value": "bdUJEHsAPYQR",
|
|
||||||
"isInheritable": false,
|
|
||||||
"position": 90
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"type": "relation",
|
|
||||||
"name": "internalLink",
|
|
||||||
"value": "HcABDtFCkbFN",
|
|
||||||
"isInheritable": false,
|
|
||||||
"position": 100
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"type": "relation",
|
|
||||||
"name": "internalLink",
|
|
||||||
"value": "GTwFsgaA0lCt",
|
|
||||||
"isInheritable": false,
|
|
||||||
"position": 110
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"type": "relation",
|
|
||||||
"name": "internalLink",
|
|
||||||
"value": "s1aBHPd79XYj",
|
|
||||||
"isInheritable": false,
|
|
||||||
"position": 120
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"type": "relation",
|
|
||||||
"name": "internalLink",
|
|
||||||
"value": "grjYqerjn243",
|
|
||||||
"isInheritable": false,
|
|
||||||
"position": 130
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"type": "relation",
|
|
||||||
"name": "internalLink",
|
|
||||||
"value": "1vHRoWCEjj0L",
|
|
||||||
"isInheritable": false,
|
|
||||||
"position": 140
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"type": "relation",
|
|
||||||
"name": "internalLink",
|
|
||||||
"value": "gBbsAeiuUxI5",
|
|
||||||
"isInheritable": false,
|
|
||||||
"position": 150
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"type": "relation",
|
|
||||||
"name": "internalLink",
|
|
||||||
"value": "81SGnPGMk7Xc",
|
|
||||||
"isInheritable": false,
|
|
||||||
"position": 160
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"type": "relation",
|
|
||||||
"name": "internalLink",
|
|
||||||
"value": "W8vYD3Q1zjCR",
|
|
||||||
"isInheritable": false,
|
|
||||||
"position": 170
|
|
||||||
}
|
}
|
||||||
],
|
],
|
||||||
"format": "markdown",
|
"format": "markdown",
|
||||||
|
|||||||
@ -16,7 +16,7 @@ Trilium allows you to share selected notes as **publicly accessible** read-only
|
|||||||
|
|
||||||
### By note type
|
### By note type
|
||||||
|
|
||||||
<figure class="table" style="width:100%;"><table class="ck-table-resized"><colgroup><col style="width:19.92%;"><col style="width:41.66%;"><col style="width:38.42%;"></colgroup><thead><tr><th> </th><th>Supported features</th><th>Limitations</th></tr></thead><tbody><tr><th><a class="reference-link" href="../Note%20Types/Text.md">Text</a></th><td><ul><li>Table of contents.</li><li>Syntax highlight of code blocks, provided a language is selected (does not work if “Auto-detected” is enabled).</li><li>Rendering for math equations.</li></ul></td><td><ul><li>Including notes is not supported.</li><li>Inline Mermaid diagrams are not rendered.</li></ul></td></tr><tr><th><a class="reference-link" href="../Note%20Types/Code.md">Code</a></th><td><ul><li>Basic support (displaying the contents of the note in a monospace font).</li></ul></td><td><ul><li>No syntax highlight.</li></ul></td></tr><tr><th><a class="reference-link" href="../Note%20Types/Saved%20Search.md">Saved Search</a></th><td colspan="2">Not supported.</td></tr><tr><th><a class="reference-link" href="../Note%20Types/Relation%20Map.md">Relation Map</a></th><td colspan="2">Not supported.</td></tr><tr><th><a class="reference-link" href="../Note%20Types/Note%20Map.md">Note Map</a></th><td colspan="2">Not supported.</td></tr><tr><th><a class="reference-link" href="../Note%20Types/Render%20Note.md">Render Note</a></th><td colspan="2">Not supported.</td></tr><tr><th><a class="reference-link" href="../Note%20Types/Book.md">Book</a></th><td><ul><li>The child notes are displayed in a fixed format. </li></ul></td><td><ul><li>More advanced view types such as the calendar view are not supported.</li></ul></td></tr><tr><th><a class="reference-link" href="../Note%20Types/Mermaid%20Diagrams.md">Mermaid Diagrams</a></th><td><ul><li>The diagram is displayed as a vector image.</li></ul></td><td><ul><li>No further interaction supported.</li></ul></td></tr><tr><th><a class="reference-link" href="../Note%20Types/Canvas.md">Canvas</a></th><td><ul><li>The diagram is displayed as a vector image.</li></ul></td><td><ul><li>No further interaction supported.</li></ul></td></tr><tr><th><a class="reference-link" href="../Note%20Types/Web%20View.md">Web View</a></th><td colspan="2">Not supported.</td></tr><tr><th><a class="reference-link" href="../Note%20Types/Mind%20Map.md">Mind Map</a></th><td>The diagram is displayed as a vector image.</td><td><ul><li>No further interaction supported.</li></ul></td></tr><tr><th><a class="reference-link" href="../Note%20Types/Geo%20Map.md">Geo Map</a></th><td colspan="2">Not supported.</td></tr><tr><th><a class="reference-link" href="../Note%20Types/File.md">File</a></th><td>Basic interaction (downloading the file).</td><td><ul><li>No further interaction supported.</li></ul></td></tr></tbody></table></figure>
|
<figure class="table" style="width:100%;"><table class="ck-table-resized"><colgroup><col style="width:19.92%;"><col style="width:41.66%;"><col style="width:38.42%;"></colgroup><thead><tr><th> </th><th>Supported features</th><th>Limitations</th></tr></thead><tbody><tr><th><a class="reference-link" href="../Note%20Types/Text.md">Text</a></th><td><ul><li>Table of contents.</li><li>Syntax highlight of code blocks, provided a language is selected (does not work if “Auto-detected” is enabled).</li><li>Rendering for math equations.</li></ul></td><td><ul><li>Including notes is not supported.</li><li>Inline Mermaid diagrams are not rendered.</li></ul></td></tr><tr><th><a class="reference-link" href="../Note%20Types/Code.md">Code</a></th><td><ul><li>Basic support (displaying the contents of the note in a monospace font).</li></ul></td><td><ul><li>No syntax highlight.</li></ul></td></tr><tr><th><a class="reference-link" href="../Note%20Types/Saved%20Search.md">Saved Search</a></th><td>Not supported.</td></tr><tr><th><a class="reference-link" href="../Note%20Types/Relation%20Map.md">Relation Map</a></th><td>Not supported.</td></tr><tr><th><a class="reference-link" href="../Note%20Types/Note%20Map.md">Note Map</a></th><td>Not supported.</td></tr><tr><th><a class="reference-link" href="../Note%20Types/Render%20Note.md">Render Note</a></th><td>Not supported.</td></tr><tr><th><a class="reference-link" href="../Note%20Types/Book.md">Book</a></th><td><ul><li>The child notes are displayed in a fixed format. </li></ul></td><td><ul><li>More advanced view types such as the calendar view are not supported.</li></ul></td></tr><tr><th><a class="reference-link" href="../Note%20Types/Mermaid%20Diagrams.md">Mermaid Diagrams</a></th><td><ul><li>The diagram is displayed as a vector image.</li></ul></td><td><ul><li>No further interaction supported.</li></ul></td></tr><tr><th><a class="reference-link" href="../Note%20Types/Canvas.md">Canvas</a></th><td><ul><li>The diagram is displayed as a vector image.</li></ul></td><td><ul><li>No further interaction supported.</li></ul></td></tr><tr><th><a class="reference-link" href="../Note%20Types/Web%20View.md">Web View</a></th><td>Not supported.</td></tr><tr><th><a class="reference-link" href="../Note%20Types/Mind%20Map.md">Mind Map</a></th><td>The diagram is displayed as a vector image.</td><td><ul><li>No further interaction supported.</li></ul></td></tr><tr><th><a class="reference-link" href="../Note%20Types/Geo%20Map.md">Geo Map</a></th><td>Not supported.</td></tr><tr><th><a class="reference-link" href="../Note%20Types/File.md">File</a></th><td>Basic interaction (downloading the file).</td><td><ul><li>No further interaction supported.</li></ul></td></tr></tbody></table></figure>
|
||||||
|
|
||||||
While the sharing feature is powerful, it has some limitations:
|
While the sharing feature is powerful, it has some limitations:
|
||||||
|
|
||||||
|
|||||||
@ -16,7 +16,7 @@ Fore more information see <a class="reference-link" href="Text/Formatting%20too
|
|||||||
|
|
||||||
Here's a list of various features supported by text notes:
|
Here's a list of various features supported by text notes:
|
||||||
|
|
||||||
<figure class="table"><table><thead><tr><th>Dedicated article</th><th>Feature</th></tr></thead><tbody><tr><td><a class="reference-link" href="Text/General%20formatting.md">General formatting</a></td><td><ul><li>Headings (section titles, paragraph)</li><li>Font size</li><li>Bold, italic, underline, strike-through</li><li>Superscript, subscript</li><li>Font color & background color</li><li>Remove formatting</li></ul></td></tr><tr><td><a class="reference-link" href="Text/Lists.md">Lists</a></td><td><ul><li>Bulleted lists</li><li>Numbered lists</li><li>To-do lists</li></ul></td></tr><tr><td><a class="reference-link" href="Text/Block%20quotes%20%26%20admonitions.md">Block quotes & admonitions</a></td><td><ul><li>Block quotes</li><li>Admonitions</li></ul></td></tr><tr><td><a class="reference-link" href="Text/Tables.md">Tables</a></td><td><ul><li>Basic tables</li><li>Merging cells</li><li>Styling tables and cells.</li><li>Table captions</li></ul></td></tr><tr><td><a class="reference-link" href="Text/Developer-specific%20formatting.md">Developer-specific formatting</a></td><td><ul><li>Inline code</li><li>Code blocks</li><li>Keyboard shortcuts</li></ul></td></tr><tr><td><a class="reference-link" href="Text/Footnotes.md">Footnotes</a></td><td><ul><li>Footnotes</li></ul></td></tr><tr><td><a class="reference-link" href="Text/Images.md">Images</a></td><td><ul><li>Images</li></ul></td></tr><tr><td><a class="reference-link" href="Text/Links.md">Links</a></td><td><ul><li>External links</li><li>Internal Trilium links</li></ul></td></tr><tr><td><a class="reference-link" href="Text/Include%20Note.md">Include Note</a></td><td><ul><li>Include note</li></ul></td></tr><tr><td><a class="reference-link" href="Text/Insert%20buttons.md">Insert buttons</a></td><td><ul><li>Symbols</li><li><a class="reference-link" href="Text/Math%20Equations.md">Math Equations</a></li><li>Mermaid diagrams</li><li>Horizontal ruler</li><li>Page break</li></ul></td></tr><tr><td><a class="reference-link" href="Text/Other%20features.md">Other features</a></td><td><ul><li>Indentation</li><li>Markdown import</li><li><a class="reference-link" href="Text/Cut%20to%20subnote.md">Cut to subnote</a></li></ul></td></tr></tbody></table></figure>
|
<figure class="table"><table><thead><tr><th>Dedicated article</th><th>Feature</th></tr></thead><tbody><tr><td><a class="reference-link" href="Text/General%20formatting.md">General formatting</a></td><td><ul><li>Headings (section titles, paragraph)</li><li>Font size</li><li>Bold, italic, underline, strike-through</li><li>Superscript, subscript</li><li>Font color & background color</li><li>Remove formatting</li></ul></td></tr><tr><td><a class="reference-link" href="Text/Lists.md">Lists</a></td><td><ul><li>Bulleted lists</li><li>Numbered lists</li><li>To-do lists</li></ul></td></tr><tr><td><a class="reference-link" href="Text/Block%20quotes%20%26%20admonitions.md">Block quotes & admonitions</a></td><td><ul><li>Block quotes</li><li>Admonitions</li></ul></td></tr><tr><td><a class="reference-link" href="Text/Tables.md">Tables</a></td><td><ul><li>Basic tables</li><li>Merging cells</li><li>Styling tables and cells.</li><li>Table captions</li></ul></td></tr><tr><td><a class="reference-link" href="Text/Developer-specific%20formatting.md">Developer-specific formatting</a></td><td><ul><li>Inline code</li><li>Code blocks</li><li>Keyboard shortcuts</li></ul></td></tr><tr><td><a class="reference-link" href="Text/Footnotes.md">Footnotes</a></td><td><ul><li>Footnotes</li></ul></td></tr><tr><td><a class="reference-link" href="Text/Images.md">Images</a></td><td><ul><li>Images</li></ul></td></tr><tr><td><a class="reference-link" href="Text/Links.md">Links</a></td><td><ul><li>External links</li><li>Internal Trilium links</li></ul></td></tr><tr><td><a class="reference-link" href="Text/Include%20Note.md">Include Note</a></td><td><ul><li>Include note</li></ul></td></tr><tr><td><a class="reference-link" href="Text/Insert%20buttons.md">Insert buttons</a></td><td><ul><li>Symbols</li><li><a class="reference-link" href="Text/Math%20Equations.md">Math Equations</a></li><li>Mermaid diagrams</li><li>Horizontal ruler</li><li>Page break</li></ul></td></tr><tr><td><a class="reference-link" href="Text/Other%20features.md">Other features</a></td><td><ul><li>Indentation<ul><li>Markdown import</li></ul></li><li><a class="reference-link" href="Text/Cut%20to%20subnote.md">Cut to subnote</a></li></ul></td></tr><tr><td><a class="reference-link" href="Text/Premium%20features.md">Premium features</a></td><td><ul><li><a class="reference-link" href="Text/Premium%20features/Slash%20Commands.md">Slash Commands</a></li><li><a class="reference-link" href="../Advanced%20Usage/Templates.md">Templates</a></li></ul></td></tr></tbody></table></figure>
|
||||||
|
|
||||||
## Read-Only vs. Editing Mode
|
## Read-Only vs. Editing Mode
|
||||||
|
|
||||||
|
|||||||
12
docs/User Guide/User Guide/Note Types/Text/Premium features.md
vendored
Normal file
12
docs/User Guide/User Guide/Note Types/Text/Premium features.md
vendored
Normal file
@ -0,0 +1,12 @@
|
|||||||
|
# Premium features
|
||||||
|
The text editor we are using for <a class="reference-link" href="../Text.md">Text</a> notes is called CKEditor and it's a commercial product. The core components are open-source, however they [offer quite a few features](https://ckeditor.com/docs/trial/latest/index.html) that require a commercial license in order to be used.
|
||||||
|
|
||||||
|
We have reached out to the CKEditor team in order to obtain a license in order to have some of these extra features and they have agreed, based on a signed agreement.
|
||||||
|
|
||||||
|
## How the license works
|
||||||
|
|
||||||
|
The license key is stored in the application and it enables the use of the previously described premium features. The license key has an expiration date which means that the features can become disabled if using an older version of the application for extended periods of time.
|
||||||
|
|
||||||
|
## Can I opt out of these features?
|
||||||
|
|
||||||
|
At this moment there is no way to disable this features, apart from manually modifying the source code. If this is a problem, [let us know](../../Troubleshooting/Reporting%20issues.md).
|
||||||
BIN
docs/User Guide/User Guide/Note Types/Text/Premium features/1_Text Snippets_image.png
vendored
Normal file
BIN
docs/User Guide/User Guide/Note Types/Text/Premium features/1_Text Snippets_image.png
vendored
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 377 B |
22
docs/User Guide/User Guide/Note Types/Text/Premium features/Slash Commands.md
vendored
Normal file
22
docs/User Guide/User Guide/Note Types/Text/Premium features/Slash Commands.md
vendored
Normal file
@ -0,0 +1,22 @@
|
|||||||
|
# Slash Commands
|
||||||
|
<figure class="image image-style-align-right"><img style="aspect-ratio:419/571" src="Slash Commands_image.png" width="419" height="571"></figure>
|
||||||
|
|
||||||
|
> [!NOTE]
|
||||||
|
> This is a premium feature of the editor we are using (CKEditor) and we benefit from it thanks to an written agreement with the team. See <a class="reference-link" href="../Premium%20features.md">Premium features</a> for more information.
|
||||||
|
|
||||||
|
Slash commands is a feature of <a class="reference-link" href="../../Text.md">Text</a> notes which allows easily accessing commonly used commands simply by using the keyboard, without having to remember dedicated <a class="reference-link" href="../../../Basic%20Concepts%20and%20Features/Keyboard%20Shortcuts.md">Keyboard Shortcuts</a>.
|
||||||
|
|
||||||
|
## Interaction
|
||||||
|
|
||||||
|
* As the name suggests, to trigger the slash commands simply press the <kbd>/</kbd> key to trigger it. Note that this can be anywhere in a paragraph as long as it's not part of the word, if it doesn't show up simply press a space and press the <kbd>/</kbd> key again.
|
||||||
|
* Use <kbd>↑</kbd> and <kbd>↓</kbd> keys to navigate between options.
|
||||||
|
* By default, the full list of commands is displayed.
|
||||||
|
* To search by title or description, simply start typing for an action.
|
||||||
|
* To trigger an action, press the <kbd>Enter</kbd> key.
|
||||||
|
|
||||||
|
## Integration with other features
|
||||||
|
|
||||||
|
Apart from the common set of commands, some features are specially integrated with the slash commands:
|
||||||
|
|
||||||
|
* For [admonitions](../Block%20quotes%20%26%20admonitions.md), each admonition type (e.g. note, tip) will be individually displayed.
|
||||||
|
* Every <a class="reference-link" href="Text%20Snippets.md">Text Snippets</a> will also appear individually, making it easy to insert them.
|
||||||
BIN
docs/User Guide/User Guide/Note Types/Text/Premium features/Slash Commands_image.png
vendored
Normal file
BIN
docs/User Guide/User Guide/Note Types/Text/Premium features/Slash Commands_image.png
vendored
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 38 KiB |
38
docs/User Guide/User Guide/Note Types/Text/Premium features/Text Snippets.md
vendored
Normal file
38
docs/User Guide/User Guide/Note Types/Text/Premium features/Text Snippets.md
vendored
Normal file
@ -0,0 +1,38 @@
|
|||||||
|
# Text Snippets
|
||||||
|
<figure class="image image-style-align-right"><img style="aspect-ratio:265/108" src="Text Snippets_image.png" width="265" height="108"></figure>
|
||||||
|
|
||||||
|
> [!NOTE]
|
||||||
|
> This is a premium feature of the editor we are using (CKEditor) and we benefit from it thanks to an written agreement with the team. See <a class="reference-link" href="../Premium%20features.md">Premium features</a> for more information.
|
||||||
|
|
||||||
|
Text Snippets are closely related to <a class="reference-link" href="../../../Advanced%20Usage/Templates.md">Templates</a>, but instead of defining the content of an entire note, text snippets are pieces of formatted text that can easily be inserted in a text note.
|
||||||
|
|
||||||
|
## Creating a text snippet
|
||||||
|
|
||||||
|
In the <a class="reference-link" href="../../../Basic%20Concepts%20and%20Features/UI%20Elements/Note%20Tree.md">Note Tree</a>:
|
||||||
|
|
||||||
|
1. Right click a note where to place the text snippet.
|
||||||
|
2. Select _Insert child note_.
|
||||||
|
3. Select _Text snippet_.
|
||||||
|
|
||||||
|
Afterwards, simply type in the content of the note the desired text. The text can be formatted in the same manner as a normal text note.
|
||||||
|
|
||||||
|
The title of the note will become the title of the template. Optionally, a description can be added in the <a class="reference-link" href="../../../Advanced%20Usage/Attributes/Promoted%20Attributes.md">Promoted Attributes</a> section.
|
||||||
|
|
||||||
|
## Inserting a snippet
|
||||||
|
|
||||||
|
Once a snippet is created, there are two options to insert it:
|
||||||
|
|
||||||
|
1. From the <a class="reference-link" href="../Formatting%20toolbar.md">Formatting toolbar</a>, by looking for the <img src="1_Text Snippets_image.png" width="19" height="19">button.
|
||||||
|
2. Using <a class="reference-link" href="Slash%20Commands.md">Slash Commands</a>:
|
||||||
|
1. To look for a specific template, start typing the name of the template (its title).
|
||||||
|
2. To look for all the templates, type `template`.
|
||||||
|
|
||||||
|
> [!TIP]
|
||||||
|
> A newly created snippet doesn't appear? Generally it takes up to a few seconds to refresh the list of templates once you make a change.
|
||||||
|
>
|
||||||
|
> If this doesn't happen, [reload the application](../../../Troubleshooting/Refreshing%20the%20application.md) and [report the issue](../../../Troubleshooting/Reporting%20issues.md)to us.
|
||||||
|
|
||||||
|
## Limitations
|
||||||
|
|
||||||
|
* Whenever a snippet is created, deleted or its title/description are modified, all the open text notes will need to be refreshed. This causes a slight flash for usually under a second, but it can cause some discomfort.
|
||||||
|
* Unlike <a class="reference-link" href="../../../Advanced%20Usage/Templates.md">Templates</a>, the snippets cannot be limited to a particular [workspace](../../../Basic%20Concepts%20and%20Features/Navigation/Workspaces.md).
|
||||||
BIN
docs/User Guide/User Guide/Note Types/Text/Premium features/Text Snippets_image.png
vendored
Normal file
BIN
docs/User Guide/User Guide/Note Types/Text/Premium features/Text Snippets_image.png
vendored
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 6.2 KiB |
Loading…
x
Reference in New Issue
Block a user