mirror of
				https://github.com/zadam/trilium.git
				synced 2025-11-03 20:06:08 +01:00 
			
		
		
		
	Merge remote-tracking branch 'origin/develop' into calendar
This commit is contained in:
		@@ -0,0 +1,19 @@
 | 
			
		||||
# Right Sidebar
 | 
			
		||||
<figure class="image"><img style="aspect-ratio:1036/372;" src="Right Sidebar_image.png" width="1036" height="372"></figure>
 | 
			
		||||
 | 
			
		||||
The right sidebar displays specific content for the current note. Currently it includes:
 | 
			
		||||
 | 
			
		||||
*   <a class="reference-link" href="../../Note%20Types/Text/Table%20of%20contents.md">Table of contents</a>
 | 
			
		||||
*   <a class="reference-link" href="../../Note%20Types/Text/Highlights%20list.md">Highlights list</a>
 | 
			
		||||
 | 
			
		||||
Note that the sidebar is not displayed if it would otherwise be empty, for example if there are too few headings and there are no highlights.
 | 
			
		||||
 | 
			
		||||
## Toggling the right sidebar
 | 
			
		||||
 | 
			
		||||
The sidebar can be hidden or shown by using the `toggleRightPane` keyboard shortcut, which is not assigned by default.
 | 
			
		||||
 | 
			
		||||
## Relation with splits
 | 
			
		||||
 | 
			
		||||
When using <a class="reference-link" href="Split%20View.md">Split View</a>, there is a single sidebar serving all the open splits for the current [tab](Tabs.md).
 | 
			
		||||
 | 
			
		||||
Clicking on a note within the split view will display the sidebar for that note. If there are no items to display in the sidebar, it will remain closed.
 | 
			
		||||
										
											Binary file not shown.
										
									
								
							| 
		 After Width: | Height: | Size: 50 KiB  | 
@@ -0,0 +1,25 @@
 | 
			
		||||
# Highlights list
 | 
			
		||||
<figure class="image image-style-align-right"><img style="aspect-ratio:250/150;" src="Highlights list_image.png" width="250" height="150"></figure>
 | 
			
		||||
 | 
			
		||||
Similar to the <a class="reference-link" href="Table%20of%20contents.md">Table of contents</a>, but instead of headings this feature will list highlighted text from a text note and allow easy navigation to them. The list will be displayed in the <a class="reference-link" href="../../Basic%20Concepts%20and%20Features/UI%20Elements/Right%20Sidebar.md">Right Sidebar</a>, provided there is at least one highlighted text.
 | 
			
		||||
 | 
			
		||||
Highlighted text is defined as:
 | 
			
		||||
 | 
			
		||||
*   Bold text.
 | 
			
		||||
*   Italic text.
 | 
			
		||||
*   Underlined text.
 | 
			
		||||
*   Text with a foreground color set.
 | 
			
		||||
*   Text with a background color/highlight set.
 | 
			
		||||
 | 
			
		||||
## Interaction
 | 
			
		||||
 | 
			
		||||
*   Clicking on a highlighted text will scroll the document to its position.
 | 
			
		||||
*   Pressing the close button will dismiss the list of highlights but it can be shown again from the <a class="reference-link" href="../../Basic%20Concepts%20and%20Features/UI%20Elements/Floating%20buttons.md">Floating buttons</a> section.
 | 
			
		||||
 | 
			
		||||
## Global configuration
 | 
			
		||||
 | 
			
		||||
It's possible to toggle the display of each category of highlighted text (as defined above) in the highlights list by going to <a class="reference-link" href="#root/_hidden/_options/_optionsTextNotes">Text Notes</a> settings and looking for the _Highlights List_ section.
 | 
			
		||||
 | 
			
		||||
## Per-note configuration
 | 
			
		||||
 | 
			
		||||
To suppress the display of highlighted text for one specific note, use <a class="reference-link" href="../../Advanced%20Usage/Attributes.md">Attributes</a> to add the `#hideHighlightWidget` label.
 | 
			
		||||
										
											Binary file not shown.
										
									
								
							| 
		 After Width: | Height: | Size: 6.3 KiB  | 
@@ -0,0 +1,23 @@
 | 
			
		||||
# Table of contents
 | 
			
		||||
<figure class="image image-style-align-right"><img style="aspect-ratio:243/171;" src="Table of contents_image.png" width="243" height="171"></figure>
 | 
			
		||||
 | 
			
		||||
The table of contents appears in the <a class="reference-link" href="../../Basic%20Concepts%20and%20Features/UI%20Elements/Right%20Sidebar.md">Right Sidebar</a> automatically when there are multiple headings in a text note.
 | 
			
		||||
 | 
			
		||||
## Interaction
 | 
			
		||||
 | 
			
		||||
*   Clicking on a heading will scroll the document to the position of the heading.
 | 
			
		||||
*   Pressing the close button will dismiss the table of contents but it can be shown again from the <a class="reference-link" href="../../Basic%20Concepts%20and%20Features/UI%20Elements/Floating%20buttons.md">Floating buttons</a> section.
 | 
			
		||||
 | 
			
		||||
## Global configuration
 | 
			
		||||
 | 
			
		||||
In <a class="reference-link" href="#root/_hidden/_options/_optionsTextNotes">Text Notes</a> options, look for the _Table of Contents_ section and configure the minimum amount of headings that need to be present in the current note in order for the table of contents to show:
 | 
			
		||||
 | 
			
		||||
*   To always hide it, set the value to a really large number (e.g. 10000).
 | 
			
		||||
*   To always display it if there's at least a single heading, set the value to 1.
 | 
			
		||||
 | 
			
		||||
## Per-note configuration
 | 
			
		||||
 | 
			
		||||
Use <a class="reference-link" href="../../Advanced%20Usage/Attributes.md">Attributes</a> to configure the table of contents for a particular note:
 | 
			
		||||
 | 
			
		||||
*   `#toc=show` will show the table of contents for that note regardless of the global settings.
 | 
			
		||||
*   Similarly, `#toc=hide` will always hide the table of contents for that note.
 | 
			
		||||
										
											Binary file not shown.
										
									
								
							| 
		 After Width: | Height: | Size: 6.9 KiB  | 
		Reference in New Issue
	
	Block a user