Skip to content

Commit faf030a

Browse files
committed
docs(user): minor improvements to the collection main page
1 parent 6e20d4b commit faf030a

File tree

3 files changed

+49
-41
lines changed

3 files changed

+49
-41
lines changed

apps/server/src/assets/doc_notes/en/User Guide/User Guide/Collections.html

Lines changed: 20 additions & 19 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

docs/User Guide/!!!meta.json

Lines changed: 14 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -9086,13 +9086,6 @@
90869086
"isInheritable": false,
90879087
"position": 90
90889088
},
9089-
{
9090-
"type": "relation",
9091-
"name": "internalLink",
9092-
"value": "oPVyFC7WL2Lp",
9093-
"isInheritable": false,
9094-
"position": 100
9095-
},
90969089
{
90979090
"type": "relation",
90989091
"name": "internalLink",
@@ -9183,6 +9176,20 @@
91839176
"value": "zP3PMqaG71Ct",
91849177
"isInheritable": false,
91859178
"position": 220
9179+
},
9180+
{
9181+
"type": "relation",
9182+
"name": "internalLink",
9183+
"value": "oPVyFC7WL2Lp",
9184+
"isInheritable": false,
9185+
"position": 230
9186+
},
9187+
{
9188+
"type": "relation",
9189+
"name": "internalLink",
9190+
"value": "MKmLg5x6xkor",
9191+
"isInheritable": false,
9192+
"position": 240
91869193
}
91879194
],
91889195
"format": "markdown",

docs/User Guide/User Guide/Collections.md

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -5,11 +5,11 @@ Collections are a unique type of notes that don't have a content, but instead di
55

66
| | |
77
| --- | --- |
8-
| <figure class="image"><img style="aspect-ratio:1651/810;" src="Collections_collection_ca.webp" width="1651" height="810"></figure> | <a class="reference-link" href="Collections/Calendar.md">Calendar View</a> <br>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. |
9-
| <figure class="image"><img style="aspect-ratio:1643/647;" src="Collections_collection_ta.webp" width="1643" height="647"></figure> | <a class="reference-link" href="Collections/Table.md">Table View</a> <br>displays each note as a row in a table, with <a class="reference-link" href="Advanced%20Usage/Attributes/Promoted%20Attributes.md">Promoted Attributes</a> being shown as well. This makes it easy to visualize attributes of notes, as well as making them easily editable. |
10-
| <figure class="image"><img style="aspect-ratio:1174/850;" src="Collections_collection_bo.webp" width="1174" height="850"></figure> | <a class="reference-link" href="Collections/Kanban%20Board.md">Board View</a> <br>displays notes in columns, grouped by the value of a label. |
11-
| <figure class="image"><img style="aspect-ratio:844/639;" src="Collections_collection_ge.webp" width="844" height="639"></figure> | <a class="reference-link" href="Collections/Geo%20Map.md">Geo Map View</a> <br>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. |
12-
| <figure class="image"><img style="aspect-ratio:1120/763;" src="Collections_collection_pr.webp" width="1120" height="763"></figure> | <a class="reference-link" href="Collections/Presentation.md">Presentation View</a> <br>which shows each note as a slide and can be presented full-screen with smooth transitions or exported to PDF for sharing. |
8+
| <figure class="image"><img style="aspect-ratio:1651/810;" src="Collections_collection_ca.webp" width="1651" height="810"></figure> | <a class="reference-link" href="Collections/Calendar.md">Calendar</a> <br>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. |
9+
| <figure class="image"><img style="aspect-ratio:1643/647;" src="Collections_collection_ta.webp" width="1643" height="647"></figure> | <a class="reference-link" href="Collections/Table.md">Table</a> <br>displays each note as a row in a table, with <a class="reference-link" href="Advanced%20Usage/Attributes/Promoted%20Attributes.md">Promoted Attributes</a> being shown as well. This makes it easy to visualize attributes of notes, as well as making them easily editable. |
10+
| <figure class="image"><img style="aspect-ratio:1174/850;" src="Collections_collection_bo.webp" width="1174" height="850"></figure> | <a class="reference-link" href="Collections/Kanban%20Board.md">Kanban Board</a> <br>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. |
11+
| <figure class="image"><img style="aspect-ratio:844/639;" src="Collections_collection_ge.webp" width="844" height="639"></figure> | <a class="reference-link" href="Collections/Geo%20Map.md">Geo Map</a> <br>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. |
12+
| <figure class="image"><img style="aspect-ratio:1120/763;" src="Collections_collection_pr.webp" width="1120" height="763"></figure> | <a class="reference-link" href="Collections/Presentation.md">Presentation</a> <br>which shows each note as a slide and can be presented full-screen with smooth transitions or exported to PDF for sharing. |
1313

1414
## Classic collections
1515

@@ -18,15 +18,21 @@ Classic collections are read-only mode and compiles the contents of all child no
1818
* <a class="reference-link" href="Collections/Grid%20View.md">Grid View</a> which is the default presentation method for child notes (see <a class="reference-link" href="Basic%20Concepts%20and%20Features/Notes/Note%20List.md">Note List</a>), where the notes are displayed as tiles with their title and content being visible.
1919
* <a class="reference-link" href="Collections/List%20View.md">List View</a> is similar to <a class="reference-link" href="Collections/Grid%20View.md">Grid View</a>, but it displays the notes one under the other with the content being expandable/collapsible, but also works recursively.
2020

21+
## Creating a new collection
22+
23+
To create a new collections, right click in the <a class="reference-link" href="Basic%20Concepts%20and%20Features/UI%20Elements/Note%20Tree.md">Note Tree</a> and look for the _Collections_ entry and select the desired type.
24+
2125
## Configuration
2226

23-
To adjust the view type, see the dedicated _Collections_ tab in the <a class="reference-link" href="Basic%20Concepts%20and%20Features/UI%20Elements/Ribbon.md">Ribbon</a>.
27+
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 <a class="reference-link" href="Basic%20Concepts%20and%20Features/UI%20Elements/Ribbon.md">Ribbon</a>.
2428

25-
## Use cases
29+
## Archived notes
2630

27-
### Creating a new collection
31+
By default, [archived notes](Basic%20Concepts%20and%20Features/Notes/Archived%20Notes.md) will not be shown in collections. This behaviour can be changed by going to _Collection Properties_ in the <a class="reference-link" href="Basic%20Concepts%20and%20Features/UI%20Elements/Ribbon.md">Ribbon</a> and checking _Show archived notes_.
2832

29-
To create a new collections, right click in the <a class="reference-link" href="Basic%20Concepts%20and%20Features/UI%20Elements/Note%20Tree.md">Note Tree</a> and look for the _Collections_ entry and select the desired type.
33+
Archived notes will be generally indicated by being greyed out as opposed to the normal ones.
34+
35+
## Advanced use cases
3036

3137
### Adding a description to a collection
3238

@@ -55,12 +61,6 @@ By default, collections come with a default configuration and sometimes even sam
5561
3. Still in the ribbon, go to _Collection Properties_ and select the desired view type.
5662
4. Consult the help page of the corresponding view type in order to understand how to configure them.
5763

58-
## Archived notes
59-
60-
By default, archived notes will not be shown in collections. This behaviour can be changed by going to _Collection Properties_ in the <a class="reference-link" href="Basic%20Concepts%20and%20Features/UI%20Elements/Ribbon.md">Ribbon</a> and checking _Show archived notes_.
61-
62-
Archived notes will be generally indicated by being greyed out as opposed to the normal ones.
63-
6464
## Under the hood
6565

6666
Collections by themselves are simply notes with no content that rely on the <a class="reference-link" href="Basic%20Concepts%20and%20Features/Notes/Note%20List.md">Note List</a> mechanism (the one that lists the children notes at the bottom of a note) to display information.

0 commit comments

Comments
 (0)