To indicate that the subtree is hidden, the note will not have an expand
button and it will display the number of children to the right.
-
It's not possible to add a new note directly from the tree.
+
It's not possible to add a new note directly from the tree.
For Collections,
it's best to use the built-in mechanism to create notes (for example by
creating a new point on a geo-map, or by adding a new row in a table).
-
For normal notes, it's still possible to create children via other means
+
For normal notes, it's still possible to create children via other means
such as using the Internal (reference) links system.
-
-
Notes can be dragged from outside the note, case in which they will be
- cloned into it.
-
-
Instead of switching to the child notes that were copied, the parent note
- is highlighted instead.
-
A notification will indicate this behavior.
-
-
-
Similarly, features such as cut/copy and then paste into the note will
- also work.
+
+
Notes can be dragged from outside the note, case in which they will be
+ cloned into it.
+
+
Instead of switching to the child notes that were copied, the parent note
+ is highlighted instead.
+
A notification will indicate this behavior.
+
+
+
Similarly, features such as cut/copy and then paste into the note will
+ also work.
Spotlighting
@@ -64,22 +66,12 @@
This is intentional to avoid displaying a partial state of the subtree.
Working with collections
-
By default, some of the Collections will
- automatically hide their child notes, for example the Kanban Board or the Table.
-
The reasoning behind this is that collections are generally opaque to
- the rest of the notes and they can generate a large amount of sub-notes
- since they intentionally lack structure (in order to allow easy swapping
- between views).
-
Some types of collections have the child notes intentionally shown, for
- example the legacy ones (Grid and List), but also the Presentation which requires the tree
- structure in order to organize and edit the slides.
+
For large collections, it can be helpful to hide their child notes for
+ performance reasons or de-cluttering the tree.
To toggle this behavior:
-
In the New Layout,
- press the Options button underneath the title and uncheck Hide child notes in tree.
+
Open the collection and in Collection Properties,
+ look for Hide child notes in tree.
Right click the collection note in the Note Tree and select Advanced → Show subtree.
Collections are a unique type of note that don't have content, but instead
display their child notes in various presentation methods.
Main collections
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
Calendar
- which displays a week, month or year calendar with the notes being shown
- as events. New events can be added easily by dragging across the calendar.
-
-
-
-
-
-
-
-
Table
- displays each note as a row in a table, with Promoted Attributes being shown as well.
- This makes it easy to visualize attributes of notes, as well as making
- them easily editable.
-
-
-
-
-
-
-
-
Kanban Board
- displays notes in columns, grouped by the value of a label. Items and
- columns can easily be created or dragged around to change their status.
-
-
-
-
-
-
-
-
Geo Map
- which displays a geographical map in which the notes are represented as
- markers/pins on the map. New events can be easily added by pointing on
- the map.
-
-
-
-
-
-
-
-
Presentation
- which shows each note as a slide and can be presented full-screen with
- smooth transitions or exported to PDF for sharing.
-
-
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Calendar
+ which displays a week, month or year calendar with the notes being shown
+ as events. New events can be added easily by dragging across the calendar.
+
+
+
+
+
+
+
+
Table
+ displays each note as a row in a table, with Promoted Attributes being shown as well.
+ This makes it easy to visualize attributes of notes, as well as making
+ them easily editable.
+
+
+
+
+
+
+
+
Kanban Board
+ displays notes in columns, grouped by the value of a label. Items and
+ columns can easily be created or dragged around to change their status.
+
+
+
+
+
+
+
+
Geo Map
+ which displays a geographical map in which the notes are represented as
+ markers/pins on the map. New events can be easily added by pointing on
+ the map.
+
+
+
+
+
+
+
+
Presentation
+ which shows each note as a slide and can be presented full-screen with
+ smooth transitions or exported to PDF for sharing.
+
+
+
+
Classic collections
Classic collections are read-only mode and compiles the contents of all
child notes into one continuous view. This makes it ideal for reading extensive
@@ -88,27 +89,49 @@
To create a new collections, right click in the Note Tree and look for the Collections entry
and select the desired type.
+
By default, collections come with a default configuration and sometimes
+ even sample notes. To create a collection completely from scratch:
Consult the help page of the corresponding view type in order to understand
+ how to configure them.
+
Configuration
To change the configuration of a collection or even switch to a different
- collection (e.g. from Kanban Board to a Calendar), see the dedicated Collections tab
- in the Ribbon.
+ collection (e.g. from Kanban Board to a Calendar), see the Collection Properties bar
+ at the top of the note.
Archived notes
By default, archived notes will not be
- shown in collections. This behavior can be changed by going to Collection Properties in
- the Ribbon and
- checking Show archived notes.
+ shown in collections. This behavior can be changed by going to
+ Collection Properties and checking Show archived notes.
Archived notes will be generally indicated by being greyed out as opposed
to the normal ones.
+
Hiding the child notes from the note tree
+
For collections with a large number of items, it can be helpful to hide
+ the items from the note tree for performance reasons and to reduce clutter.
+ This is especially useful for standalone collections, such as a geomap
+ or a task board.
Now the text will be displayed above while still maintaining the collection
view.
+
The only downside to this method is that Collection Properties will
+ not be shown anymore. In this case, modify the attributes manually or switch
+ back temporarily to the Collection type for configuration purposes.
Using saved search
Collections, by default, only display the child notes. However, it is
possible to use the Search functionality
@@ -123,19 +146,6 @@
of the search results. The reason is that the search might hit a note multiple
times, causing an exponential rise in the number of results.
-
Creating a collection from scratch
-
By default, collections come with a default configuration and sometimes
- even sample notes. To create a collection completely from scratch:
-
-
Create a new note of type Text (or any type).
-
In the Ribbon,
- go to Basic Properties and select Collection as the note
- type.
-
Still in the ribbon, go to Collection Properties and select the
- desired view type.
-
Consult the help page of the corresponding view type in order to understand
- how to configure them.
The Calendar view will display each child note in a calendar that has
@@ -11,42 +11,18 @@
time-specific events, not just all-day events.
Month view, where the entire month is displayed and all-day events can
be inserted. Both time-specific events and all-day events are listed.
-
Year view, which displays the entire year for quick reference.
-
List view, which displays all the events of a given month in sequence.
+
Year view, which displays the entire year for quick reference.
+
List view, which displays all the events of a given month in sequence.
Unlike other Collection 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 Collection 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 Collection.
-
-
-
2
-
-
-
-
Once created, the “View type” of the Collection needs changed to “Calendar”,
- by selecting the “Collection Properties” tab in the ribbon.
-
-
-
-
+
Right click on an existing note in the Note Tree and select Insert child note and
+ look for Calendar.
Creating a new event/note
Clicking on a day will create a new child note and assign it to that particular
@@ -68,7 +44,7 @@
Hovering the mouse over an event will display information about the note.
-
+
Left clicking the event will open a Quick edit to
edit the note in a popup while allowing easy return to the calendar by
@@ -80,7 +56,8 @@
Drag and drop an event on the calendar to move it to another day.
-
The length of an event can be changed by placing the mouse to the right
+
The length of an event can be changed by placing the mouse to the right
edge of the event and dragging the mouse around.
Interaction on mobile
@@ -89,23 +66,26 @@
Clicking on an event triggers the contextual menu, including the option
to open in Quick edit.
-
To insert a new event, touch and hold the empty space. When successful,
+
To insert a new event, touch and hold the empty space. When successful,
the empty space will become colored to indicate the selection.
Before releasing, drag across multiple spaces to create multi-day events.
-
When released, a prompt will appear to enter the note title.
+
When released, a prompt will appear to enter the note title.
-
-
To move an existing event, touch and hold the event until the empty space
- near it will become colored.
-
-
At this point the event can be dragged across other days on the calendar.
-
Or the event can be resized by tapping on the small circle to the right
- end of the event.
-
To exit out of editing mode, simply tap the empty space anywhere on the
- calendar.
+
+
To move an existing event, touch and hold the event until the empty space
+ near it will become colored.
+
+
At this point the event can be dragged across other days on the calendar.
+
Or the event can be resized by tapping on the small circle to the right
+ end of the event.
+
To exit out of editing mode, simply tap the empty space anywhere on the
+ calendar.
-
+
Configuring the calendar view
In the Collections tab in the Ribbon,
@@ -116,296 +96,311 @@
Configuring the calendar using attributes
The following attributes can be added to the Collection 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.
-
-
-
#calendar:initialDate
-
-
Change the date the calendar opens on. When not present, the calendar
- opens on the current date.
-
-
-
#calendar:view
-
-
-
Which view to display in the calendar:
-
-
timeGridWeek for the week view;
-
dayGridMonth for the month view;
-
multiMonthYear for the year view;
-
listMonth for the list view.
-
-
Any other value will be dismissed and the default view (month) will be
- used instead.
-
The value of this label is automatically updated when changing the view
- using the UI buttons.
-
-
-
-
~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 using attributes
-
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.
-
-
-
#startTime
-
-
The time the event starts at. If this value is missing, then the event
- is considered a full-day event. The format is HH:MM (hours
- in 24-hour format and minutes).
-
-
-
#endTime
-
-
Similar to startTime, it mentions the time
- at which the event ends (in relation with endDate if
- present, or startDate).
-
-
-
#color
-
-
Displays the event with a specified color (named such as red,
- grayor hex such as #FF0000). This
- will also change the color of the note in other places such as the note
- tree.
-
-
-
#calendar:color
-
-
❌️ Removed since v0.100.0. Use**#color**instead.
-
- 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, can either a label or a relation (without the # or
- ~symbol). See 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
-
-
Similar to #calendar:startDate, allows
- changing the attribute which is being used to read the end date.
-
-
-
#calendar:startTime
-
-
Similar to #calendar:startDate, allows
- changing the attribute which is being used to read the start time.
-
-
-
#calendar:endTime
-
-
Similar to #calendar:startDate, allows
- changing the attribute which is being used to read the end time.
-
-
-
-
-
How the calendar works
-
-
-
-
The calendar displays all the child notes of the Collection 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 Collection note:
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.
+
+
+
#calendar:initialDate
+
+
Change the date the calendar opens on. When not present, the calendar
+ opens on the current date.
+
+
+
#calendar:view
+
+
+
Which view to display in the calendar:
+
+
timeGridWeek for the week view;
+
dayGridMonth for the month view;
+
multiMonthYear for the year view;
+
listMonth for the list view.
+
+
Any other value will be dismissed and the default view (month) will be
+ used instead.
+
The value of this label is automatically updated when changing the view
+ using the UI buttons.
+
+
+
+
~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 using attributes
+
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.
+
+
+
#startTime
+
+
The time the event starts at. If this value is missing, then the event
+ is considered a full-day event. The format is HH:MM (hours
+ in 24-hour format and minutes).
+
+
+
#endTime
+
+
Similar to startTime, it mentions the time
+ at which the event ends (in relation with endDate if
+ present, or startDate).
+
+
+
#color
+
+
Displays the event with a specified color (named such as red,
+ grayor hex such as #FF0000). This
+ will also change the color of the note in other places such as the note
+ tree.
+
+
+
#calendar:color
+
+
❌️ Removed since v0.100.0. Use**#color**instead.
+
+ 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, can either a label or a relation (without the # or
+ ~symbol). See 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
+
+
Similar to #calendar:startDate, allows
+ changing the attribute which is being used to read the end date.
+
+
+
#calendar:startTime
+
+
Similar to #calendar:startDate, allows
+ changing the attribute which is being used to read the start time.
+
+
+
#calendar:endTime
+
+
Similar to #calendar:startDate, allows
+ changing the attribute which is being used to read the end time.
+
+
+
+
+
How the calendar works
+
+
+
+
The calendar displays all the child notes of the Collection 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 Collection note:
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 Collection 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/Collection note), with the value being
- namewhere name can be any label (make
- not to add the # prefix). 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.
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.
-
-
-
-
-
-
-
-
-
-
#startDate=2025-02-14 #endDate=2025-02-15 ~for=@John Smith ~for=@Jane Doe #calendar:title="for"
-
-
-
-
-
-
-
-
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).
-
-
-
-
-
-
-
-
-
-
#calendar:title="shortName" #shortName="John S."
-
-
-
-
-
-
-
-
-
\ No newline at end of file
+
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 Collection 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/Collection note), with the value being
+ namewhere name can be any label (make
+ not to add the # prefix). 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.
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.
+
+
+
+
+
+
+
+
+
+
+
#startDate=2025-02-14 #endDate=2025-02-15 ~for=@John Smith ~for=@Jane Doe #calendar:title="for"
+
+
+
+
+
+
+
+
+
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).
+
+
+
+
+
+
+
+
+
+
+
#calendar:title="shortName" #shortName="John S."
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Collections/Collection Properties.html b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Collections/Collection Properties.html
new file mode 100644
index 000000000..029bfd7be
--- /dev/null
+++ b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Collections/Collection Properties.html
@@ -0,0 +1,27 @@
+
+
+
+
The Collection Properties is a toolbar that is displayed at the
+ top of every collection note.
+
For versions prior to v0.102.0, this feature was only available for the
+ New Layout. Starting with this version, the collection properties
+ are enabled for the Old layout as well, and Ribbon no
+ longer contains a dedicated tab for collection properties.
+
The collection properties has:
+
+
A quick selector for the view type (e.g. grid, calendar, board).
+
A settings button with:
+
+
Settings for the current view, for example hiding the weekends in a calendar.
Specific interactions for the current view, for example month selector
+ and view switcher for the calendar.
+
\ No newline at end of file
diff --git a/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Collections/Collection Properties_imag.png b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Collections/Collection Properties_imag.png
new file mode 100644
index 000000000..c1955ce8b
Binary files /dev/null and b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Collections/Collection Properties_imag.png differ
diff --git a/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Collections/Geo Map.html b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Collections/Geo Map.html
index e86e58f98..2fd8a7198 100644
--- a/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Collections/Geo Map.html
+++ b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Collections/Geo Map.html
@@ -5,46 +5,16 @@
href="#root/_help_0ESUbbAxVnoK">Note List.
-
This note type displays the children notes on a geographical map, based
on an attribute. It is also possible to add new notes at a specific location
using the built-in interface.
Creating a new geo map
-
-
-
-
-
-
-
-
-
-
-
-
1
-
-
-
-
-
-
Right click on any note on the note tree and select Insert child note → Geo Map (beta).
-
-
-
2
-
-
-
-
-
-
By default the map will be empty and will show the entire world.
-
-
-
-
+
Right click on an existing note in the Note Tree and select Geo Map.
+
By default the map will be empty and will show the entire world.
Repositioning the map
Click and drag the map in order to move across the map.
@@ -69,12 +39,12 @@
1
To create a marker, first navigate to the desired point on the map. Then
press the
- button in the Floating buttons (top-right)
- area.
+ button in the Floating buttons (top-right)
+ area.
If the button is not visible, make sure the button section is visible
by pressing the chevron button (
- ) in the top-right of the map.
+ ) in the top-right of the map.
@@ -84,7 +54,7 @@
width="1730" height="416">
Once pressed, the map will enter in the insert mode, as illustrated by
- the notification.
+ the notification.
Simply click the point on the map where to place the marker, or the Escape
key to cancel.
@@ -100,7 +70,7 @@
4
-
Once confirmed, the marker will show up on the map and it will also be
@@ -143,7 +113,7 @@
The location of a marker is stored in the #geolocation attribute
of the child notes:
-
This value can be added manually if needed. The value of the attribute
@@ -227,15 +197,15 @@
1
-
Go to Google Maps on the web and look for a desired location, right click
- on it and a context menu will show up.
+ on it and a context menu will show up.
Simply click on the first item displaying the coordinates and they will
- be copied to clipboard.
+ be copied to clipboard.
Then paste the value inside the text box into the #geolocation attribute
of a child note of the map (don't forget to surround the value with a
@@ -256,7 +226,7 @@
3
-
@@ -296,7 +266,7 @@
width="696" height="480">
The address will be visible in the top-left of the screen, in the place
- of the search bar.
+ of the search bar.
Select the coordinates and copy them into the clipboard.
When going back to the map, the track should now be visible.
+
When going back to the map, the track should now be visible.
The start and end points of the track are indicated by the two blue markers.
@@ -384,8 +354,9 @@ class="table">
class="reference-link" href="#root/_help_XpOYSgsLkTJy">Floating buttons. To disable it, press the button again.
Configuration
Map Style
-
The styling of the map can be adjusted in the Collection Properties (above
- the map, by pressing on the Gear icon) or manually via the #map:style attribute.
+
The styling of the map can be adjusted in the Collection Properties or
+ manually via the #map:style attribute.
The geo map comes with two different types of styles:
Raster styles
@@ -414,8 +385,8 @@ class="table">
in raster format.
Custom vector map support is planned, but not yet implemented.
Other options
-
The following options can be configured either via the Collection properties
- pane above the map, by clicking on the settings (Gear icon). Alternatively,
- each of these options also have a corresponding label that
- can be set manually.
+
The following options can be configured either via the Collection Properties,
+ by clicking on the settings (Gear icon). Alternatively, each of these options
+ also have a corresponding label that can
+ be set manually.
-
-
Scale, which illustrates the scale of the map in kilometers and miles
- in the bottom-left of the map.
-
-
-
The name of the markers is displayed by default underneath the pin on
- the map. Since v0.102.0, it is possible to hide these labels which increases
- the performance and decreases clutter when there are many markers on the
- map.
-
+
Scale, which illustrates the scale of the map in kilometers and miles
+ in the bottom-left of the map.
+
The name of the markers is displayed by default underneath the pin on
+ the map. Since v0.102.0, it is possible to hide these labels which increases
+ the performance and decreases clutter when there are many markers on the
+ map.
The grid view is also used by default in the Note List of every note, making it easy
to navigate to children notes.
+
Creating a new table
+
Right click on an existing note in the Note Tree and select Insert child note and
+ look for Grid View.
Configuration
Unlike most other view types, the grid view is not actually configurable.
\ No newline at end of file
diff --git a/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Collections/Kanban Board.html b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Collections/Kanban Board.html
index 5a20f9985..f32dc4f7a 100644
--- a/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Collections/Kanban Board.html
+++ b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Collections/Kanban Board.html
@@ -5,6 +5,10 @@
The Board view presents sub-notes in columns for a Kanban-like experience.
Each column represents a possible value for a status label, which can be
adjusted.
+
Creating a Kanban board
+
Right click on an existing note in the Note Tree and select Insert child note and
+ look for Kanban Board.
How it works
When first creating a collection of Board type, a few subnotes
will be created, each having a #status label
@@ -24,14 +28,15 @@
To reorder a column, simply hold the mouse over the title and drag it
to the desired position.
To delete a column, right click on its title and select Delete column.
-
To rename a column, click on the note title.
+
To rename a column, click on the note title.
Press Enter to confirm.
Upon renaming a column, the corresponding status attribute of all its
notes will be changed in bulk.
-
-
If there are many columns, use the mouse wheel to scroll.
+
+
If there are many columns, use the mouse wheel to scroll.
Hold the mouse on the note and drag it to the to the desired column.
+
Hold the mouse on the note and drag it to the to the desired column.
This works for:
Notes that are not children of the board, case in which a clone will
be created.
Notes that are children of the board, but not yet assigned on the board.
-
Notes that are children of the board, case in which they will be moved
+
Notes that are children of the board, case in which they will be moved
to the new column.
Keyboard interaction
@@ -92,9 +99,10 @@
column titles, notes and the “New item” button for each of the columns,
in sequential order.
To rename a column or a note, press F2 while it is focused.
-
To open a specific note or create a new item, press Enter while
+
To open a specific note or create a new item, press Enter while
it is focused.
-
To dismiss a rename of a note or a column, press Escape.
+
To dismiss a rename of a note or a column, press Escape.
Configuration
Displaying custom attributes
@@ -110,8 +118,9 @@
Go to board note.
In the ribbon select Owned Attributes → plus button → Add new label/relation definition.
-
Configure the attribute as desired.
-
Check Inheritable to make it applicable to child notes automatically.
+
Configure the attribute as desired.
+
Check Inheritable to make it applicable to child notes automatically.
After creating the attribute, click on a note and fill in the promoted
attributes which should then reflect inside the board.
@@ -122,13 +131,15 @@
assigning a custom name.
Both “Single value” and “Multi value” attributes are supported. In case
of multi-value, a badge is displayed for every instance of the attribute.
-
All label types are supported, including dates, booleans and URLs.
-
Relation attributes are also supported as well, showing a link with the
- target note title and icon.
-
Currently, it's not possible to adjust which promoted attributes are displayed,
- since all promoted attributes will be displayed (except the board:groupBy one).
- There are plans to improve upon this being able to hide promoted attributes
- individually.
+
All label types are supported, including dates, booleans and URLs.
+
Relation attributes are also supported as well, showing a link with the
+ target note title and icon.
+
Currently, it's not possible to adjust which promoted attributes are displayed,
+ since all promoted attributes will be displayed (except the board:groupBy one).
+ There are plans to improve upon this being able to hide promoted attributes
+ individually.
Grouping by another label
By default, the label used to group the notes is #status.
@@ -146,36 +157,33 @@
The columns represent the target notes of a relation.
When creating a new column, a note is selected instead of a column name.
-
The column icon will match the target note.
-
Moving notes between columns will change its relation.
-
Renaming an existing column will change the target note of all the notes
- in that column.
+
The column icon will match the target note.
+
Moving notes between columns will change its relation.
+
Renaming an existing column will change the target note of all the notes
+ in that column.
Using relations instead of labels has some benefits:
The status/grouping of the notes is visible outside the Kanban board,
for example on the Note Map.
-
Columns can have icons.
-
Renaming columns is less intensive since it simply involves changing the
- note title of the target note instead of having to do a bulk rename.
+
Columns can have icons.
+
Renaming columns is less intensive since it simply involves changing the
+ note title of the target note instead of having to do a bulk rename.
To do so:
-
-
First, create a Kanban board from scratch and not a template:
-
-
-
Assign #viewType=board #hidePromotedAttributes to
- emulate the default template.
-
-
-
Set #board:groupBy to the name of a relation
+
First, create a Kanban board from scratch and not a template:
+
Assign #viewType=board #hidePromotedAttributes to
+ emulate the default template.
+
Set #board:groupBy to the name of a relation
to group by, including the~prefix (e.g.
~status).
-
-
-
Optionally, use Promoted Attributes for
- easy status change within the note:
\ No newline at end of file
diff --git a/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Collections/List View.html b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Collections/List View.html
index 82d074b11..6048e4d3b 100644
--- a/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Collections/List View.html
+++ b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Collections/List View.html
@@ -10,6 +10,10 @@
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
as a single continuous document.
+
Creating a new table
+
Right click on an existing note in the Note Tree and select Insert child note and
+ look for List View.
Interaction
Each note can be expanded or collapsed by clicking on the arrow to the
@@ -26,14 +30,15 @@
functionality:
The table of contents of the PDF will reflect the structure of the notes.
-
Reference and inline links to other notes within the same hierarchy will
+
Reference and inline links to other notes within the same hierarchy will
be functional (will jump to the corresponding page). If a link refers to
a note that is not in the printed hierarchy, it will be unlinked.
Expanding and collapsing multiple notes at once
Apart from individually expanding or collapsing notes, it's also possible
- to expand or collapse them all at once. To do so, go to the Collection Properties tab
- in the Ribbon and
+ to expand or collapse them all at once. To do so, go to the Collection Properties and
look for the corresponding button.
By default, the Expand button will only expand the direct children
(first level) of the collection. Starting with v0.100.0, it's possible
diff --git a/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Collections/Presentation.html b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Collections/Presentation.html
index 1f3cd63dc..795ea0a46 100644
--- a/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Collections/Presentation.html
+++ b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Collections/Presentation.html
@@ -4,23 +4,29 @@
The Presentation view allows the creation of slideshows directly from
within Trilium.
+
Creating a new presentation
+
Right click on an existing note in the Note Tree and select Insert child note and
+ look for Presentation.
How it works
Each slide is a child note of the collection.
The order of the child notes determines the order of the slides.
-
Unlike traditional presentation software, slides can be laid out both
+
Unlike traditional presentation software, slides can be laid out both
horizontally and vertically (see belwo for more information).
-
Direct children will be laid out horizontally and the children of those
- will be laid out vertically. Children deeper than two levels of nesting
- are ignored.
+
Direct children will be laid out horizontally and the children of those
+ will be laid out vertically. Children deeper than two levels of nesting
+ are ignored.
Interaction and navigation
In the floating buttons section (top-right):
Edit button to go to the corresponding note of the current slide.
-
Press Overview button (or the O key) to show a birds-eye view
+
Press Overview button (or the O key) to show a birds-eye view
of the slides. Press the button again to disable it.
-
Press the “Start presentation” button to show the presentation in full-screen.
+
Press the “Start presentation” button to show the presentation in full-screen.
The following keyboard shortcuts are supported:
@@ -82,10 +88,11 @@
At collection level, it's possible to adjust:
The theme of the entire presentation to one of the predefined themes by
- going to the Ribbon and
- looking for the Collection Properties tab.
Text notes generally respect the formatting (bold, italic, foreground
and background colors) and font size. Code blocks and tables also work.
-
Try using more than just text notes, the presentation uses the same mechanism
+
Try using more than just text notes, the presentation uses the same mechanism
as shared notes and Note List so it should be able to display
Mind Map in full-screen (without the interactivity).
-
-
Consider using a transparent background for Canvas, if the slides have a custom background
- (go to the hamburger menu in the Canvas, press the button select a custom
- color and write transparent).
-
+
Consider using a transparent background for Canvas, if the slides have a custom background
+ (go to the hamburger menu in the Canvas, press the button select a custom
+ color and write transparent).
For Mermaid Diagrams,
some of them have a predefined background which can be changed via the
@@ -129,7 +135,7 @@ config:
---
-
+
Under the hood
The Presentation view uses Reveal.js to
diff --git a/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Collections/Table.html b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Collections/Table.html
index deea34463..45f464c06 100644
--- a/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Collections/Table.html
+++ b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Collections/Table.html
@@ -36,8 +36,9 @@
Interaction
Creating a new table
-
Right click the Note Tree and
- select Insert child note and look for the Table item.
+
Right click on an existing note in the Note Tree and select Insert child note and
+ look for Table.
To limit to a certain depth, type in the desired number (e.g. 2 to only
diff --git a/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Theme development/Creating an icon pack.html b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Theme development/Creating an icon pack.html
index 301602420..e4af1aad7 100644
--- a/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Theme development/Creating an icon pack.html
+++ b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Theme development/Creating an icon pack.html
@@ -1,7 +1,8 @@
First read the quick flow to get the overall steps. After that there is
a concrete example (Phosphor) with a small Node.js script you can run to
@@ -11,67 +12,61 @@
Verify the icon set is a font (one of: .woff2, .woff, .ttf).
Obtain a list that maps icon names to Unicode code points (often provided
as a JSON like selection.json or a CSS file).
-
Create a manifest JSON that maps icon ids to glyphs and search terms.
-
Create a Trilium note of type Code, set language to JSON, paste the manifest
- as the note content.
-
Upload the font file as an attachment to the same note (MIME type must
- be font/woff2, font/woff,
- or font/ttf and role file).
-
Add the label #iconPack=<prefix> to
- the note (prefix: alphanumeric, hyphen, underscore only).
-
Refresh the client and verify the icon pack appears in the icon selector.
+
Create a manifest JSON that maps icon ids to glyphs and search terms.
+
Create a Trilium note of type Code, set language to JSON, paste the manifest
+ as the note content.
+
Upload the font file as an attachment to the same note (MIME type must
+ be font/woff2, font/woff,
+ or font/ttf and role file).
+
Add the label #iconPack=<prefix> to
+ the note (prefix: alphanumeric, hyphen, underscore only).
+
Refresh the client and verify the icon pack appears in the icon selector.
Verify the icon set
The first step is to analyze if the icon set being packed can be integrated
into Trilium.
Trilium only supports font-based icon sets, with the following
formats:
-
-
-
-
-
Extension
-
MIME type
-
Description
-
-
-
-
-
.woff2
-
-
font/woff2
-
-
Recommended due to great compression (low size).
-
-
-
.woff
-
-
font/woff
-
-
Higher compatibility, but the font file is bigger.
-
-
-
.ttf
-
-
font/ttf
-
-
Most common, but highest font size.
-
-
-
-
+
+
+
+
Extension
+
MIME type
+
Description
+
+
+
+
+
.woff2
+
+
font/woff2
+
+
Recommended due to great compression (low size).
+
+
+
.woff
+
+
font/woff
+
+
Higher compatibility, but the font file is bigger.
+
+
+
.ttf
+
+
font/ttf
+
+
Most common, but highest font size.
+
+
+
Trilium does not support the following formats:
SVG-based fonts.
Individual SVGs.
.eot fonts (legacy and proprietary).
-
Duotone icons, since it requires a special CSS format that Trilium doesn't
+
Duotone icons, since it requires a special CSS format that Trilium doesn't
support.
-
Any other font format not specified in the Supported formats section.
+
Any other font format not specified in the Supported formats section.
In this case, the font must be manually converted to one of the supported
formats (ideally .woff2).
@@ -103,8 +98,7 @@
or as the actual UTF‑8 character.
It is also possible to use the unescaped glyph inside the JSON. It will
appear strange (e.g. ), but it will be rendered properly regardless.
-
The manifest keys (e.g. ph-acorn) should
+
The manifest keys (e.g. ph-acorn) should
match the class names used by the font (prefix + name is a common pattern).
@@ -246,8 +240,7 @@ processIconPack("light");
Optionally, assign an icon from the new icon pack to this note. This icon
will be used in the icon pack filter for a visual distinction.
One example is if the font could not be retrieved: ERROR: Icon pack is missing WOFF/WOFF2/TTF attachment: Boxicons v3 400 (dup) (XRzqDQ67fHEK).
-
Make sure the prefix is unique and not already taken by some other icon
+
Make sure the prefix is unique and not already taken by some other icon
pack. When there are two icon packs with the same prefix, only one is used.
The server logs will indicate if this situation occurs.
-
Make sure the prefix consists only of alphanumeric characters, hyphens
- and underscore.
+
Make sure the prefix consists only of alphanumeric characters, hyphens
+ and underscore.
\ No newline at end of file
diff --git a/docs/Developer Guide/Developer Guide/Documentation.md b/docs/Developer Guide/Developer Guide/Documentation.md
index 8e669ac86..7eae341ea 100644
--- a/docs/Developer Guide/Developer Guide/Documentation.md
+++ b/docs/Developer Guide/Developer Guide/Documentation.md
@@ -1,5 +1,5 @@
# Documentation
-There are multiple types of documentation for Trilium:
+There are multiple types of documentation for Trilium:
* The _User Guide_ represents the user-facing documentation. This documentation can be browsed by users directly from within Trilium, by pressing F1.
* The _Developer's Guide_ represents a set of Markdown documents that present the internals of Trilium, for developers.
diff --git a/docs/User Guide/!!!meta.json b/docs/User Guide/!!!meta.json
index dcd9086dd..924c03a59 100644
--- a/docs/User Guide/!!!meta.json
+++ b/docs/User Guide/!!!meta.json
@@ -2537,34 +2537,6 @@
"isInheritable": false,
"position": 40
},
- {
- "type": "relation",
- "name": "internalLink",
- "value": "CtBQqbwXDx1w",
- "isInheritable": false,
- "position": 50
- },
- {
- "type": "relation",
- "name": "internalLink",
- "value": "2FvYrpmOXm29",
- "isInheritable": false,
- "position": 60
- },
- {
- "type": "relation",
- "name": "internalLink",
- "value": "zP3PMqaG71Ct",
- "isInheritable": false,
- "position": 70
- },
- {
- "type": "relation",
- "name": "internalLink",
- "value": "IjZS7iK5EXtb",
- "isInheritable": false,
- "position": 80
- },
{
"type": "relation",
"name": "internalLink",
@@ -2585,6 +2557,13 @@
"value": "bx bx-hide",
"isInheritable": false,
"position": 40
+ },
+ {
+ "type": "relation",
+ "name": "internalLink",
+ "value": "CssoWBu8I7jF",
+ "isInheritable": false,
+ "position": 100
}
],
"format": "markdown",
@@ -10774,6 +10753,20 @@
"value": "bx bx-book",
"isInheritable": false,
"position": 20
+ },
+ {
+ "type": "relation",
+ "name": "internalLink",
+ "value": "CssoWBu8I7jF",
+ "isInheritable": false,
+ "position": 170
+ },
+ {
+ "type": "relation",
+ "name": "internalLink",
+ "value": "KSZ04uQ2D1St",
+ "isInheritable": false,
+ "position": 180
}
],
"format": "markdown",
@@ -10864,6 +10857,13 @@
"value": "calendar",
"isInheritable": false,
"position": 30
+ },
+ {
+ "type": "relation",
+ "name": "internalLink",
+ "value": "oPVyFC7WL2Lp",
+ "isInheritable": false,
+ "position": 40
}
],
"format": "markdown",
@@ -10886,7 +10886,7 @@
"dataFileName": "1_Calendar_image.png"
},
{
- "attachmentId": "AU7dnIevWPrz",
+ "attachmentId": "fOdCNTs2BuI0",
"title": "image.png",
"role": "image",
"mime": "image/png",
@@ -10894,7 +10894,7 @@
"dataFileName": "2_Calendar_image.png"
},
{
- "attachmentId": "COiR1tnE86i1",
+ "attachmentId": "HfBu0m3WXtn2",
"title": "image.png",
"role": "image",
"mime": "image/png",
@@ -10902,7 +10902,7 @@
"dataFileName": "3_Calendar_image.png"
},
{
- "attachmentId": "fOdCNTs2BuI0",
+ "attachmentId": "ho00OJTNrxVI",
"title": "image.png",
"role": "image",
"mime": "image/png",
@@ -10910,7 +10910,7 @@
"dataFileName": "4_Calendar_image.png"
},
{
- "attachmentId": "HfBu0m3WXtn2",
+ "attachmentId": "irfNX8n4159U",
"title": "image.png",
"role": "image",
"mime": "image/png",
@@ -10918,7 +10918,7 @@
"dataFileName": "5_Calendar_image.png"
},
{
- "attachmentId": "ho00OJTNrxVI",
+ "attachmentId": "KF56rdNuOwWd",
"title": "image.png",
"role": "image",
"mime": "image/png",
@@ -10926,7 +10926,7 @@
"dataFileName": "6_Calendar_image.png"
},
{
- "attachmentId": "irfNX8n4159U",
+ "attachmentId": "oBWr5GL6cUAZ",
"title": "image.png",
"role": "image",
"mime": "image/png",
@@ -10934,36 +10934,20 @@
"dataFileName": "7_Calendar_image.png"
},
{
- "attachmentId": "KF56rdNuOwWd",
+ "attachmentId": "oS6yUoQtfhpg",
"title": "image.png",
"role": "image",
"mime": "image/png",
"position": 10,
"dataFileName": "8_Calendar_image.png"
},
- {
- "attachmentId": "oBWr5GL6cUAZ",
- "title": "image.png",
- "role": "image",
- "mime": "image/png",
- "position": 10,
- "dataFileName": "9_Calendar_image.png"
- },
- {
- "attachmentId": "oS6yUoQtfhpg",
- "title": "image.png",
- "role": "image",
- "mime": "image/png",
- "position": 10,
- "dataFileName": "10_Calendar_image.png"
- },
{
"attachmentId": "u2c09UpZghff",
"title": "image.png",
"role": "image",
"mime": "image/png",
"position": 10,
- "dataFileName": "11_Calendar_image.png"
+ "dataFileName": "9_Calendar_image.png"
}
]
},
@@ -11010,13 +10994,6 @@
"isInheritable": false,
"position": 40
},
- {
- "type": "relation",
- "name": "internalLink",
- "value": "BlN9DFI679QC",
- "isInheritable": false,
- "position": 50
- },
{
"type": "relation",
"name": "internalLink",
@@ -11044,6 +11021,13 @@
"value": "table",
"isInheritable": false,
"position": 80
+ },
+ {
+ "type": "relation",
+ "name": "internalLink",
+ "value": "CssoWBu8I7jF",
+ "isInheritable": false,
+ "position": 90
}
],
"format": "markdown",
@@ -11180,49 +11164,56 @@
"name": "internalLink",
"value": "KSZ04uQ2D1St",
"isInheritable": false,
- "position": 30
+ "position": 10
},
{
"type": "relation",
"name": "internalLink",
"value": "0ESUbbAxVnoK",
"isInheritable": false,
- "position": 40
+ "position": 20
},
{
"type": "relation",
"name": "internalLink",
"value": "XpOYSgsLkTJy",
"isInheritable": false,
- "position": 50
+ "position": 30
},
{
"type": "relation",
"name": "internalLink",
"value": "oPVyFC7WL2Lp",
"isInheritable": false,
- "position": 60
+ "position": 40
},
{
"type": "relation",
"name": "internalLink",
"value": "IakOLONlIfGI",
"isInheritable": false,
- "position": 70
+ "position": 50
},
{
"type": "relation",
"name": "internalLink",
"value": "lgKX7r3aL30x",
"isInheritable": false,
- "position": 80
+ "position": 60
},
{
"type": "relation",
"name": "internalLink",
"value": "ZjLYv08Rp3qC",
"isInheritable": false,
- "position": 90
+ "position": 70
+ },
+ {
+ "type": "relation",
+ "name": "internalLink",
+ "value": "HI6GBBIduIgv",
+ "isInheritable": false,
+ "position": 80
},
{
"type": "label",
@@ -11241,9 +11232,9 @@
{
"type": "relation",
"name": "internalLink",
- "value": "HI6GBBIduIgv",
+ "value": "CssoWBu8I7jF",
"isInheritable": false,
- "position": 110
+ "position": 100
}
],
"format": "markdown",
@@ -11313,21 +11304,13 @@
"position": 10,
"dataFileName": "7_Geo Map_image.png"
},
- {
- "attachmentId": "gJ4Yz80jxcbn",
- "title": "image.png",
- "role": "image",
- "mime": "image/png",
- "position": 10,
- "dataFileName": "8_Geo Map_image.png"
- },
{
"attachmentId": "I39BinT2gsN9",
"title": "image.png",
"role": "image",
"mime": "image/png",
"position": 10,
- "dataFileName": "9_Geo Map_image.png"
+ "dataFileName": "8_Geo Map_image.png"
},
{
"attachmentId": "IeXU8SLZU7Oz",
@@ -11343,7 +11326,7 @@
"role": "image",
"mime": "image/png",
"position": 10,
- "dataFileName": "10_Geo Map_image.png"
+ "dataFileName": "9_Geo Map_image.png"
},
{
"attachmentId": "Mx2xwNIk76ZS",
@@ -11351,7 +11334,7 @@
"role": "image",
"mime": "image/png",
"position": 10,
- "dataFileName": "11_Geo Map_image.png"
+ "dataFileName": "10_Geo Map_image.png"
},
{
"attachmentId": "oaahbsMRbqd2",
@@ -11359,7 +11342,7 @@
"role": "image",
"mime": "image/png",
"position": 10,
- "dataFileName": "12_Geo Map_image.png"
+ "dataFileName": "11_Geo Map_image.png"
},
{
"attachmentId": "pGf1p74KKGU4",
@@ -11367,7 +11350,7 @@
"role": "image",
"mime": "image/jpg",
"position": 10,
- "dataFileName": "13_Geo Map_image.png"
+ "dataFileName": "12_Geo Map_image.png"
},
{
"attachmentId": "tfa1TRUatWEh",
@@ -11375,15 +11358,7 @@
"role": "image",
"mime": "image/png",
"position": 10,
- "dataFileName": "14_Geo Map_image.png"
- },
- {
- "attachmentId": "tuNZ7Uk9WfX1",
- "title": "image.png",
- "role": "image",
- "mime": "image/png",
- "position": 10,
- "dataFileName": "15_Geo Map_image.png"
+ "dataFileName": "13_Geo Map_image.png"
},
{
"attachmentId": "x6yBLIsY2LSv",
@@ -11391,7 +11366,7 @@
"role": "image",
"mime": "image/png",
"position": 10,
- "dataFileName": "16_Geo Map_image.png"
+ "dataFileName": "14_Geo Map_image.png"
},
{
"attachmentId": "yJMyBRYA3Kwi",
@@ -11399,7 +11374,7 @@
"role": "image",
"mime": "image/png",
"position": 10,
- "dataFileName": "17_Geo Map_image.png"
+ "dataFileName": "15_Geo Map_image.png"
},
{
"attachmentId": "ZvTlu9WMd37z",
@@ -11407,7 +11382,7 @@
"role": "image",
"mime": "image/png",
"position": 10,
- "dataFileName": "18_Geo Map_image.png"
+ "dataFileName": "16_Geo Map_image.png"
}
]
},
@@ -11426,13 +11401,6 @@
"type": "text",
"mime": "text/html",
"attributes": [
- {
- "type": "relation",
- "name": "internalLink",
- "value": "BlN9DFI679QC",
- "isInheritable": false,
- "position": 10
- },
{
"type": "relation",
"name": "internalLink",
@@ -11495,6 +11463,20 @@
"value": "presentation",
"isInheritable": false,
"position": 90
+ },
+ {
+ "type": "relation",
+ "name": "internalLink",
+ "value": "oPVyFC7WL2Lp",
+ "isInheritable": false,
+ "position": 100
+ },
+ {
+ "type": "relation",
+ "name": "internalLink",
+ "value": "CssoWBu8I7jF",
+ "isInheritable": false,
+ "position": 110
}
],
"format": "markdown",
@@ -11574,6 +11556,13 @@
"value": "grid",
"isInheritable": false,
"position": 50
+ },
+ {
+ "type": "relation",
+ "name": "internalLink",
+ "value": "oPVyFC7WL2Lp",
+ "isInheritable": false,
+ "position": 60
}
],
"format": "markdown",
@@ -11645,6 +11634,20 @@
"value": "list",
"isInheritable": false,
"position": 30
+ },
+ {
+ "type": "relation",
+ "name": "internalLink",
+ "value": "oPVyFC7WL2Lp",
+ "isInheritable": false,
+ "position": 50
+ },
+ {
+ "type": "relation",
+ "name": "internalLink",
+ "value": "CssoWBu8I7jF",
+ "isInheritable": false,
+ "position": 60
}
],
"format": "markdown",
@@ -11659,6 +11662,77 @@
"dataFileName": "List View_image.png"
}
]
+ },
+ {
+ "isClone": false,
+ "noteId": "CssoWBu8I7jF",
+ "notePath": [
+ "pOsGYCXsbNQG",
+ "GTwFsgaA0lCt",
+ "CssoWBu8I7jF"
+ ],
+ "title": "Collection Properties",
+ "notePosition": 120,
+ "prefix": null,
+ "isExpanded": false,
+ "type": "text",
+ "mime": "text/html",
+ "attributes": [
+ {
+ "type": "relation",
+ "name": "internalLink",
+ "value": "GTwFsgaA0lCt",
+ "isInheritable": false,
+ "position": 30
+ },
+ {
+ "type": "relation",
+ "name": "internalLink",
+ "value": "IjZS7iK5EXtb",
+ "isInheritable": false,
+ "position": 40
+ },
+ {
+ "type": "relation",
+ "name": "internalLink",
+ "value": "BlN9DFI679QC",
+ "isInheritable": false,
+ "position": 50
+ },
+ {
+ "type": "relation",
+ "name": "internalLink",
+ "value": "wyaGBBQrl4i3",
+ "isInheritable": false,
+ "position": 60
+ },
+ {
+ "type": "relation",
+ "name": "internalLink",
+ "value": "MKmLg5x6xkor",
+ "isInheritable": false,
+ "position": 70
+ },
+ {
+ "type": "label",
+ "name": "iconClass",
+ "value": "bx bx-cog",
+ "isInheritable": false,
+ "position": 80
+ }
+ ],
+ "format": "markdown",
+ "dataFileName": "Collection Properties.md",
+ "attachments": [
+ {
+ "attachmentId": "xsJTD19tJm3X",
+ "title": "image.png",
+ "role": "image",
+ "mime": "image/png",
+ "position": 10,
+ "dataFileName": "Collection Properties_imag.png"
+ }
+ ]
}
]
},
diff --git a/docs/User Guide/User Guide/Basic Concepts and Features/UI Elements/Note Tree/Hiding the subtree.md b/docs/User Guide/User Guide/Basic Concepts and Features/UI Elements/Note Tree/Hiding the subtree.md
index 9c9b75455..a2c3f26cc 100644
--- a/docs/User Guide/User Guide/Basic Concepts and Features/UI Elements/Note Tree/Hiding the subtree.md
+++ b/docs/User Guide/User Guide/Basic Concepts and Features/UI Elements/Note Tree/Hiding the subtree.md
@@ -39,15 +39,11 @@ The note appears in italics to indicate its temporary display. When switching to
## Working with collections
-By default, some of the Collections will automatically hide their child notes, for example the Kanban Board or the Table.
-
-The reasoning behind this is that collections are generally opaque to the rest of the notes and they can generate a large amount of sub-notes since they intentionally lack structure (in order to allow easy swapping between views).
-
-Some types of collections have the child notes intentionally shown, for example the legacy ones (Grid and List), but also the Presentation which requires the tree structure in order to organize and edit the slides.
+For large collections, it can be helpful to hide their child notes for performance reasons or de-cluttering the tree.
To toggle this behavior:
-* In the New Layout, press the Options button underneath the title and uncheck _Hide child notes in tree_.
+* Open the collection and in Collection Properties, look for _Hide child notes in tree_.
* Right click the collection note in the Note Tree and select _Advanced_ → _Show subtree_.
## Working with normal notes
diff --git a/docs/User Guide/User Guide/Collections.md b/docs/User Guide/User Guide/Collections.md
index 3a9fc9728..cc0fa3cbe 100644
--- a/docs/User Guide/User Guide/Collections.md
+++ b/docs/User Guide/User Guide/Collections.md
@@ -5,11 +5,11 @@ Collections are a unique type of note that don't have content, but instead displ
| | |
| --- | --- |
-| | Calendar which displays a week, month or year calendar with the notes being shown as events. New events can be added easily by dragging across the calendar. |
-| | Table displays each note as a row in a table, with Promoted Attributes being shown as well. This makes it easy to visualize attributes of notes, as well as making them easily editable. |
-| | Kanban Board displays notes in columns, grouped by the value of a label. Items and columns can easily be created or dragged around to change their status. |
-| | Geo Map which displays a geographical map in which the notes are represented as markers/pins on the map. New events can be easily added by pointing on the map. |
-| | Presentation which shows each note as a slide and can be presented full-screen with smooth transitions or exported to PDF for sharing. |
+| | Calendar which displays a week, month or year calendar with the notes being shown as events. New events can be added easily by dragging across the calendar. |
+| | Table displays each note as a row in a table, with Promoted Attributes being shown as well. This makes it easy to visualize attributes of notes, as well as making them easily editable. |
+| | Kanban Board displays notes in columns, grouped by the value of a label. Items and columns can easily be created or dragged around to change their status. |
+| | Geo Map which displays a geographical map in which the notes are represented as markers/pins on the map. New events can be easily added by pointing on the map. |
+| | Presentation which shows each note as a slide and can be presented full-screen with smooth transitions or exported to PDF for sharing. |
## Classic collections
@@ -22,16 +22,29 @@ Classic collections are read-only mode and compiles the contents of all child no
To create a new collections, right click in the Note Tree and look for the _Collections_ entry and select the desired type.
+By default, collections come with a default configuration and sometimes even sample notes. To create a collection completely from scratch:
+
+1. Create a new note of type _Text_ (or any type).
+2. Change the [note type](Note%20Types.md) to _Collection_.
+3. In Collection Properties, select the desired view type.
+4. Consult the help page of the corresponding view type in order to understand how to configure them.
+
## Configuration
-To change the configuration of a collection or even switch to a different collection (e.g. from Kanban Board to a Calendar), see the dedicated _Collections_ tab in the Ribbon.
+To change the configuration of a collection or even switch to a different collection (e.g. from Kanban Board to a Calendar), see the Collection Properties bar at the top of the note.
## Archived notes
-By default, [archived notes](Basic%20Concepts%20and%20Features/Notes/Archived%20Notes.md) will not be shown in collections. This behavior can be changed by going to _Collection Properties_ in the Ribbon and checking _Show archived notes_.
+By default, [archived notes](Basic%20Concepts%20and%20Features/Notes/Archived%20Notes.md) will not be shown in collections. This behavior can be changed by going to Collection Properties and checking _Show archived notes_.
Archived notes will be generally indicated by being greyed out as opposed to the normal ones.
+## Hiding the child notes from the note tree
+
+For collections with a large number of items, it can be helpful to hide the items from the note tree for performance reasons and to reduce clutter. This is especially useful for standalone collections, such as a geomap or a task board.
+
+To do so, go to Collection Properties and select _Hide child notes in tree_.
+
## Advanced use cases
### Adding a description to a collection
@@ -39,10 +52,12 @@ Archived notes will be generally indicated by being greyed out as opposed to the
To add a text before the collection, for example to describe it:
1. Create a new collection.
-2. In the Ribbon, go to _Basic Properties_ and change the note type from _Collection_ to _Text_.
+2. Change the [note type](Note%20Types.md) from _Collection_ to _Text_.
Now the text will be displayed above while still maintaining the collection view.
+The only downside to this method is that Collection Properties will not be shown anymore. In this case, modify the attributes manually or switch back temporarily to the _Collection_ type for configuration purposes.
+
### Using saved search
Collections, by default, only display the child notes. However, it is possible to use the Search functionality to display notes all across the tree, with advanced querying functionality.
@@ -52,15 +67,6 @@ To do so, simply start a Ribbon, go to _Basic Properties_ and select _Collection_ as the note type.
-3. Still in the ribbon, go to _Collection Properties_ and select the desired view type.
-4. Consult the help page of the corresponding view type in order to understand how to configure them.
-
## Under the hood
Collections by themselves are simply notes with no content that rely on the Note List mechanism (the one that lists the children notes at the bottom of a note) to display information.
diff --git a/docs/User Guide/User Guide/Collections/10_Calendar_image.png b/docs/User Guide/User Guide/Collections/10_Calendar_image.png
deleted file mode 100644
index 875127df2..000000000
Binary files a/docs/User Guide/User Guide/Collections/10_Calendar_image.png and /dev/null differ
diff --git a/docs/User Guide/User Guide/Collections/10_Geo Map_image.png b/docs/User Guide/User Guide/Collections/10_Geo Map_image.png
index 4a463f121..5c8cec0fe 100644
Binary files a/docs/User Guide/User Guide/Collections/10_Geo Map_image.png and b/docs/User Guide/User Guide/Collections/10_Geo Map_image.png differ
diff --git a/docs/User Guide/User Guide/Collections/11_Calendar_image.png b/docs/User Guide/User Guide/Collections/11_Calendar_image.png
deleted file mode 100644
index 7bdf27a6f..000000000
Binary files a/docs/User Guide/User Guide/Collections/11_Calendar_image.png and /dev/null differ
diff --git a/docs/User Guide/User Guide/Collections/11_Geo Map_image.png b/docs/User Guide/User Guide/Collections/11_Geo Map_image.png
index 5c8cec0fe..96140dfd7 100644
Binary files a/docs/User Guide/User Guide/Collections/11_Geo Map_image.png and b/docs/User Guide/User Guide/Collections/11_Geo Map_image.png differ
diff --git a/docs/User Guide/User Guide/Collections/12_Geo Map_image.png b/docs/User Guide/User Guide/Collections/12_Geo Map_image.png
index 96140dfd7..0c1519f2c 100644
Binary files a/docs/User Guide/User Guide/Collections/12_Geo Map_image.png and b/docs/User Guide/User Guide/Collections/12_Geo Map_image.png differ
diff --git a/docs/User Guide/User Guide/Collections/13_Geo Map_image.png b/docs/User Guide/User Guide/Collections/13_Geo Map_image.png
index 0c1519f2c..b99d116ea 100644
Binary files a/docs/User Guide/User Guide/Collections/13_Geo Map_image.png and b/docs/User Guide/User Guide/Collections/13_Geo Map_image.png differ
diff --git a/docs/User Guide/User Guide/Collections/14_Geo Map_image.png b/docs/User Guide/User Guide/Collections/14_Geo Map_image.png
index b99d116ea..34685cef1 100644
Binary files a/docs/User Guide/User Guide/Collections/14_Geo Map_image.png and b/docs/User Guide/User Guide/Collections/14_Geo Map_image.png differ
diff --git a/docs/User Guide/User Guide/Collections/15_Geo Map_image.png b/docs/User Guide/User Guide/Collections/15_Geo Map_image.png
index 72dbb9861..0831d8a8e 100644
Binary files a/docs/User Guide/User Guide/Collections/15_Geo Map_image.png and b/docs/User Guide/User Guide/Collections/15_Geo Map_image.png differ
diff --git a/docs/User Guide/User Guide/Collections/16_Geo Map_image.png b/docs/User Guide/User Guide/Collections/16_Geo Map_image.png
index 34685cef1..0c4ec9be2 100644
Binary files a/docs/User Guide/User Guide/Collections/16_Geo Map_image.png and b/docs/User Guide/User Guide/Collections/16_Geo Map_image.png differ
diff --git a/docs/User Guide/User Guide/Collections/17_Geo Map_image.png b/docs/User Guide/User Guide/Collections/17_Geo Map_image.png
deleted file mode 100644
index 0831d8a8e..000000000
Binary files a/docs/User Guide/User Guide/Collections/17_Geo Map_image.png and /dev/null differ
diff --git a/docs/User Guide/User Guide/Collections/18_Geo Map_image.png b/docs/User Guide/User Guide/Collections/18_Geo Map_image.png
deleted file mode 100644
index 0c4ec9be2..000000000
Binary files a/docs/User Guide/User Guide/Collections/18_Geo Map_image.png and /dev/null differ
diff --git a/docs/User Guide/User Guide/Collections/2_Calendar_image.png b/docs/User Guide/User Guide/Collections/2_Calendar_image.png
index 2c17bb45a..0ec1e363e 100644
Binary files a/docs/User Guide/User Guide/Collections/2_Calendar_image.png and b/docs/User Guide/User Guide/Collections/2_Calendar_image.png differ
diff --git a/docs/User Guide/User Guide/Collections/3_Calendar_image.png b/docs/User Guide/User Guide/Collections/3_Calendar_image.png
index 3bf94720f..3db9e775e 100644
Binary files a/docs/User Guide/User Guide/Collections/3_Calendar_image.png and b/docs/User Guide/User Guide/Collections/3_Calendar_image.png differ
diff --git a/docs/User Guide/User Guide/Collections/4_Calendar_image.png b/docs/User Guide/User Guide/Collections/4_Calendar_image.png
index 0ec1e363e..b147a7991 100644
Binary files a/docs/User Guide/User Guide/Collections/4_Calendar_image.png and b/docs/User Guide/User Guide/Collections/4_Calendar_image.png differ
diff --git a/docs/User Guide/User Guide/Collections/5_Calendar_image.png b/docs/User Guide/User Guide/Collections/5_Calendar_image.png
index 3db9e775e..920ffc607 100644
Binary files a/docs/User Guide/User Guide/Collections/5_Calendar_image.png and b/docs/User Guide/User Guide/Collections/5_Calendar_image.png differ
diff --git a/docs/User Guide/User Guide/Collections/6_Calendar_image.png b/docs/User Guide/User Guide/Collections/6_Calendar_image.png
index b147a7991..e89fee4d0 100644
Binary files a/docs/User Guide/User Guide/Collections/6_Calendar_image.png and b/docs/User Guide/User Guide/Collections/6_Calendar_image.png differ
diff --git a/docs/User Guide/User Guide/Collections/7_Calendar_image.png b/docs/User Guide/User Guide/Collections/7_Calendar_image.png
index 920ffc607..ae9c9a3c1 100644
Binary files a/docs/User Guide/User Guide/Collections/7_Calendar_image.png and b/docs/User Guide/User Guide/Collections/7_Calendar_image.png differ
diff --git a/docs/User Guide/User Guide/Collections/8_Calendar_image.png b/docs/User Guide/User Guide/Collections/8_Calendar_image.png
index e89fee4d0..875127df2 100644
Binary files a/docs/User Guide/User Guide/Collections/8_Calendar_image.png and b/docs/User Guide/User Guide/Collections/8_Calendar_image.png differ
diff --git a/docs/User Guide/User Guide/Collections/8_Geo Map_image.png b/docs/User Guide/User Guide/Collections/8_Geo Map_image.png
index c2317a878..554e18c97 100644
Binary files a/docs/User Guide/User Guide/Collections/8_Geo Map_image.png and b/docs/User Guide/User Guide/Collections/8_Geo Map_image.png differ
diff --git a/docs/User Guide/User Guide/Collections/9_Calendar_image.png b/docs/User Guide/User Guide/Collections/9_Calendar_image.png
index ae9c9a3c1..7bdf27a6f 100644
Binary files a/docs/User Guide/User Guide/Collections/9_Calendar_image.png and b/docs/User Guide/User Guide/Collections/9_Calendar_image.png differ
diff --git a/docs/User Guide/User Guide/Collections/9_Geo Map_image.png b/docs/User Guide/User Guide/Collections/9_Geo Map_image.png
index 554e18c97..4a463f121 100644
Binary files a/docs/User Guide/User Guide/Collections/9_Geo Map_image.png and b/docs/User Guide/User Guide/Collections/9_Geo Map_image.png differ
diff --git a/docs/User Guide/User Guide/Collections/Calendar.md b/docs/User Guide/User Guide/Collections/Calendar.md
index a7ae7dce7..f7309feac 100644
--- a/docs/User Guide/User Guide/Collections/Calendar.md
+++ b/docs/User Guide/User Guide/Collections/Calendar.md
@@ -1,5 +1,5 @@
# Calendar
-
+
The Calendar view will display each child note in a calendar that has a start date and optionally an end date, as an event.
@@ -14,10 +14,7 @@ Unlike other Collection view types, the Calendar view also allows some kind of i
## Creating a calendar
-| | | |
-| --- | --- | --- |
-| 1 |  | The Calendar View works only for Collection 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 _Collection_. |
-| 2 |  | Once created, the “View type” of the Collection needs changed to “Calendar”, by selecting the “Collection Properties” tab in the ribbon. |
+Right click on an existing note in the Note Tree and select _Insert child note_ and look for _Calendar_.
## Creating a new event/note
@@ -30,7 +27,7 @@ Unlike other Collection view types, the Calendar view also allows some kind of i
## Interacting with events
* Hovering the mouse over an event will display information about the note.
- 
+ 
* Left clicking the event will open a Quick edit to edit the note in a popup while allowing easy return to the calendar by just dismissing the popup.
* Middle clicking will open the note in a new tab.
* Right click will offer more options including opening the note in a new split or window.
@@ -61,7 +58,7 @@ In the _Collections_ tab in the timeGridWeek for the week view;
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.
#calendar:initialDate
Change the date the calendar opens on. When not present, the calendar opens on the current date.
#calendar:view
Which view to display in the calendar:
timeGridWeek for the week view;
dayGridMonth for the month view;
multiMonthYear for the year view;
listMonth for the list view.
Any other value will be dismissed and the default view (month) will be used instead.
The value of this label is automatically updated when changing the view using the UI buttons.
~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.
@@ -76,10 +73,10 @@ For each note of the calendar, the following attributes can be used:
| `#startTime` | The time the event starts at. If this value is missing, then the event is considered a full-day event. The format is `HH:MM` (hours in 24-hour format and minutes). |
| `#endTime` | Similar to `startTime`, it mentions the time at which the event ends (in relation with `endDate` if present, or `startDate`). |
| `#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` | **❌️ Removed since v0.100.0. Use** `**#color**` **instead.**
Similar to `#color`, but applies the color only for the event in the calendar and not for other places such as the note tree. |
+| `#calendar:color` | **❌️ Removed since v0.100.0. Use** `**#color**` **instead.**
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, can either a label or a relation (without the `#` or `~` symbol). See _Use-cases_ for more information. |
-| `#calendar:displayedAttributes` | Allows displaying the value of one or more attributes in the calendar like this:
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:displayedAttributes` | Allows displaying the value of one or more attributes in the calendar like this:
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` | Similar to `#calendar:startDate`, allows changing the attribute which is being used to read the end date. |
| `#calendar:startTime` | Similar to `#calendar:startDate`, allows changing the attribute which is being used to read the start time. |
@@ -87,7 +84,7 @@ For each note of the calendar, the following attributes can be used:
## How the calendar works
-
+
The calendar displays all the child notes of the Collection that have a `#startDate`. An `#endDate` can optionally be added.
@@ -101,7 +98,7 @@ If editing the start date and end date from the note itself is desirable, the fo
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.
@@ -118,7 +115,7 @@ Based on the `#calendarRoot` (or `#workspaceCalendarRoot`) attribute, the calend
* 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
@@ -126,7 +123,7 @@ By default, events are displayed on the calendar by their note title. However, i
To do so, assign `#calendar:title` to the child note (not the calendar/Collection note), with the value being `name` where `name` can be any label (make not to add the `#` prefix). 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
@@ -134,7 +131,7 @@ Similarly to using an attribute, use `#calendar:title` and set it to `name` wher
Moreover, if there are more relations of the same name, they will be displayed as multiple events coming from the same note.
-
#startDate=2025-02-14 #endDate=2025-02-15 ~for=@John Smith ~for=@Jane Doe #calendar:title="for"
+
#startDate=2025-02-14 #endDate=2025-02-15 ~for=@John Smith ~for=@Jane Doe #calendar:title="for"
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).
diff --git a/docs/User Guide/User Guide/Collections/Collection Properties.md b/docs/User Guide/User Guide/Collections/Collection Properties.md
new file mode 100644
index 000000000..ba7ac09b0
--- /dev/null
+++ b/docs/User Guide/User Guide/Collections/Collection Properties.md
@@ -0,0 +1,14 @@
+# Collection Properties
+
+
+The _Collection Properties_ is a toolbar that is displayed at the top of every [collection note](../Collections.md).
+
+For versions prior to v0.102.0, this feature was only available for the New Layout. Starting with this version, the collection properties are enabled for the Old layout as well, and Ribbon no longer contains a dedicated tab for collection properties.
+
+The collection properties has:
+
+* A quick selector for the view type (e.g. grid, calendar, board).
+* A settings button with:
+ * Settings for the current view, for example hiding the weekends in a calendar.
+ * Generic settings for the collection, such as [hiding the child notes](../Basic%20Concepts%20and%20Features/UI%20Elements/Note%20Tree/Hiding%20the%20subtree.md) or showing [archived notes](../Basic%20Concepts%20and%20Features/Notes/Archived%20Notes.md).
+* Specific interactions for the current view, for example month selector and view switcher for the calendar.
\ No newline at end of file
diff --git a/docs/User Guide/User Guide/Collections/Collection Properties_imag.png b/docs/User Guide/User Guide/Collections/Collection Properties_imag.png
new file mode 100644
index 000000000..c1955ce8b
Binary files /dev/null and b/docs/User Guide/User Guide/Collections/Collection Properties_imag.png differ
diff --git a/docs/User Guide/User Guide/Collections/Geo Map.md b/docs/User Guide/User Guide/Collections/Geo Map.md
index 91d583b19..5077c5a35 100644
--- a/docs/User Guide/User Guide/Collections/Geo Map.md
+++ b/docs/User Guide/User Guide/Collections/Geo Map.md
@@ -2,16 +2,15 @@
> [!IMPORTANT]
> Starting with Trilium v0.97.0, the geo map has been converted from a standalone [note type](../Note%20Types.md) to a type of view for the Note List.
-
+
This note type displays the children notes on a geographical map, based on an attribute. It is also possible to add new notes at a specific location using the built-in interface.
## Creating a new geo map
-| | | |
-| --- | --- | --- |
-| 1 | | Right click on any note on the note tree and select _Insert child note_ → _Geo Map (beta)_. |
-| 2 | | By default the map will be empty and will show the entire world. |
+Right click on an existing note in the Note Tree and select _Geo Map_.
+
+By default the map will be empty and will show the entire world.
## Repositioning the map
@@ -26,10 +25,10 @@ The position on the map and the zoom are saved inside the map note and restored
| | | |
| --- | --- | --- |
-| 1 | To create a marker, first navigate to the desired point on the map. Then press the  button in the [Floating buttons](../Basic%20Concepts%20and%20Features/UI%20Elements/Floating%20buttons.md) (top-right) area.
If the button is not visible, make sure the button section is visible by pressing the chevron button () in the top-right of the map. | |
-| 2 | | Once pressed, the map will enter in the insert mode, as illustrated by the notification.
Simply click the point on the map where to place the marker, or the Escape key to cancel. |
+| 1 | To create a marker, first navigate to the desired point on the map. Then press the  button in the [Floating buttons](../Basic%20Concepts%20and%20Features/UI%20Elements/Floating%20buttons.md) (top-right) area.
If the button is not visible, make sure the button section is visible by pressing the chevron button () in the top-right of the map. | |
+| 2 | | Once pressed, the map will enter in the insert mode, as illustrated by the notification.
Simply click the point on the map where to place the marker, or the Escape key to cancel. |
| 3 | | Enter the name of the marker/note to be created. |
-| 4 | | Once confirmed, the marker will show up on the map and it will also be displayed as a child note of the map. |
+| 4 | | Once confirmed, the marker will show up on the map and it will also be displayed as a child note of the map. |
### Adding a new note using the contextual menu
@@ -57,7 +56,7 @@ This works for:
The location of a marker is stored in the `#geolocation` attribute of the child notes:
-
+
This value can be added manually if needed. The value of the attribute is made up of the latitude and longitude separated by a comma.
@@ -109,9 +108,9 @@ The value of the attribute is made up of the latitude and longitude separated by
| | | |
| --- | --- | --- |
-| 1 | | Go to Google Maps on the web and look for a desired location, right click on it and a context menu will show up.
Simply click on the first item displaying the coordinates and they will be copied to clipboard.
Then paste the value inside the text box into the `#geolocation` attribute of a child note of the map (don't forget to surround the value with a `"` character). |
+| 1 | | Go to Google Maps on the web and look for a desired location, right click on it and a context menu will show up.
Simply click on the first item displaying the coordinates and they will be copied to clipboard.
Then paste the value inside the text box into the `#geolocation` attribute of a child note of the map (don't forget to surround the value with a `"` character). |
| 2 | | In Trilium, create a child note under the map. |
-| 3 | | And then go to Owned Attributes and type `#geolocation="`, then paste from the clipboard as-is and then add the ending `"` character. Press Enter to confirm and the map should now be updated to contain the new note. |
+| 3 | | And then go to Owned Attributes and type `#geolocation="`, then paste from the clipboard as-is and then add the ending `"` character. Press Enter to confirm and the map should now be updated to contain the new note. |
### Adding from OpenStreetMap
@@ -120,7 +119,7 @@ Similarly to the Google Maps approach:
| | | |
| --- | --- | --- |
| 1 | | Go to any location on openstreetmap.org and right click to bring up the context menu. Select the “Show address” item. |
-| 2 | | The address will be visible in the top-left of the screen, in the place of the search bar.
Select the coordinates and copy them into the clipboard. |
+| 2 | | The address will be visible in the top-left of the screen, in the place of the search bar.
Select the coordinates and copy them into the clipboard. |
| 3 | | Simply paste the value inside the text box into the `#geolocation` attribute of a child note of the map and then it should be displayed on the map. |
## Adding GPS tracks (.gpx)
@@ -130,8 +129,8 @@ Trilium has basic support for displaying GPS tracks on the geo map.
| | | |
| --- | --- | --- |
| 1 | | To add a track, simply drag & drop a .gpx file inside the geo map in the note tree. |
-| 2 | | In order for the file to be recognized as a GPS track, it needs to show up as `application/gpx+xml` in the _File type_ field. |
-| 3 | | When going back to the map, the track should now be visible.
The start and end points of the track are indicated by the two blue markers. |
+| 2 | | In order for the file to be recognized as a GPS track, it needs to show up as `application/gpx+xml` in the _File type_ field. |
+| 3 | | When going back to the map, the track should now be visible.
The start and end points of the track are indicated by the two blue markers. |
> [!NOTE]
> The starting point of the track will be displayed as a marker, with the name of the note underneath. The start marker will also respect the icon and the `color` of the note. The end marker is displayed with a distinct icon.
@@ -152,7 +151,7 @@ To enable read-only mode simply press the _Lock_ icon from the Collection Properties or manually via the `#map:style` attribute.
The geo map comes with two different types of styles:
@@ -170,7 +169,7 @@ The geo map comes with two different types of styles:
Starting with v0.102.0 it is possible to use custom tile sets, but only in raster format.
-To do so, manually set the `#map:style` [label](../Advanced%20Usage/Attributes/Labels.md) to the URL of the tile set. For example, to use Esri.NatGeoWorldMap, set the value to [`https://server.arcgisonline.com/ArcGIS/rest/services/NatGeo_World_Map/MapServer/tile/{z}/{y}/{x}`.](https://server.arcgisonline.com/ArcGIS/rest/services/NatGeo_World_Map/MapServer/tile/{z}/{y}/{x}.)
+To do so, manually set the `#map:style` [label](../Advanced%20Usage/Attributes/Labels.md) to the URL of the tile set. For example, to use Esri.NatGeoWorldMap, set the value to [`https://server.arcgisonline.com/ArcGIS/rest/services/NatGeo_World_Map/MapServer/tile/{z}/{y}/{x}`.](https://server.arcgisonline.com/ArcGIS/rest/services/NatGeo_World_Map/MapServer/tile/%7Bz%7D/%7By%7D/%7Bx%7D.)
> [!NOTE]
> For a list of tile sets, see the [Leaflet Providers preview](https://leaflet-extras.github.io/leaflet-providers/preview/) page. Select a desired tile set and just copy the URL from the _Plain JavaScript_ example.
@@ -179,14 +178,14 @@ Custom vector map support is planned, but not yet implemented.
### Other options
-The following options can be configured either via the Collection properties pane above the map, by clicking on the settings (Gear icon). Alternatively, each of these options also have a corresponding [label](../Advanced%20Usage/Attributes/Labels.md) that can be set manually.
+The following options can be configured either via the Collection Properties, by clicking on the settings (Gear icon). Alternatively, each of these options also have a corresponding [label](../Advanced%20Usage/Attributes/Labels.md) that can be set manually.
* Scale, which illustrates the scale of the map in kilometers and miles in the bottom-left of the map.
* The name of the markers is displayed by default underneath the pin on the map. Since v0.102.0, it is possible to hide these labels which increases the performance and decreases clutter when there are many markers on the map.
## Troubleshooting
-
+
### Grid-like artifacts on the map
diff --git a/docs/User Guide/User Guide/Collections/Grid View.md b/docs/User Guide/User Guide/Collections/Grid View.md
index 94c091555..4b98b5045 100644
--- a/docs/User Guide/User Guide/Collections/Grid View.md
+++ b/docs/User Guide/User Guide/Collections/Grid View.md
@@ -18,6 +18,10 @@ Depending on the type of note:
The grid view is also used by default in the Note List of every note, making it easy to navigate to children notes.
+### Creating a new table
+
+Right click on an existing note in the Note Tree and select _Insert child note_ and look for _Grid View_.
+
## Configuration
Unlike most other view types, the grid view is not actually configurable.
\ No newline at end of file
diff --git a/docs/User Guide/User Guide/Collections/Kanban Board.md b/docs/User Guide/User Guide/Collections/Kanban Board.md
index 872c85e97..e3b772cd2 100644
--- a/docs/User Guide/User Guide/Collections/Kanban Board.md
+++ b/docs/User Guide/User Guide/Collections/Kanban Board.md
@@ -3,6 +3,10 @@
The Board view presents sub-notes in columns for a Kanban-like experience. Each column represents a possible value for a status label, which can be adjusted.
+## Creating a Kanban board
+
+Right click on an existing note in the Note Tree and select _Insert child note_ and look for _Kanban Board_.
+
## How it works
When first creating a collection of _Board_ type, a few subnotes will be created, each having a `#status` label set. The board then groups each note by the value of the status attribute.
diff --git a/docs/User Guide/User Guide/Collections/List View.md b/docs/User Guide/User Guide/Collections/List View.md
index 70c2a9acd..900fc92c1 100644
--- a/docs/User Guide/User Guide/Collections/List View.md
+++ b/docs/User Guide/User Guide/Collections/List View.md
@@ -5,6 +5,10 @@ List view is similar to Grid Vi
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 as a single continuous document.
+### Creating a new table
+
+Right click on an existing note in the Note Tree and select _Insert child note_ and look for _List View_.
+
## Interaction
* Each note can be expanded or collapsed by clicking on the arrow to the left of the title.
@@ -23,7 +27,7 @@ If exported to PDF within the desktop application, there is additional functiona
## Expanding and collapsing multiple notes at once
-Apart from individually expanding or collapsing notes, it's also possible to expand or collapse them all at once. To do so, go to the _Collection Properties_ tab in the Ribbon and look for the corresponding button.
+Apart from individually expanding or collapsing notes, it's also possible to expand or collapse them all at once. To do so, go to the Collection Properties and look for the corresponding button.
By default, the _Expand_ button will only expand the direct children (first level) of the collection. Starting with v0.100.0, it's possible to expand multiple levels of notes using the arrow button next to the button.
diff --git a/docs/User Guide/User Guide/Collections/Presentation.md b/docs/User Guide/User Guide/Collections/Presentation.md
index 2f7b44944..adb7667cc 100644
--- a/docs/User Guide/User Guide/Collections/Presentation.md
+++ b/docs/User Guide/User Guide/Collections/Presentation.md
@@ -3,6 +3,10 @@
The Presentation view allows the creation of slideshows directly from within Trilium.
+### Creating a new presentation
+
+Right click on an existing note in the Note Tree and select _Insert child note_ and look for _Presentation_.
+
## How it works
* Each slide is a child note of the collection.
@@ -55,7 +59,7 @@ In the following example, the note structure is as follows:
At collection level, it's possible to adjust:
-* The theme of the entire presentation to one of the predefined themes by going to the Ribbon and looking for the _Collection Properties_ tab.
+* The theme of the entire presentation to one of the predefined themes by going to the Collection Properties and looking for the _Theme_ option.
* It's currently not possible to create custom themes, although it is planned.
* Note that it is note possible to alter the CSS via Custom app-wide CSS because the slides are rendered isolated (in a shadow DOM).
diff --git a/docs/User Guide/User Guide/Collections/Table.md b/docs/User Guide/User Guide/Collections/Table.md
index 576c28b29..bf0366f40 100644
--- a/docs/User Guide/User Guide/Collections/Table.md
+++ b/docs/User Guide/User Guide/Collections/Table.md
@@ -25,7 +25,7 @@ There are also a few predefined columns:
### Creating a new table
-Right click the Note Tree and select _Insert child note_ and look for the _Table item_.
+Right click on an existing note in the Note Tree and select _Insert child note_ and look for _Table_.
### Adding columns
@@ -120,7 +120,7 @@ Next to the title of each element there will be a button to expand or collapse.
Since nesting is not always desirable, it is possible to limit the nesting to a certain number of levels or even disable it completely. To do so, either:
-* Go to _Collection Properties_ in the Ribbon and look for the _Max nesting depth_ section.
+* Go to Collection Properties and look for the _Max nesting depth_ section.
* To disable nesting, type 0 and press Enter.
* To limit to a certain depth, type in the desired number (e.g. 2 to only display children and sub-children).
* To re-enable unlimited nesting, remove the number and press Enter.