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.
Used in Scripting,
- 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.
Displays the children of the note either as a grid, a list, or for a more
- specialized case: a calendar.
-
- Generally useful for easy reading of short notes.
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.
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.
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.
Used in Scripting,
+ 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.
Displays the children of the note either as a grid, a list, or for a more
+ specialized case: a calendar.
+
+ Generally useful for easy reading of short notes.
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.
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.
The source/preview can be laid out left-right or bottom-top via the Move editing pane to the left / bottom option.
-
Press Lock editing to automatically mark the note as read-only.
+
Press Lock editing 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 Unlock editing to mark a read-only note as editable.
-
Press the Copy image reference to the clipboard to be able to insert
- the image representation of the diagram into a text note. See Image references for more information.
-
Press the Export diagram as SVG to download a scalable/vector rendering
- of the diagram. Can be used to present the diagram without degrading when
- zooming.
+
Press the Copy image reference to the clipboard to be able to insert
+ the image representation of the diagram into a text note. See Image references for more information.
+
Press the Export diagram as SVG to download a scalable/vector rendering
+ of the diagram. Can be used to present the diagram without degrading when
+ zooming.
Press the Export diagram as PNG 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.
-
-
+
+
Errors in the diagram
If there is an error in the source code, the error will be displayed in
diff --git a/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Spreadsheets.html b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Spreadsheets.html
new file mode 100644
index 0000000000..5b34fba0eb
--- /dev/null
+++ b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Spreadsheets.html
@@ -0,0 +1,111 @@
+
+
+
+
+
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 Table 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,
+ Text 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,
+ 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 from
+ Univer at some point. If there is a particular feature that can be added
+ easily, it can be discussed over GitHub Issues.
+
Features not supported yet
+
Regarding Pro features
+
Univer spreadsheets also feature a Pro plan 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.
+
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,
+ 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.
+
+
\ No newline at end of file
diff --git a/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Spreadsheets_image.png b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Spreadsheets_image.png
new file mode 100644
index 0000000000..6b957c220b
Binary files /dev/null and b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Spreadsheets_image.png differ
diff --git a/docs/User Guide/!!!meta.json b/docs/User Guide/!!!meta.json
index 9ca3ac6154..c4d0e0a604 100644
--- a/docs/User Guide/!!!meta.json
+++ b/docs/User Guide/!!!meta.json
@@ -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"
+ }
+ ]
}
]
},
diff --git a/docs/User Guide/User Guide.md b/docs/User Guide/User Guide.md
index d02f4ecc38..3e5537135c 100644
--- a/docs/User Guide/User Guide.md
+++ b/docs/User Guide/User Guide.md
@@ -15,7 +15,7 @@ Trilium is an open-source solution for note-taking and organizing a personal kno
* Desktop Installation
* Server Installation
-* [missing note] or [missing note]
+* Frontend API or Backend API
* [ETAPI reference](User%20Guide/Advanced%20Usage/ETAPI%20\(REST%20API\)/API%20Reference.dat)
## External links
diff --git a/docs/User Guide/User Guide/Note Types.md b/docs/User Guide/User Guide/Note Types.md
index 27958b4ab3..71ac53e644 100644
--- a/docs/User Guide/User Guide/Note Types.md
+++ b/docs/User Guide/User Guide/Note Types.md
@@ -33,10 +33,10 @@ The following note types are supported by Trilium:
| Relation Map | Allows easy creation of notes and relations between them. Can be used for mainly relational data such as a family tree. |
| Note Map | Displays the relationships between the notes, whether via relations or their hierarchical structure. |
| Render Note | Used in Scripting, 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. |
-| Collections | Displays the children of the note either as a grid, a list, or for a more specialized case: a calendar.
Generally useful for easy reading of short notes. |
+| Collections | Displays the children of the note either as a grid, a list, or for a more specialized case: a calendar.
Generally useful for easy reading of short notes. |
| Mermaid Diagrams | 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. |
| Canvas | Allows easy drawing of sketches, diagrams, handwritten content. Uses the same technology behind [excalidraw.com](https://excalidraw.com). |
| Web View | Displays the content of an external web page, similar to a browser. |
| Mind Map | Easy for brainstorming ideas, by placing them in a hierarchical layout. |
-| Geo Map View | 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. |
+| Geo Map | 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. |
| File | Represents an uploaded file such as PDFs, images, video or audio files. |
\ No newline at end of file
diff --git a/docs/User Guide/User Guide/Note Types/Spreadsheets.md b/docs/User Guide/User Guide/Note Types/Spreadsheets.md
new file mode 100644
index 0000000000..70fa55a757
--- /dev/null
+++ b/docs/User Guide/User Guide/Note Types/Spreadsheets.md
@@ -0,0 +1,66 @@
+# Spreadsheets
+
+
+> [!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 Table 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, Text 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.
\ No newline at end of file
diff --git a/docs/User Guide/User Guide/Note Types/Spreadsheets_image.png b/docs/User Guide/User Guide/Note Types/Spreadsheets_image.png
new file mode 100644
index 0000000000..6b957c220b
Binary files /dev/null and b/docs/User Guide/User Guide/Note Types/Spreadsheets_image.png differ
Ribbon.
- 
+