mirror of
https://github.com/TriliumNext/Notes.git
synced 2025-07-27 18:12:29 +08:00
feat(docs): document note list
This commit is contained in:
Elian Doran
parent
e50c1b36f6
commit
ed53b034f7
@ -2517,10 +2517,85 @@
|
|||||||
"isExpanded": false,
|
"isExpanded": false,
|
||||||
"type": "text",
|
"type": "text",
|
||||||
"mime": "text/html",
|
"mime": "text/html",
|
||||||
"attributes": [],
|
"attributes": [
|
||||||
|
{
|
||||||
|
"type": "label",
|
||||||
|
"name": "iconClass",
|
||||||
|
"value": "bx bxs-grid",
|
||||||
|
"isInheritable": false,
|
||||||
|
"position": 10
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"type": "relation",
|
||||||
|
"name": "internalLink",
|
||||||
|
"value": "6f9hih2hXXZk",
|
||||||
|
"isInheritable": false,
|
||||||
|
"position": 20
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"type": "relation",
|
||||||
|
"name": "internalLink",
|
||||||
|
"value": "iPIMuisry3hd",
|
||||||
|
"isInheritable": false,
|
||||||
|
"position": 30
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"type": "relation",
|
||||||
|
"name": "internalLink",
|
||||||
|
"value": "W8vYD3Q1zjCR",
|
||||||
|
"isInheritable": false,
|
||||||
|
"position": 40
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"type": "relation",
|
||||||
|
"name": "internalLink",
|
||||||
|
"value": "xWbu3jpNWapp",
|
||||||
|
"isInheritable": false,
|
||||||
|
"position": 50
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"type": "relation",
|
||||||
|
"name": "internalLink",
|
||||||
|
"value": "GTwFsgaA0lCt",
|
||||||
|
"isInheritable": false,
|
||||||
|
"position": 60
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"type": "relation",
|
||||||
|
"name": "internalLink",
|
||||||
|
"value": "BlN9DFI679QC",
|
||||||
|
"isInheritable": false,
|
||||||
|
"position": 70
|
||||||
|
}
|
||||||
|
],
|
||||||
"format": "markdown",
|
"format": "markdown",
|
||||||
"dataFileName": "Note List.md",
|
"dataFileName": "Note List.md",
|
||||||
"attachments": []
|
"attachments": [
|
||||||
|
{
|
||||||
|
"attachmentId": "1SA0UPq471jp",
|
||||||
|
"title": "image.png",
|
||||||
|
"role": "image",
|
||||||
|
"mime": "image/png",
|
||||||
|
"position": 10,
|
||||||
|
"dataFileName": "Note List_image.png"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"attachmentId": "2xoejxffj82c",
|
||||||
|
"title": "image.png",
|
||||||
|
"role": "image",
|
||||||
|
"mime": "image/png",
|
||||||
|
"position": 10,
|
||||||
|
"dataFileName": "1_Note List_image.png"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"attachmentId": "mppVaDhlClF7",
|
||||||
|
"title": "image.png",
|
||||||
|
"role": "image",
|
||||||
|
"mime": "image/png",
|
||||||
|
"position": 10,
|
||||||
|
"dataFileName": "2_Note List_image.png"
|
||||||
|
}
|
||||||
|
]
|
||||||
}
|
}
|
||||||
]
|
]
|
||||||
},
|
},
|
||||||
@ -5894,29 +5969,13 @@
|
|||||||
"position": 10,
|
"position": 10,
|
||||||
"dataFileName": "5_File_image.png"
|
"dataFileName": "5_File_image.png"
|
||||||
},
|
},
|
||||||
{
|
|
||||||
"attachmentId": "QuS3PW5vuXmf",
|
|
||||||
"title": "image.png",
|
|
||||||
"role": "image",
|
|
||||||
"mime": "image/png",
|
|
||||||
"position": 10,
|
|
||||||
"dataFileName": "6_File_image.png"
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"attachmentId": "uEFfm1fmx9G7",
|
|
||||||
"title": "image.png",
|
|
||||||
"role": "image",
|
|
||||||
"mime": "image/png",
|
|
||||||
"position": 10,
|
|
||||||
"dataFileName": "7_File_image.png"
|
|
||||||
},
|
|
||||||
{
|
{
|
||||||
"attachmentId": "wNHX24feZRAl",
|
"attachmentId": "wNHX24feZRAl",
|
||||||
"title": "image.png",
|
"title": "image.png",
|
||||||
"role": "image",
|
"role": "image",
|
||||||
"mime": "image/png",
|
"mime": "image/png",
|
||||||
"position": 10,
|
"position": 10,
|
||||||
"dataFileName": "8_File_image.png"
|
"dataFileName": "6_File_image.png"
|
||||||
}
|
}
|
||||||
]
|
]
|
||||||
}
|
}
|
||||||
|
|||||||
Binary file not shown.
|
After Width: | Height: | Size: 101 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 34 KiB |
@ -0,0 +1,34 @@
|
|||||||
|
# Note List
|
||||||
|
When a note has one or more child notes, they will be listed at the end of the note for easy navigation.
|
||||||
|
|
||||||
|
## View types
|
||||||
|
|
||||||
|
By default, the notes will be displayed in a grid, however there are also some other view types available.
|
||||||
|
|
||||||
|
> [!TIP]
|
||||||
|
> Generally the view type can only be changed in a [Book](../../Note%20Types/Book.md) note from the [Ribbon](../UI%20Elements/Ribbon.md), but it can also be changed manually on any type of note using the `#viewType` attribute.
|
||||||
|
|
||||||
|
### Grid view
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
The title and a short snippet of the content of the note will be displayed in a grid format.
|
||||||
|
|
||||||
|
* For [Text](../../Note%20Types/Text.md) note, the text can be slighly scrollable via the mouse wheel to reveal more context.
|
||||||
|
* For [Code](../../Note%20Types/Code.md) notes, syntax highlighting is applied.
|
||||||
|
* For [File](../../Note%20Types/File.md) notes, a preview is made available for audio, video and PDF notes.
|
||||||
|
* If the note does not have a content, a list of its child notes will be displayed instead.
|
||||||
|
|
||||||
|
This is the default view type.
|
||||||
|
|
||||||
|
### List view
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
In the list view mode, each note is displayed in a single row with only the title and the icon of the note being visible by the default. By pressing the expand button it's possible to view the content of the note, as well as the children of the note (recursively).
|
||||||
|
|
||||||
|
### Calendar view
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
In the calendar view, child notes are represented as events, with a start date and optionally an end date. The view also has interaction support such as moving or creating new events. See [Calendar View](../../Note%20Types/Book/Calendar%20View.md) for more information.
|
||||||
Binary file not shown.
|
After Width: | Height: | Size: 35 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 165 KiB After Width: | Height: | Size: 22 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 165 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 22 KiB |
@ -86,4 +86,4 @@ If the file could not be identified as any of the supported file types from abov
|
|||||||
|
|
||||||
Files are also displayed in the [Note List](../Basic%20Concepts%20and%20Features/Notes/Note%20List.md) based on their type:
|
Files are also displayed in the [Note List](../Basic%20Concepts%20and%20Features/Notes/Note%20List.md) based on their type:
|
||||||
|
|
||||||
|
|
||||||
97
src/public/app/doc_notes/en/User Guide/!!!meta.json
generated
97
src/public/app/doc_notes/en/User Guide/!!!meta.json
generated
@ -2517,10 +2517,85 @@
|
|||||||
"isExpanded": false,
|
"isExpanded": false,
|
||||||
"type": "text",
|
"type": "text",
|
||||||
"mime": "text/html",
|
"mime": "text/html",
|
||||||
"attributes": [],
|
"attributes": [
|
||||||
|
{
|
||||||
|
"type": "label",
|
||||||
|
"name": "iconClass",
|
||||||
|
"value": "bx bxs-grid",
|
||||||
|
"isInheritable": false,
|
||||||
|
"position": 10
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"type": "relation",
|
||||||
|
"name": "internalLink",
|
||||||
|
"value": "6f9hih2hXXZk",
|
||||||
|
"isInheritable": false,
|
||||||
|
"position": 20
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"type": "relation",
|
||||||
|
"name": "internalLink",
|
||||||
|
"value": "iPIMuisry3hd",
|
||||||
|
"isInheritable": false,
|
||||||
|
"position": 30
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"type": "relation",
|
||||||
|
"name": "internalLink",
|
||||||
|
"value": "W8vYD3Q1zjCR",
|
||||||
|
"isInheritable": false,
|
||||||
|
"position": 40
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"type": "relation",
|
||||||
|
"name": "internalLink",
|
||||||
|
"value": "xWbu3jpNWapp",
|
||||||
|
"isInheritable": false,
|
||||||
|
"position": 50
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"type": "relation",
|
||||||
|
"name": "internalLink",
|
||||||
|
"value": "GTwFsgaA0lCt",
|
||||||
|
"isInheritable": false,
|
||||||
|
"position": 60
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"type": "relation",
|
||||||
|
"name": "internalLink",
|
||||||
|
"value": "BlN9DFI679QC",
|
||||||
|
"isInheritable": false,
|
||||||
|
"position": 70
|
||||||
|
}
|
||||||
|
],
|
||||||
"format": "html",
|
"format": "html",
|
||||||
"dataFileName": "Note List.html",
|
"dataFileName": "Note List.html",
|
||||||
"attachments": []
|
"attachments": [
|
||||||
|
{
|
||||||
|
"attachmentId": "1SA0UPq471jp",
|
||||||
|
"title": "image.png",
|
||||||
|
"role": "image",
|
||||||
|
"mime": "image/png",
|
||||||
|
"position": 10,
|
||||||
|
"dataFileName": "Note List_image.png"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"attachmentId": "2xoejxffj82c",
|
||||||
|
"title": "image.png",
|
||||||
|
"role": "image",
|
||||||
|
"mime": "image/png",
|
||||||
|
"position": 10,
|
||||||
|
"dataFileName": "1_Note List_image.png"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"attachmentId": "mppVaDhlClF7",
|
||||||
|
"title": "image.png",
|
||||||
|
"role": "image",
|
||||||
|
"mime": "image/png",
|
||||||
|
"position": 10,
|
||||||
|
"dataFileName": "2_Note List_image.png"
|
||||||
|
}
|
||||||
|
]
|
||||||
}
|
}
|
||||||
]
|
]
|
||||||
},
|
},
|
||||||
@ -5894,29 +5969,13 @@
|
|||||||
"position": 10,
|
"position": 10,
|
||||||
"dataFileName": "5_File_image.png"
|
"dataFileName": "5_File_image.png"
|
||||||
},
|
},
|
||||||
{
|
|
||||||
"attachmentId": "QuS3PW5vuXmf",
|
|
||||||
"title": "image.png",
|
|
||||||
"role": "image",
|
|
||||||
"mime": "image/png",
|
|
||||||
"position": 10,
|
|
||||||
"dataFileName": "6_File_image.png"
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"attachmentId": "uEFfm1fmx9G7",
|
|
||||||
"title": "image.png",
|
|
||||||
"role": "image",
|
|
||||||
"mime": "image/png",
|
|
||||||
"position": 10,
|
|
||||||
"dataFileName": "7_File_image.png"
|
|
||||||
},
|
|
||||||
{
|
{
|
||||||
"attachmentId": "wNHX24feZRAl",
|
"attachmentId": "wNHX24feZRAl",
|
||||||
"title": "image.png",
|
"title": "image.png",
|
||||||
"role": "image",
|
"role": "image",
|
||||||
"mime": "image/png",
|
"mime": "image/png",
|
||||||
"position": 10,
|
"position": 10,
|
||||||
"dataFileName": "8_File_image.png"
|
"dataFileName": "6_File_image.png"
|
||||||
}
|
}
|
||||||
]
|
]
|
||||||
}
|
}
|
||||||
|
|||||||
Binary file not shown.
|
After Width: | Height: | Size: 101 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 34 KiB |
@ -12,7 +12,56 @@
|
|||||||
<div class="content">
|
<div class="content">
|
||||||
<h1 data-trilium-h1>Note List</h1>
|
<h1 data-trilium-h1>Note List</h1>
|
||||||
|
|
||||||
<div class="ck-content"></div>
|
<div class="ck-content">
|
||||||
|
<p>When a note has one or more child notes, they will be listed at the end
|
||||||
|
of the note for easy navigation.</p>
|
||||||
|
<h2>View types</h2>
|
||||||
|
<p>By default, the notes will be displayed in a grid, however there are also
|
||||||
|
some other view types available.</p>
|
||||||
|
<aside class="admonition tip">
|
||||||
|
<p>Generally the view type can only be changed in a <a class="reference-link"
|
||||||
|
href="../../Note%20Types/Book.html">Book</a> note from the
|
||||||
|
<a
|
||||||
|
class="reference-link" href="../UI%20Elements/Ribbon.html">Ribbon</a>, but it can also be changed manually on any type of note using
|
||||||
|
the <code>#viewType</code> attribute.</p>
|
||||||
|
</aside>
|
||||||
|
<h3>Grid view</h3>
|
||||||
|
<p>
|
||||||
|
<img src="1_Note List_image.png" width="1025" height="655">
|
||||||
|
</p>
|
||||||
|
<p>The title and a short snippet of the content of the note will be displayed
|
||||||
|
in a grid format.</p>
|
||||||
|
<ul>
|
||||||
|
<li>For <a class="reference-link" href="../../Note%20Types/Text.html">Text</a> note,
|
||||||
|
the text can be slighly scrollable via the mouse wheel to reveal more context.</li>
|
||||||
|
<li>For <a class="reference-link" href="../../Note%20Types/Code.html">Code</a> notes,
|
||||||
|
syntax highlighting is applied.</li>
|
||||||
|
<li>For <a class="reference-link" href="../../Note%20Types/File.html">File</a> notes,
|
||||||
|
a preview is made available for audio, video and PDF notes.</li>
|
||||||
|
<li>If the note does not have a content, a list of its child notes will be
|
||||||
|
displayed instead.</li>
|
||||||
|
</ul>
|
||||||
|
<p>This is the default view type.</p>
|
||||||
|
<h3>List view</h3>
|
||||||
|
<figure class="image">
|
||||||
|
<img style="aspect-ratio:1013/526;" src="Note List_image.png" width="1013"
|
||||||
|
height="526">
|
||||||
|
</figure>
|
||||||
|
<p>In the list view mode, each note is displayed in a single row with only
|
||||||
|
the title and the icon of the note being visible by the default. By pressing
|
||||||
|
the expand button it's possible to view the content of the note, as well
|
||||||
|
as the children of the note (recursively).</p>
|
||||||
|
<h3>Calendar view</h3>
|
||||||
|
<figure class="image">
|
||||||
|
<img style="aspect-ratio:1090/598;" src="2_Note List_image.png" width="1090"
|
||||||
|
height="598">
|
||||||
|
</figure>
|
||||||
|
<p>In the calendar view, child notes are represented as events, with a start
|
||||||
|
date and optionally an end date. The view also has interaction support
|
||||||
|
such as moving or creating new events. See <a class="reference-link"
|
||||||
|
href="../../Note%20Types/Book/Calendar%20View.html">Calendar View</a> for
|
||||||
|
more information.</p>
|
||||||
|
</div>
|
||||||
</div>
|
</div>
|
||||||
</body>
|
</body>
|
||||||
|
|
||||||
|
|||||||
BIN
src/public/app/doc_notes/en/User Guide/User Guide/Basic Concepts and Features/Notes/Note List_image.png
generated
Normal file
BIN
src/public/app/doc_notes/en/User Guide/User Guide/Basic Concepts and Features/Notes/Note List_image.png
generated
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 35 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 165 KiB After Width: | Height: | Size: 22 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 165 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 22 KiB |
@ -132,7 +132,7 @@
|
|||||||
<p>Files are also displayed in the <a class="reference-link" href="../Basic%20Concepts%20and%20Features/Notes/Note%20List.html">Note List</a> based
|
<p>Files are also displayed in the <a class="reference-link" href="../Basic%20Concepts%20and%20Features/Notes/Note%20List.html">Note List</a> based
|
||||||
on their type:</p>
|
on their type:</p>
|
||||||
<p>
|
<p>
|
||||||
<img src="8_File_image.png" width="853" height="315">
|
<img src="6_File_image.png" width="853" height="315">
|
||||||
</p>
|
</p>
|
||||||
<p> </p>
|
<p> </p>
|
||||||
</div>
|
</div>
|
||||||
|
|||||||
Loading…
x
Reference in New Issue
Block a user