docs(user): document the new layout
2
apps/server/src/assets/doc_notes/en/User Guide/!!!meta.json
generated
vendored
BIN
apps/server/src/assets/doc_notes/en/User Guide/User Guide/Basic Concepts and Features/UI Elements/1_New Layout_image.png
generated
vendored
Normal file
|
After Width: | Height: | Size: 21 KiB |
BIN
apps/server/src/assets/doc_notes/en/User Guide/User Guide/Basic Concepts and Features/UI Elements/2_New Layout_image.png
generated
vendored
Normal file
|
After Width: | Height: | Size: 10 KiB |
BIN
apps/server/src/assets/doc_notes/en/User Guide/User Guide/Basic Concepts and Features/UI Elements/3_New Layout_image.png
generated
vendored
Normal file
|
After Width: | Height: | Size: 3.7 KiB |
BIN
apps/server/src/assets/doc_notes/en/User Guide/User Guide/Basic Concepts and Features/UI Elements/4_New Layout_image.png
generated
vendored
Normal file
|
After Width: | Height: | Size: 7.2 KiB |
BIN
apps/server/src/assets/doc_notes/en/User Guide/User Guide/Basic Concepts and Features/UI Elements/5_New Layout_image.png
generated
vendored
Normal file
|
After Width: | Height: | Size: 23 KiB |
218
apps/server/src/assets/doc_notes/en/User Guide/User Guide/Basic Concepts and Features/UI Elements/New Layout.html
generated
vendored
Normal file
@ -0,0 +1,218 @@
|
||||
<p>The <em>New layout</em> is a series of UI/UX changes that were introduced
|
||||
in v0.101.0 that heavily change both existing UI elements, as well as adding
|
||||
some new ones. The goal of this new layout is to modernize the application
|
||||
and to make it more intuitive but at the same time to reduce clutter.</p>
|
||||
<h2>Newly introduced features</h2>
|
||||
<h3>Status bar</h3>
|
||||
<p>At the bottom of the window there is a new bar called the <em>Status bar</em>.
|
||||
This bar houses multiple items such as the Breadcrumb navigation and information
|
||||
and settings about the current note, such as the <a href="#root/pOsGYCXsbNQG/KSZ04uQ2D1St/iPIMuisry3hd/_help_veGu4faJErEM">content language</a> and
|
||||
<a
|
||||
class="reference-link" href="#root/pOsGYCXsbNQG/tC7s2alapj8V/_help_zEY4DaJG4YT5">Attributes</a>.</p>
|
||||
<p>For more information, consult the <a href="#root/pOsGYCXsbNQG/gh7bpGYxajRS/Vc8PjrjAGuOp/IjZS7iK5EXtb/_help_AlJ73vBCjWDw">dedicated page</a>.</p>
|
||||
<figure
|
||||
class="image">
|
||||
<img style="aspect-ratio:1150/27;" src="4_New Layout_image.png"
|
||||
width="1150" height="27">
|
||||
</figure>
|
||||
<h3>Inline title</h3>
|
||||
<p>In previous versions of Trilium, the title bar was fixed at all times.
|
||||
In the new layout, there is both a fixed title bar and one that scrolls
|
||||
with the text. The newly introduced title is called the <em>Inline title</em> and
|
||||
it displays the title in a larger font, while also displaying additional
|
||||
information such as the creation and the modification date.</p>
|
||||
<p>Whenever the title is scrolled past, the fixed title is shown instead.</p>
|
||||
<p>This only affects <a class="reference-link" href="#root/pOsGYCXsbNQG/KSZ04uQ2D1St/_help_iPIMuisry3hd">Text</a> and
|
||||
<a
|
||||
class="reference-link" href="#root/pOsGYCXsbNQG/KSZ04uQ2D1St/_help_6f9hih2hXXZk">Code</a> notes. Note types that take the entirety of the screen such
|
||||
as <a class="reference-link" href="#root/pOsGYCXsbNQG/KSZ04uQ2D1St/_help_grjYqerjn243">Canvas</a> will
|
||||
always have only the fixed title bar.</p>
|
||||
<p>Depending on the note type, the inline title will also present some more
|
||||
interactive options such as being able to switch the note type (see below).</p>
|
||||
<figure
|
||||
class="image">
|
||||
<img style="aspect-ratio:899/122;" src="New Layout_image.png"
|
||||
width="899" height="122">
|
||||
<figcaption>The <em>Inline title</em>, which is displayed at the top of the note and
|
||||
can be scrolled past.</figcaption>
|
||||
</figure>
|
||||
<figure class="image">
|
||||
<img style="aspect-ratio:910/104;" src="3_New Layout_image.png"
|
||||
width="910" height="104">
|
||||
<figcaption>The fixed title bar. The title only appears after scrolling past the <em>Inline title</em>.</figcaption>
|
||||
</figure>
|
||||
<h3>New note type switcher</h3>
|
||||
<p>When a new <a class="reference-link" href="#root/pOsGYCXsbNQG/KSZ04uQ2D1St/_help_iPIMuisry3hd">Text</a> or
|
||||
<a
|
||||
class="reference-link" href="#root/pOsGYCXsbNQG/KSZ04uQ2D1St/_help_6f9hih2hXXZk">Code</a> note is created, a note type switcher will appear below
|
||||
the <em>Inline title</em>. Apart from changing the note type, it's also
|
||||
possible to apply a <a href="#root/pOsGYCXsbNQG/tC7s2alapj8V/_help_KC1HB96bqqHX">template</a>.</p>
|
||||
<p>The switcher will disappear as soon as a text is entered.</p>
|
||||
<p>
|
||||
<img src="5_New Layout_image.png" width="735" height="143">
|
||||
</p>
|
||||
<h3>Note badges</h3>
|
||||
<p>Note badges appear near the fixed note title and indicate important information
|
||||
about the note such as whether it is read-only. Some of the badges are
|
||||
also interactive.</p>
|
||||
<figure class="image">
|
||||
<img style="aspect-ratio:910/49;" src="2_New Layout_image.png"
|
||||
width="910" height="49">
|
||||
</figure>
|
||||
<p>The following badges are available:</p>
|
||||
<ul>
|
||||
<li data-list-item-id="e681fff45ecdebbf3a5c6fc8398b4e8b1"><strong>Read-only badge</strong>, which will be shown if the note is not
|
||||
editable due to either automatic read-only or manual read-only. Clicking
|
||||
on the badge will temporarily edit the note (similar to the Edit <a href="#root/pOsGYCXsbNQG/gh7bpGYxajRS/Vc8PjrjAGuOp/_help_XpOYSgsLkTJy">floating button</a>).</li>
|
||||
<li
|
||||
data-list-item-id="ee8bd349f3feb3df5069b31345e627985"><strong>Share badge</strong>, which will indicate that the current note
|
||||
is shared. The badge will also indicate if the share is on the local network
|
||||
(for the desktop application without <a class="reference-link" href="#root/pOsGYCXsbNQG/Otzi9La2YAUX/_help_cbkrhQjrkKrh">Synchronization</a> set
|
||||
up) or publicly accessible (for the server). </li>
|
||||
<li data-list-item-id="e8f5a122ba42c453bf36eb4f0064d570d"><strong>Web clip badge</strong>, which will indicate if the note was clipped
|
||||
using the <a class="reference-link" href="#root/pOsGYCXsbNQG/Otzi9La2YAUX/_help_MtPxeAWVAzMg">Web Clipper</a>.
|
||||
The badge acts as a link, so it can be clicked on to navigate to the page
|
||||
or right clicked for more options.</li>
|
||||
<li data-list-item-id="e4f52532a9ae7b5ff88cc081da81049ad"><strong>Execute badge</strong>, for <a href="#root/pOsGYCXsbNQG/_help_CdNpE2pqjmI6">scripts</a> or
|
||||
<a
|
||||
href="#root/pOsGYCXsbNQG/tC7s2alapj8V/wX4HbRucYSDD/oyIAJ9PvvwHX/_help_YKWqdJhzi2VY">saved SQL queries</a>which have an execute button or a description.</li>
|
||||
</ul>
|
||||
<p>Some of these badges replace the dedicated panels at the top of the note.</p>
|
||||
<h3>Collapsible sections</h3>
|
||||
<figure class="image">
|
||||
<img style="aspect-ratio:496/265;" src="1_New Layout_image.png"
|
||||
width="496" height="265">
|
||||
</figure>
|
||||
<p>The following sections have been made collapsible:</p>
|
||||
<ul>
|
||||
<li class="ck-list-marker-italic" data-list-item-id="e1e7527a923c6adc4b25a81c836aa54bb"><em>Promoted Attributes</em>
|
||||
<ul>
|
||||
<li data-list-item-id="e81342adbccbbbe0c186887eb0c96f6c7">For full-height notes such as <a class="reference-link" href="#root/pOsGYCXsbNQG/KSZ04uQ2D1St/_help_grjYqerjn243">Canvas</a>,
|
||||
the promoted attributes are collapsed by default to make room.</li>
|
||||
<li
|
||||
data-list-item-id="e6c14c0f102892bc42cc6f503d901b1f0">The keyboard shortcut previously used to trigger the promoted attributes
|
||||
ribbon tab (which was no longer working) has been repurposed to toggle
|
||||
the promoted attributes instead.</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li data-list-item-id="e11bfe716c8b0b09f68d9c7cc99c93e03"><em>Edited Notes</em>, which appears for <a class="reference-link"
|
||||
href="#root/pOsGYCXsbNQG/tC7s2alapj8V/5668rwcirq1t/_help_l0tKav7yLHGF">Day Notes</a> is
|
||||
now shown underneath the title.
|
||||
<ul>
|
||||
<li data-list-item-id="e24a6e624c699432c4d812b34f25a137a">Whether the section is collapsed or not depends on the choice in
|
||||
<a
|
||||
class="reference-link" href="#root/pOsGYCXsbNQG/gh7bpGYxajRS/Vc8PjrjAGuOp/_help_4TIF1oA4VQRO">Options</a> → Appearance.</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li data-list-item-id="e16420a44b06dbe4810f6ab5087bb7f09"><em>Search Properties</em>, which appears for the full <a class="reference-link"
|
||||
href="#root/pOsGYCXsbNQG/gh7bpGYxajRS/wArbEsdSae6g/_help_eIg8jdvaoNNd">Search</a> and
|
||||
<a
|
||||
class="reference-link" href="#root/pOsGYCXsbNQG/KSZ04uQ2D1St/_help_m523cpzocqaD">Saved Search</a>.</li>
|
||||
</ul>
|
||||
<h2>Changing to the existing layout</h2>
|
||||
<h3>Removal of the ribbon</h3>
|
||||
<p>The most significant change is the removal of the ribbon. All the actions
|
||||
and options from the ribbon were integrated in other places in the application.</p>
|
||||
<p>Here's how all the different tabs that were once part of the ribbon are
|
||||
now available in the new layout:</p>
|
||||
<ul>
|
||||
<li data-list-item-id="e23a8f5ef92bc84b978897596a0f311d5">“Formatting toolbar” was relocated to the top of the page.
|
||||
<ul>
|
||||
<li data-list-item-id="eaff03a54c5d839b1cf491b873e4ac417">Instead of having one per split, now there is a single formatting toolbar
|
||||
per tab. This allows more space for the toolbar items.</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li data-list-item-id="e55efa7b7fa563c7a792952d0a00f69c7">“Owned attributes” and “Inherited attributes” were merged and moved to
|
||||
the status bar region (displayed one above the other).</li>
|
||||
<li data-list-item-id="eaf2afbfe470834eca4dc7269b7310964">“Basic Properties” were integrated in the <a class="reference-link"
|
||||
href="#root/pOsGYCXsbNQG/gh7bpGYxajRS/Vc8PjrjAGuOp/_help_8YBEPzcpUgxw">Note buttons</a> menu.
|
||||
<ul>
|
||||
<li data-list-item-id="e44ec78344d9a6c8966b0c9c68ae79d79">The only exception here is the Language combo box which can now be found
|
||||
in the status bar (top-right of the screen).</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li data-list-item-id="ea5cf9c168f3291f8247ce89924472c33">“File” and “Image” tabs
|
||||
<ul>
|
||||
<li data-list-item-id="e32291890baede8270361747c20724271">The buttons were moved to the right of the note title, as dedicated entries
|
||||
in <a class="reference-link" href="#root/pOsGYCXsbNQG/gh7bpGYxajRS/Vc8PjrjAGuOp/_help_8YBEPzcpUgxw">Note buttons</a>.</li>
|
||||
<li
|
||||
data-list-item-id="e4e0b374eeaa3d5cee3ec10c2f0f51e1c">The info section has been merged into the <em>Note info </em>section of
|
||||
the status bar.</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li data-list-item-id="ea542c02972f94d40cd87ed5f971db880">Edited notes
|
||||
<ul>
|
||||
<li data-list-item-id="e628eec12558a51865f1b4f14e9f3fec8">Moved underneath the title, displayed under a collapsible area and the
|
||||
notes are represented as badges/chips.</li>
|
||||
<li data-list-item-id="ed819af0e25679551eb56d66bd81cf431">Whether the section is expanded or collapsed depends on the “Edited Notes
|
||||
ribbon tab will automatically open on day notes” setting from Options →
|
||||
Appearance.</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li data-list-item-id="eb5f31f734338d9f6ada1329849ac9652">Search definition tab
|
||||
<ul>
|
||||
<li data-list-item-id="ee00a5cb8f4d7920a236fb95f34d93dbf">Moved underneath the title under a collapsible area.</li>
|
||||
<li data-list-item-id="e310963b6aafce5d8e75fd65810087d0b">Expanded by default for new searches, collapsed for saved searches.</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li data-list-item-id="e7713cf206015ff83cdc8569fe22301a4">The Note map is now available in the Note actions menu.
|
||||
<ul>
|
||||
<li data-list-item-id="e507702eef9a13e0fc6b88da4e8b4b280">Instead of opening into a panel in the ribbon, the note map now opens
|
||||
in a side split (similar to the in-app help).</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li data-list-item-id="e36fac289364571fe38384d913a9b82f6">“Note info” tab was moved to a small (i) icon in the status bar.</li>
|
||||
<li
|
||||
data-list-item-id="ec77db0f7e17da59142a53738bd6e5dde">“Similar notes” tab
|
||||
<ul>
|
||||
<li data-list-item-id="e82f29a4705ba7ef67cfa7871d09d55ec">Moved to the status bar, by going to the “Note info” section and pressing
|
||||
the button to show similar notes.</li>
|
||||
<li data-list-item-id="e4824fa59a2e7b078c235fdf191809693">Displayed as a fixed panel, similar to the attributes.</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li data-list-item-id="e51662a87308396697ebe51f8dad842f9">The Collection properties tab were relocated under the note title and
|
||||
grouped into:
|
||||
<ul>
|
||||
<li data-list-item-id="e5355d95afa06871493dd0633eeb21342">A combo box to quickly switch between views.</li>
|
||||
<li data-list-item-id="eebd3911c5dd2fc770534ae8fc7d2b47e">Individual settings for the current view in a submenu.</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li data-list-item-id="eae9dae6a2a5b74aaea84d818d1334fc9">Some smaller ribbon tabs were converted to badges that appear near the
|
||||
note title in the breadcrumb section:
|
||||
<ul>
|
||||
<li data-list-item-id="ea7f24c544b22fda5ef7d513410454738">Original URL indicator for clipped web pages (<code spellcheck="false">#pageUrl</code>).</li>
|
||||
<li
|
||||
data-list-item-id="e43d835ca69e35e71203f64efd2fd12c2">SQL and script execute buttons.</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
<aside class="admonition note">
|
||||
<p>The ribbon keyboard shortcuts (e.g. <code spellcheck="false">toggleRibbonTabClassicEditor</code>)
|
||||
have been repurposed to work on the new layout, where they will toggle
|
||||
the appropriate panel.</p>
|
||||
</aside>
|
||||
<h3>Removal of the floating buttons</h3>
|
||||
<p>Most of the buttons were relocated to the right of the note title, in
|
||||
the <a class="reference-link" href="#root/pOsGYCXsbNQG/gh7bpGYxajRS/Vc8PjrjAGuOp/_help_8YBEPzcpUgxw">Note buttons</a> area,
|
||||
with the exception of:</p>
|
||||
<ul>
|
||||
<li data-list-item-id="ec0623b0ce81f563d1c58d0d17de7c517">The Edit button is displayed near the note title, as a badge.</li>
|
||||
<li
|
||||
data-list-item-id="e0f1d6b12f8ebaf09d070aa9c86850726"><em>Backlinks</em> is displayed in the status bar. When clicked, the same
|
||||
list of backlinks is displayed.</li>
|
||||
<li data-list-item-id="e9693ac78b6cb054e6e492e464abd7c16">Relation map zoom buttons are now part of the relation map itself.</li>
|
||||
<li
|
||||
data-list-item-id="e4f2e79a6ea41e31ffe58e6c25a75216a">Export image to PNG/SVG are now in the Note actions menu, in the <em>Export as image</em> option.</li>
|
||||
</ul>
|
||||
<h2>How to toggle the new layout</h2>
|
||||
<p>Starting with v0.101.0, this new layout is enabled by default. It is possible
|
||||
to fall back to the old layout by going to <a class="reference-link"
|
||||
href="#root/pOsGYCXsbNQG/gh7bpGYxajRS/Vc8PjrjAGuOp/_help_4TIF1oA4VQRO">Options</a> →
|
||||
Appearance and selecting <em>Old layout</em>.</p>
|
||||
<aside class="admonition important">
|
||||
<p>Since a new layout was introduced, this becomes the standard one. The <em>Old layout</em> is
|
||||
considered deprecated and will not receive new features (for example, the
|
||||
breadcrumb) as we focus on the new one. At some point the old layout will
|
||||
be removed entirely, as maintaining two layouts with major differences
|
||||
creates a maintenance burden.</p>
|
||||
</aside>
|
||||
55
apps/server/src/assets/doc_notes/en/User Guide/User Guide/Basic Concepts and Features/UI Elements/New Layout/Breadcrumb.html
generated
vendored
Normal file
@ -0,0 +1,55 @@
|
||||
<figure class="image">
|
||||
<img style="aspect-ratio:1150/27;" src="Breadcrumb_image.png"
|
||||
width="1150" height="27">
|
||||
</figure>
|
||||
<p>The breadcrumb allows quickly viewing the note hierarchy of the current
|
||||
note and navigating through it.</p>
|
||||
<p>It is part of the <a class="reference-link" href="#root/pOsGYCXsbNQG/gh7bpGYxajRS/Vc8PjrjAGuOp/IjZS7iK5EXtb/_help_AlJ73vBCjWDw">Status bar</a>,
|
||||
displayed in the bottom-left of the screen.</p>
|
||||
<h2>Layout and Interaction</h2>
|
||||
<ul>
|
||||
<li data-list-item-id="eeca71aa25c6fc24ccea32b3fd91c7d03">If a note or workspace is hoisted, a badge will appear on the left-most
|
||||
side.
|
||||
<ul>
|
||||
<li data-list-item-id="e0c5e4b89d1a4f0fccfd64fd5a5c401de">Clicking on the badge will un-hoist the note/workspace.</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li data-list-item-id="e3f4bcf3d23cc23094991e4b982fab65d">The left-most icon represents the root note, or the hoisted note or workspace.
|
||||
<ul>
|
||||
<li data-list-item-id="e0acc69822ac800e00f15286d69150011">Clicking the icon will jump to the root note.</li>
|
||||
<li data-list-item-id="ea7ad114455b8e77f527cab5064b24f62">Right clicking the icon will display a menu that allows opening the note
|
||||
in a new tab, split, etc.</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li data-list-item-id="e1e81c0cc1c8ca8ae94e3861e2e7ba104">Each segment shows the title of a note in the current note hierarchy.
|
||||
<ul>
|
||||
<li data-list-item-id="e42e1001c318c8b55ec25d44649f116f6">Clicking the icon will jump to that note.</li>
|
||||
<li data-list-item-id="ebd05c3d7be7f994f229d48131ccd79bb">Right clicking will open a menu with multiple options such as opening
|
||||
the note in a different tab/split/window, hoisting, moving/cloning the
|
||||
note, duplicating as well as changing the color of the note.</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li data-list-item-id="ed8111f04712d97db418a8ba507cf1cf4">Clicking the arrow next to each segment will reveal the child notes of
|
||||
the segment on the left.
|
||||
<ul>
|
||||
<li data-list-item-id="e9689b35aa5224f861cf61e63fc3abd96">Clicking on an icon will navigate to that particular note.</li>
|
||||
<li data-list-item-id="ea008f6126b2d2dc03e9795fa89a8fe0c">It's also possible to create a new child note from here.</li>
|
||||
<li data-list-item-id="e5d56879e41e3eba28d89999ac208cf63">The menu can optionally hide the archived notes.</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li data-list-item-id="ed65ebfd673ab4cc6eb2e2a227f0caa95">If the current note is deep within a hierarchy, the segments will collapse
|
||||
into a […] button in order not to occupy too much space.
|
||||
<ul>
|
||||
<li data-list-item-id="e3081db77d1acea4568da8d69d199171b">Clicking this button will display each collapsed entry as a menu item.
|
||||
Clicking on it will navigate to that particular note.</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li data-list-item-id="e17205300d9c0018d65cf0f0fc92343bf">Right clicking on an empty space to the right of the breadcrumb (before
|
||||
the other status bar items) will reveal another menu that allows:
|
||||
<ul>
|
||||
<li data-list-item-id="e80899972041248ee12d26fb7065772a3">Toggling whether archived notes are displayed in the breadcrumb and in
|
||||
the note tree.</li>
|
||||
<li data-list-item-id="ef692f737f9df3df6d77b180ade9ecd45">Copying the current note path to clipboard.</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
BIN
apps/server/src/assets/doc_notes/en/User Guide/User Guide/Basic Concepts and Features/UI Elements/New Layout/Breadcrumb_image.png
generated
vendored
Normal file
|
After Width: | Height: | Size: 7.2 KiB |
53
apps/server/src/assets/doc_notes/en/User Guide/User Guide/Basic Concepts and Features/UI Elements/New Layout/Status bar.html
generated
vendored
Normal file
@ -0,0 +1,53 @@
|
||||
<p>The status bar displays information about the current note and allows
|
||||
changing settings related to it such as configuring the language or attributes.</p>
|
||||
<h2>Layout and interaction</h2>
|
||||
<p>On the left side, the <a class="reference-link" href="#root/pOsGYCXsbNQG/gh7bpGYxajRS/Vc8PjrjAGuOp/IjZS7iK5EXtb/_help_I6p2a06hdnL6">Breadcrumb</a> is
|
||||
displayed which indicates the current note as well as its parent notes
|
||||
and allows for quick navigation throughout the hierarchy.</p>
|
||||
<p>On the right side, specific sections will show depending on the type of
|
||||
the current note.</p>
|
||||
<ol>
|
||||
<li data-list-item-id="ef3e251512bf6573cca80079d8efd08ec">For code notes, the language mode of the note is indicated (e.g. JavaScript,
|
||||
plain text), as well as allowing easy switching to another mode.</li>
|
||||
<li
|
||||
data-list-item-id="eb5c80ff8ad9e92fd95cae059af10f1b9">For text notes, the content language is displayed and can be changed,
|
||||
thus configuring the spell-check and the right-to-left support.
|
||||
<ol>
|
||||
<li data-list-item-id="eb8a685a73d822de440eacbf53b361d80">Note that this applies to the entire note and not the selection, unlike
|
||||
some text editors.</li>
|
||||
</ol>
|
||||
</li>
|
||||
<li data-list-item-id="eec1c0804323b8b841538dd493654e6ac">If a note is placed in multiple places in the tree (cloned), the number
|
||||
of the note paths will be displayed.
|
||||
<ol>
|
||||
<li data-list-item-id="e5975fc63b51ceaee4639a4185025c912">Clicking it will reveal the full list of note paths and a button to place
|
||||
it somewhere else.</li>
|
||||
</ol>
|
||||
</li>
|
||||
<li data-list-item-id="e9644f8d1759a085172efe05ca9de454e">If a note has attachments, their number will be displayed.
|
||||
<ol>
|
||||
<li data-list-item-id="e1f84e230de4009fc971a999330eee2d2">Clicking on it will reveal the list of attachments in a new tab.</li>
|
||||
</ol>
|
||||
</li>
|
||||
<li data-list-item-id="eae7faacee8099500ffeed87bcd10d48c">If a note is linked from other text notes (backlinks), the number of backlinks
|
||||
will be displayed.
|
||||
<ol>
|
||||
<li data-list-item-id="e23765b409994cae53cc3085abdb8c6f4">Clicking on it will show the list of notes that link to this note, as
|
||||
well as an excerpt of where the note is referenced.</li>
|
||||
</ol>
|
||||
</li>
|
||||
</ol>
|
||||
<p>Regardless of note type, the following items will always be displayed
|
||||
if there is a note:</p>
|
||||
<ol>
|
||||
<li data-list-item-id="eeba7911e7138db1df76d76712b360b45">Note info, which displays:
|
||||
<ol>
|
||||
<li data-list-item-id="ea184596335824cc6cdf737949ee4be0e">The creation/modification date of the note.</li>
|
||||
<li data-list-item-id="e785134c29b68229dd42afab43413cd70">The type and MIME of the note.</li>
|
||||
<li data-list-item-id="e06b3ee88bd4ae7da4182e3747264223e">The note ID.</li>
|
||||
<li data-list-item-id="e896b429faa3a7b9e4ddff8abb2ff0795">An estimation of the note size of the note itself and its children.</li>
|
||||
<li
|
||||
data-list-item-id="e2749abcfbc46d6d8cab5b7f0b3fbb161">A button to show Similar notes.</li>
|
||||
</ol>
|
||||
</li>
|
||||
</ol>
|
||||
BIN
apps/server/src/assets/doc_notes/en/User Guide/User Guide/Basic Concepts and Features/UI Elements/New Layout_image.png
generated
vendored
Normal file
|
After Width: | Height: | Size: 9.9 KiB |
@ -3,10 +3,15 @@
|
||||
<img src="Note buttons_image.png">
|
||||
</p>
|
||||
<ul>
|
||||
<li>The Note Revisions button displays the <a href="#root/_help_vZWERwf8U3nx">Note Revisions</a> for
|
||||
<li data-list-item-id="e9bebdee3f029e4352aaa066ccc75f3cc">The Note Revisions button displays the <a href="#root/_help_vZWERwf8U3nx">Note Revisions</a> for
|
||||
that particular note.</li>
|
||||
<li>The contextual menu offers commands for the note or its subtree, such
|
||||
<li data-list-item-id="ed4fd4715e47307a0808ccb0481660303">The contextual menu offers commands for the note or its subtree, such
|
||||
as import, export, viewing the <a href="#root/_help_4FahAwuGTAwC">Note source code</a> or
|
||||
<a
|
||||
href="#root/_help_0vhv7lsOLy82">Attachments</a>.</li>
|
||||
</ul>
|
||||
<p>On the <a class="reference-link" href="#root/pOsGYCXsbNQG/gh7bpGYxajRS/Vc8PjrjAGuOp/_help_IjZS7iK5EXtb">New Layout</a>,
|
||||
the button area is populated by some more buttons that are specific to
|
||||
the current note. For example, for Image and <a class="reference-link"
|
||||
href="#root/pOsGYCXsbNQG/KSZ04uQ2D1St/_help_W8vYD3Q1zjCR">File</a> notes,
|
||||
the download and copy buttons were relocated there.</p>
|
||||
144
apps/server/src/assets/doc_notes/en/User Guide/User Guide/Collections/Kanban Board.html
generated
vendored
@ -7,98 +7,94 @@
|
||||
adjusted.</p>
|
||||
<h2>How it works</h2>
|
||||
<p>When first creating a collection of <em>Board</em> type, a few subnotes
|
||||
will be created, each having a <code spellcheck="false">#status</code> label
|
||||
set. The board then groups each note by the value of the status attribute.</p>
|
||||
will be created, each having a <code>#status</code> label set. The board
|
||||
then groups each note by the value of the status attribute.</p>
|
||||
<p>Notes are displayed recursively, so even the child notes of the child
|
||||
notes will be displayed. However, unlike the <a class="reference-link"
|
||||
href="#root/_help_2FvYrpmOXm29">Table</a>, the notes are not displayed in a hierarchy.</p>
|
||||
<h2>Interaction</h2>
|
||||
<h3>Working with columns</h3>
|
||||
<ul>
|
||||
<li data-list-item-id="eed75fe2d70ba712457da18d13b91fa16">Create a new column by pressing <em>Add Column</em> near the last column.
|
||||
<li>Create a new column by pressing <em>Add Column</em> near the last column.
|
||||
<ul>
|
||||
<li data-list-item-id="ef2cf2654ff26b4f04aabe7aea447ba04">Once pressed, a text box will be displayed to set the name of the column.
|
||||
<li>Once pressed, a text box will be displayed to set the name of the column.
|
||||
Press <kbd>Enter</kbd> to confirm, or <kbd>Escape</kbd> to dismiss.</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li data-list-item-id="ecf404437de7a7126ec6e74428386c644">To reorder a column, simply hold the mouse over the title and drag it
|
||||
<li>To reorder a column, simply hold the mouse over the title and drag it
|
||||
to the desired position.</li>
|
||||
<li data-list-item-id="ebe673a03d3e54db84bad22ac06caf1bc">To delete a column, right click on its title and select <em>Delete column</em>.</li>
|
||||
<li
|
||||
data-list-item-id="e7c4c69d4c1ef862d13c886c29fccc0e2">To rename a column, click on the note title.
|
||||
<li>To delete a column, right click on its title and select <em>Delete column</em>.</li>
|
||||
<li>To rename a column, click on the note title.
|
||||
<ul>
|
||||
<li data-list-item-id="ea8ee1c0d6783c0c64fde427a7334f703">Press Enter to confirm.</li>
|
||||
<li data-list-item-id="e85724e2b224df1670b08a418e560b05d">Upon renaming a column, the corresponding status attribute of all its
|
||||
<li>Press Enter to confirm.</li>
|
||||
<li>Upon renaming a column, the corresponding status attribute of all its
|
||||
notes will be changed in bulk.</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li data-list-item-id="e2836e9a5f492795750c949f1f060f548">If there are many columns, use the mouse wheel to scroll.</li>
|
||||
<li>If there are many columns, use the mouse wheel to scroll.</li>
|
||||
</ul>
|
||||
<h3>Working with notes</h3>
|
||||
<ul>
|
||||
<li data-list-item-id="efb7df180d7edb7e6c070bcfee5aa6595">Create a new note in any column by pressing <em>New item</em>
|
||||
<li>Create a new note in any column by pressing <em>New item</em>
|
||||
<ul>
|
||||
<li data-list-item-id="e1cba0534a1bd351bad9a8eab629a2267">Enter the name of the note and press <kbd>Enter</kbd> or click away. To
|
||||
<li>Enter the name of the note and press <kbd>Enter</kbd> or click away. To
|
||||
dismiss the creation of a new note, simply press <kbd>Escape</kbd> or leave
|
||||
the name empty.</li>
|
||||
<li data-list-item-id="ecd0181ef17ca7eea5c4f5864472bb4b3">Once created, the new note will have an attribute (<code spellcheck="false">status</code> label
|
||||
<li>Once created, the new note will have an attribute (<code>status</code> label
|
||||
by default) set to the name of the column.</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li data-list-item-id="ee23b9bd9fedee464cb70079e80379b12">To open the note, simply click on it.</li>
|
||||
<li data-list-item-id="ef6b267a604ab3dedcce739bda9928c36">To change the title of the note directly from the board, hover the mouse
|
||||
<li>To open the note, simply click on it.</li>
|
||||
<li>To change the title of the note directly from the board, hover the mouse
|
||||
over its card and press the edit button on the right.</li>
|
||||
<li data-list-item-id="ebbe903cc36e703cf676e988a5b58d950">To change the state of a note, simply drag a note from one column to the
|
||||
<li>To change the state of a note, simply drag a note from one column to the
|
||||
other to change its state.</li>
|
||||
<li data-list-item-id="e41960c677e9041fcf07692b44e70b5af">The order of the notes in each column corresponds to their position in
|
||||
<li>The order of the notes in each column corresponds to their position in
|
||||
the tree.
|
||||
<ul>
|
||||
<li data-list-item-id="e0868bc9825cdef09da3fc03e873c47d7">It's possible to reorder notes simply by dragging them to the desired
|
||||
<li>It's possible to reorder notes simply by dragging them to the desired
|
||||
position within the same columns.</li>
|
||||
<li data-list-item-id="e0706409ea69226ec62e3364d85001697">It's also possible to drag notes across columns, at the desired position.</li>
|
||||
<li>It's also possible to drag notes across columns, at the desired position.</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li data-list-item-id="e5ad1e7155fc0100222f460ef9feb6b41">For more options, right click on a note to display a context menu with
|
||||
<li>For more options, right click on a note to display a context menu with
|
||||
the following options:
|
||||
<ul>
|
||||
<li data-list-item-id="e1ce2217942aaa4c6b78b8c76a7f38dbb">Open the note in a new tab/split/window or quick edit.</li>
|
||||
<li data-list-item-id="e707e47f9eede68e4546eb6b8a83e8a17">Move the note to any column.</li>
|
||||
<li data-list-item-id="e3125b7d4859803621bad3d679339dab9">Insert a new note above/below the current one.</li>
|
||||
<li data-list-item-id="ea16c75aba80bbcb50b3dd416cec09753">Archive/unarchive the current note.</li>
|
||||
<li data-list-item-id="e5ea20c999a4f17c69ed4094d24a706f3">Delete the current note.</li>
|
||||
<li>Open the note in a new tab/split/window or quick edit.</li>
|
||||
<li>Move the note to any column.</li>
|
||||
<li>Insert a new note above/below the current one.</li>
|
||||
<li>Archive/unarchive the current note.</li>
|
||||
<li>Delete the current note.</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li data-list-item-id="e568d17582bdddc191dfe89bb9aca89d5">If there are many notes within the column, move the mouse over the column
|
||||
<li>If there are many notes within the column, move the mouse over the column
|
||||
and use the mouse wheel to scroll.</li>
|
||||
</ul>
|
||||
<h3>Working with the note tree</h3>
|
||||
<p>It's also possible to add items on the board using the <a class="reference-link"
|
||||
href="#root/_help_oPVyFC7WL2Lp">Note Tree</a>.</p>
|
||||
<ol>
|
||||
<li data-list-item-id="e921887a37d6dba75eb00782ac7c7e118">Select the desired note in the <a class="reference-link" href="#root/_help_oPVyFC7WL2Lp">Note Tree</a>.</li>
|
||||
<li
|
||||
data-list-item-id="efeec7811e055ff6465ed839bbba2f776">Hold the mouse on the note and drag it to the to the desired column.</li>
|
||||
<li>Select the desired note in the <a class="reference-link" href="#root/_help_oPVyFC7WL2Lp">Note Tree</a>.</li>
|
||||
<li>Hold the mouse on the note and drag it to the to the desired column.</li>
|
||||
</ol>
|
||||
<p>This works for:</p>
|
||||
<ul>
|
||||
<li data-list-item-id="e31561dca83d4b9598775e33d9c4a8396">Notes that are not children of the board, case in which a <a href="#root/_help_IakOLONlIfGI">clone</a> will
|
||||
<li>Notes that are not children of the board, case in which a <a href="#root/_help_IakOLONlIfGI">clone</a> will
|
||||
be created.</li>
|
||||
<li data-list-item-id="e74f3978f78cb119c8ae4b0ec167f8683">Notes that are children of the board, but not yet assigned on the board.</li>
|
||||
<li
|
||||
data-list-item-id="e581a876b974f0e5f0381651496400d48">Notes that are children of the board, case in which they will be moved
|
||||
<li>Notes that are children of the board, but not yet assigned on the board.</li>
|
||||
<li>Notes that are children of the board, case in which they will be moved
|
||||
to the new column.</li>
|
||||
</ul>
|
||||
<h3>Keyboard interaction</h3>
|
||||
<p>The board view has mild support for keyboard-based navigation:</p>
|
||||
<ul>
|
||||
<li data-list-item-id="e956369914e25568591f1d3dda5ae970e">Use <kbd>Tab</kbd> and <kbd>Shift</kbd>+<kbd>Tab</kbd> to navigate between
|
||||
<li>Use <kbd>Tab</kbd> and <kbd>Shift</kbd>+<kbd>Tab</kbd> to navigate between
|
||||
column titles, notes and the “New item” button for each of the columns,
|
||||
in sequential order.</li>
|
||||
<li data-list-item-id="e5211444d02da23ac54a370bc1cced494">To rename a column or a note, press <kbd>F2</kbd> while it is focused.</li>
|
||||
<li
|
||||
data-list-item-id="e11a91b88f8a12237ef40ab9c32d9f8f8">To open a specific note or create a new item, press <kbd>Enter</kbd> while
|
||||
<li>To rename a column or a note, press <kbd>F2</kbd> while it is focused.</li>
|
||||
<li>To open a specific note or create a new item, press <kbd>Enter</kbd> while
|
||||
it is focused.</li>
|
||||
<li data-list-item-id="e34aabe77a5bce273c353c2400da91cee">To dismiss a rename of a note or a column, press <kbd>Escape</kbd>.</li>
|
||||
<li>To dismiss a rename of a note or a column, press <kbd>Escape</kbd>.</li>
|
||||
</ul>
|
||||
<h2>Configuration</h2>
|
||||
<h3>Displaying custom attributes</h3>
|
||||
@ -112,37 +108,33 @@
|
||||
href="#root/_help_OFXdgB2nNk1F">Promoted Attributes</a>). The easiest way to
|
||||
add these is:</p>
|
||||
<ol>
|
||||
<li data-list-item-id="e63c976202ef9f633570f685d391b5e50">Go to board note.</li>
|
||||
<li data-list-item-id="ea821edb6d448b1bde26f9d756b4b0fec">In the ribbon select <em>Owned Attributes</em> → plus button → <em>Add new label/relation definition</em>.</li>
|
||||
<li
|
||||
data-list-item-id="e94dd8b134591fe71e2dcea3506247df6">Configure the attribute as desired.</li>
|
||||
<li data-list-item-id="ea08e72fd3555837459105e19c12c1e33">Check <em>Inheritable</em> to make it applicable to child notes automatically.</li>
|
||||
<li>Go to board note.</li>
|
||||
<li>In the ribbon select <em>Owned Attributes</em> → plus button → <em>Add new label/relation definition</em>.</li>
|
||||
<li>Configure the attribute as desired.</li>
|
||||
<li>Check <em>Inheritable</em> to make it applicable to child notes automatically.</li>
|
||||
</ol>
|
||||
<p>After creating the attribute, click on a note and fill in the promoted
|
||||
attributes which should then reflect inside the board.</p>
|
||||
<p>Of note:</p>
|
||||
<ul>
|
||||
<li data-list-item-id="eb9e8b5e12e3dc2f5410bc10ba091d552">Both promoted and non-promoted attribute definitions are supported. The
|
||||
<li>Both promoted and non-promoted attribute definitions are supported. The
|
||||
only difference is that non-promoted attributes don't have an “Alias” for
|
||||
assigning a custom name.</li>
|
||||
<li data-list-item-id="ee41e79b02872367b2c5f2c4f88c3da41">Both “Single value” and “Multi value” attributes are supported. In case
|
||||
<li>Both “Single value” and “Multi value” attributes are supported. In case
|
||||
of multi-value, a badge is displayed for every instance of the attribute.</li>
|
||||
<li
|
||||
data-list-item-id="eb4d6fdbc5f52e70263706b3f51d929e3">All label types are supported, including dates, booleans and URLs.</li>
|
||||
<li
|
||||
data-list-item-id="ec141a7d5aca14f33f58abb3fdb1ab2e3">Relation attributes are also supported as well, showing a link with the
|
||||
<li>All label types are supported, including dates, booleans and URLs.</li>
|
||||
<li>Relation attributes are also supported as well, showing a link with the
|
||||
target note title and icon.</li>
|
||||
<li data-list-item-id="ef13f98f321ca5b0b0ea881966e7a8ce9">Currently, it's not possible to adjust which promoted attributes are displayed,
|
||||
since all promoted attributes will be displayed (except the <code spellcheck="false">board:groupBy</code> one).
|
||||
<li>Currently, it's not possible to adjust which promoted attributes are displayed,
|
||||
since all promoted attributes will be displayed (except the <code>board:groupBy</code> one).
|
||||
There are plans to improve upon this being able to hide promoted attributes
|
||||
individually.</li>
|
||||
</ul>
|
||||
<h3>Grouping by another label</h3>
|
||||
<p>By default, the label used to group the notes is <code spellcheck="false">#status</code>.
|
||||
It is possible to use a different label if needed by defining a label named
|
||||
<code
|
||||
spellcheck="false">#board:groupBy</code>with the value being the attribute to use (with or
|
||||
without <code spellcheck="false">#</code> attribute prefix).</p>
|
||||
<p>By default, the label used to group the notes is <code>#status</code>.
|
||||
It is possible to use a different label if needed by defining a label named <code>#board:groupBy</code> with
|
||||
the value being the attribute to use (with or without <code>#</code> attribute
|
||||
prefix).</p>
|
||||
<h3>Grouping by relations</h3>
|
||||
<figure class="image image-style-align-right">
|
||||
<img style="aspect-ratio:535/245;" src="1_Kanban Board_image.png"
|
||||
@ -151,34 +143,34 @@
|
||||
<p>A more advanced use-case is grouping by <a href="#root/_help_Cq5X6iKQop6R">Relations</a>.</p>
|
||||
<p>During this mode:</p>
|
||||
<ul>
|
||||
<li data-list-item-id="e8b12352beeecdc5fbba7ab2cc8c17ebf">The columns represent the <em>target notes</em> of a relation.</li>
|
||||
<li data-list-item-id="e93e74a0b91864714971460d4f0c70d7c">When creating a new column, a note is selected instead of a column name.</li>
|
||||
<li
|
||||
data-list-item-id="ef5f8b62aea5f50ce16fd0eb7ec2da8a9">The column icon will match the target note.</li>
|
||||
<li data-list-item-id="e1a406b952707601c17f59b79b428fcc4">Moving notes between columns will change its relation.</li>
|
||||
<li data-list-item-id="e26ad186c049342b5071dbd7e288c34a5">Renaming an existing column will change the target note of all the notes
|
||||
<li>The columns represent the <em>target notes</em> of a relation.</li>
|
||||
<li>When creating a new column, a note is selected instead of a column name.</li>
|
||||
<li>The column icon will match the target note.</li>
|
||||
<li>Moving notes between columns will change its relation.</li>
|
||||
<li>Renaming an existing column will change the target note of all the notes
|
||||
in that column.</li>
|
||||
</ul>
|
||||
<p>Using relations instead of labels has some benefits:</p>
|
||||
<ul>
|
||||
<li data-list-item-id="e023fc2ef6ec6e976dc81d3e2b0fd0c46">The status/grouping of the notes is visible outside the Kanban board,
|
||||
<li>The status/grouping of the notes is visible outside the Kanban board,
|
||||
for example on the <a class="reference-link" href="#root/_help_bdUJEHsAPYQR">Note Map</a>.</li>
|
||||
<li
|
||||
data-list-item-id="e3b0b352a62b78f4ec2cf335e054f1cac">Columns can have icons.</li>
|
||||
<li data-list-item-id="e5646f801237c13c7ddd600eecffea714">Renaming columns is less intensive since it simply involves changing the
|
||||
<li>Columns can have icons.</li>
|
||||
<li>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.</li>
|
||||
</ul>
|
||||
<p>To do so:</p>
|
||||
<ol>
|
||||
<li data-list-item-id="ecd59797f1fe062de6118a1020034f761">First, create a Kanban board from scratch and not a template:</li>
|
||||
<li
|
||||
data-list-item-id="ea3e28bea94fae0e37b0319a1e2c0f48c">Assign <code spellcheck="false">#viewType=board #hidePromotedAttributes</code> to
|
||||
emulate the default template.</li>
|
||||
<li data-list-item-id="e063e32f35af1b206b060779666db84e5">Set <code spellcheck="false">#board:groupBy</code> to the name of a relation
|
||||
to group by, <strong>including the</strong> <code spellcheck="false">~</code> <strong>prefix</strong> (e.g.
|
||||
<code
|
||||
spellcheck="false">~status</code>).</li>
|
||||
<li data-list-item-id="e079874488794f7fa65ea90c7aa6a71a9">
|
||||
<li>
|
||||
<p>First, create a Kanban board from scratch and not a template:</p>
|
||||
</li>
|
||||
<li>
|
||||
<p>Assign <code>#viewType=board #hidePromotedAttributes</code> to emulate the
|
||||
default template.</p>
|
||||
</li>
|
||||
<li>
|
||||
<p>Set <code>#board:groupBy</code> to the name of a relation to group by, <strong>including the</strong> <code>~</code> <strong>prefix</strong> (e.g. <code>~status</code>).</p>
|
||||
</li>
|
||||
<li>
|
||||
<p>Optionally, use <a class="reference-link" href="#root/_help_OFXdgB2nNk1F">Promoted Attributes</a> for
|
||||
easy status change within the note:</p><pre><code class="language-text-x-trilium-auto">#relation:status(inheritable)="promoted,alias=Status,single"</code></pre>
|
||||
</li>
|
||||
|
||||
@ -1,5 +1,5 @@
|
||||
# Documentation
|
||||
There are multiple types of documentation for Trilium:<img class="image-style-align-right" src="api/images/lONK7oKNhIgu/Documentation_image.png" width="205" height="162">
|
||||
There are multiple types of documentation for Trilium:<img class="image-style-align-right" src="api/images/Y3urZDbSOH6u/Documentation_image.png" width="205" height="162">
|
||||
|
||||
* The _User Guide_ represents the user-facing documentation. This documentation can be browsed by users directly from within Trilium, by pressing <kbd>F1</kbd>.
|
||||
* The _Developer's Guide_ represents a set of Markdown documents that present the internals of Trilium, for developers.
|
||||
|
||||
294
docs/User Guide/!!!meta.json
vendored
@ -2851,6 +2851,20 @@
|
||||
"value": "note-buttons",
|
||||
"isInheritable": false,
|
||||
"position": 60
|
||||
},
|
||||
{
|
||||
"type": "relation",
|
||||
"name": "internalLink",
|
||||
"value": "IjZS7iK5EXtb",
|
||||
"isInheritable": false,
|
||||
"position": 70
|
||||
},
|
||||
{
|
||||
"type": "relation",
|
||||
"name": "internalLink",
|
||||
"value": "W8vYD3Q1zjCR",
|
||||
"isInheritable": false,
|
||||
"position": 80
|
||||
}
|
||||
],
|
||||
"format": "markdown",
|
||||
@ -3436,6 +3450,286 @@
|
||||
"dataFileName": "Note Tooltip_image.png"
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
"isClone": false,
|
||||
"noteId": "IjZS7iK5EXtb",
|
||||
"notePath": [
|
||||
"pOsGYCXsbNQG",
|
||||
"gh7bpGYxajRS",
|
||||
"Vc8PjrjAGuOp",
|
||||
"IjZS7iK5EXtb"
|
||||
],
|
||||
"title": "New Layout",
|
||||
"notePosition": 220,
|
||||
"prefix": null,
|
||||
"isExpanded": false,
|
||||
"type": "text",
|
||||
"mime": "text/html",
|
||||
"attributes": [
|
||||
{
|
||||
"type": "label",
|
||||
"name": "iconClass",
|
||||
"value": "bx bx-layout",
|
||||
"isInheritable": false,
|
||||
"position": 30
|
||||
},
|
||||
{
|
||||
"type": "relation",
|
||||
"name": "internalLink",
|
||||
"value": "4TIF1oA4VQRO",
|
||||
"isInheritable": false,
|
||||
"position": 40
|
||||
},
|
||||
{
|
||||
"type": "relation",
|
||||
"name": "internalLink",
|
||||
"value": "iPIMuisry3hd",
|
||||
"isInheritable": false,
|
||||
"position": 50
|
||||
},
|
||||
{
|
||||
"type": "relation",
|
||||
"name": "internalLink",
|
||||
"value": "6f9hih2hXXZk",
|
||||
"isInheritable": false,
|
||||
"position": 60
|
||||
},
|
||||
{
|
||||
"type": "relation",
|
||||
"name": "internalLink",
|
||||
"value": "KC1HB96bqqHX",
|
||||
"isInheritable": false,
|
||||
"position": 70
|
||||
},
|
||||
{
|
||||
"type": "relation",
|
||||
"name": "internalLink",
|
||||
"value": "8YBEPzcpUgxw",
|
||||
"isInheritable": false,
|
||||
"position": 80
|
||||
},
|
||||
{
|
||||
"type": "relation",
|
||||
"name": "internalLink",
|
||||
"value": "grjYqerjn243",
|
||||
"isInheritable": false,
|
||||
"position": 90
|
||||
},
|
||||
{
|
||||
"type": "relation",
|
||||
"name": "internalLink",
|
||||
"value": "XpOYSgsLkTJy",
|
||||
"isInheritable": false,
|
||||
"position": 100
|
||||
},
|
||||
{
|
||||
"type": "relation",
|
||||
"name": "internalLink",
|
||||
"value": "cbkrhQjrkKrh",
|
||||
"isInheritable": false,
|
||||
"position": 110
|
||||
},
|
||||
{
|
||||
"type": "relation",
|
||||
"name": "internalLink",
|
||||
"value": "MtPxeAWVAzMg",
|
||||
"isInheritable": false,
|
||||
"position": 120
|
||||
},
|
||||
{
|
||||
"type": "relation",
|
||||
"name": "internalLink",
|
||||
"value": "CdNpE2pqjmI6",
|
||||
"isInheritable": false,
|
||||
"position": 140
|
||||
},
|
||||
{
|
||||
"type": "relation",
|
||||
"name": "internalLink",
|
||||
"value": "YKWqdJhzi2VY",
|
||||
"isInheritable": false,
|
||||
"position": 150
|
||||
},
|
||||
{
|
||||
"type": "relation",
|
||||
"name": "internalLink",
|
||||
"value": "veGu4faJErEM",
|
||||
"isInheritable": false,
|
||||
"position": 160
|
||||
},
|
||||
{
|
||||
"type": "relation",
|
||||
"name": "internalLink",
|
||||
"value": "zEY4DaJG4YT5",
|
||||
"isInheritable": false,
|
||||
"position": 170
|
||||
},
|
||||
{
|
||||
"type": "relation",
|
||||
"name": "internalLink",
|
||||
"value": "AlJ73vBCjWDw",
|
||||
"isInheritable": false,
|
||||
"position": 180
|
||||
},
|
||||
{
|
||||
"type": "relation",
|
||||
"name": "internalLink",
|
||||
"value": "l0tKav7yLHGF",
|
||||
"isInheritable": false,
|
||||
"position": 190
|
||||
},
|
||||
{
|
||||
"type": "relation",
|
||||
"name": "internalLink",
|
||||
"value": "eIg8jdvaoNNd",
|
||||
"isInheritable": false,
|
||||
"position": 200
|
||||
},
|
||||
{
|
||||
"type": "relation",
|
||||
"name": "internalLink",
|
||||
"value": "m523cpzocqaD",
|
||||
"isInheritable": false,
|
||||
"position": 210
|
||||
}
|
||||
],
|
||||
"format": "markdown",
|
||||
"dataFileName": "New Layout.md",
|
||||
"attachments": [
|
||||
{
|
||||
"attachmentId": "3DFGaMiTTHQ1",
|
||||
"title": "image.png",
|
||||
"role": "image",
|
||||
"mime": "image/png",
|
||||
"position": 10,
|
||||
"dataFileName": "New Layout_image.png"
|
||||
},
|
||||
{
|
||||
"attachmentId": "6iN5nrmdwG6z",
|
||||
"title": "image.png",
|
||||
"role": "image",
|
||||
"mime": "image/png",
|
||||
"position": 10,
|
||||
"dataFileName": "1_New Layout_image.png"
|
||||
},
|
||||
{
|
||||
"attachmentId": "KvNAEoJjRhyr",
|
||||
"title": "image.png",
|
||||
"role": "image",
|
||||
"mime": "image/png",
|
||||
"position": 10,
|
||||
"dataFileName": "2_New Layout_image.png"
|
||||
},
|
||||
{
|
||||
"attachmentId": "lEKxf6dYMG6u",
|
||||
"title": "image.png",
|
||||
"role": "image",
|
||||
"mime": "image/png",
|
||||
"position": 10,
|
||||
"dataFileName": "3_New Layout_image.png"
|
||||
},
|
||||
{
|
||||
"attachmentId": "SYOTVGCyx749",
|
||||
"title": "image.png",
|
||||
"role": "image",
|
||||
"mime": "image/png",
|
||||
"position": 10,
|
||||
"dataFileName": "4_New Layout_image.png"
|
||||
},
|
||||
{
|
||||
"attachmentId": "wCwzwfGspejR",
|
||||
"title": "image.png",
|
||||
"role": "image",
|
||||
"mime": "image/png",
|
||||
"position": 10,
|
||||
"dataFileName": "5_New Layout_image.png"
|
||||
}
|
||||
],
|
||||
"dirFileName": "New Layout",
|
||||
"children": [
|
||||
{
|
||||
"isClone": false,
|
||||
"noteId": "I6p2a06hdnL6",
|
||||
"notePath": [
|
||||
"pOsGYCXsbNQG",
|
||||
"gh7bpGYxajRS",
|
||||
"Vc8PjrjAGuOp",
|
||||
"IjZS7iK5EXtb",
|
||||
"I6p2a06hdnL6"
|
||||
],
|
||||
"title": "Breadcrumb",
|
||||
"notePosition": 10,
|
||||
"prefix": null,
|
||||
"isExpanded": false,
|
||||
"type": "text",
|
||||
"mime": "text/html",
|
||||
"attributes": [
|
||||
{
|
||||
"type": "relation",
|
||||
"name": "internalLink",
|
||||
"value": "AlJ73vBCjWDw",
|
||||
"isInheritable": false,
|
||||
"position": 30
|
||||
},
|
||||
{
|
||||
"type": "label",
|
||||
"name": "iconClass",
|
||||
"value": "bx bx-chevron-right",
|
||||
"isInheritable": false,
|
||||
"position": 40
|
||||
}
|
||||
],
|
||||
"format": "markdown",
|
||||
"dataFileName": "Breadcrumb.md",
|
||||
"attachments": [
|
||||
{
|
||||
"attachmentId": "CjYmaJD0L1D4",
|
||||
"title": "image.png",
|
||||
"role": "image",
|
||||
"mime": "image/png",
|
||||
"position": 10,
|
||||
"dataFileName": "Breadcrumb_image.png"
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
"isClone": false,
|
||||
"noteId": "AlJ73vBCjWDw",
|
||||
"notePath": [
|
||||
"pOsGYCXsbNQG",
|
||||
"gh7bpGYxajRS",
|
||||
"Vc8PjrjAGuOp",
|
||||
"IjZS7iK5EXtb",
|
||||
"AlJ73vBCjWDw"
|
||||
],
|
||||
"title": "Status bar",
|
||||
"notePosition": 20,
|
||||
"prefix": null,
|
||||
"isExpanded": false,
|
||||
"type": "text",
|
||||
"mime": "text/html",
|
||||
"attributes": [
|
||||
{
|
||||
"type": "relation",
|
||||
"name": "internalLink",
|
||||
"value": "I6p2a06hdnL6",
|
||||
"isInheritable": false,
|
||||
"position": 30
|
||||
},
|
||||
{
|
||||
"type": "label",
|
||||
"name": "iconClass",
|
||||
"value": "bx bx-dock-bottom",
|
||||
"isInheritable": false,
|
||||
"position": 40
|
||||
}
|
||||
],
|
||||
"format": "markdown",
|
||||
"dataFileName": "Status bar.md",
|
||||
"attachments": []
|
||||
}
|
||||
]
|
||||
}
|
||||
]
|
||||
},
|
||||
|
||||
BIN
docs/User Guide/User Guide/Basic Concepts and Features/UI Elements/1_New Layout_image.png
vendored
Normal file
|
After Width: | Height: | Size: 21 KiB |
BIN
docs/User Guide/User Guide/Basic Concepts and Features/UI Elements/2_New Layout_image.png
vendored
Normal file
|
After Width: | Height: | Size: 10 KiB |
BIN
docs/User Guide/User Guide/Basic Concepts and Features/UI Elements/3_New Layout_image.png
vendored
Normal file
|
After Width: | Height: | Size: 3.7 KiB |
BIN
docs/User Guide/User Guide/Basic Concepts and Features/UI Elements/4_New Layout_image.png
vendored
Normal file
|
After Width: | Height: | Size: 7.2 KiB |
BIN
docs/User Guide/User Guide/Basic Concepts and Features/UI Elements/5_New Layout_image.png
vendored
Normal file
|
After Width: | Height: | Size: 23 KiB |
114
docs/User Guide/User Guide/Basic Concepts and Features/UI Elements/New Layout.md
vendored
Normal file
@ -0,0 +1,114 @@
|
||||
# New Layout
|
||||
The _New layout_ is a series of UI/UX changes that were introduced in v0.101.0 that heavily change both existing UI elements, as well as adding some new ones. The goal of this new layout is to modernize the application and to make it more intuitive but at the same time to reduce clutter.
|
||||
|
||||
## Newly introduced features
|
||||
|
||||
### Status bar
|
||||
|
||||
At the bottom of the window there is a new bar called the _Status bar_. This bar houses multiple items such as the Breadcrumb navigation and information and settings about the current note, such as the [content language](../../Note%20Types/Text/Content%20language%20%26%20Right-to-le.md) and <a class="reference-link" href="../../Advanced%20Usage/Attributes.md">Attributes</a>.
|
||||
|
||||
For more information, consult the [dedicated page](New%20Layout/Status%20bar.md).
|
||||
|
||||
<figure class="image"><img style="aspect-ratio:1150/27;" src="4_New Layout_image.png" width="1150" height="27"></figure>
|
||||
|
||||
### Inline title
|
||||
|
||||
In previous versions of Trilium, the title bar was fixed at all times. In the new layout, there is both a fixed title bar and one that scrolls with the text. The newly introduced title is called the _Inline title_ and it displays the title in a larger font, while also displaying additional information such as the creation and the modification date.
|
||||
|
||||
Whenever the title is scrolled past, the fixed title is shown instead.
|
||||
|
||||
This only affects <a class="reference-link" href="../../Note%20Types/Text.md">Text</a> and <a class="reference-link" href="../../Note%20Types/Code.md">Code</a> notes. Note types that take the entirety of the screen such as <a class="reference-link" href="../../Note%20Types/Canvas.md">Canvas</a> will always have only the fixed title bar.
|
||||
|
||||
Depending on the note type, the inline title will also present some more interactive options such as being able to switch the note type (see below).
|
||||
|
||||
<figure class="image"><img style="aspect-ratio:899/122;" src="New Layout_image.png" width="899" height="122"><figcaption>The <em>Inline title</em>, which is displayed at the top of the note and can be scrolled past.</figcaption></figure><figure class="image"><img style="aspect-ratio:910/104;" src="3_New Layout_image.png" width="910" height="104"><figcaption>The fixed title bar. The title only appears after scrolling past the <em>Inline title</em>.</figcaption></figure>
|
||||
|
||||
### New note type switcher
|
||||
|
||||
When a new <a class="reference-link" href="../../Note%20Types/Text.md">Text</a> or <a class="reference-link" href="../../Note%20Types/Code.md">Code</a> note is created, a note type switcher will appear below the _Inline title_. Apart from changing the note type, it's also possible to apply a [template](../../Advanced%20Usage/Templates.md).
|
||||
|
||||
The switcher will disappear as soon as a text is entered.
|
||||
|
||||
<img src="5_New Layout_image.png" width="735" height="143">
|
||||
|
||||
### Note badges
|
||||
|
||||
Note badges appear near the fixed note title and indicate important information about the note such as whether it is read-only. Some of the badges are also interactive.
|
||||
|
||||
<figure class="image"><img style="aspect-ratio:910/49;" src="2_New Layout_image.png" width="910" height="49"></figure>
|
||||
|
||||
The following badges are available:
|
||||
|
||||
* **Read-only badge**, which will be shown if the note is not editable due to either automatic read-only or manual read-only. Clicking on the badge will temporarily edit the note (similar to the Edit [floating button](Floating%20buttons.md)).
|
||||
* **Share badge**, which will indicate that the current note is shared. The badge will also indicate if the share is on the local network (for the desktop application without <a class="reference-link" href="../../Installation%20%26%20Setup/Synchronization.md">Synchronization</a> set up) or publicly accessible (for the server).
|
||||
* **Web clip badge**, which will indicate if the note was clipped using the <a class="reference-link" href="../../Installation%20%26%20Setup/Web%20Clipper.md">Web Clipper</a>. The badge acts as a link, so it can be clicked on to navigate to the page or right clicked for more options.
|
||||
* **Execute badge**, for [scripts](../../Scripting.md) or [saved SQL queries](../../Advanced%20Usage/Database/Manually%20altering%20the%20database/SQL%20Console.md) which have an execute button or a description.
|
||||
|
||||
Some of these badges replace the dedicated panels at the top of the note.
|
||||
|
||||
### Collapsible sections
|
||||
|
||||
<figure class="image"><img style="aspect-ratio:496/265;" src="1_New Layout_image.png" width="496" height="265"></figure>
|
||||
|
||||
The following sections have been made collapsible:
|
||||
|
||||
* _Promoted Attributes_
|
||||
* For full-height notes such as <a class="reference-link" href="../../Note%20Types/Canvas.md">Canvas</a>, the promoted attributes are collapsed by default to make room.
|
||||
* The keyboard shortcut previously used to trigger the promoted attributes ribbon tab (which was no longer working) has been repurposed to toggle the promoted attributes instead.
|
||||
* _Edited Notes_, which appears for <a class="reference-link" href="../../Advanced%20Usage/Advanced%20Showcases/Day%20Notes.md">Day Notes</a> is now shown underneath the title.
|
||||
* Whether the section is collapsed or not depends on the choice in <a class="reference-link" href="Options.md">Options</a> → Appearance.
|
||||
* _Search Properties_, which appears for the full <a class="reference-link" href="../Navigation/Search.md">Search</a> and <a class="reference-link" href="../../Note%20Types/Saved%20Search.md">Saved Search</a>.
|
||||
|
||||
## Changing to the existing layout
|
||||
|
||||
### Removal of the ribbon
|
||||
|
||||
The most significant change is the removal of the ribbon. All the actions and options from the ribbon were integrated in other places in the application.
|
||||
|
||||
Here's how all the different tabs that were once part of the ribbon are now available in the new layout:
|
||||
|
||||
* “Formatting toolbar” was relocated to the top of the page.
|
||||
* Instead of having one per split, now there is a single formatting toolbar per tab. This allows more space for the toolbar items.
|
||||
* “Owned attributes” and “Inherited attributes” were merged and moved to the status bar region (displayed one above the other).
|
||||
* “Basic Properties” were integrated in the <a class="reference-link" href="Note%20buttons.md">Note buttons</a> menu.
|
||||
* The only exception here is the Language combo box which can now be found in the status bar (top-right of the screen).
|
||||
* “File” and “Image” tabs
|
||||
* The buttons were moved to the right of the note title, as dedicated entries in <a class="reference-link" href="Note%20buttons.md">Note buttons</a>.
|
||||
* The info section has been merged into the _Note info_ section of the status bar.
|
||||
* Edited notes
|
||||
* Moved underneath the title, displayed under a collapsible area and the notes are represented as badges/chips.
|
||||
* Whether the section is expanded or collapsed depends on the “Edited Notes ribbon tab will automatically open on day notes” setting from Options → Appearance.
|
||||
* Search definition tab
|
||||
* Moved underneath the title under a collapsible area.
|
||||
* Expanded by default for new searches, collapsed for saved searches.
|
||||
* The Note map is now available in the Note actions menu.
|
||||
* Instead of opening into a panel in the ribbon, the note map now opens in a side split (similar to the in-app help).
|
||||
* “Note info” tab was moved to a small (i) icon in the status bar.
|
||||
* “Similar notes” tab
|
||||
* Moved to the status bar, by going to the “Note info” section and pressing the button to show similar notes.
|
||||
* Displayed as a fixed panel, similar to the attributes.
|
||||
* The Collection properties tab were relocated under the note title and grouped into:
|
||||
* A combo box to quickly switch between views.
|
||||
* Individual settings for the current view in a submenu.
|
||||
* Some smaller ribbon tabs were converted to badges that appear near the note title in the breadcrumb section:
|
||||
* Original URL indicator for clipped web pages (`#pageUrl`).
|
||||
* SQL and script execute buttons.
|
||||
|
||||
> [!NOTE]
|
||||
> The ribbon keyboard shortcuts (e.g. `toggleRibbonTabClassicEditor`) have been repurposed to work on the new layout, where they will toggle the appropriate panel.
|
||||
|
||||
### Removal of the floating buttons
|
||||
|
||||
Most of the buttons were relocated to the right of the note title, in the <a class="reference-link" href="Note%20buttons.md">Note buttons</a> area, with the exception of:
|
||||
|
||||
* The Edit button is displayed near the note title, as a badge.
|
||||
* _Backlinks_ is displayed in the status bar. When clicked, the same list of backlinks is displayed.
|
||||
* Relation map zoom buttons are now part of the relation map itself.
|
||||
* Export image to PNG/SVG are now in the Note actions menu, in the _Export as image_ option.
|
||||
|
||||
## How to toggle the new layout
|
||||
|
||||
Starting with v0.101.0, this new layout is enabled by default. It is possible to fall back to the old layout by going to <a class="reference-link" href="Options.md">Options</a> → Appearance and selecting _Old layout_.
|
||||
|
||||
> [!IMPORTANT]
|
||||
> Since a new layout was introduced, this becomes the standard one. The _Old layout_ is considered deprecated and will not receive new features (for example, the breadcrumb) as we focus on the new one. At some point the old layout will be removed entirely, as maintaining two layouts with major differences creates a maintenance burden.
|
||||
26
docs/User Guide/User Guide/Basic Concepts and Features/UI Elements/New Layout/Breadcrumb.md
vendored
Normal file
@ -0,0 +1,26 @@
|
||||
# Breadcrumb
|
||||
<figure class="image"><img style="aspect-ratio:1150/27;" src="Breadcrumb_image.png" width="1150" height="27"></figure>
|
||||
|
||||
The breadcrumb allows quickly viewing the note hierarchy of the current note and navigating through it.
|
||||
|
||||
It is part of the <a class="reference-link" href="Status%20bar.md">Status bar</a>, displayed in the bottom-left of the screen.
|
||||
|
||||
## Layout and Interaction
|
||||
|
||||
* If a note or workspace is hoisted, a badge will appear on the left-most side.
|
||||
* Clicking on the badge will un-hoist the note/workspace.
|
||||
* The left-most icon represents the root note, or the hoisted note or workspace.
|
||||
* Clicking the icon will jump to the root note.
|
||||
* Right clicking the icon will display a menu that allows opening the note in a new tab, split, etc.
|
||||
* Each segment shows the title of a note in the current note hierarchy.
|
||||
* Clicking the icon will jump to that note.
|
||||
* Right clicking will open a menu with multiple options such as opening the note in a different tab/split/window, hoisting, moving/cloning the note, duplicating as well as changing the color of the note.
|
||||
* Clicking the arrow next to each segment will reveal the child notes of the segment on the left.
|
||||
* Clicking on an icon will navigate to that particular note.
|
||||
* It's also possible to create a new child note from here.
|
||||
* The menu can optionally hide the archived notes.
|
||||
* If the current note is deep within a hierarchy, the segments will collapse into a \[…\] button in order not to occupy too much space.
|
||||
* Clicking this button will display each collapsed entry as a menu item. Clicking on it will navigate to that particular note.
|
||||
* Right clicking on an empty space to the right of the breadcrumb (before the other status bar items) will reveal another menu that allows:
|
||||
* Toggling whether archived notes are displayed in the breadcrumb and in the note tree.
|
||||
* Copying the current note path to clipboard.
|
||||
BIN
docs/User Guide/User Guide/Basic Concepts and Features/UI Elements/New Layout/Breadcrumb_image.png
vendored
Normal file
|
After Width: | Height: | Size: 7.2 KiB |
27
docs/User Guide/User Guide/Basic Concepts and Features/UI Elements/New Layout/Status bar.md
vendored
Normal file
@ -0,0 +1,27 @@
|
||||
# Status bar
|
||||
The status bar displays information about the current note and allows changing settings related to it such as configuring the language or attributes.
|
||||
|
||||
## Layout and interaction
|
||||
|
||||
On the left side, the <a class="reference-link" href="Breadcrumb.md">Breadcrumb</a> is displayed which indicates the current note as well as its parent notes and allows for quick navigation throughout the hierarchy.
|
||||
|
||||
On the right side, specific sections will show depending on the type of the current note.
|
||||
|
||||
1. For code notes, the language mode of the note is indicated (e.g. JavaScript, plain text), as well as allowing easy switching to another mode.
|
||||
2. For text notes, the content language is displayed and can be changed, thus configuring the spell-check and the right-to-left support.
|
||||
1. Note that this applies to the entire note and not the selection, unlike some text editors.
|
||||
3. If a note is placed in multiple places in the tree (cloned), the number of the note paths will be displayed.
|
||||
1. Clicking it will reveal the full list of note paths and a button to place it somewhere else.
|
||||
4. If a note has attachments, their number will be displayed.
|
||||
1. Clicking on it will reveal the list of attachments in a new tab.
|
||||
5. If a note is linked from other text notes (backlinks), the number of backlinks will be displayed.
|
||||
1. Clicking on it will show the list of notes that link to this note, as well as an excerpt of where the note is referenced.
|
||||
|
||||
Regardless of note type, the following items will always be displayed if there is a note:
|
||||
|
||||
1. Note info, which displays:
|
||||
1. The creation/modification date of the note.
|
||||
2. The type and MIME of the note.
|
||||
3. The note ID.
|
||||
4. An estimation of the note size of the note itself and its children.
|
||||
5. A button to show Similar notes.
|
||||
BIN
docs/User Guide/User Guide/Basic Concepts and Features/UI Elements/New Layout_image.png
vendored
Normal file
|
After Width: | Height: | Size: 9.9 KiB |
@ -3,3 +3,5 @@ To the right of the [Ribbon](Ribbon.md) there are a few more buttons:  for that particular note.
|
||||
* The contextual menu offers commands for the note or its subtree, such as import, export, viewing the [Note source code](../../Advanced%20Usage/Note%20source.md) or [Attachments](../Notes/Attachments.md).
|
||||
|
||||
On the <a class="reference-link" href="New%20Layout.md">New Layout</a>, the button area is populated by some more buttons that are specific to the current note. For example, for Image and <a class="reference-link" href="../../Note%20Types/File.md">File</a> notes, the download and copy buttons were relocated there.
|
||||