From bdeaa2829d4c5436e86d0d943a2a332d0c016804 Mon Sep 17 00:00:00 2001 From: azivner Date: Sun, 10 Dec 2017 23:21:47 -0500 Subject: [PATCH] added doc folder --- doc/0001-Welcome to Trilium!.html | 21 +++++++++++++++++++ .../0000-Protected notes.html | 19 +++++++++++++++++ .../0001-Note cloning.html | 12 +++++++++++ .../0002-Synchronization.html | 3 +++ 4 files changed, 55 insertions(+) create mode 100644 doc/0001-Welcome to Trilium!.html create mode 100644 doc/0001-Welcome to Trilium!/0000-Protected notes.html create mode 100644 doc/0001-Welcome to Trilium!/0001-Note cloning.html create mode 100644 doc/0001-Welcome to Trilium!/0002-Synchronization.html diff --git a/doc/0001-Welcome to Trilium!.html b/doc/0001-Welcome to Trilium!.html new file mode 100644 index 000000000..ddf21c84f --- /dev/null +++ b/doc/0001-Welcome to Trilium!.html @@ -0,0 +1,21 @@ +

Trilium is a personal knowledge base tool. This allows you to write and + manage your knowledge in a structured manner.

+

Main features

+ +

Homepage

+

Trilium project is maintained in GitHub repository where + you can find up to date documentation, source code and you can file issues.

\ No newline at end of file diff --git a/doc/0001-Welcome to Trilium!/0000-Protected notes.html b/doc/0001-Welcome to Trilium!/0000-Protected notes.html new file mode 100644 index 000000000..aec42324b --- /dev/null +++ b/doc/0001-Welcome to Trilium!/0000-Protected notes.html @@ -0,0 +1,19 @@ +

Protected notes are encrypted using AES encryption algorithm where encryption + key is generated using Scrypt key derivation function from user entered + password.

+

 

+

You can either protect individual notes or whole subtree by right clicking + on an item in the tree pane. In such a case it's still a case of all of + the notes being encrypted individually. One consequence is that you can + still create unprotected notes under protected notes.

+

 

+

In protected notes, only note title and note text are encrypted. All metadata + like date of last modification, note structure etc. are not encrypted and + can be visible even without entering protected mode.

+

 

+

When you try to perform action which requires protected session (e.g. + reading protected notes or making note protected), you'll be asked to enter + password. After successful authentication, protected session is established + for limited period of time (by default 10 minutes). If protected session + is not refreshed during this time, protected session expires and user needs + to authenticate again to start new protected session.

\ No newline at end of file diff --git a/doc/0001-Welcome to Trilium!/0001-Note cloning.html b/doc/0001-Welcome to Trilium!/0001-Note cloning.html new file mode 100644 index 000000000..ebc618616 --- /dev/null +++ b/doc/0001-Welcome to Trilium!/0001-Note cloning.html @@ -0,0 +1,12 @@ +Note cloning allows you to "register" single note (and it's subtree) under +multiple different notes.  +

 

+

This allows the same note to appear in multiple places in the tree. This + is useful when note logically belongs to multiple categories - e.g. in + time based structure you can categorize the note for the given date and + then separately you might want to put it somewhere else by it's taxonomy. + In this sense it works similarly to tags, only more generally and in a + tree structure (while tags are typically flat structured).

+

 

+

When note has multiple parents, then technically there isn't any one "original" + and "clones", all of the parents are equal.

\ No newline at end of file diff --git a/doc/0001-Welcome to Trilium!/0002-Synchronization.html b/doc/0001-Welcome to Trilium!/0002-Synchronization.html new file mode 100644 index 000000000..11e53cb77 --- /dev/null +++ b/doc/0001-Welcome to Trilium!/0002-Synchronization.html @@ -0,0 +1,3 @@ +

Trilium supports synchronization between different instances. Typical + scenario is when you have web version of Trilium deployed on your server + and desktop builds on your personal and work computer (star shaped topology).

\ No newline at end of file