diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..d19812c --- /dev/null +++ b/.gitignore @@ -0,0 +1 @@ +.idea/** \ No newline at end of file diff --git a/Apache-proxy-setup.md b/Apache proxy setup.md similarity index 100% rename from Apache-proxy-setup.md rename to Apache proxy setup.md diff --git a/Backup.md b/Backup.md index 6008a32..a250083 100644 --- a/Backup.md +++ b/Backup.md @@ -5,7 +5,7 @@ Trilium supports simple backup scheme where it saves copy of the [[document]] on * once a month * before DB migration to newer version -So in total you'll have at most 4 backups from different points in time which should protect you from various problems. These backups are stored by default in `~/trilium-data/backup`. +So in total you'll have at most 4 backups from different points in time which should protect you from various problems. These backups are stored by default in `backup` directory placed in the [[data directory]]. This is only very basic backup solution and you're encouraged to add some better backup solution - e.g. backing up the [[document]] to cloud / different computer etc. diff --git a/Data directory.md b/Data directory.md new file mode 100644 index 0000000..d30061c --- /dev/null +++ b/Data directory.md @@ -0,0 +1,25 @@ +Data directory contains: + +* `document.db` - [[document]] +* `config.ini` - instance level settings like port on which the Trilium application runs +* `backup` - contains automatically [[backup]] of documents +* `log` - contains application log files + +## Location +Data directory is normally named `trilium-data` and it is stored in: + +* `/home/[user]/.local/share` for Linux +* `C:\Users\[user]\AppData\Roaming` for Windows Vista and up +* `/Users/[user]/Library/Application Support` for Mac OS +* user's home is a fallback if some of the paths above don't exist +* user's home is also a default setup for [[docker|Docker server installation]] + +If you want to backup your Trilium data, just backup this single file - it contains everything you need. + +### Changing the location of data directory + +If you want to use some other location for the data directory than the default one, you may change it via TRILIUM_DATA_DIR environment variable to some other location, e.g.: + +``` +export TRILIUM_DATA_DIR=/home/myuser/data/my-trilium-data +``` \ No newline at end of file diff --git a/Document.md b/Document.md index 63a7365..7b9f0fb 100644 --- a/Document.md +++ b/Document.md @@ -1,21 +1,8 @@ Document is [SQLite](https://www.sqlite.org) database which contains all notes, tree structure, metadata and most of the configuration. ## Location -It's stored in single file, by default in `trilium-data/document.db`, where `trilium-data` is stored in: -* `/home/[user]/.local/share` for Linux -* `C:\Users\[user]\AppData\Roaming` for Windows Vista and up -* `/Users/[user]/Library/Application Support` for Mac OS -* user's home is a fallback if some of the paths above don't exist -* user's home is also a default setup for [[docker|Docker server installation]] - -If you want to backup your Trilium data, just backup this single file - it contains everything you need. - -### Changing the location of the document - -If you want to use some other location for the document than the default one, you may change it via TRILIUM_DATA_DIR environment variable to some other location, e.g.: - -export TRILIUM_DATA_DIR=/home/myuser/data/my-trilium-data +Document is stored in the [[data directory]]. ## Demo document diff --git a/Keyboard-shortcuts.md b/Keyboard shortcuts.md similarity index 89% rename from Keyboard-shortcuts.md rename to Keyboard shortcuts.md index 6491bc4..9a93f7b 100644 --- a/Keyboard-shortcuts.md +++ b/Keyboard shortcuts.md @@ -13,6 +13,17 @@ This is supposed to be a complete list of keyboard shortcuts. Note that some of See demo of some of these features in [[note navigation|Note navigation]]. +## Tabs + +* `CTRL+click` - (or middle mouse click) on note link opens note in a new tab + +Only in desktop (electron build): + +* `CTRL+T` - opens empty tab +* `CTRL+W` - closes active tab +* `CTRL+Tab` - activates next tab +* `CTRL+Shift+Tab` - activates previous tab + ## Creating notes * `CTRL+O` - creates new note after the current note @@ -26,7 +37,7 @@ See demo of some of these features in [[note navigation|Note navigation]]. * `CTRL+RIGHT` - move note down in the note tree * `SHIFT+UP`, `SHIFT+DOWN` - multi-select note above/below * `CTRL+A` - select all notes in the current level -* `CTRL+click` - multi select note which you clicked on +* `SHIFT+click` - multi select note which you clicked on * `CTRL+C` - copies current note (or current selection) into clipboard (used for [[cloning|Cloning notes]]) * `CTRL+X` - cuts current (or current selection) note into clipboard (used for moving notes) * `CTRL+V` - pastes note(s) as sub-note into current note (which is either move or clone depending on whether it was copied or cut into clipboard) diff --git a/Link map.md b/Link map.md new file mode 100644 index 0000000..f31b640 --- /dev/null +++ b/Link map.md @@ -0,0 +1,17 @@ +Link map is a visualization of links and relations incoming to and outgoing from a particular note. + +This provides an insight into a structure ("web") of notes. + +[[images/link-map.png]] + +There's several types of links: + +* hyperlinks - internal hyperlinks from one text note to another note +* relations - relation [[attributes]] +* image links - this link represents inclusion of an image in a text note +* relation map links - this link represents inclusion of a note in a [[relation map]] + +[[Relation map]] is a similar concept, with some differences: + +* link map is automatically generated while relation map must be created manually +* relation map is a type of note while a link map is just virtual visualization \ No newline at end of file diff --git a/Protected-notes.md b/Protected notes.md similarity index 100% rename from Protected-notes.md rename to Protected notes.md diff --git a/Relation map.md b/Relation map.md index b428147..15974c9 100644 --- a/Relation map.md +++ b/Relation map.md @@ -35,4 +35,8 @@ There are several steps here: * we create another note for Princess Diana and create "isPartnerOf" relation from Charles. Again notice how the relation has arrows both ways - this is because "isPartnerOf" definition specifies its inverse relation as again "isPartnerOf" so the opposite relation is created automatically. * as the last step we pan & zoom the map to fit better to window dimensions. -Relation definitions mentioned above come from "Person template" note which is assigned to any child of "My Family Tree" relation note. You can play with the whole thing in the [[demo document|Document#Demo document]]. \ No newline at end of file +Relation definitions mentioned above come from "Person template" note which is assigned to any child of "My Family Tree" relation note. You can play with the whole thing in the [[demo document|Document#Demo document]]. + +## See also + +* [[Link map]] is a similar concept to relation maps \ No newline at end of file diff --git a/Script-API.md b/Script API.md similarity index 100% rename from Script-API.md rename to Script API.md diff --git a/Server-installation.md b/Server installation.md similarity index 88% rename from Server-installation.md rename to Server installation.md index 3d4119a..f97fe3f 100644 --- a/Server-installation.md +++ b/Server installation.md @@ -10,11 +10,11 @@ Server installation has both desktop and [[mobile frontend]]. ## Configuration -For server installations, you might want to configure e.g. port or [[TLS|TLS configuration]]. This is done in the Trilium config file, by default it's in ~/trilium-data/config.ini (where ~ is your home directory). +For server installations, you might want to configure e.g. port or [[TLS|TLS configuration]]. This is done in the Trilium config file, by default it's in `config.ini` in the [[data directory]] ### Config location -`config.ini`, [[document]] and some other important Trilium data files are by default persisted in `trilium-data` directory placed in your home directory. +`config.ini`, [[document]] and some other important Trilium data files are by default persisted in the [[data directory]]. If this is not desired, you may change it via `TRILIUM_DATA_DIR` environment variable to some other location, e.g.: diff --git a/TLS-configuration.md b/TLS configuration.md similarity index 90% rename from TLS-configuration.md rename to TLS configuration.md index ac07f0a..6c99c82 100644 --- a/TLS-configuration.md +++ b/TLS configuration.md @@ -7,7 +7,7 @@ First thing to do is to get a TLS certificate. You have two options: ## Modifying config.ini -Now that you have your certificate, we need to modify ~/trilium-data/config.ini so that Trilium will use it: +Now that you have your certificate, we need to modify `config.ini` in the [[data directory]] so that Trilium will use it: ``` [Network] diff --git a/Text-editor.md b/Text editor.md similarity index 100% rename from Text-editor.md rename to Text editor.md diff --git a/Tree-concepts.md b/Tree concepts.md similarity index 100% rename from Tree-concepts.md rename to Tree concepts.md diff --git a/Troubleshooting.md b/Troubleshooting.md index 937c81c..5aaa538 100644 --- a/Troubleshooting.md +++ b/Troubleshooting.md @@ -30,7 +30,7 @@ All JavaScript errors should be also logged to backend logs, but it's possible s ### Backend logs -Trilium logs important events and errors into `trilium-data/logs` directory. These logs are very helpful in debugging problems so please attach the latest ones with your bug report. You don't have to worry, they don't contain any sensitive information about your notes. +Trilium logs important events and errors into `logs` directory (inside [[data directory]]). These logs are very helpful in debugging problems so please attach the latest ones with your bug report. You don't have to worry, they don't contain any sensitive information about your notes. ### Anonymized database @@ -38,7 +38,7 @@ In some cases it's necessary to see the database structure to be able to debug t For this Trilium supports anonymization of the database - you can trigger this in Settings -> Advanced tab. -This will create a copy of your document and remove all sensitive data (currently note titles, contents, revisions, history and some of the options) while leaving all structure and metadata (e.g. date of last change). After this is done, database is [VACUUMed](https://sqlite.org/lang_vacuum.html) to make sure there's no stale sensitive data in the document file. Resulting file is stored in `trilium-data/anonymized` directory. You can safely attach it with your bug report. +This will create a copy of your document and remove all sensitive data (currently note titles, contents, revisions, history and some of the options) while leaving all structure and metadata (e.g. date of last change). After this is done, database is [VACUUMed](https://sqlite.org/lang_vacuum.html) to make sure there's no stale sensitive data in the document file. Resulting file is stored in `anonymized` directory (placed in the [[data directory]]). You can safely attach it with your bug report. Note that [[attributes]] are not cleared because they can contain important metadata for debugging. diff --git a/images/link-map.png b/images/link-map.png new file mode 100644 index 0000000..65f2c21 Binary files /dev/null and b/images/link-map.png differ