+
Select an existing day note, and the menubar contains a calendar widget. Select any day to create a note for that day.
-
+
This pattern works well also because of Cloning Notes functionality - note can appear in multiple places in the note tree, so besides appearing under day note, it can also be categorized into other notes.
- 
+
You can see the structure of day notes appearing under "Journal" note - there's a note for the whole year 2017, under it, you have "12 - December" diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Advanced Usage/Advanced Showcases/Task Manager.html b/src/public/app/doc_notes/en/User Guide/User Guide/Advanced Usage/Advanced Showcases/Task Manager.html index 1a7e9bf4e..3c0b1fb84 100644 --- a/src/public/app/doc_notes/en/User Guide/User Guide/Advanced Usage/Advanced Showcases/Task Manager.html +++ b/src/public/app/doc_notes/en/User Guide/User Guide/Advanced Usage/Advanced Showcases/Task Manager.html @@ -18,7 +18,7 @@ href="../../Note%20Types/Code/Scripts.html">scriptsshowcase present in the demo notes.
- 
+
Task Manager manages outstanding (TODO) tasks and finished tasks (non-empty doneDate attribute). Outstanding tasks are further categorized by location diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Advanced Usage/Advanced Showcases/Weight Tracker.html b/src/public/app/doc_notes/en/User Guide/User Guide/Advanced Usage/Advanced Showcases/Weight Tracker.html index 1629f2af4..e20f4d792 100644 --- a/src/public/app/doc_notes/en/User Guide/User Guide/Advanced Usage/Advanced Showcases/Weight Tracker.html +++ b/src/public/app/doc_notes/en/User Guide/User Guide/Advanced Usage/Advanced Showcases/Weight Tracker.html @@ -14,7 +14,7 @@
- 
+
The Weight Tracker is a Script API showcase
present in the demo notes.
These attributes play a crucial role in organizing, categorising, and enhancing the functionality of notes.
- 
+
Labels in Trilium can be used for a variety of purposes:
diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Advanced Usage/Attributes/Promoted Attributes.html b/src/public/app/doc_notes/en/User Guide/User Guide/Advanced Usage/Attributes/Promoted Attributes.html index 325639164..a15f9f447 100644 --- a/src/public/app/doc_notes/en/User Guide/User Guide/Advanced Usage/Attributes/Promoted Attributes.html +++ b/src/public/app/doc_notes/en/User Guide/User Guide/Advanced Usage/Attributes/Promoted Attributes.html @@ -17,7 +17,7 @@ are considered important and thus are "promoted" onto the main note UI. See example below:
- 
+
You can see the note having kind of form with several fields. Each of these is just regular attribute, the only difference is that they appear @@ -32,7 +32,7 @@ - is it just string, or is it a date? Should we allow multiple values or note? And importantly, should we promote the attribute or not?
- 
+
You can notice tag attribute definition. These "definition" attributes define how the "value" attributes should behave.
diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Advanced Usage/Database/Manually altering the database.html b/src/public/app/doc_notes/en/User Guide/User Guide/Advanced Usage/Database/Manually altering the database.html index eaa2dad70..a8f61c0fd 100644 --- a/src/public/app/doc_notes/en/User Guide/User Guide/Advanced Usage/Database/Manually altering the database.html +++ b/src/public/app/doc_notes/en/User Guide/User Guide/Advanced Usage/Database/Manually altering the database.html @@ -41,7 +41,7 @@
- 
+
First, start the SQLite 3 CLI by specifying the path to the database:
sqlite3 ~/.local/share/trilium-data/document.dbIt can be accessed by going to the global menu → Advanced → Open SQL Console.
- 
+
To run the statement, press the
- 
icon.
icon.
For queries that return a result, the data will displayed in a table.
- 
+
SQL queries or commands can be saved into a dedicated note.
To do so, simply write the query and press the
- 
button. Once saved, the note will appear in Day Notes.
button. Once saved, the note will appear in Day Notes.
Shows relations between notes:
- 
+
Shows hierarchical map of notes:
- 
+
Relation map is a similar concept, with diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Advanced Usage/Relation Map.html b/src/public/app/doc_notes/en/User Guide/User Guide/Advanced Usage/Relation Map.html index 7751d1f3d..f1ce9dadb 100644 --- a/src/public/app/doc_notes/en/User Guide/User Guide/Advanced Usage/Relation Map.html +++ b/src/public/app/doc_notes/en/User Guide/User Guide/Advanced Usage/Relation Map.html @@ -20,11 +20,11 @@
This is a basic example how you can create simple diagram using relation maps:
- 
+
And this is how you can create it:
- 
+
We start completely from scratch by first creating new note called "Development process" and changing its type to "Relation map". After that we create @@ -39,11 +39,11 @@
This is more complicated demo using some advanced concepts. Resulting diagram is here:
- 
+
This is how you get to it:
- 
+
There are several steps here:
+
+
Simply add the #shareRaw attribute and the note will always
be rendered raw when accessed from the share URL.
#shareRaw attribute is added on the
note.
-
+
If you want to import just a chunk of markdown from clipboard, you can do it from editor block menu:
- 
+
You can also import Markdown files from files:
@@ -38,20 +38,20 @@[[gifs/markdown-file-import.gif]]
- 
+
You can export whole subtree to ZIP archive which will have directory structured modelled after subtree structure:
- 
+
If you want to export just single note without its subtree, you can do it from Note actions menu:
- 
+
If you want to export protected notes, enter a protected session first! diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Basic Concepts/Navigation/Bookmarks.html b/src/public/app/doc_notes/en/User Guide/User Guide/Basic Concepts/Navigation/Bookmarks.html index 10f58c90b..946c7ed71 100644 --- a/src/public/app/doc_notes/en/User Guide/User Guide/Basic Concepts/Navigation/Bookmarks.html +++ b/src/public/app/doc_notes/en/User Guide/User Guide/Basic Concepts/Navigation/Bookmarks.html @@ -15,13 +15,13 @@
To easily access selected notes, you can bookmark them. See demo:
- 
+
Space in the left panel is limited, and you might want to bookmark many items. One possible solution is to bookmark a folder, so it shows its children:
- 
+
To do this, you need to add a #bookmarkFolder label to the
note.
- 
+
In addition to showing only this subtree, this also narrows both full text search and “jump to note” to just diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Basic Concepts/Navigation/Note Navigation.html b/src/public/app/doc_notes/en/User Guide/User Guide/Basic Concepts/Navigation/Note Navigation.html index 8e49f7fc8..feb1719a2 100644 --- a/src/public/app/doc_notes/en/User Guide/User Guide/Basic Concepts/Navigation/Note Navigation.html +++ b/src/public/app/doc_notes/en/User Guide/User Guide/Basic Concepts/Navigation/Note Navigation.html @@ -21,14 +21,14 @@
This works identically to browser backwards / forwards, it's actually using built-in browser support for this.
- 
+
This is useful to quickly find and view arbitrary note - click on Jump to button
on the top or press Ctrl + J . Then type part of the
note name and autocomplete will help you pick the desired note.
- 
+
Jump to note also has the ability to show the list of recently viewed @@ -38,7 +38,7 @@ will show the list of recent notes.
Alternatively you can click on the "time" icon on the right.
- 
+
easy entering of workspace:
- 
+
visual identification of workspace in tabs:
- 
+
You can control whether archived notes are displayed in the note tree with a setting:
- 
+
- 
+
In the demo, you can see how a clone can be created using the context menu. It's possible to do this also using the Add Link dialog or with Ctrl+C and Ctrl+V diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Basic Concepts/Note/Export as PDF.html b/src/public/app/doc_notes/en/User Guide/User Guide/Basic Concepts/Note/Export as PDF.html index 9adfe50b8..6db70ece0 100644 --- a/src/public/app/doc_notes/en/User Guide/User Guide/Basic Concepts/Note/Export as PDF.html +++ b/src/public/app/doc_notes/en/User Guide/User Guide/Basic Concepts/Note/Export as PDF.html @@ -14,7 +14,7 @@
- 
+
Screenshot of the note contextual menu indicating the “Export as PDF” option.
@@ -22,7 +22,7 @@ as PDF. On the server or PWA (mobile), the option is not available due to technical constraints and it will be hidden.To print a note, select the
- 
button to the right of the note and select Export as PDF.
button to the right of the note and select Export as PDF.
Afterwards you will be prompted to select where to save the PDF file. Upon confirmation, the resulting PDF will be opened automatically using the default/system application configured for PDFs.
@@ -31,7 +31,7 @@ report the issue. In this case, it's best to offer a sample note (click on the -button, select Export note → This note and all of its descendants → HTML
+ button, select Export note → This note and all of its descendants → HTML
in ZIP archive). Make sure not to accidentally leak any personal information.
When exporting to PDF, there are no customizable settings such as page diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Basic Concepts/Note/Note Revisions.html b/src/public/app/doc_notes/en/User Guide/User Guide/Basic Concepts/Note/Note Revisions.html index e7db23875..68f207d7a 100644 --- a/src/public/app/doc_notes/en/User Guide/User Guide/Basic Concepts/Note/Note Revisions.html +++ b/src/public/app/doc_notes/en/User Guide/User Guide/Basic Concepts/Note/Note Revisions.html @@ -35,7 +35,7 @@
Note revisions can be accessed through the button on the right of ribbon toolbar.
- 
+
After making changes, press Ctrl + R to reload the frontend and apply your new styles.
- 
+
To apply specific styles to certain notes in the tree:
diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Basic Concepts/UI Elements/Global menu.html b/src/public/app/doc_notes/en/User Guide/User Guide/Basic Concepts/UI Elements/Global menu.html index 5de10b75a..dabecef2e 100644 --- a/src/public/app/doc_notes/en/User Guide/User Guide/Basic Concepts/UI Elements/Global menu.html +++ b/src/public/app/doc_notes/en/User Guide/User Guide/Basic Concepts/UI Elements/Global menu.html @@ -16,7 +16,7 @@The global menu configures the current window (zoom, keeping the window on top) and offers access to some more advanced options.
- 
+
See Vertical and horizontal layout since diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Basic Concepts/UI Elements/Launch Bar.html b/src/public/app/doc_notes/en/User Guide/User Guide/Basic Concepts/UI Elements/Launch Bar.html index c49a3718b..76af9978b 100644 --- a/src/public/app/doc_notes/en/User Guide/User Guide/Basic Concepts/UI Elements/Launch Bar.html +++ b/src/public/app/doc_notes/en/User Guide/User Guide/Basic Concepts/UI Elements/Launch Bar.html @@ -38,7 +38,7 @@
This will open a new tab with the Note Tree listing the launchers.
- 
+
Expanding Available Launchers section will show the list of launchers that are not displayed on the launch bar. The Visible Launchers will diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Basic Concepts/UI Elements/Note Tree.html b/src/public/app/doc_notes/en/User Guide/User Guide/Basic Concepts/UI Elements/Note Tree.html index 2b901005e..687a689fc 100644 --- a/src/public/app/doc_notes/en/User Guide/User Guide/Basic Concepts/UI Elements/Note Tree.html +++ b/src/public/app/doc_notes/en/User Guide/User Guide/Basic Concepts/UI Elements/Note Tree.html @@ -16,7 +16,7 @@
This page explains how to manipulate the note tree in TriliumNext, focusing on moving notes.
- 
+
@@ -51,7 +51,7 @@ Shift and click on the note to end the selection with. All the notes between the start and the end note will be selected as well.
- 
+
In the right-click menu, operations such as Cut, Copy, Move to, Clone to or Delete will apply to all the selected notes. It is also possible diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Basic Concepts/UI Elements/Ribbon.html b/src/public/app/doc_notes/en/User Guide/User Guide/Basic Concepts/UI Elements/Ribbon.html index b83fd3f17..62814c49c 100644 --- a/src/public/app/doc_notes/en/User Guide/User Guide/Basic Concepts/UI Elements/Ribbon.html +++ b/src/public/app/doc_notes/en/User Guide/User Guide/Basic Concepts/UI Elements/Ribbon.html @@ -14,7 +14,7 @@
- 
+
The ribbon allows changing options, attributes and viewing information about the current note.
diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Basic Concepts/UI Elements/Vertical and horizontal layout.html b/src/public/app/doc_notes/en/User Guide/User Guide/Basic Concepts/UI Elements/Vertical and horizontal layout.html index 263ab1b4e..832cda585 100644 --- a/src/public/app/doc_notes/en/User Guide/User Guide/Basic Concepts/UI Elements/Vertical and horizontal layout.html +++ b/src/public/app/doc_notes/en/User Guide/User Guide/Basic Concepts/UI Elements/Vertical and horizontal layout.html @@ -26,13 +26,13 @@ href="Note%20Tree.html">Note Tree.
button at the bottom of the Launcher Bar.button at the bottom of the Launcher Bar.
icon at the top of the Launcher Bar.
- 
+
The horizontal layout is a more traditional layout, since it bears similarity @@ -48,13 +48,13 @@ removed if needed.
button to the left of the first tab.button to the left of the first tab.
button at the end of the Launcher Bar.
- 
+
Go to Settings and diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Basic Concepts/Zen mode.html b/src/public/app/doc_notes/en/User Guide/User Guide/Basic Concepts/Zen mode.html index 7f1b9210b..f334cd72f 100644 --- a/src/public/app/doc_notes/en/User Guide/User Guide/Basic Concepts/Zen mode.html +++ b/src/public/app/doc_notes/en/User Guide/User Guide/Basic Concepts/Zen mode.html @@ -14,7 +14,7 @@
- 
+
Screenshot of Zen Mode activated on a Windows 11 system with native title bar off and background effects on.
@@ -22,7 +22,7 @@ of Trilium is hidden away in order to be able to focus on the content, whether it's for reading or writing.
- 
+
Screenshot of the Zen Mode option in the global menu.
Once Zen Mode is activated, all the UI elements of the application will
be hidden away, including the global menu. In that case, the Zen Mode can
be deactivated either by pressing the
- 
icon in the top-right corner of the window or by pressing the keyboard
+ icon in the top-right corner of the window or by pressing the keyboard
combination again.
Do note that, by design, activating or deactivating the Zen Mode applies only to the current window. Restarting the application will also disable @@ -45,7 +45,7 @@ can still be moved by dragging the mouse across the top part of the window where the note titles are.
- 
+
Screenshot of two notes side-by-side while Zen Mode is active, on Windows 11 with background effects off.
diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Developer Guides/Examples/Using promoted attributes to c.html b/src/public/app/doc_notes/en/User Guide/User Guide/Developer Guides/Examples/Using promoted attributes to c.html index 3039dbd7d..228a43606 100644 --- a/src/public/app/doc_notes/en/User Guide/User Guide/Developer Guides/Examples/Using promoted attributes to c.html +++ b/src/public/app/doc_notes/en/User Guide/User Guide/Developer Guides/Examples/Using promoted attributes to c.html @@ -18,7 +18,7 @@ it's processing data, or a checkbox to define a particular change in behavior for the script.
-
+
Instead of asking the user to modify a boolean value in the script, it's diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Installation & Setup/Data directory.html b/src/public/app/doc_notes/en/User Guide/User Guide/Installation & Setup/Data directory.html index ead3e2f91..bfc22b2b7 100644 --- a/src/public/app/doc_notes/en/User Guide/User Guide/Installation & Setup/Data directory.html +++ b/src/public/app/doc_notes/en/User Guide/User Guide/Installation & Setup/Data directory.html @@ -27,7 +27,7 @@
Easy way how to find out which data directory Trilium uses is to look at the "About Trilium Notes" dialog (from "Menu" in upper left corner):
- 
+
Here's how the location is decided:
Data directory is normally named trilium-data and it is stored
diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Installation & Setup/Mobile Frontend.html b/src/public/app/doc_notes/en/User Guide/User Guide/Installation & Setup/Mobile Frontend.html
index 825d9acf7..410840f42 100644
--- a/src/public/app/doc_notes/en/User Guide/User Guide/Installation & Setup/Mobile Frontend.html
+++ b/src/public/app/doc_notes/en/User Guide/User Guide/Installation & Setup/Mobile Frontend.html
@@ -24,11 +24,11 @@
- 
+
- 
+
Mobile frontend provides only some of the features of the full desktop diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Installation & Setup/Server Installation/1. Installing the server/Manual server installation.html b/src/public/app/doc_notes/en/User Guide/User Guide/Installation & Setup/Server Installation/1. Installing the server/Manual server installation.html index d125ca2c8..fe7d113ee 100644 --- a/src/public/app/doc_notes/en/User Guide/User Guide/Installation & Setup/Server Installation/1. Installing the server/Manual server installation.html +++ b/src/public/app/doc_notes/en/User Guide/User Guide/Installation & Setup/Server Installation/1. Installing the server/Manual server installation.html @@ -30,7 +30,7 @@
You can either download source code zip/tar from https://github.com/TriliumNext/Notes/releases/latest.
-For the latest version including betas, clone Git repository from master branch with:
git clone -b master https://github.com/triliumnext/notes.gitFor the latest version including betas, clone Git repository from **master** branch with:
git clone -b master https://github.com/triliumnext/notes.gitcd trilium
# download all node dependencies
diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Installation & Setup/Synchronization.html b/src/public/app/doc_notes/en/User Guide/User Guide/Installation & Setup/Synchronization.html
index 6ed46a039..330e99a9c 100644
--- a/src/public/app/doc_notes/en/User Guide/User Guide/Installation & Setup/Synchronization.html
+++ b/src/public/app/doc_notes/en/User Guide/User Guide/Installation & Setup/Synchronization.html
@@ -18,7 +18,7 @@
up synchronization with a server instance, allowing multiple desktop clients
to sync with a central server. This creates a star-shaped topology:
- 
+
In this setup, a central server (referred to as the sync server)
and multiple client (or desktop) instances synchronize with
diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Installation & Setup/Web Clipper.html b/src/public/app/doc_notes/en/User Guide/User Guide/Installation & Setup/Web Clipper.html
index 899ef8874..fbc3a2b39 100644
--- a/src/public/app/doc_notes/en/User Guide/User Guide/Installation & Setup/Web Clipper.html
+++ b/src/public/app/doc_notes/en/User Guide/User Guide/Installation & Setup/Web Clipper.html
@@ -14,7 +14,7 @@
- 
+
Trilium Web Clipper is a web browser extension which allows user to clip
text, screenshots, whole pages and short notes and save them directly to
diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Note Types/Book.html b/src/public/app/doc_notes/en/User Guide/User Guide/Note Types/Book.html
index 3a6458f86..171d2f9c5 100644
--- a/src/public/app/doc_notes/en/User Guide/User Guide/Note Types/Book.html
+++ b/src/public/app/doc_notes/en/User Guide/User Guide/Note Types/Book.html
@@ -18,7 +18,7 @@
book-like reading experience. This format is particularly useful for viewing
multiple smaller notes in a cohesive, continuous manner.
- 
+
In the example above, the "node.js" note on the left panel contains several
child notes. The right panel displays the content of these child notes
@@ -33,7 +33,7 @@
This view presents the child notes in a grid format, allowing for a more
visual navigation experience.
- 
+
Switching between these views can be easily managed through the Book Note's
settings (or viewType attribute), allowing users to choose the
diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Note Types/Book/Calendar View.html b/src/public/app/doc_notes/en/User Guide/User Guide/Note Types/Book/Calendar View.html
index d834e0be5..0bd85ce36 100644
--- a/src/public/app/doc_notes/en/User Guide/User Guide/Note Types/Book/Calendar View.html
+++ b/src/public/app/doc_notes/en/User Guide/User Guide/Note Types/Book/Calendar View.html
@@ -14,44 +14,43 @@
- 
+
The Calendar view of Book notes will display each child note in a calendar
that has a start date and optionally an end date, as an event.
Unlike other Book view types, the Calendar view also allows some kind
of interaction, such as moving events around as well as creating new ones.
Creating a calendar
-
-
-
-
-
-
-
-
-
-
-
- 1
-
- 
-
- The Calendar View works only for Book note types. To create a new note,
- right click on the note tree on the left and select Insert note after,
- or Insert child note and then select Book.
-
-
- 2
-
- 
-
- Once created, the “View type” of the Book needs changed to “Calendar”,
- by selecting the “Book Properties” tab in the ribbon.
-
-
-
-
- Creating a new event/note
+
+
+
+
+
+
+
+ 1
+
+
+
+ The Calendar View works only for Book note types. To create a new note,
+ right click on the note tree on the left and select Insert note after,
+ or Insert child note and then select Book.
+
+
+ 2
+
+
+
+ Once created, the “View type” of the Book needs changed to “Calendar”,
+ by selecting the “Book Properties” tab in the ribbon.
+
+
+
+
+Creating a new event/note
- Clicking on a day will create a new child note and assign it to that particular
day.
@@ -63,7 +62,7 @@
- It's possible to drag across multiple days to set both the start and end
date of a particular note.
- 
+
- Creating new notes from the calendar will respect the
~child:template relation
if set on the book note.
@@ -72,7 +71,7 @@
- Hovering the mouse over an event will display information about the note.
- 
+
- Left clicking the event will go to that note. Middle clicking will open
the note in a new tab and right click will offer more options including
@@ -83,242 +82,234 @@
Configuring the calendar
The following attributes can be added to the book type:
-
-
-
-
- Name
- Description
-
-
-
-
- #calendar:hideWeekends
- When present (regardless of value), it will hide Saturday and Sundays
- from the calendar.
-
-
- #calendar:weekNumbers
- When present (regardless of value), it will show the number of the week
- on the calendar.
-
-
- ~child:template
- Defines the template for newly created notes in the calendar (via dragging
- or clicking).
-
-
-
-
+
+
+
+ Name
+ Description
+
+
+
+
+ #calendar:hideWeekends
+ When present (regardless of value), it will hide Saturday and Sundays
+ from the calendar.
+
+
+ #calendar:weekNumbers
+ When present (regardless of value), it will show the number of the week
+ on the calendar.
+
+
+ ~child:template
+ Defines the template for newly created notes in the calendar (via dragging
+ or clicking).
+
+
+
In addition, the first day of the week can be either Sunday or Monday
and can be adjusted from the application settings.
Configuring the calendar events
For each note of the calendar, the following attributes can be used:
-
-
-
-
- Name
- Description
-
-
-
-
- #startDate
- The date the event starts, which will display it in the calendar. The
- format is YYYY-MM-DD (year, month and day separated by a minus
- sign).
-
-
- #endDate
- Similar to startDate, mentions the end date if the event spans
- across multiple days. The date is inclusive, so the end day is also considered.
- The attribute can be missing for single-day events.
-
-
- #color
- Displays the event with a specified color (named such as red, gray or
- hex such as #FF0000). This will also change the color of the
- note in other places such as the note tree.
-
-
- #calendar:color
- Similar to #color, but applies the color only for the event
- in the calendar and not for other places such as the note tree.
-
-
- #iconClass
- If present, the icon of the note will be displayed to the left of the
- event title.
-
-
- #calendar:title
- Changes the title of an event to point to an attribute of the note other
- than the title, either a label (e.g. #assignee) or a relation
- (e.g. ~for). See Advanced use-cases for more information.
-
-
- #calendar:displayedAttributes
-
- Allows displaying the value of one or more attributes in the calendar
- like this:
-
- 
-
#weight="70"
-#Mood="Good"
-#calendar:displayedAttributes="weight,Mood"
- It can also be used with relations, case in which it will display the
- title of the target note:
~assignee=@My assignee
-#calendar:displayedAttributes="assignee"
-
-
-
- #calendar:startDate
- Allows using a different label to represent the start date, other than startDate (e.g. expiryDate).
- The label name must not be prefixed with #.
- If the label is not defined for a note, the default will be used instead.
-
-
- #calendar:endDate
- Allows using a different label to represent the start date, other than endDate.
- The label name must not be prefixed with #.
- If the label is not defined for a note, the default will be used instead.
-
-
-
-
- How the calendar works
-
- 
-
- The calendar displays all the child notes of the book that have a #startDate.
- An #endDate can optionally be added.
- If editing the start date and end date from the note itself is desirable,
- the following attributes can be added to the book note:
#viewType=calendar #label:startDate(inheritable)="promoted,alias=Start Date,single,date"
+
+
+
+ Name
+ Description
+
+
+
+
+ #startDate
+ The date the event starts, which will display it in the calendar. The
+ format is YYYY-MM-DD (year, month and day separated by a minus
+ sign).
+
+
+ #endDate
+ Similar to startDate, mentions the end date if the event spans
+ across multiple days. The date is inclusive, so the end day is also considered.
+ The attribute can be missing for single-day events.
+
+
+ #color
+ Displays the event with a specified color (named such as red, gray or
+ hex such as #FF0000). This will also change the color of the
+ note in other places such as the note tree.
+
+
+ #calendar:color
+ Similar to #color, but applies the color only for the event
+ in the calendar and not for other places such as the note tree.
+
+
+ #iconClass
+ If present, the icon of the note will be displayed to the left of the
+ event title.
+
+
+ #calendar:title
+ Changes the title of an event to point to an attribute of the note other
+ than the title, either a label (e.g. #assignee) or a relation
+ (e.g. ~for). See Advanced use-cases for more information.
+
+
+ #calendar:displayedAttributes
+ Allows displaying the value of one or more attributes in the calendar
+ like this:
+
+
+
+
+
<br>#weight="70"<br>#Mood="Good"<br>#calendar:displayedAttributes="weight,Mood"<br>
+
+
It can also be used with relations, case in which it will display the
+ title of the target note:
+
+
<br>~assignee=@My assignee<br>#calendar:displayedAttributes="assignee"<br>
+
+
+
+ #calendar:startDate
+ Allows using a different label to represent the start date, other than startDate (e.g. expiryDate).
+ The label name must not be prefixed with #.
+ If the label is not defined for a note, the default will be used instead.
+
+
+ #calendar:endDate
+ Allows using a different label to represent the start date, other than endDate.
+ The label name must not be prefixed with #.
+ If the label is not defined for a note, the default will be used instead.
+
+
+
+
+How the calendar works
+
+
+
+ The calendar displays all the child notes of the book that have a #startDate.
+ An #endDate can optionally be added.
+ If editing the start date and end date from the note itself is desirable,
+ the following attributes can be added to the book note:
#viewType=calendar #label:startDate(inheritable)="promoted,alias=Start Date,single,date"
#label:endDate(inheritable)="promoted,alias=End Date,single,date"
#hidePromotedAttributes
- This will result in:
-
- 
-
- When not used in a Journal, the calendar is recursive. That is, it will
- look for events not just in its child notes but also in the children of
- these child notes.
- Use-cases
- Using with the Journal / calendar
- It is possible to integrate the calendar view into the Journal with day
- notes. In order to do so change the note type of the Journal note (calendar
- root) to Book and then select the Calendar View.
- Based on the #calendarRoot (or #workspaceCalendarRoot)
- attribute, the calendar will know that it's in a calendar and apply the
- following:
-
- - The calendar events are now rendered based on their
dateNote attribute
- rather than startDate.
- - Interactive editing such as dragging over an empty era or resizing an
- event is no longer possible.
- - Clicking on the empty space on a date will automatically open that day's
- note or create it if it does not exist.
- - Direct children of a day note will be displayed on the calendar despite
- not having a
dateNote attribute. Children of the child notes
- will not be displayed.
-
-
- 
-
- Using a different attribute as event title
- By default, events are displayed on the calendar by their note title.
- However, it is possible to configure a different attribute to be displayed
- instead.
- To do so, assign #calendar:title to the child note (not the
- calendar/book note), with the value being #name where name can
- be any label. The attribute can also come through inheritance such as a
- template attribute. If the note does not have the requested label, the
- title of the note will be used instead.
-
-
-
-
-
-
-
-
-
-
-
- 
-
-
- 
-
-
-
-
-
- Using a relation attribute as event title
- Similarly to using an attribute, use #calendar:title and set
- it to ~name where name is the name of the relation
- to use.
- Moreover, if there are more relations of the same name, they will be displayed
- as multiple events coming from the same note.
-
-
-
-
-
-
-
-
-
-
-
- 
-
-
- 
-
-
-
-
-
- Note that it's even possible to have a #calendar:title on the
- target note (e.g. “John Smith”) which will try to render an attribute of
- it. Note that it's not possible to use a relation here as well for safety
- reasons (an accidental recursion of attributes could cause the application
- to loop infinitely).
-
-
-
-
-
-
-
-
-
-
-
- 
-
-
- 
-
-
-
-
-
+ This will result in:
+
+
+
+ When not used in a Journal, the calendar is recursive. That is, it will
+ look for events not just in its child notes but also in the children of
+ these child notes.
+ Use-cases
+ Using with the Journal / calendar
+ It is possible to integrate the calendar view into the Journal with day
+ notes. In order to do so change the note type of the Journal note (calendar
+ root) to Book and then select the Calendar View.
+ Based on the #calendarRoot (or #workspaceCalendarRoot)
+ attribute, the calendar will know that it's in a calendar and apply the
+ following:
+
+ - The calendar events are now rendered based on their
dateNote attribute
+ rather than startDate.
+ - Interactive editing such as dragging over an empty era or resizing an
+ event is no longer possible.
+ - Clicking on the empty space on a date will automatically open that day's
+ note or create it if it does not exist.
+ - Direct children of a day note will be displayed on the calendar despite
+ not having a
dateNote attribute. Children of the child notes
+ will not be displayed.
+
+
+
+
+ Using a different attribute as event title
+ By default, events are displayed on the calendar by their note title.
+ However, it is possible to configure a different attribute to be displayed
+ instead.
+ To do so, assign #calendar:title to the child note (not the
+ calendar/book note), with the value being #name where name can
+ be any label. The attribute can also come through inheritance such as a
+ template attribute. If the note does not have the requested label, the
+ title of the note will be used instead.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Using a relation attribute as event title
+ Similarly to using an attribute, use #calendar:title and set
+ it to ~name where name is the name of the relation
+ to use.
+ Moreover, if there are more relations of the same name, they will be displayed
+ as multiple events coming from the same note.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Note that it's even possible to have a #calendar:title on the
+ target note (e.g. “John Smith”) which will try to render an attribute of
+ it. Note that it's not possible to use a relation here as well for safety
+ reasons (an accidental recursion of attributes could cause the application
+ to loop infinitely).
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+