diff --git a/docs/User Guide/!!!meta.json b/docs/User Guide/!!!meta.json index cc1419564..fe08afb95 100644 --- a/docs/User Guide/!!!meta.json +++ b/docs/User Guide/!!!meta.json @@ -1915,6 +1915,71 @@ "dataFileName": "Floating buttons_image.png" } ] + }, + { + "isClone": false, + "noteId": "RnaPdbciOfeq", + "notePath": [ + "pOsGYCXsbNQG", + "gh7bpGYxajRS", + "Vc8PjrjAGuOp", + "RnaPdbciOfeq" + ], + "title": "Right Sidebar", + "notePosition": 170, + "prefix": null, + "isExpanded": false, + "type": "text", + "mime": "text/html", + "attributes": [ + { + "type": "label", + "name": "iconClass", + "value": "bx bxs-dock-right", + "isInheritable": false, + "position": 10 + }, + { + "type": "relation", + "name": "internalLink", + "value": "BFvAtE74rbP6", + "isInheritable": false, + "position": 20 + }, + { + "type": "relation", + "name": "internalLink", + "value": "AxshuNRegLAv", + "isInheritable": false, + "position": 30 + }, + { + "type": "relation", + "name": "internalLink", + "value": "luNhaphA37EO", + "isInheritable": false, + "position": 40 + }, + { + "type": "relation", + "name": "internalLink", + "value": "3seOhtN8uLIY", + "isInheritable": false, + "position": 50 + } + ], + "format": "markdown", + "dataFileName": "Right Sidebar.md", + "attachments": [ + { + "attachmentId": "ze9MwXmOPhp0", + "title": "image.png", + "role": "image", + "mime": "image/png", + "position": 10, + "dataFileName": "Right Sidebar_image.png" + } + ] } ] }, @@ -4542,6 +4607,78 @@ } ] }, + { + "isClone": false, + "noteId": "AxshuNRegLAv", + "notePath": [ + "pOsGYCXsbNQG", + "KSZ04uQ2D1St", + "iPIMuisry3hd", + "AxshuNRegLAv" + ], + "title": "Highlights list", + "notePosition": 60, + "prefix": null, + "isExpanded": false, + "type": "text", + "mime": "text/html", + "attributes": [ + { + "type": "label", + "name": "iconClass", + "value": "bx bx-highlight", + "isInheritable": false, + "position": 10 + }, + { + "type": "relation", + "name": "internalLink", + "value": "BFvAtE74rbP6", + "isInheritable": false, + "position": 20 + }, + { + "type": "relation", + "name": "internalLink", + "value": "RnaPdbciOfeq", + "isInheritable": false, + "position": 30 + }, + { + "type": "relation", + "name": "internalLink", + "value": "_optionsTextNotes", + "isInheritable": false, + "position": 40 + }, + { + "type": "relation", + "name": "internalLink", + "value": "zEY4DaJG4YT5", + "isInheritable": false, + "position": 50 + }, + { + "type": "relation", + "name": "internalLink", + "value": "XpOYSgsLkTJy", + "isInheritable": false, + "position": 60 + } + ], + "format": "markdown", + "dataFileName": "Highlights list.md", + "attachments": [ + { + "attachmentId": "lDcgRFQO5hDE", + "title": "image.png", + "role": "image", + "mime": "image/png", + "position": 10, + "dataFileName": "Highlights list_image.png" + } + ] + }, { "isClone": false, "noteId": "mT0HEkOsz6i1", @@ -4552,7 +4689,7 @@ "mT0HEkOsz6i1" ], "title": "Images", - "notePosition": 60, + "notePosition": 70, "prefix": null, "isExpanded": false, "type": "text", @@ -4781,7 +4918,7 @@ "nBAXQFj20hS1" ], "title": "Include Note", - "notePosition": 70, + "notePosition": 80, "prefix": null, "isExpanded": false, "type": "text", @@ -4818,7 +4955,7 @@ "QEAPj01N5f7w" ], "title": "Links", - "notePosition": 80, + "notePosition": 90, "prefix": null, "isExpanded": false, "type": "text", @@ -4877,7 +5014,7 @@ "S6Xx8QIWTV66" ], "title": "Lists", - "notePosition": 90, + "notePosition": 100, "prefix": null, "isExpanded": false, "type": "text", @@ -4943,6 +5080,71 @@ "dataFileName": "5_Lists_image.png" } ] + }, + { + "isClone": false, + "noteId": "BFvAtE74rbP6", + "notePath": [ + "pOsGYCXsbNQG", + "KSZ04uQ2D1St", + "iPIMuisry3hd", + "BFvAtE74rbP6" + ], + "title": "Table of contents", + "notePosition": 110, + "prefix": null, + "isExpanded": false, + "type": "text", + "mime": "text/html", + "attributes": [ + { + "type": "relation", + "name": "internalLink", + "value": "XpOYSgsLkTJy", + "isInheritable": false, + "position": 10 + }, + { + "type": "relation", + "name": "internalLink", + "value": "_optionsTextNotes", + "isInheritable": false, + "position": 20 + }, + { + "type": "label", + "name": "iconClass", + "value": "bx bx-heading", + "isInheritable": false, + "position": 30 + }, + { + "type": "relation", + "name": "internalLink", + "value": "zEY4DaJG4YT5", + "isInheritable": false, + "position": 40 + }, + { + "type": "relation", + "name": "internalLink", + "value": "RnaPdbciOfeq", + "isInheritable": false, + "position": 50 + } + ], + "format": "markdown", + "dataFileName": "Table of contents.md", + "attachments": [ + { + "attachmentId": "DL6PJX71Fk3S", + "title": "image.png", + "role": "image", + "mime": "image/png", + "position": 10, + "dataFileName": "Table of contents_image.png" + } + ] } ] }, diff --git a/docs/User Guide/User Guide/Basic Concepts and Features/UI Elements/Right Sidebar.md b/docs/User Guide/User Guide/Basic Concepts and Features/UI Elements/Right Sidebar.md new file mode 100644 index 000000000..bf967626f --- /dev/null +++ b/docs/User Guide/User Guide/Basic Concepts and Features/UI Elements/Right Sidebar.md @@ -0,0 +1,19 @@ +# Right Sidebar +
+ +The right sidebar displays specific content for the current note. Currently it includes: + +* Table of contents +* Highlights list + +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 Split View, 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. \ No newline at end of file diff --git a/docs/User Guide/User Guide/Basic Concepts and Features/UI Elements/Right Sidebar_image.png b/docs/User Guide/User Guide/Basic Concepts and Features/UI Elements/Right Sidebar_image.png new file mode 100644 index 000000000..d6717a0cc Binary files /dev/null and b/docs/User Guide/User Guide/Basic Concepts and Features/UI Elements/Right Sidebar_image.png differ diff --git a/docs/User Guide/User Guide/Note Types/Text/Highlights list.md b/docs/User Guide/User Guide/Note Types/Text/Highlights list.md new file mode 100644 index 000000000..96b6a1216 --- /dev/null +++ b/docs/User Guide/User Guide/Note Types/Text/Highlights list.md @@ -0,0 +1,25 @@ +# Highlights list +
+ +Similar to the Table of contents, 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 Right Sidebar, 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 Floating buttons 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 Text Notes settings and looking for the _Highlights List_ section. + +## Per-note configuration + +To suppress the display of highlighted text for one specific note, use Attributes to add the `#hideHighlightWidget` label. \ No newline at end of file diff --git a/docs/User Guide/User Guide/Note Types/Text/Highlights list_image.png b/docs/User Guide/User Guide/Note Types/Text/Highlights list_image.png new file mode 100644 index 000000000..5053f128c Binary files /dev/null and b/docs/User Guide/User Guide/Note Types/Text/Highlights list_image.png differ diff --git a/docs/User Guide/User Guide/Note Types/Text/Table of contents.md b/docs/User Guide/User Guide/Note Types/Text/Table of contents.md new file mode 100644 index 000000000..950dc002e --- /dev/null +++ b/docs/User Guide/User Guide/Note Types/Text/Table of contents.md @@ -0,0 +1,23 @@ +# Table of contents +
+ +The table of contents appears in the Right Sidebar 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 Floating buttons section. + +## Global configuration + +In Text Notes 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 Attributes 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. \ No newline at end of file diff --git a/docs/User Guide/User Guide/Note Types/Text/Table of contents_image.png b/docs/User Guide/User Guide/Note Types/Text/Table of contents_image.png new file mode 100644 index 000000000..9c80dad37 Binary files /dev/null and b/docs/User Guide/User Guide/Note Types/Text/Table of contents_image.png differ diff --git a/src/public/app/doc_notes/en/User Guide/!!!meta.json b/src/public/app/doc_notes/en/User Guide/!!!meta.json index 9695801b9..356b29b42 100644 --- a/src/public/app/doc_notes/en/User Guide/!!!meta.json +++ b/src/public/app/doc_notes/en/User Guide/!!!meta.json @@ -1915,6 +1915,71 @@ "dataFileName": "Floating buttons_image.png" } ] + }, + { + "isClone": false, + "noteId": "RnaPdbciOfeq", + "notePath": [ + "pOsGYCXsbNQG", + "gh7bpGYxajRS", + "Vc8PjrjAGuOp", + "RnaPdbciOfeq" + ], + "title": "Right Sidebar", + "notePosition": 170, + "prefix": null, + "isExpanded": false, + "type": "text", + "mime": "text/html", + "attributes": [ + { + "type": "label", + "name": "iconClass", + "value": "bx bxs-dock-right", + "isInheritable": false, + "position": 10 + }, + { + "type": "relation", + "name": "internalLink", + "value": "BFvAtE74rbP6", + "isInheritable": false, + "position": 20 + }, + { + "type": "relation", + "name": "internalLink", + "value": "AxshuNRegLAv", + "isInheritable": false, + "position": 30 + }, + { + "type": "relation", + "name": "internalLink", + "value": "luNhaphA37EO", + "isInheritable": false, + "position": 40 + }, + { + "type": "relation", + "name": "internalLink", + "value": "3seOhtN8uLIY", + "isInheritable": false, + "position": 50 + } + ], + "format": "html", + "dataFileName": "Right Sidebar.html", + "attachments": [ + { + "attachmentId": "ze9MwXmOPhp0", + "title": "image.png", + "role": "image", + "mime": "image/png", + "position": 10, + "dataFileName": "Right Sidebar_image.png" + } + ] } ] }, @@ -4542,6 +4607,78 @@ } ] }, + { + "isClone": false, + "noteId": "AxshuNRegLAv", + "notePath": [ + "pOsGYCXsbNQG", + "KSZ04uQ2D1St", + "iPIMuisry3hd", + "AxshuNRegLAv" + ], + "title": "Highlights list", + "notePosition": 60, + "prefix": null, + "isExpanded": false, + "type": "text", + "mime": "text/html", + "attributes": [ + { + "type": "label", + "name": "iconClass", + "value": "bx bx-highlight", + "isInheritable": false, + "position": 10 + }, + { + "type": "relation", + "name": "internalLink", + "value": "BFvAtE74rbP6", + "isInheritable": false, + "position": 20 + }, + { + "type": "relation", + "name": "internalLink", + "value": "RnaPdbciOfeq", + "isInheritable": false, + "position": 30 + }, + { + "type": "relation", + "name": "internalLink", + "value": "_optionsTextNotes", + "isInheritable": false, + "position": 40 + }, + { + "type": "relation", + "name": "internalLink", + "value": "zEY4DaJG4YT5", + "isInheritable": false, + "position": 50 + }, + { + "type": "relation", + "name": "internalLink", + "value": "XpOYSgsLkTJy", + "isInheritable": false, + "position": 60 + } + ], + "format": "html", + "dataFileName": "Highlights list.html", + "attachments": [ + { + "attachmentId": "lDcgRFQO5hDE", + "title": "image.png", + "role": "image", + "mime": "image/png", + "position": 10, + "dataFileName": "Highlights list_image.png" + } + ] + }, { "isClone": false, "noteId": "mT0HEkOsz6i1", @@ -4552,7 +4689,7 @@ "mT0HEkOsz6i1" ], "title": "Images", - "notePosition": 60, + "notePosition": 70, "prefix": null, "isExpanded": false, "type": "text", @@ -4781,7 +4918,7 @@ "nBAXQFj20hS1" ], "title": "Include Note", - "notePosition": 70, + "notePosition": 80, "prefix": null, "isExpanded": false, "type": "text", @@ -4818,7 +4955,7 @@ "QEAPj01N5f7w" ], "title": "Links", - "notePosition": 80, + "notePosition": 90, "prefix": null, "isExpanded": false, "type": "text", @@ -4877,7 +5014,7 @@ "S6Xx8QIWTV66" ], "title": "Lists", - "notePosition": 90, + "notePosition": 100, "prefix": null, "isExpanded": false, "type": "text", @@ -4943,6 +5080,71 @@ "dataFileName": "5_Lists_image.png" } ] + }, + { + "isClone": false, + "noteId": "BFvAtE74rbP6", + "notePath": [ + "pOsGYCXsbNQG", + "KSZ04uQ2D1St", + "iPIMuisry3hd", + "BFvAtE74rbP6" + ], + "title": "Table of contents", + "notePosition": 110, + "prefix": null, + "isExpanded": false, + "type": "text", + "mime": "text/html", + "attributes": [ + { + "type": "relation", + "name": "internalLink", + "value": "XpOYSgsLkTJy", + "isInheritable": false, + "position": 10 + }, + { + "type": "relation", + "name": "internalLink", + "value": "_optionsTextNotes", + "isInheritable": false, + "position": 20 + }, + { + "type": "label", + "name": "iconClass", + "value": "bx bx-heading", + "isInheritable": false, + "position": 30 + }, + { + "type": "relation", + "name": "internalLink", + "value": "zEY4DaJG4YT5", + "isInheritable": false, + "position": 40 + }, + { + "type": "relation", + "name": "internalLink", + "value": "RnaPdbciOfeq", + "isInheritable": false, + "position": 50 + } + ], + "format": "html", + "dataFileName": "Table of contents.html", + "attachments": [ + { + "attachmentId": "DL6PJX71Fk3S", + "title": "image.png", + "role": "image", + "mime": "image/png", + "position": 10, + "dataFileName": "Table of contents_image.png" + } + ] } ] }, diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Basic Concepts and Features/UI Elements/Right Sidebar.html b/src/public/app/doc_notes/en/User Guide/User Guide/Basic Concepts and Features/UI Elements/Right Sidebar.html new file mode 100644 index 000000000..d128147d6 --- /dev/null +++ b/src/public/app/doc_notes/en/User Guide/User Guide/Basic Concepts and Features/UI Elements/Right Sidebar.html @@ -0,0 +1,45 @@ + + + + + + + + Right Sidebar + + + +
+

Right Sidebar

+ +
+
+ +
+

The right sidebar displays specific content for the current note. Currently + it includes:

+ +

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 Split View, + there is a single sidebar serving all the open splits for the current + tab.

+

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.

+
+
+ + + \ No newline at end of file diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Basic Concepts and Features/UI Elements/Right Sidebar_image.png b/src/public/app/doc_notes/en/User Guide/User Guide/Basic Concepts and Features/UI Elements/Right Sidebar_image.png new file mode 100644 index 000000000..d6717a0cc Binary files /dev/null and b/src/public/app/doc_notes/en/User Guide/User Guide/Basic Concepts and Features/UI Elements/Right Sidebar_image.png differ diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Note Types/Text/Highlights list.html b/src/public/app/doc_notes/en/User Guide/User Guide/Note Types/Text/Highlights list.html new file mode 100644 index 000000000..6bd65a081 --- /dev/null +++ b/src/public/app/doc_notes/en/User Guide/User Guide/Note Types/Text/Highlights list.html @@ -0,0 +1,52 @@ + + + + + + + + Highlights list + + + +
+

Highlights list

+ +
+
+ +
+

Similar to the Table of contents, + 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 Right Sidebar, + provided there is at least one highlighted text.

+

Highlighted text is defined as:

+ +

Interaction

+ +

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 Text Notes settings + and looking for the Highlights List section.

+

Per-note configuration

+

To suppress the display of highlighted text for one specific note, use  + Attributes to add the #hideHighlightWidget label.

+
+
+ + + \ No newline at end of file diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Note Types/Text/Highlights list_image.png b/src/public/app/doc_notes/en/User Guide/User Guide/Note Types/Text/Highlights list_image.png new file mode 100644 index 000000000..5053f128c Binary files /dev/null and b/src/public/app/doc_notes/en/User Guide/User Guide/Note Types/Text/Highlights list_image.png differ diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Note Types/Text/Table of contents.html b/src/public/app/doc_notes/en/User Guide/User Guide/Note Types/Text/Table of contents.html new file mode 100644 index 000000000..b503678db --- /dev/null +++ b/src/public/app/doc_notes/en/User Guide/User Guide/Note Types/Text/Table of contents.html @@ -0,0 +1,52 @@ + + + + + + + + Table of contents + + + +
+

Table of contents

+ +
+
+ +
+

The table of contents appears in the Right Sidebar automatically + when there are multiple headings in a text note.

+

Interaction

+ +

Global configuration

+

In Text Notes 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:

+ +

Per-note configuration

+

Use Attributes to + configure the table of contents for a particular note:

+ +
+
+ + + \ No newline at end of file diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Note Types/Text/Table of contents_image.png b/src/public/app/doc_notes/en/User Guide/User Guide/Note Types/Text/Table of contents_image.png new file mode 100644 index 000000000..9c80dad37 Binary files /dev/null and b/src/public/app/doc_notes/en/User Guide/User Guide/Note Types/Text/Table of contents_image.png differ diff --git a/src/public/app/doc_notes/en/User Guide/navigation.html b/src/public/app/doc_notes/en/User Guide/navigation.html index a26876b30..cd5b57d63 100644 --- a/src/public/app/doc_notes/en/User Guide/navigation.html +++ b/src/public/app/doc_notes/en/User Guide/navigation.html @@ -106,6 +106,9 @@
  • Floating buttons
  • +
  • Right Sidebar +
  • Notes @@ -231,6 +234,8 @@
  • Formatting toolbar
  • +
  • Highlights list +
  • Images
  • Code