gaschz/trilium
1
0
Fork 0
mirror of https://github.com/zadam/trilium.git synced 2025-11-02 12:39:04 +01:00
Code Issues Actions 31 Packages Projects Releases Wiki Activity

docs(user): add icons to most notes

Browse Source
This commit is contained in:
Elian Doran 2025-10-30 11:40:07 +02:00
parent c058b663ee
commit 552df50fe4
No known key found for this signature in database
5 changed files with 760 additions and 486 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
apps/server/src/assets/doc_notes/en/User Guide/!!!meta.json generated vendored
View File

File diff suppressed because one or more lines are too long

78
apps/server/src/assets/doc_notes/en/User Guide/User Guide/Advanced Usage/Sharing.html generated vendored
View File

@ -6,22 +6,19 @@ class="image">
<img style="aspect-ratio:1144/660;" src="Sharing_image.png" <img style="aspect-ratio:1144/660;" src="Sharing_image.png"
width="1144" height="660"> width="1144" height="660">
</figure> </figure>
<h2>Features, interaction and limitations</h2>
<h2>Features, interaction and limitations</h2>
<ul> <ul>
<li data-list-item-id="e3d96e7ea6a5bea335865c6d4e7b757e7">Searching by note title.</li> <li>Searching by note title.</li>
<li data-list-item-id="ee4b7dc44731b62ab2b94af6bb0b09b54">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>
<li <li>Mobile-friendly layout, with sidebar.</li>
data-list-item-id="e05664c88e4c9baf3ef1144e434854e98">Mobile-friendly layout, with sidebar.</li> <li>Collapsible tree with the same note icons as the application.</li>
<li data-list-item-id="e36f09f62924dbb6ee8750629e58a67c7">Collapsible tree with the same note icons as the application.</li> <li>Customizable logo.</li>
<li <li>Toggle button for dark/light mode, which also stores the user preferences.</li>
data-list-item-id="e3488b84ff81ca5a98a087dcc4daad56e">Customizable logo.</li> <li>Quick navigation buttons (previous and next note).</li>
<li data-list-item-id="ead2653f0d194c6991937d1acb4ebb32b">Toggle button for dark/light mode, which also stores the user preferences.</li> <li>Displaying the date of the last update of the note.</li>
<li
data-list-item-id="ecca067cbb8147ff5516eda5bd8622588">Quick navigation buttons (previous and next note).</li>
<li data-list-item-id="e0d3e7e3148573c18ac736f48b099d026">Displaying the date of the last update of the note.</li>
</ul> </ul>
<h3>By note type</h3> <h3>By note type</h3>
<figure class="table">
<table class="ck-table-resized"> <table class="ck-table-resized">
<colgroup> <colgroup>
<col style="width:19.92%;"> <col style="width:19.92%;">
@ -169,15 +166,13 @@ class="image">
</tr> </tr>
</tbody> </tbody>
</table> </table>
</figure>
<p>While the sharing feature is powerful, it has some limitations:</p> <p>While the sharing feature is powerful, it has some limitations:</p>
<ul> <ul>
<li data-list-item-id="e065770574d6cb87bf4f84c76080fe113"><strong>Code Notes</strong>: No syntax highlighting.</li> <li><strong>Code Notes</strong>: No syntax highlighting.</li>
<li class="ck-list-marker-bold" <li><strong>Static Note Tree</strong>
data-list-item-id="ea9548ac5f7f92e3af669d000bdf1bd9a"><strong>Static Note Tree</strong>
</li> </li>
<li data-list-item-id="e8691323347bafe4ac37868242dd77e49"><strong>Protected Notes</strong>: Cannot be shared.</li> <li><strong>Protected Notes</strong>: Cannot be shared.</li>
<li data-list-item-id="eb608c920b3b82c1ce22b3c91b3747ea9"><strong>Include Notes</strong>: Not supported.</li> <li><strong>Include Notes</strong>: Not supported.</li>
</ul> </ul>
<p>Some of these limitations may be addressed in future updates.</p> <p>Some of these limitations may be addressed in future updates.</p>
<h2>Prerequisites</h2> <h2>Prerequisites</h2>
@ -186,7 +181,7 @@ class="image">
is necessary because the notes will be hosted from the server.</p> is necessary because the notes will be hosted from the server.</p>
<h2>Sharing a note</h2> <h2>Sharing a note</h2>
<ol> <ol>
<li data-list-item-id="e988ff9db126f02a278d9006667a10be5"> <li>
<p><strong>Enable Sharing</strong>: To share a note, toggle the <code>Shared</code> switch <p><strong>Enable Sharing</strong>: To share a note, toggle the <code>Shared</code> switch
within the note's interface. Once sharing is enabled, an URL will appear, within the note's interface. Once sharing is enabled, an URL will appear,
which you can click to access the shared note.</p> which you can click to access the shared note.</p>
@ -195,9 +190,11 @@ class="image">
alt="Share Note"> alt="Share Note">
</p> </p>
</li> </li>
<li data-list-item-id="ec2fc57fcc9c804d6ad8accc887cd8a76"><strong>Access the Shared Note</strong>: The link provided will open the <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, 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> 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
@ -223,13 +220,12 @@ class="image">
<p>The default design should be a good starting point, but you can customize <p>The default design should be a good starting point, but you can customize
it using your own CSS:</p> it using your own CSS:</p>
<ul> <ul>
<li data-list-item-id="ea5b1b08c7c4eb3773a280bbde86b59c6"><strong>Custom CSS</strong>: Link a CSS&nbsp;<a class="reference-link" <li><strong>Custom CSS</strong>: Link a CSS&nbsp;<a class="reference-link"
href="#root/_help_6f9hih2hXXZk">Code</a>&nbsp;note to the shared page by adding href="#root/_help_6f9hih2hXXZk">Code</a>&nbsp;note to the shared page by adding
a <code>~shareCss</code> relation to the note. If you want this style to a <code>~shareCss</code> relation to the note. If you want this style to
apply to the entire subtree, make the label inheritable. You can hide the apply to the entire subtree, make the label inheritable. You can hide the
CSS code note from the tree navigation by adding the <code>#shareHiddenFromTree</code> label.</li> CSS code note from the tree navigation by adding the <code>#shareHiddenFromTree</code> label.</li>
<li <li><strong>Omitting Default CSS</strong>: For extensive styling changes,
data-list-item-id="e7778638630918e0fab2ce206ecd0a1a0"><strong>Omitting Default CSS</strong>: For extensive styling changes,
use the <code>#shareOmitDefaultCss</code> label to avoid conflicts with Trilium's use the <code>#shareOmitDefaultCss</code> label to avoid conflicts with Trilium's
<a <a
href="#root/_help_Wy267RK4M69c">default stylesheet</a>.</li> href="#root/_help_Wy267RK4M69c">default stylesheet</a>.</li>
@ -247,22 +243,22 @@ class="image">
itself.</p> itself.</p>
<p>The <code>#shareHtmlLocation</code> label accepts values in the format <code>location:position</code>:</p> <p>The <code>#shareHtmlLocation</code> label accepts values in the format <code>location:position</code>:</p>
<ul> <ul>
<li data-list-item-id="eb2c73bca2e9dc2a101f807349625bdd9"><strong>Locations</strong>: <code>head</code>, <code>body</code>, <code>content</code> <li><strong>Locations</strong>: <code>head</code>, <code>body</code>, <code>content</code>
</li> </li>
<li data-list-item-id="eef94ce6c51cd33ea3ecdc960d1523eac"><strong>Positions</strong>: <code>start</code>, <code>end</code> <li><strong>Positions</strong>: <code>start</code>, <code>end</code>
</li> </li>
</ul> </ul>
<p>For example:</p> <p>For example:</p>
<ul> <ul>
<li data-list-item-id="eb2df553ed57f138b95d13437c0059797"><code>#shareHtmlLocation=head:start</code> - Injects HTML at the beginning <li><code>#shareHtmlLocation=head:start</code> - Injects HTML at the beginning
of the <code>&lt;head&gt;</code> section</li> of the <code>&lt;head&gt;</code> section</li>
<li data-list-item-id="ed1695099b19e45ac696c236cc402177e"><code>#shareHtmlLocation=head:end</code> - Injects HTML at the end of the <code>&lt;head&gt;</code> section <li><code>#shareHtmlLocation=head:end</code> - Injects HTML at the end of the <code>&lt;head&gt;</code> section
(default)</li> (default)</li>
<li data-list-item-id="ea6c77d0d28577bdef31a5d068ee58af9"><code>#shareHtmlLocation=body:start</code> - Injects HTML at the beginning <li><code>#shareHtmlLocation=body:start</code> - Injects HTML at the beginning
of the <code>&lt;body&gt;</code> section</li> of the <code>&lt;body&gt;</code> section</li>
<li data-list-item-id="eecfee4d5f45c06ce51367f92d36f615f"><code>#shareHtmlLocation=content:start</code> - Injects HTML at the beginning <li><code>#shareHtmlLocation=content:start</code> - Injects HTML at the beginning
of the content area</li> of the content area</li>
<li data-list-item-id="e21b97811c4181dbf03def3e69f3e2ce5"><code>#shareHtmlLocation=content:end</code> - Injects HTML at the end of <li><code>#shareHtmlLocation=content:end</code> - Injects HTML at the end of
the content area</li> the content area</li>
</ul> </ul>
<p>If no location is specified, the HTML will be injected at <code>content:end</code> by <p>If no location is specified, the HTML will be injected at <code>content:end</code> by
@ -280,18 +276,17 @@ for (const attr of parentNote.attributes) {
This will change the URL to <code>http://domain.tld/share/highlighting</code>.</p> This will change the URL to <code>http://domain.tld/share/highlighting</code>.</p>
<p><strong>Important</strong>:</p> <p><strong>Important</strong>:</p>
<ol> <ol>
<li data-list-item-id="ea30893757780d6191d0ed21349532508">Ensure that aliases are unique.</li> <li>Ensure that aliases are unique.</li>
<li data-list-item-id="e6af818e0cb736f10e7e6b8b5cbb769f7">Using slashes (<code>/</code>) within aliases to create subpaths is not <li>Using slashes (<code>/</code>) within aliases to create subpaths is not
supported.</li> supported.</li>
</ol> </ol>
<aside class="admonition tip"> <aside class="admonition tip">
<ul> <ul>
<li data-list-item-id="e0356d768ad2a78f57520ca27f123c5a5">To easily identify pages that don't have a share alias, run a&nbsp; <li>To easily identify pages that don't have a share alias, run a&nbsp;
<a <a
class="reference-link" href="#root/pOsGYCXsbNQG/gh7bpGYxajRS/wArbEsdSae6g/_help_eIg8jdvaoNNd">Search</a>&nbsp;with <code>#!shareAlias</code>.</li> class="reference-link" href="#root/_help_eIg8jdvaoNNd">Search</a>&nbsp;with <code>#!shareAlias</code>.</li>
<li data-list-item-id="e6fbd28f04e5ac468ccbcc8851fa084b9">To be able to enter the share alias faster, consider using&nbsp;<a class="reference-link" <li>To be able to enter the share alias faster, consider using&nbsp;<a class="reference-link"
href="#root/pOsGYCXsbNQG/tC7s2alapj8V/zEY4DaJG4YT5/_help_OFXdgB2nNk1F">Promoted Attributes</a>&nbsp;(for href="#root/_help_OFXdgB2nNk1F">Promoted Attributes</a>&nbsp;(for example <code>#label:shareAlias(inheritable)="promoted,alias=Slug,single,text"</code>).</li>
example <code>#label:shareAlias(inheritable)="promoted,alias=Slug,single,text"</code>).</li>
</ul> </ul>
</aside> </aside>
<h3>Setting a custom favicon</h3> <h3>Setting a custom favicon</h3>
@ -314,7 +309,6 @@ for (const attr of parentNote.attributes) {
When viewed, the list of shared roots will be displayed at the bottom of When viewed, the list of shared roots will be displayed at the bottom of
the note.</p> the note.</p>
<h2>Attribute reference</h2> <h2>Attribute reference</h2>
<figure class="table">
<table> <table>
<thead> <thead>
<tr> <tr>
@ -398,8 +392,8 @@ for (const attr of parentNote.attributes) {
</tr> </tr>
</tbody> </tbody>
</table> </table>
</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,

52
apps/server/src/assets/doc_notes/en/User Guide/User Guide/Collections.html generated vendored
View File

@ -1,12 +1,13 @@
<p>Collections are a unique type of notes that don't have a content, but <p>Collections are a unique type of notes that don't have a content, but
instead display its child notes in various presentation methods.</p> instead display its child notes in various presentation methods.</p>
<h2>Main collections</h2> <h2>Main collections</h2>
<figure class="table" style="width:100%;"> <table>
<table class="ck-table-resized"> <thead>
<colgroup> <tr>
<col style="width:30.01%;"> <th></th>
<col style="width:69.99%;"> <th></th>
</colgroup> </tr>
</thead>
<tbody> <tbody>
<tr> <tr>
<td> <td>
@ -15,12 +16,9 @@
width="1651" height="810"> width="1651" height="810">
</figure> </figure>
</td> </td>
<td style="width:65%;"> <td><a class="reference-link" href="#root/_help_xWbu3jpNWapp">Calendar</a>
<p><a class="reference-link" href="#root/_help_xWbu3jpNWapp">Calendar</a>
<br>which displays a week, month or year calendar with the notes being shown <br>which displays a week, month or year calendar with the notes being shown
as events. New events can be added easily by dragging across the calendar.</p> as events. New events can be added easily by dragging across the calendar.</td>
<p>&nbsp;</p>
</td>
</tr> </tr>
<tr> <tr>
<td> <td>
@ -60,32 +58,28 @@
</tr> </tr>
<tr> <tr>
<td> <td>
<p>&nbsp;</p>
<figure class="image"> <figure class="image">
<img style="aspect-ratio:1120/763;" src="Collections_collection_pr.webp" <img style="aspect-ratio:1120/763;" src="Collections_collection_pr.webp"
width="1120" height="763"> width="1120" height="763">
</figure> </figure>
</td> </td>
<td> <td><a class="reference-link" href="#root/_help_zP3PMqaG71Ct">Presentation</a>
<p><a class="reference-link" href="#root/pOsGYCXsbNQG/GTwFsgaA0lCt/_help_zP3PMqaG71Ct">Presentation</a>
<br>which shows each note as a slide and can be presented full-screen with <br>which shows each note as a slide and can be presented full-screen with
smooth transitions or exported to PDF for sharing.</p> smooth transitions or exported to PDF for sharing.</td>
<p>&nbsp;</p>
</td>
</tr> </tr>
</tbody> </tbody>
</table> </table>
</figure>
<h2>Classic collections</h2> <h2>Classic collections</h2>
<p>Classic collections are read-only mode and compiles the contents of all <p>Classic collections are read-only mode and compiles the contents of all
child notes into one continuous view. This makes it ideal for reading extensive child notes into one continuous view. This makes it ideal for reading extensive
information broken into smaller, manageable segments.</p> information broken into smaller, manageable segments.</p>
<ul> <ul>
<li data-list-item-id="e60d70e68aa961b53ed51519a6074fe3e"><a class="reference-link" href="#root/_help_8QqnMzx393bx">Grid View</a>&nbsp;which <li><a class="reference-link" href="#root/_help_8QqnMzx393bx">Grid View</a>&nbsp;which
is the default presentation method for child notes (see&nbsp;<a class="reference-link" is the default presentation method for child notes (see&nbsp;<a class="reference-link"
href="#root/_help_0ESUbbAxVnoK">Note List</a>), where the notes are displayed href="#root/_help_0ESUbbAxVnoK">Note List</a>), where the notes are displayed
as tiles with their title and content being visible.</li> as tiles with their title and content being visible.</li>
<li data-list-item-id="eeafb9e9474962e23fa9caefc8501ef49"><a class="reference-link" href="#root/_help_mULW0Q3VojwY">List View</a>&nbsp;is <li><a class="reference-link" href="#root/_help_mULW0Q3VojwY">List View</a>&nbsp;is
similar to&nbsp;<a class="reference-link" href="#root/_help_8QqnMzx393bx">Grid View</a>, similar to&nbsp;<a class="reference-link" href="#root/_help_8QqnMzx393bx">Grid View</a>,
but it displays the notes one under the other with the content being expandable/collapsible, but it displays the notes one under the other with the content being expandable/collapsible,
but also works recursively.</li> but also works recursively.</li>
@ -99,8 +93,8 @@
collection (e.g. from Kanban Board to a Calendar), see the dedicated <em>Collections</em> tab collection (e.g. from Kanban Board to a Calendar), see the dedicated <em>Collections</em> tab
in the&nbsp;<a class="reference-link" href="#root/_help_BlN9DFI679QC">Ribbon</a>.</p> in the&nbsp;<a class="reference-link" href="#root/_help_BlN9DFI679QC">Ribbon</a>.</p>
<h2>Archived notes</h2> <h2>Archived notes</h2>
<p>By default, <a href="#root/pOsGYCXsbNQG/gh7bpGYxajRS/BFs8mudNFgCS/_help_MKmLg5x6xkor">archived notes</a> will <p>By default, <a href="#root/_help_MKmLg5x6xkor">archived notes</a> will not be
not be shown in collections. This behaviour can be changed by going to <em>Collection Properties</em> in shown in collections. This behaviour can be changed by going to <em>Collection Properties</em> in
the&nbsp;<a class="reference-link" href="#root/_help_BlN9DFI679QC">Ribbon</a>&nbsp;and the&nbsp;<a class="reference-link" href="#root/_help_BlN9DFI679QC">Ribbon</a>&nbsp;and
checking <em>Show archived notes</em>.</p> checking <em>Show archived notes</em>.</p>
<p>Archived notes will be generally indicated by being greyed out as opposed <p>Archived notes will be generally indicated by being greyed out as opposed
@ -109,8 +103,8 @@
<h3>Adding a description to a collection</h3> <h3>Adding a description to a collection</h3>
<p>To add a text before the collection, for example to describe it:</p> <p>To add a text before the collection, for example to describe it:</p>
<ol> <ol>
<li data-list-item-id="e68c7668efccff8c169f876e9c3be8007">Create a new collection.</li> <li>Create a new collection.</li>
<li data-list-item-id="e101fe6949917eac65e5c0c76920e3bce">In the&nbsp;<a class="reference-link" href="#root/_help_BlN9DFI679QC">Ribbon</a>, <li>In the&nbsp;<a class="reference-link" href="#root/_help_BlN9DFI679QC">Ribbon</a>,
go to <em>Basic Properties</em> and change the note type from <em>Collection</em> to <em>Text</em>.</li> go to <em>Basic Properties</em> and change the note type from <em>Collection</em> to <em>Text</em>.</li>
</ol> </ol>
<p>Now the text will be displayed above while still maintaining the collection <p>Now the text will be displayed above while still maintaining the collection
@ -133,13 +127,13 @@
<p>By default, collections come with a default configuration and sometimes <p>By default, collections come with a default configuration and sometimes
even sample notes. To create a collection completely from scratch:</p> even sample notes. To create a collection completely from scratch:</p>
<ol> <ol>
<li data-list-item-id="e615ae0200ba35a1ee9a7c33b1ddca962">Create a new note of type <em>Text</em> (or any type).</li> <li>Create a new note of type <em>Text</em> (or any type).</li>
<li data-list-item-id="e4f7f8d925e028b79272de20d5667e6ac">In the&nbsp;<a class="reference-link" href="#root/_help_BlN9DFI679QC">Ribbon</a>, <li>In the&nbsp;<a class="reference-link" href="#root/_help_BlN9DFI679QC">Ribbon</a>,
go to <em>Basic Properties</em> and select <em>Collection</em> as the note go to <em>Basic Properties</em> and select <em>Collection</em> as the note
type.</li> type.</li>
<li data-list-item-id="e6b27bd28d0bf75154274b1c73277b7e2">Still in the ribbon, go to <em>Collection Properties</em> and select the <li>Still in the ribbon, go to <em>Collection Properties</em> and select the
desired view type.</li> desired view type.</li>
<li data-list-item-id="e67306995e90c31a1bb6fbdfff63dc83f">Consult the help page of the corresponding view type in order to understand <li>Consult the help page of the corresponding view type in order to understand
how to configure them.</li> how to configure them.</li>
</ol> </ol>
<h2>Under the hood</h2> <h2>Under the hood</h2>

8
apps/server/src/assets/doc_notes/en/User Guide/User Guide/Collections/Calendar.html generated vendored
View File

@ -283,8 +283,8 @@
not having a <code>dateNote</code> attribute. Children of the child notes not having a <code>dateNote</code> attribute. Children of the child notes
will not be displayed.</li> will not be displayed.</li>
</ul> </ul>
<img src="8_Calendar_image.png" <img src="8_Calendar_image.png" width="1217"
width="1217" height="724"> height="724">
<h3>Using a different attribute as event title</h3> <h3>Using a different attribute as event title</h3>
<p>By default, events are displayed on the calendar by their note title. <p>By default, events are displayed on the calendar by their note title.
@ -335,8 +335,8 @@ width="1217" height="724">
<td><pre><code class="language-text-x-trilium-auto">#startDate=2025-02-14 #endDate=2025-02-15 ~for=@John Smith ~for=@Jane Doe #calendar:title="for"</code></pre> <td><pre><code class="language-text-x-trilium-auto">#startDate=2025-02-14 #endDate=2025-02-15 ~for=@John Smith ~for=@Jane Doe #calendar:title="for"</code></pre>
</td> </td>
<td> <td>
<img src="6_Calendar_image.png" <img src="6_Calendar_image.png" width="294"
width="294" height="151"> height="151">
</td> </td>
</tr> </tr>
</tbody> </tbody>

532
docs/User Guide/!!!meta.json vendored
View File

File diff suppressed because it is too large Load Diff