docs(guide): premium features

apps/server/src/assets/doc_notes/en/User Guide/User Guide/Advanced Usage/Sharing.html

@@ -6,7 +6,8 @@ class="image">
   <img style="aspect-ratio:1144/660;" src="Sharing_image.png" width="1144"
   height="660">
   </figure>
-  <h2>Features, interaction and limitations</h2>
+  
+<h2>Features, interaction and limitations</h2>
   <ul>
     <li>Searching by note title.</li>
     <li>Automatic dark/light mode based on the user's browser settings.</li>
@@ -34,7 +35,7 @@ class="image">
       </thead>
       <tbody>
         <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>
           <td>
             <ul>
@@ -52,7 +53,7 @@ class="image">
           </td>
         </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>
           <td>
             <ul>
@@ -66,27 +67,27 @@ class="image">
           </td>
         </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>
-          <td colspan="2">Not supported.</td>
+          <td>Not supported.</td>
         </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>
-          <td colspan="2">Not supported.</td>
+          <td>Not supported.</td>
         </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>
-          <td colspan="2">Not supported.</td>
+          <td>Not supported.</td>
         </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>
-          <td colspan="2">Not supported.</td>
+          <td>Not supported.</td>
         </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>
           <td>
             <ul>
@@ -100,7 +101,7 @@ class="image">
           </td>
         </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>
           <td>
             <ul>
@@ -114,7 +115,7 @@ class="image">
           </td>
         </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>
           <td>
             <ul>
@@ -128,12 +129,12 @@ class="image">
           </td>
         </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>
-          <td colspan="2">Not supported.</td>
+          <td>Not supported.</td>
         </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>
           <td>The diagram is displayed as a vector image.</td>
           <td>
@@ -143,12 +144,12 @@ class="image">
           </td>
         </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>
-          <td colspan="2">Not supported.</td>
+          <td>Not supported.</td>
         </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>
           <td>Basic interaction (downloading the file).</td>
           <td>
@@ -183,9 +184,11 @@ class="image">
         <img src="Sharing_share-single-note.png" alt="Share Note">
       </p>
     </li>
-    <li><strong>Access the Shared Note</strong>: The link provided will open the
-      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>.</li>
+    <li>
+      <p><strong>Access the Shared Note</strong>: The link provided will open the
+        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>
   <h2>Sharing a Note Subtree</h2>
   <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>
     </table>
   </figure>
-  <h2>Credits</h2>
+  
+<h2>Credits</h2>
   <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
     functionality (such as mobile support, dark/light mode, collapsible tree,

apps/server/src/assets/doc_notes/en/User Guide/User Guide/Advanced Usage/Sharing/Serving directly the content o.html

@@ -24,6 +24,7 @@
     </tbody>
   </table>
 </figure>
+
 <h2>By adding an attribute to the note</h2>
 <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>

apps/server/src/assets/doc_notes/en/User Guide/User Guide/Basic Concepts and Features/Navigation/Search.html

@@ -146,6 +146,8 @@
   <li><code>#publicationYear %= '19[0-9]{2}'</code>: Use the '%=' operator to
     match a regular expression (regex). This feature has been available since
     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>
 <h3>Advanced Use Cases</h3>
 <ul>

apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Text.html

@@ -142,18 +142,32 @@ class="table">
         </td>
         <td>
           <ul>
-            <li>Indentation</li>
-            <li>Markdown import</li>
+            <li>Indentation
+              <ul>
+                <li>Markdown import</li>
+              </ul>
+            </li>
             <li><a class="reference-link" href="#root/_help_2x0ZAX9ePtzV">Cut to subnote</a>
             </li>
           </ul>
         </td>
       </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>
   </table>
   </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
     read-only mode if the note is too big or the note is explicitly marked
     as read-only. For more information, see&nbsp;<a class="reference-link"

apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Text/Premium features.html

@@ -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>

apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Text/Premium features/Slash Commands.html

@@ -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>

apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Text/Premium features/Text Snippets.html

@@ -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>