mirror of
https://github.com/zadam/trilium.git
synced 2026-03-12 23:20:26 +01:00
docs(user): specify spreadsheets
This commit is contained in:
Elian Doran
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
190
apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types.html
generated
vendored
190
apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types.html
generated
vendored
@@ -9,7 +9,8 @@
|
||||
note where to place the new one and select:</p>
|
||||
<ul>
|
||||
<li><em>Insert note after</em>, to put the new note underneath the one selected.</li>
|
||||
<li><em>Insert child note</em>, to insert the note as a child of the selected
|
||||
<li
|
||||
><em>Insert child note</em>, to insert the note as a child of the selected
|
||||
note.</li>
|
||||
</ul>
|
||||
<p>
|
||||
@@ -20,7 +21,8 @@
|
||||
<li>When adding a <a href="#root/_help_QEAPj01N5f7w">link</a> in a <a class="reference-link"
|
||||
href="#root/_help_iPIMuisry3hd">Text</a> note, type the desired title of
|
||||
the new note and press Enter. Afterwards the type of the note will be asked.</li>
|
||||
<li>Similarly, when creating a new tab, type the desired title and press Enter.</li>
|
||||
<li
|
||||
>Similarly, when creating a new tab, type the desired title and press Enter.</li>
|
||||
</ul>
|
||||
<h2>Changing the type of a note</h2>
|
||||
<p>It is possible to change the type of a note after it has been created
|
||||
@@ -30,94 +32,96 @@
|
||||
edit the <a href="#root/_help_4FahAwuGTAwC">source of a note</a>.</p>
|
||||
<h2>Supported note types</h2>
|
||||
<p>The following note types are supported by Trilium:</p>
|
||||
<table>
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Note Type</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><a class="reference-link" href="#root/_help_iPIMuisry3hd">Text</a>
|
||||
</td>
|
||||
<td>The default note type, which allows for rich text formatting, images,
|
||||
admonitions and right-to-left support.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><a class="reference-link" href="#root/_help_6f9hih2hXXZk">Code</a>
|
||||
</td>
|
||||
<td>Uses a mono-space font and can be used to store larger chunks of code
|
||||
or plain text than a text note, and has better syntax highlighting.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><a class="reference-link" href="#root/_help_m523cpzocqaD">Saved Search</a>
|
||||
</td>
|
||||
<td>Stores the information about a search (the search text, criteria, etc.)
|
||||
for later use. Can be used for quick filtering of a large amount of notes,
|
||||
for example. The search can easily be triggered.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><a class="reference-link" href="#root/_help_iRwzGnHPzonm">Relation Map</a>
|
||||
</td>
|
||||
<td>Allows easy creation of notes and relations between them. Can be used
|
||||
for mainly relational data such as a family tree.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><a class="reference-link" href="#root/_help_bdUJEHsAPYQR">Note Map</a>
|
||||
</td>
|
||||
<td>Displays the relationships between the notes, whether via relations or
|
||||
their hierarchical structure.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><a class="reference-link" href="#root/_help_HcABDtFCkbFN">Render Note</a>
|
||||
</td>
|
||||
<td>Used in <a class="reference-link" href="#root/_help_CdNpE2pqjmI6">Scripting</a>,
|
||||
it displays the HTML content of another note. This allows displaying any
|
||||
kind of content, provided there is a script behind it to generate it.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><a class="reference-link" href="#root/_help_GTwFsgaA0lCt">Collections</a>
|
||||
</td>
|
||||
<td>Displays the children of the note either as a grid, a list, or for a more
|
||||
specialized case: a calendar.
|
||||
<br>
|
||||
<br>Generally useful for easy reading of short notes.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><a class="reference-link" href="#root/_help_s1aBHPd79XYj">Mermaid Diagrams</a>
|
||||
</td>
|
||||
<td>Displays diagrams such as bar charts, flow charts, state diagrams, etc.
|
||||
Requires a bit of technical knowledge since the diagrams are written in
|
||||
a specialized format.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><a class="reference-link" href="#root/_help_grjYqerjn243">Canvas</a>
|
||||
</td>
|
||||
<td>Allows easy drawing of sketches, diagrams, handwritten content. Uses the
|
||||
same technology behind <a href="https://excalidraw.com">excalidraw.com</a>.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><a class="reference-link" href="#root/_help_1vHRoWCEjj0L">Web View</a>
|
||||
</td>
|
||||
<td>Displays the content of an external web page, similar to a browser.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><a class="reference-link" href="#root/_help_gBbsAeiuUxI5">Mind Map</a>
|
||||
</td>
|
||||
<td>Easy for brainstorming ideas, by placing them in a hierarchical layout.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><a class="reference-link" href="#root/_help_81SGnPGMk7Xc">Geo Map View</a>
|
||||
</td>
|
||||
<td>Displays the children of the note as a geographical map, one use-case
|
||||
would be to plan vacations. It even has basic support for tracks. Notes
|
||||
can also be created from it.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><a class="reference-link" href="#root/_help_W8vYD3Q1zjCR">File</a>
|
||||
</td>
|
||||
<td>Represents an uploaded file such as PDFs, images, video or audio files.</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<figure class="table">
|
||||
<table>
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Note Type</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><a class="reference-link" href="#root/_help_iPIMuisry3hd">Text</a>
|
||||
</td>
|
||||
<td>The default note type, which allows for rich text formatting, images,
|
||||
admonitions and right-to-left support.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><a class="reference-link" href="#root/_help_6f9hih2hXXZk">Code</a>
|
||||
</td>
|
||||
<td>Uses a mono-space font and can be used to store larger chunks of code
|
||||
or plain text than a text note, and has better syntax highlighting.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><a class="reference-link" href="#root/_help_m523cpzocqaD">Saved Search</a>
|
||||
</td>
|
||||
<td>Stores the information about a search (the search text, criteria, etc.)
|
||||
for later use. Can be used for quick filtering of a large amount of notes,
|
||||
for example. The search can easily be triggered.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><a class="reference-link" href="#root/_help_iRwzGnHPzonm">Relation Map</a>
|
||||
</td>
|
||||
<td>Allows easy creation of notes and relations between them. Can be used
|
||||
for mainly relational data such as a family tree.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><a class="reference-link" href="#root/_help_bdUJEHsAPYQR">Note Map</a>
|
||||
</td>
|
||||
<td>Displays the relationships between the notes, whether via relations or
|
||||
their hierarchical structure.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><a class="reference-link" href="#root/_help_HcABDtFCkbFN">Render Note</a>
|
||||
</td>
|
||||
<td>Used in <a class="reference-link" href="#root/_help_CdNpE2pqjmI6">Scripting</a>,
|
||||
it displays the HTML content of another note. This allows displaying any
|
||||
kind of content, provided there is a script behind it to generate it.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><a class="reference-link" href="#root/_help_GTwFsgaA0lCt">Collections</a>
|
||||
</td>
|
||||
<td>Displays the children of the note either as a grid, a list, or for a more
|
||||
specialized case: a calendar.
|
||||
<br>
|
||||
<br>Generally useful for easy reading of short notes.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><a class="reference-link" href="#root/_help_s1aBHPd79XYj">Mermaid Diagrams</a>
|
||||
</td>
|
||||
<td>Displays diagrams such as bar charts, flow charts, state diagrams, etc.
|
||||
Requires a bit of technical knowledge since the diagrams are written in
|
||||
a specialized format.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><a class="reference-link" href="#root/_help_grjYqerjn243">Canvas</a>
|
||||
</td>
|
||||
<td>Allows easy drawing of sketches, diagrams, handwritten content. Uses the
|
||||
same technology behind <a href="https://excalidraw.com">excalidraw.com</a>.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><a class="reference-link" href="#root/_help_1vHRoWCEjj0L">Web View</a>
|
||||
</td>
|
||||
<td>Displays the content of an external web page, similar to a browser.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><a class="reference-link" href="#root/_help_gBbsAeiuUxI5">Mind Map</a>
|
||||
</td>
|
||||
<td>Easy for brainstorming ideas, by placing them in a hierarchical layout.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><a class="reference-link" href="#root/_help_81SGnPGMk7Xc">Geo Map</a>
|
||||
</td>
|
||||
<td>Displays the children of the note as a geographical map, one use-case
|
||||
would be to plan vacations. It even has basic support for tracks. Notes
|
||||
can also be created from it.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><a class="reference-link" href="#root/_help_W8vYD3Q1zjCR">File</a>
|
||||
</td>
|
||||
<td>Represents an uploaded file such as PDFs, images, video or audio files.</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</figure>
|
||||
39
apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/File.html
generated
vendored
39
apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/File.html
generated
vendored
@@ -5,8 +5,7 @@
|
||||
create a <em>File</em> note type directly:</p>
|
||||
<ul>
|
||||
<li>Drag a file into the <a class="reference-link" href="#root/_help_oPVyFC7WL2Lp">Note Tree</a>.</li>
|
||||
<li
|
||||
>Right click a note and select <em>Import into note</em> and point it to
|
||||
<li>Right click a note and select <em>Import into note</em> and point it to
|
||||
one of the supported files.</li>
|
||||
</ul>
|
||||
<h2>Supported file types</h2>
|
||||
@@ -31,7 +30,7 @@
|
||||
</li>
|
||||
</ul>
|
||||
<h3>Videos</h3>
|
||||
<p>See <a class="reference-link" href="#root/pOsGYCXsbNQG/KSZ04uQ2D1St/W8vYD3Q1zjCR/_help_AjqEeiDUOzj4">Videos</a>.</p>
|
||||
<p>See <a class="reference-link" href="#root/_help_AjqEeiDUOzj4">Videos</a>.</p>
|
||||
<h3>Audio</h3>
|
||||
<figure class="image image-style-align-center image_resized" style="width:50%;">
|
||||
<img style="aspect-ratio:850/243;" src="1_File_image.png"
|
||||
@@ -83,30 +82,28 @@
|
||||
href="#root/_help_BlN9DFI679QC">Ribbon</a>.
|
||||
<ul>
|
||||
<li><em>Download</em>, which will download the file for local use.</li>
|
||||
<li
|
||||
><em>Open</em>, will will open the file with the system-default application.</li>
|
||||
<li
|
||||
>Upload new revision to replace the file with a new one.</li>
|
||||
<li><em>Open</em>, will will open the file with the system-default application.</li>
|
||||
<li>Upload new revision to replace the file with a new one.</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li>It is <strong>not</strong> possible to change the note type of a <em>File</em> note.</li>
|
||||
<li
|
||||
>Convert into an <a href="#root/_help_0vhv7lsOLy82">attachment</a> from the <a href="#root/_help_8YBEPzcpUgxw">note menu</a>.</li>
|
||||
</li>
|
||||
<li>It is <strong>not</strong> possible to change the note type of a <em>File</em> note.</li>
|
||||
<li>Convert into an <a href="#root/_help_0vhv7lsOLy82">attachment</a> from the <a href="#root/_help_8YBEPzcpUgxw">note menu</a>.</li>
|
||||
</ul>
|
||||
<h2>Relation with other notes</h2>
|
||||
<ul>
|
||||
<li>
|
||||
<p>Files are also displayed in the <a class="reference-link" href="#root/_help_0ESUbbAxVnoK">Note List</a> based
|
||||
on their type:</p>
|
||||
<p>
|
||||
<img class="image_resized" style="aspect-ratio:853/315;width:50%;" src="4_File_image.png"
|
||||
width="853" height="315">
|
||||
</p>
|
||||
<img class="image_resized" style="aspect-ratio:853/315;width:50%;"
|
||||
src="4_File_image.png" width="853" height="315">
|
||||
</li>
|
||||
<li>
|
||||
<p>Non-image files can be embedded into text notes as read-only widgets via
|
||||
the <a class="reference-link" href="#root/_help_nBAXQFj20hS1">Include Note</a> functionality.</p>
|
||||
</li>
|
||||
<li>
|
||||
<p>Image files can be embedded into text notes like normal images via
|
||||
<a
|
||||
class="reference-link" href="#root/_help_0Ofbk1aSuVRu">Image references</a>.</p>
|
||||
</li>
|
||||
<li>Non-image files can be embedded into text notes as read-only widgets via
|
||||
the <a class="reference-link" href="#root/_help_nBAXQFj20hS1">Include Note</a> functionality.</li>
|
||||
<li
|
||||
>Image files can be embedded into text notes like normal images via
|
||||
<a
|
||||
class="reference-link" href="#root/_help_0Ofbk1aSuVRu">Image references</a>.</li>
|
||||
</ul>
|
||||
171
apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/File/Videos.html
generated
vendored
171
apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/File/Videos.html
generated
vendored
@@ -38,113 +38,94 @@
|
||||
<li>
|
||||
<p>On the left side there are buttons to:</p>
|
||||
<ul>
|
||||
<li>
|
||||
<p>Adjust the playback speed (e.g. 0.5x, 1x).</p>
|
||||
</li>
|
||||
<li>
|
||||
<p>Rotate the video by 90 degrees.</p>
|
||||
</li>
|
||||
<li>Adjust the playback speed (e.g. 0.5x, 1x).</li>
|
||||
<li>Rotate the video by 90 degrees.</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li>
|
||||
<p>In the center:</p>
|
||||
<ul>
|
||||
<li>
|
||||
<p>Go back by 10s</p>
|
||||
</li>
|
||||
<li>
|
||||
<p>Play/pause</p>
|
||||
</li>
|
||||
<li>
|
||||
<p>Go forward by 30s</p>
|
||||
</li>
|
||||
<li>
|
||||
<p>Loop, which when enabled will restart the video once it reaches the end.</p>
|
||||
</li>
|
||||
<li>Go back by 10s</li>
|
||||
<li>Play/pause</li>
|
||||
<li>Go forward by 30s</li>
|
||||
<li>Loop, which when enabled will restart the video once it reaches the end.</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li>
|
||||
<p>On the right side:</p>
|
||||
<ul>
|
||||
<li>
|
||||
<p>Mute button</p>
|
||||
</li>
|
||||
<li>
|
||||
<p>Volume adjustment</p>
|
||||
</li>
|
||||
<li>
|
||||
<p>Full screen</p>
|
||||
</li>
|
||||
<li>
|
||||
<p>Zoom to fill, which will crop the video so that it fills the entire window.</p>
|
||||
</li>
|
||||
<li>
|
||||
<p>Picture-in-picture (if the browser supports it).</p>
|
||||
</li>
|
||||
<li>Mute button</li>
|
||||
<li>Volume adjustment</li>
|
||||
<li>Full screen</li>
|
||||
<li>Zoom to fill, which will crop the video so that it fills the entire window.</li>
|
||||
<li>Picture-in-picture (if the browser supports it).</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
<h2>Keyboard shortcuts</h2>
|
||||
<p>The following keyboard shortcuts are supported by the video player:</p>
|
||||
<figure
|
||||
class="table">
|
||||
<table>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><kbd>Space</kbd>
|
||||
</td>
|
||||
<td>Play/pause</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><kbd>Left arrow key</kbd>
|
||||
</td>
|
||||
<td>Go back by 10s</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><kbd>Right arrow key</kbd>
|
||||
</td>
|
||||
<td>Go forward by 10s</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><kbd>Ctrl</kbd> + <kbd>Left arrow key</kbd>
|
||||
</td>
|
||||
<td>Go back by 1 min</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><kbd>Ctrl</kbd> + <kbd>Right arrow key</kbd>
|
||||
</td>
|
||||
<td>Go right by 1 min</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><kbd>F</kbd>
|
||||
</td>
|
||||
<td>Toggle full-screen</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><kbd>M</kbd>
|
||||
</td>
|
||||
<td>Mute/unmute</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><kbd>Home</kbd>
|
||||
</td>
|
||||
<td>Go to the beginning of the video</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><kbd>End</kbd>
|
||||
</td>
|
||||
<td>Go to the end of the video</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><kbd>Up</kbd>
|
||||
</td>
|
||||
<td>Increase volume by 5%</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><kbd>Down</kbd>
|
||||
</td>
|
||||
<td>Decrease volume by 5%</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</figure>
|
||||
<table>
|
||||
<thead>
|
||||
<tr>
|
||||
<th></th>
|
||||
<th></th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><kbd>Space</kbd>
|
||||
</td>
|
||||
<td>Play/pause</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><kbd>Left arrow key</kbd>
|
||||
</td>
|
||||
<td>Go back by 10s</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><kbd>Right arrow key</kbd>
|
||||
</td>
|
||||
<td>Go forward by 10s</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><kbd>Ctrl</kbd> + <kbd>Left arrow key</kbd>
|
||||
</td>
|
||||
<td>Go back by 1 min</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><kbd>Ctrl</kbd> + <kbd>Right arrow key</kbd>
|
||||
</td>
|
||||
<td>Go right by 1 min</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><kbd>F</kbd>
|
||||
</td>
|
||||
<td>Toggle full-screen</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><kbd>M</kbd>
|
||||
</td>
|
||||
<td>Mute/unmute</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><kbd>Home</kbd>
|
||||
</td>
|
||||
<td>Go to the beginning of the video</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><kbd>End</kbd>
|
||||
</td>
|
||||
<td>Go to the end of the video</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><kbd>Up</kbd>
|
||||
</td>
|
||||
<td>Increase volume by 5%</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><kbd>Down</kbd>
|
||||
</td>
|
||||
<td>Decrease volume by 5%</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
@@ -38,30 +38,34 @@
|
||||
<img src="1_Mermaid Diagrams_image.png">
|
||||
</li>
|
||||
<li>The preview can be moved around by holding the left mouse button and dragging.</li>
|
||||
<li>Zooming can also be done by using the scroll wheel.</li>
|
||||
<li>The zoom and position on the preview will remain fixed as the diagram
|
||||
changes, to be able to work more easily with large diagrams.</li>
|
||||
</ul>
|
||||
<li
|
||||
>Zooming can also be done by using the scroll wheel.</li>
|
||||
<li>The zoom and position on the preview will remain fixed as the diagram
|
||||
changes, to be able to work more easily with large diagrams.</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li>The size of the source/preview panes can be adjusted by hovering over
|
||||
the border between them and dragging it with the mouse.</li>
|
||||
<li>In the <a class="reference-link" href="#root/_help_XpOYSgsLkTJy">Floating buttons</a> area:
|
||||
<ul>
|
||||
<li>The source/preview can be laid out left-right or bottom-top via the <em>Move editing pane to the left / bottom</em> option.</li>
|
||||
<li>Press <em>Lock editing</em> to automatically mark the note as read-only.
|
||||
<li
|
||||
>Press <em>Lock editing</em> to automatically mark the note as read-only.
|
||||
In this mode, the code pane is hidden and the diagram is displayed full-size.
|
||||
Similarly, press <em>Unlock editing</em> to mark a read-only note as editable.</li>
|
||||
<li>Press the <em>Copy image reference to the clipboard</em> to be able to insert
|
||||
the image representation of the diagram into a text note. See <a class="reference-link"
|
||||
href="#root/_help_0Ofbk1aSuVRu">Image references</a> for more information.</li>
|
||||
<li>Press the <em>Export diagram as SVG</em> to download a scalable/vector rendering
|
||||
of the diagram. Can be used to present the diagram without degrading when
|
||||
zooming.</li>
|
||||
<li
|
||||
>Press the <em>Copy image reference to the clipboard</em> to be able to insert
|
||||
the image representation of the diagram into a text note. See <a class="reference-link"
|
||||
href="#root/_help_0Ofbk1aSuVRu">Image references</a> for more information.</li>
|
||||
<li
|
||||
>Press the <em>Export diagram as SVG</em> to download a scalable/vector rendering
|
||||
of the diagram. Can be used to present the diagram without degrading when
|
||||
zooming.</li>
|
||||
<li>Press the <em>Export diagram as PNG</em> to download a normal image (at
|
||||
1x scale, raster) of the diagram. Can be used to send the diagram in more
|
||||
traditional channels such as e-mail.</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
<h2>Errors in the diagram</h2>
|
||||
<p>If there is an error in the source code, the error will be displayed in
|
||||
|
||||
111
apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Spreadsheets.html
generated
vendored
Normal file
111
apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Spreadsheets.html
generated
vendored
Normal file
@@ -0,0 +1,111 @@
|
||||
<figure class="image">
|
||||
<img style="aspect-ratio:1102/573;" src="Spreadsheets_image.png"
|
||||
width="1102" height="573">
|
||||
</figure>
|
||||
<aside class="admonition important">
|
||||
<p>Spreadsheets are a new type of note introduced in v0.103.0 and are currently
|
||||
considered experimental/beta. As such, expect major changes to occur to
|
||||
this note type.</p>
|
||||
</aside>
|
||||
<p>Spreadsheets provide a familiar experience to Microsoft Excel or LibreOffice
|
||||
Calc, with support for formulas, data validation and text formatting.</p>
|
||||
<h2>Spreadsheets vs. collections</h2>
|
||||
<p>There is a slight overlap between spreadsheets and the <a class="reference-link"
|
||||
href="#root/pOsGYCXsbNQG/GTwFsgaA0lCt/_help_2FvYrpmOXm29">Table</a> collection.
|
||||
In general the table collection is useful to track meta-information about
|
||||
notes (for example a collection of people and their birthdays), whereas
|
||||
spreadsheets are quite useful for calculations since they support formulas.</p>
|
||||
<p>Spreadsheets also benefit from a wider range of features such as data
|
||||
validation, formatting and can work on a relatively large dataset.</p>
|
||||
<h2>Important statement regarding data format</h2>
|
||||
<p>For Trilium as a knowledge database, it is important that data is stored
|
||||
in a format that is easy to convert to something else. For example,
|
||||
<a
|
||||
class="reference-link" href="#root/pOsGYCXsbNQG/KSZ04uQ2D1St/_help_iPIMuisry3hd">Text</a> notes can be exported to either HTML or Markdown, making
|
||||
it relatively easy to migrate to another software or simply to stand the
|
||||
test of time.</p>
|
||||
<p>For spreadsheets, Trilium uses a technology called <a href="https://docs.univer.ai/">Univer Sheets</a>,
|
||||
developed by DreamNum Co., Ltd. Although this software library is quite
|
||||
powerful and has a good track record (starting with Luckysheet from 2020,
|
||||
becoming Univer somewhere in 2023), it uses its own JSON format to store
|
||||
the sheets.</p>
|
||||
<p>As such, if Univer were to become unmaintained or incompatible for some
|
||||
reason, your data might become vendor locked-in.</p>
|
||||
<p>With that in mind, spreadsheets can be really useful for quick calculations,
|
||||
but it's important not to have critical information on it that you might
|
||||
not want to need in a few years time.</p>
|
||||
<h2>Regarding data export</h2>
|
||||
<p>Currently, in Trilium there is no way to export the spreadsheets to CSV
|
||||
or Excel formats. We might manage to add support for it at some point,
|
||||
but currently this is not the case.</p>
|
||||
<h2>Supported features</h2>
|
||||
<p>The spreadsheet has support for the following features:</p>
|
||||
<ul>
|
||||
<li>
|
||||
<p>Filtering</p>
|
||||
</li>
|
||||
<li>
|
||||
<p>Sorting</p>
|
||||
</li>
|
||||
<li>
|
||||
<p>Data validation</p>
|
||||
</li>
|
||||
<li>
|
||||
<p>Conditional formatting</p>
|
||||
</li>
|
||||
<li>
|
||||
<p>Notes / annotations</p>
|
||||
</li>
|
||||
<li>
|
||||
<p>Find / replace</p>
|
||||
</li>
|
||||
</ul>
|
||||
<p>We might consider adding <a href="https://docs.univer.ai/guides/sheets/features/filter">other features</a> from
|
||||
Univer at some point. If there is a particular feature that can be added
|
||||
easily, it can be discussed over <a href="#root/pOsGYCXsbNQG/BgmBlOIl72jZ/_help_wy8So3yZZlH9">GitHub Issues</a>.</p>
|
||||
<h2>Features not supported yet</h2>
|
||||
<h3>Regarding Pro features</h3>
|
||||
<p>Univer spreadsheets also feature a <a href="https://univer.ai/pro">Pro plan</a> which
|
||||
adds quite a lot of functionality such as charts, printing, pivot tables,
|
||||
export, etc.</p>
|
||||
<p>As the Pro plan needs a license, Trilium does not support any of the premium
|
||||
features. Theoretically, pro features can be used in trial mode with some
|
||||
limitations, we might explore this direction at some point.</p>
|
||||
<h3>Planned features</h3>
|
||||
<p>There are a few features that are already planned but are not supported
|
||||
yet:</p>
|
||||
<ul>
|
||||
<li>
|
||||
<p>Trilium-specific formulas (e.g. to obtain the title of a note).</p>
|
||||
</li>
|
||||
<li>
|
||||
<p>User-defined formulas</p>
|
||||
</li>
|
||||
<li>
|
||||
<p>Cross-workbook calculation</p>
|
||||
</li>
|
||||
</ul>
|
||||
<p>If you would like us to work on these features, consider <a href="https://triliumnotes.org/en/support-us">supporting us</a>.</p>
|
||||
<h2>Known limitations</h2>
|
||||
<ul>
|
||||
<li>
|
||||
<p>It is possible to share a spreadsheet, case in which a best-effort HTML
|
||||
rendering of the spreadsheet is done.</p>
|
||||
<ul>
|
||||
<li>
|
||||
<p>For more advanced use cases, this will most likely not work as intended.
|
||||
Feel free to <a href="#root/pOsGYCXsbNQG/BgmBlOIl72jZ/_help_wy8So3yZZlH9">report issues</a>,
|
||||
but keep in mind that we might not be able to have a complete feature parity
|
||||
with all the features of Univer.</p>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li>
|
||||
<p>There is currently no export functionality, as stated previously.</p>
|
||||
</li>
|
||||
<li>
|
||||
<p>There is no dedicated mobile support. Mobile support is currently experimental
|
||||
in Univer and when it becomes stable, we could potentially integrate it
|
||||
into Trilium as well.</p>
|
||||
</li>
|
||||
</ul>
|
||||
BIN
apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Spreadsheets_image.png
generated
vendored
Normal file
BIN
apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Spreadsheets_image.png
generated
vendored
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 117 KiB |
89
docs/User Guide/!!!meta.json
vendored
89
docs/User Guide/!!!meta.json
vendored
@@ -10391,54 +10391,61 @@
|
||||
"isInheritable": false,
|
||||
"position": 50
|
||||
},
|
||||
{
|
||||
"type": "relation",
|
||||
"name": "internalLink",
|
||||
"value": "AjqEeiDUOzj4",
|
||||
"isInheritable": false,
|
||||
"position": 60
|
||||
},
|
||||
{
|
||||
"type": "relation",
|
||||
"name": "internalLink",
|
||||
"value": "mHbBMPDPkVV5",
|
||||
"isInheritable": false,
|
||||
"position": 80
|
||||
"position": 70
|
||||
},
|
||||
{
|
||||
"type": "relation",
|
||||
"name": "internalLink",
|
||||
"value": "6f9hih2hXXZk",
|
||||
"isInheritable": false,
|
||||
"position": 90
|
||||
"position": 80
|
||||
},
|
||||
{
|
||||
"type": "relation",
|
||||
"name": "internalLink",
|
||||
"value": "BlN9DFI679QC",
|
||||
"isInheritable": false,
|
||||
"position": 100
|
||||
"position": 90
|
||||
},
|
||||
{
|
||||
"type": "relation",
|
||||
"name": "internalLink",
|
||||
"value": "0vhv7lsOLy82",
|
||||
"isInheritable": false,
|
||||
"position": 110
|
||||
"position": 100
|
||||
},
|
||||
{
|
||||
"type": "relation",
|
||||
"name": "internalLink",
|
||||
"value": "8YBEPzcpUgxw",
|
||||
"isInheritable": false,
|
||||
"position": 120
|
||||
"position": 110
|
||||
},
|
||||
{
|
||||
"type": "relation",
|
||||
"name": "internalLink",
|
||||
"value": "0ESUbbAxVnoK",
|
||||
"isInheritable": false,
|
||||
"position": 130
|
||||
"position": 120
|
||||
},
|
||||
{
|
||||
"type": "relation",
|
||||
"name": "internalLink",
|
||||
"value": "nBAXQFj20hS1",
|
||||
"isInheritable": false,
|
||||
"position": 140
|
||||
"position": 130
|
||||
},
|
||||
{
|
||||
"type": "label",
|
||||
@@ -10453,13 +10460,6 @@
|
||||
"value": "bx bx-file-blank",
|
||||
"isInheritable": false,
|
||||
"position": 140
|
||||
},
|
||||
{
|
||||
"type": "relation",
|
||||
"name": "internalLink",
|
||||
"value": "AjqEeiDUOzj4",
|
||||
"isInheritable": false,
|
||||
"position": 150
|
||||
}
|
||||
],
|
||||
"format": "markdown",
|
||||
@@ -10616,14 +10616,14 @@
|
||||
"name": "internalLink",
|
||||
"value": "wX4HbRucYSDD",
|
||||
"isInheritable": false,
|
||||
"position": 30
|
||||
"position": 10
|
||||
},
|
||||
{
|
||||
"type": "relation",
|
||||
"name": "internalLink",
|
||||
"value": "ODY7qQn5m2FT",
|
||||
"isInheritable": false,
|
||||
"position": 40
|
||||
"position": 20
|
||||
},
|
||||
{
|
||||
"type": "label",
|
||||
@@ -10647,6 +10647,63 @@
|
||||
]
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
"isClone": false,
|
||||
"noteId": "GWHEkY4I4OE3",
|
||||
"notePath": [
|
||||
"pOsGYCXsbNQG",
|
||||
"KSZ04uQ2D1St",
|
||||
"GWHEkY4I4OE3"
|
||||
],
|
||||
"title": "Spreadsheets",
|
||||
"notePosition": 220,
|
||||
"prefix": null,
|
||||
"isExpanded": false,
|
||||
"type": "text",
|
||||
"mime": "text/html",
|
||||
"attributes": [
|
||||
{
|
||||
"type": "label",
|
||||
"name": "iconClass",
|
||||
"value": "bx bx-table",
|
||||
"isInheritable": false,
|
||||
"position": 30
|
||||
},
|
||||
{
|
||||
"type": "relation",
|
||||
"name": "internalLink",
|
||||
"value": "2FvYrpmOXm29",
|
||||
"isInheritable": false,
|
||||
"position": 40
|
||||
},
|
||||
{
|
||||
"type": "relation",
|
||||
"name": "internalLink",
|
||||
"value": "iPIMuisry3hd",
|
||||
"isInheritable": false,
|
||||
"position": 50
|
||||
},
|
||||
{
|
||||
"type": "relation",
|
||||
"name": "internalLink",
|
||||
"value": "wy8So3yZZlH9",
|
||||
"isInheritable": false,
|
||||
"position": 60
|
||||
}
|
||||
],
|
||||
"format": "markdown",
|
||||
"dataFileName": "Spreadsheets.md",
|
||||
"attachments": [
|
||||
{
|
||||
"attachmentId": "Eedn7QHJQbiV",
|
||||
"title": "image.png",
|
||||
"role": "image",
|
||||
"mime": "image/png",
|
||||
"position": 10,
|
||||
"dataFileName": "Spreadsheets_image.png"
|
||||
}
|
||||
]
|
||||
}
|
||||
]
|
||||
},
|
||||
|
||||
2
docs/User Guide/User Guide.md
vendored
2
docs/User Guide/User Guide.md
vendored
@@ -15,7 +15,7 @@ Trilium is an open-source solution for note-taking and organizing a personal kno
|
||||
|
||||
* <a class="reference-link" href="User%20Guide/Installation%20%26%20Setup/Desktop%20Installation.md">Desktop Installation</a>
|
||||
* <a class="reference-link" href="User%20Guide/Installation%20%26%20Setup/Server%20Installation.md">Server Installation</a>
|
||||
* <a class="reference-link" href="User%20Guide/Scripting/Script%20API/Frontend%20API">[missing note]</a> or <a class="reference-link" href="User%20Guide/Scripting/Script%20API/Backend%20API.dat">[missing note]</a>
|
||||
* <a class="reference-link" href="User%20Guide/Scripting/Script%20API/Frontend%20API">Frontend API</a> or <a class="reference-link" href="User%20Guide/Scripting/Script%20API/Backend%20API.dat">Backend API</a>
|
||||
* [ETAPI reference](User%20Guide/Advanced%20Usage/ETAPI%20\(REST%20API\)/API%20Reference.dat)
|
||||
|
||||
## External links
|
||||
|
||||
4
docs/User Guide/User Guide/Note Types.md
vendored
4
docs/User Guide/User Guide/Note Types.md
vendored
@@ -33,10 +33,10 @@ The following note types are supported by Trilium:
|
||||
| <a class="reference-link" href="Note%20Types/Relation%20Map.md">Relation Map</a> | Allows easy creation of notes and relations between them. Can be used for mainly relational data such as a family tree. |
|
||||
| <a class="reference-link" href="Note%20Types/Note%20Map.md">Note Map</a> | Displays the relationships between the notes, whether via relations or their hierarchical structure. |
|
||||
| <a class="reference-link" href="Note%20Types/Render%20Note.md">Render Note</a> | Used in <a class="reference-link" href="Scripting.md">Scripting</a>, it displays the HTML content of another note. This allows displaying any kind of content, provided there is a script behind it to generate it. |
|
||||
| <a class="reference-link" href="Collections.md">Collections</a> | Displays the children of the note either as a grid, a list, or for a more specialized case: a calendar. <br> <br>Generally useful for easy reading of short notes. |
|
||||
| <a class="reference-link" href="Collections.md">Collections</a> | Displays the children of the note either as a grid, a list, or for a more specialized case: a calendar. <br> <br>Generally useful for easy reading of short notes. |
|
||||
| <a class="reference-link" href="Note%20Types/Mermaid%20Diagrams.md">Mermaid Diagrams</a> | Displays diagrams such as bar charts, flow charts, state diagrams, etc. Requires a bit of technical knowledge since the diagrams are written in a specialized format. |
|
||||
| <a class="reference-link" href="Note%20Types/Canvas.md">Canvas</a> | Allows easy drawing of sketches, diagrams, handwritten content. Uses the same technology behind [excalidraw.com](https://excalidraw.com). |
|
||||
| <a class="reference-link" href="Note%20Types/Web%20View.md">Web View</a> | Displays the content of an external web page, similar to a browser. |
|
||||
| <a class="reference-link" href="Note%20Types/Mind%20Map.md">Mind Map</a> | Easy for brainstorming ideas, by placing them in a hierarchical layout. |
|
||||
| <a class="reference-link" href="Collections/Geo%20Map.md">Geo Map View</a> | Displays the children of the note as a geographical map, one use-case would be to plan vacations. It even has basic support for tracks. Notes can also be created from it. |
|
||||
| <a class="reference-link" href="Collections/Geo%20Map.md">Geo Map</a> | Displays the children of the note as a geographical map, one use-case would be to plan vacations. It even has basic support for tracks. Notes can also be created from it. |
|
||||
| <a class="reference-link" href="Note%20Types/File.md">File</a> | Represents an uploaded file such as PDFs, images, video or audio files. |
|
||||
66
docs/User Guide/User Guide/Note Types/Spreadsheets.md
vendored
Normal file
66
docs/User Guide/User Guide/Note Types/Spreadsheets.md
vendored
Normal file
@@ -0,0 +1,66 @@
|
||||
# Spreadsheets
|
||||
<figure class="image"><img style="aspect-ratio:1102/573;" src="Spreadsheets_image.png" width="1102" height="573"></figure>
|
||||
|
||||
> [!IMPORTANT]
|
||||
> Spreadsheets are a new type of note introduced in v0.103.0 and are currently considered experimental/beta. As such, expect major changes to occur to this note type.
|
||||
|
||||
Spreadsheets provide a familiar experience to Microsoft Excel or LibreOffice Calc, with support for formulas, data validation and text formatting.
|
||||
|
||||
## Spreadsheets vs. collections
|
||||
|
||||
There is a slight overlap between spreadsheets and the <a class="reference-link" href="../Collections/Table.md">Table</a> collection. In general the table collection is useful to track meta-information about notes (for example a collection of people and their birthdays), whereas spreadsheets are quite useful for calculations since they support formulas.
|
||||
|
||||
Spreadsheets also benefit from a wider range of features such as data validation, formatting and can work on a relatively large dataset.
|
||||
|
||||
## Important statement regarding data format
|
||||
|
||||
For Trilium as a knowledge database, it is important that data is stored in a format that is easy to convert to something else. For example, <a class="reference-link" href="Text.md">Text</a> notes can be exported to either HTML or Markdown, making it relatively easy to migrate to another software or simply to stand the test of time.
|
||||
|
||||
For spreadsheets, Trilium uses a technology called [Univer Sheets](https://docs.univer.ai/), developed by DreamNum Co., Ltd. Although this software library is quite powerful and has a good track record (starting with Luckysheet from 2020, becoming Univer somewhere in 2023), it uses its own JSON format to store the sheets.
|
||||
|
||||
As such, if Univer were to become unmaintained or incompatible for some reason, your data might become vendor locked-in.
|
||||
|
||||
With that in mind, spreadsheets can be really useful for quick calculations, but it's important not to have critical information on it that you might not want to need in a few years time.
|
||||
|
||||
## Regarding data export
|
||||
|
||||
Currently, in Trilium there is no way to export the spreadsheets to CSV or Excel formats. We might manage to add support for it at some point, but currently this is not the case.
|
||||
|
||||
## Supported features
|
||||
|
||||
The spreadsheet has support for the following features:
|
||||
|
||||
* Filtering
|
||||
* Sorting
|
||||
* Data validation
|
||||
* Conditional formatting
|
||||
* Notes / annotations
|
||||
* Find / replace
|
||||
|
||||
We might consider adding [other features](https://docs.univer.ai/guides/sheets/features/filter) from Univer at some point. If there is a particular feature that can be added easily, it can be discussed over [GitHub Issues](../Troubleshooting/Reporting%20issues.md).
|
||||
|
||||
## Features not supported yet
|
||||
|
||||
### Regarding Pro features
|
||||
|
||||
Univer spreadsheets also feature a [Pro plan](https://univer.ai/pro) which adds quite a lot of functionality such as charts, printing, pivot tables, export, etc.
|
||||
|
||||
As the Pro plan needs a license, Trilium does not support any of the premium features. Theoretically, pro features can be used in trial mode with some limitations, we might explore this direction at some point.
|
||||
|
||||
### Planned features
|
||||
|
||||
There are a few features that are already planned but are not supported yet:
|
||||
|
||||
* Trilium-specific formulas (e.g. to obtain the title of a note).
|
||||
* User-defined formulas
|
||||
* Cross-workbook calculation
|
||||
|
||||
If you would like us to work on these features, consider [supporting us](https://triliumnotes.org/en/support-us).
|
||||
|
||||
## Known limitations
|
||||
|
||||
* It is possible to share a spreadsheet, case in which a best-effort HTML rendering of the spreadsheet is done.
|
||||
|
||||
* For more advanced use cases, this will most likely not work as intended. Feel free to [report issues](../Troubleshooting/Reporting%20issues.md), but keep in mind that we might not be able to have a complete feature parity with all the features of Univer.
|
||||
* There is currently no export functionality, as stated previously.
|
||||
* There is no dedicated mobile support. Mobile support is currently experimental in Univer and when it becomes stable, we could potentially integrate it into Trilium as well.
|
||||
BIN
docs/User Guide/User Guide/Note Types/Spreadsheets_image.png
vendored
Normal file
BIN
docs/User Guide/User Guide/Note Types/Spreadsheets_image.png
vendored
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 117 KiB |
Reference in New Issue
Block a user