mirror of
https://github.com/zadam/trilium.git
synced 2025-12-21 23:04:24 +01:00
feat(docs): improve link docs organization
This commit is contained in:
Chris Cavalluzzi
parent
58e2111a8f
commit
51bbf71577
30
apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Text/Links.html
generated
vendored
30
apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Text/Links.html
generated
vendored
@ -1,34 +1,10 @@
|
|||||||
<p>There are two types of links:</p>
|
<p>There are two types of links:</p>
|
||||||
<ul>
|
<ul>
|
||||||
<li><a class="reference-link" href="#root/_help_3IDVtesTQ8ds">External links</a>,
|
<li data-list-item-id="e82c51490700a6d914cdc583aaa7f2d50"><a class="reference-link" href="#root/_help_3IDVtesTQ8ds">External links</a>,
|
||||||
for standard hyperlinks to websites or other resources.</li>
|
for standard hyperlinks to websites or other resources.</li>
|
||||||
<li><a class="reference-link" href="#root/_help_hrZ1D00cLbal">Internal (reference) links</a> for
|
<li data-list-item-id="e42214142bbcd7f5561ed2934cbe1d89d"><a class="reference-link" href="#root/_help_hrZ1D00cLbal">Internal (reference) links</a> for
|
||||||
links to other notes within Trilium.</li>
|
links to other notes within Trilium.</li>
|
||||||
</ul>
|
</ul>
|
||||||
<h2>Pasting links</h2>
|
|
||||||
<ul>
|
|
||||||
<li>For internal links (links to notes in Trilium), press Ctrl+C in the
|
|
||||||
<a
|
|
||||||
class="reference-link" href="#root/_help_oPVyFC7WL2Lp">Note Tree</a>:
|
|
||||||
<ul>
|
|
||||||
<li>Pasting directly in a text note will create a reference link (with an
|
|
||||||
icon to the note and the actual note title).</li>
|
|
||||||
<li>Pasting over an existing text will create a traditional link.</li>
|
|
||||||
</ul>
|
|
||||||
</li>
|
|
||||||
<li>For external links:
|
|
||||||
<ul>
|
|
||||||
<li>Paste the raw URL directly and press space to turn it into a link.</li>
|
|
||||||
<li>Select a text and paste the URL over it to turn that text into a link.</li>
|
|
||||||
<li>If you are pasting a formatted link (e.g. from the a webpage in a browser),
|
|
||||||
simply paste it and it will keep the original text and URL.</li>
|
|
||||||
</ul>
|
|
||||||
</li>
|
|
||||||
</ul>
|
|
||||||
<h2>In-place linking</h2>
|
|
||||||
<p>Trilium also provides "inline" linking - type <code>@</code> and you'll
|
|
||||||
see an autocomplete, just type few characters from the desired note title,
|
|
||||||
press enter and you have a link.</p>
|
|
||||||
<h2>Note map</h2>
|
<h2>Note map</h2>
|
||||||
<p>Trilium provides a visualisation of incoming and outgoing links for a
|
<p>Trilium provides a visualization of incoming and outgoing links for a
|
||||||
particular note. See <a href="#root/_help_BCkXAVs63Ttv">note map</a> for details.</p>
|
particular note. See <a href="#root/_help_BCkXAVs63Ttv">note map</a> for details.</p>
|
||||||
BIN
apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Text/Links/1_Internal (reference) links.png
generated
vendored
Normal file
BIN
apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Text/Links/1_Internal (reference) links.png
generated
vendored
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 178 B |
@ -3,36 +3,37 @@
|
|||||||
an external link to a Wikipedia page.</p>
|
an external link to a Wikipedia page.</p>
|
||||||
<p>To create a link without a custom text:</p>
|
<p>To create a link without a custom text:</p>
|
||||||
<ul>
|
<ul>
|
||||||
<li>Press
|
<li data-list-item-id="ef1f1d08f83256d9cd0decde4b9946a45">Press
|
||||||
<img src="1_External links_image.png"
|
<img src="1_External links_image.png"
|
||||||
width="15" height="16">in the <a class="reference-link" href="#root/_help_nRhnJkTT8cPs">Formatting toolbar</a>:
|
width="15" height="16">in the <a class="reference-link" href="#root/_help_nRhnJkTT8cPs">Formatting toolbar</a>:
|
||||||
<ul>
|
<ul>
|
||||||
<li>A popup will appear, type or paste the URL in the box.</li>
|
<li data-list-item-id="e42aacb027baa00ee585f946e926a3142">A popup will appear, type or paste the URL in the box.</li>
|
||||||
<li>Press <kbd>Enter</kbd> or the check mark icon to confirm.</li>
|
<li data-list-item-id="ea8819fbae5cadb9c41c4bfbc7d1aee49">Press <kbd>Enter</kbd> or the check mark icon to confirm.</li>
|
||||||
</ul>
|
</ul>
|
||||||
</li>
|
</li>
|
||||||
<li>Alternatively, press <kbd>Ctrl</kbd>+<kbd>K</kbd> to trigger the aforementioned
|
<li data-list-item-id="e9a43f0407bfe86c11301bbc7f382d4bc">Alternatively, press <kbd>Ctrl</kbd>+<kbd>K</kbd> to trigger the aforementioned
|
||||||
popup.</li>
|
popup.</li>
|
||||||
<li>A simpler way is to paste the raw link and press space to turn it automatically
|
<li data-list-item-id="e29b802b4a875d815f0c22d9344d3576f">A simpler way is to paste the raw link and press space to turn it automatically
|
||||||
into a link.</li>
|
into a link.</li>
|
||||||
</ul>
|
</ul>
|
||||||
<p>To create a link with a custom text:</p>
|
<p>To create a link with a custom text:</p>
|
||||||
<ul>
|
<ul>
|
||||||
<li>First, type and select the text which will be turned into a link.</li>
|
<li data-list-item-id="ef3e27921557ab03c3c923dadc4ee5e7e">First, type and select the text which will be turned into a link.</li>
|
||||||
<li>Follow the previous steps to open the link interface (via the formatting
|
<li
|
||||||
|
data-list-item-id="e7d152d5b0b188b915549ece3e0bab5d7">Follow the previous steps to open the link interface (via the formatting
|
||||||
toolbar, or <kbd>Ctrl</kbd>+<kbd>K</kbd>).</li>
|
toolbar, or <kbd>Ctrl</kbd>+<kbd>K</kbd>).</li>
|
||||||
<li>Alternatively, simply paste (<kbd>Ctrl</kbd>+<kbd>V</kbd>) over the selected
|
<li data-list-item-id="ea7c0566eb5733921b28ef0302468614e">Alternatively, simply paste (<kbd>Ctrl</kbd>+<kbd>V</kbd>) over the selected
|
||||||
text to turn it into a link.</li>
|
text to turn it into a link.</li>
|
||||||
</ul>
|
</ul>
|
||||||
<p>Once a link is inserted:</p>
|
<p>Once a link is inserted:</p>
|
||||||
<ul>
|
<ul>
|
||||||
<li>The text inside the link can be changed if needed but the link itself
|
<li data-list-item-id="e803bb540340ebc308d83c295c8ed946c">The text inside the link can be changed if needed but the link itself
|
||||||
will remain.</li>
|
will remain.</li>
|
||||||
<li>To modify the link, click on the link to display the popup and press the
|
<li data-list-item-id="e6f02215f1a3117bf7eb72c11d2d265e3">To modify the link, click on the link to display the popup and press the
|
||||||
<img
|
<img
|
||||||
src="External links_image.png" width="18"
|
src="External links_image.png" width="18"
|
||||||
height="18"> <em>Edit link</em> button.</li>
|
height="18"> <em>Edit link</em> button.</li>
|
||||||
<li>To remove a link, click on it and press the
|
<li data-list-item-id="e847bfed44ef36b41c0beb206b6e90df0">To remove a link, click on it and press the
|
||||||
<img src="2_External links_image.png"
|
<img src="2_External links_image.png"
|
||||||
width="18" height="18"> <em>Unlink</em> button.</li>
|
width="18" height="18"> <em>Unlink</em> button.</li>
|
||||||
</ul>
|
</ul>
|
||||||
|
|||||||
@ -1,33 +1,51 @@
|
|||||||
<p>Unlike external notes, internal links (links to other notes) can be created
|
<p>Internal links are links to other notes within Trilium.</p>
|
||||||
at the current position by :</p>
|
<p>You can open an internal link by clicking it. You can also see a read-only
|
||||||
|
preview of an internal link's contents by hovering over it.</p>
|
||||||
|
<h2>Inserting internal links</h2>
|
||||||
|
<p>Internal links can be created at the current position in a text note by:</p>
|
||||||
<ol>
|
<ol>
|
||||||
<li>Pressing <kbd>Ctrl</kbd> + <kbd>L</kbd> or the
|
<li data-list-item-id="e29e0d3b278daf6febaea9333082e5b9e">Pressing <kbd>Ctrl</kbd> + <kbd>L</kbd> or the
|
||||||
<img src="Internal (reference) links.png"
|
<img src="Internal (reference) links.png"
|
||||||
width="20" height="17">button from the <a class="reference-link" href="#root/_help_nRhnJkTT8cPs">Formatting toolbar</a>.</li>
|
width="20" height="17">button underneath the
|
||||||
<li>Filling in the desired note to link. It's also possible to create notes
|
<img src="1_Internal (reference) links.png"
|
||||||
from this dialog by typing a non-existing note title and selecting <em>Create and link child note</em>.</li>
|
width="34" height="16">menu in the <a class="reference-link" href="#root/_help_nRhnJkTT8cPs">Formatting toolbar</a>.</li>
|
||||||
|
<li
|
||||||
|
data-list-item-id="e341cd05a9cc65e10b522ac93beec991a">Searching for the title of the desired note to link. It's also possible
|
||||||
|
to create new notes from this dialog by typing a non-existing note title
|
||||||
|
and selecting <em>Create and link child note</em>.</li>
|
||||||
</ol>
|
</ol>
|
||||||
<p>There are two link types, adjustable when creating the link to the note:</p>
|
<p>There are two link types which you can select when creating the link to
|
||||||
|
the note:</p>
|
||||||
<ol>
|
<ol>
|
||||||
<li><em>link title mirrors the note's current title</em>
|
<li class="ck-list-marker-italic" data-list-item-id="ebf95649cfd8a19747541d8848a8d2856"><em>Link title mirrors the note's current title</em>
|
||||||
<ol>
|
<ol>
|
||||||
<li>This is sometimes also called "reference link".</li>
|
<li data-list-item-id="e7eb3b028cb3f219700c77d7b3d91e3cb">This is sometimes also called "reference link".</li>
|
||||||
<li>Title of such links cannot be changed, instead it is always mirroring
|
<li data-list-item-id="e1dc2787bc7ff62b5631a295b4a1235af">The title of these links cannot be changed. Instead, it will always show
|
||||||
the title of linked note.</li>
|
the current title of linked note.</li>
|
||||||
<li>The icon of the note is also displayed.</li>
|
<li data-list-item-id="ede5ae5dec6c076a18b342286deba6441">The icon of the linked note will also be displayed.</li>
|
||||||
<li>The link title will automatically update if the title of the note is changed.</li>
|
|
||||||
</ol>
|
</ol>
|
||||||
</li>
|
</li>
|
||||||
<li><em>link title can be changed arbitrarily</em>
|
<li class="ck-list-marker-italic" data-list-item-id="e9960ad801a520ed8abb166aed7cf8456"><em>Link title can be changed arbitrarily</em>
|
||||||
<ol>
|
<ol>
|
||||||
<li>This is the traditional hyperlink, where the text of the link can be different
|
<li data-list-item-id="e4ebd5b42004897e59b5c5c5afeb44082">This will create a traditional hyperlink, where the text of the link can
|
||||||
to the note title.</li>
|
be different from the note title.</li>
|
||||||
</ol>
|
</ol>
|
||||||
</li>
|
</li>
|
||||||
</ol>
|
</ol>
|
||||||
<p>Once an internal link is created:</p>
|
<h2>In-place linking</h2>
|
||||||
<ul>
|
<p>You can also insert internal links “inline” by using the <code spellcheck="false">@</code> symbol:</p>
|
||||||
<li>You can follow the note link by double clicking it.</li>
|
<ol>
|
||||||
<li>Alternatively if you only wish to quickly preview the content, you can
|
<li data-list-item-id="eb4028a28fb309b91f45a013c0f87a066">Type <code spellcheck="false">@</code> in a text note, which will open the
|
||||||
hover over the link and will see read only preview.</li>
|
note search menu.</li>
|
||||||
</ul>
|
<li data-list-item-id="e48df1d4bbce7e2341a502500966b92e1">Search for the desired note's title by typing a few characters. Use <kbd>Up</kbd> and <kbd>Down</kbd> to
|
||||||
|
select the correct note, and press <kbd>Enter</kbd> or <kbd>Tab</kbd> to create
|
||||||
|
the link. It's also possible to create new notes with this method by typing
|
||||||
|
a non-existing note title and selecting <em>Create and link child note</em>.</li>
|
||||||
|
</ol>
|
||||||
|
<h2>Pasting internal links</h2>
|
||||||
|
<p>You can also insert internal links by copying a note from the note tree.</p>
|
||||||
|
<ol>
|
||||||
|
<li data-list-item-id="e99023bbb4a8e9b054ae057e875b9f0a6">In the <a class="reference-link" href="#root/_help_oPVyFC7WL2Lp">Note Tree</a>,
|
||||||
|
select a note and press <kbd>Ctrl</kbd> + <kbd>C</kbd>.</li>
|
||||||
|
<li data-list-item-id="eb565ddea7a2eb5165206737be3485cfb">In a text note, paste the link by pressing <kbd>Ctrl</kbd> + <kbd>V</kbd>.</li>
|
||||||
|
</ol>
|
||||||
22
docs/User Guide/!!!meta.json
vendored
22
docs/User Guide/!!!meta.json
vendored
@ -7621,13 +7621,6 @@
|
|||||||
"isInheritable": false,
|
"isInheritable": false,
|
||||||
"position": 20
|
"position": 20
|
||||||
},
|
},
|
||||||
{
|
|
||||||
"type": "relation",
|
|
||||||
"name": "internalLink",
|
|
||||||
"value": "oPVyFC7WL2Lp",
|
|
||||||
"isInheritable": false,
|
|
||||||
"position": 30
|
|
||||||
},
|
|
||||||
{
|
{
|
||||||
"type": "relation",
|
"type": "relation",
|
||||||
"name": "internalLink",
|
"name": "internalLink",
|
||||||
@ -7760,6 +7753,13 @@
|
|||||||
"value": "reference-links",
|
"value": "reference-links",
|
||||||
"isInheritable": false,
|
"isInheritable": false,
|
||||||
"position": 30
|
"position": 30
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"type": "relation",
|
||||||
|
"name": "internalLink",
|
||||||
|
"value": "oPVyFC7WL2Lp",
|
||||||
|
"isInheritable": false,
|
||||||
|
"position": 40
|
||||||
}
|
}
|
||||||
],
|
],
|
||||||
"format": "markdown",
|
"format": "markdown",
|
||||||
@ -7772,6 +7772,14 @@
|
|||||||
"mime": "image/png",
|
"mime": "image/png",
|
||||||
"position": 10,
|
"position": 10,
|
||||||
"dataFileName": "Internal (reference) links.png"
|
"dataFileName": "Internal (reference) links.png"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"attachmentId": "VWmqBZtLxTJH",
|
||||||
|
"title": "image.png",
|
||||||
|
"role": "image",
|
||||||
|
"mime": "image/png",
|
||||||
|
"position": 10,
|
||||||
|
"dataFileName": "1_Internal (reference) links.png"
|
||||||
}
|
}
|
||||||
]
|
]
|
||||||
}
|
}
|
||||||
|
|||||||
@ -4,20 +4,6 @@ There are two types of links:
|
|||||||
* <a class="reference-link" href="Links/External%20links.md">External links</a>, for standard hyperlinks to websites or other resources.
|
* <a class="reference-link" href="Links/External%20links.md">External links</a>, for standard hyperlinks to websites or other resources.
|
||||||
* <a class="reference-link" href="Links/Internal%20(reference)%20links.md">Internal (reference) links</a> for links to other notes within Trilium.
|
* <a class="reference-link" href="Links/Internal%20(reference)%20links.md">Internal (reference) links</a> for links to other notes within Trilium.
|
||||||
|
|
||||||
## Pasting links
|
|
||||||
|
|
||||||
* For internal links (links to notes in Trilium), press Ctrl+C in the <a class="reference-link" href="../../Basic%20Concepts%20and%20Features/UI%20Elements/Note%20Tree.md">Note Tree</a>:
|
|
||||||
* Pasting directly in a text note will create a reference link (with an icon to the note and the actual note title).
|
|
||||||
* Pasting over an existing text will create a traditional link.
|
|
||||||
* For external links:
|
|
||||||
* Paste the raw URL directly and press space to turn it into a link.
|
|
||||||
* Select a text and paste the URL over it to turn that text into a link.
|
|
||||||
* If you are pasting a formatted link (e.g. from the a webpage in a browser), simply paste it and it will keep the original text and URL.
|
|
||||||
|
|
||||||
## In-place linking
|
|
||||||
|
|
||||||
Trilium also provides "inline" linking - type `@` and you'll see an autocomplete, just type few characters from the desired note title, press enter and you have a link.
|
|
||||||
|
|
||||||
## Note map
|
## Note map
|
||||||
|
|
||||||
Trilium provides a visualisation of incoming and outgoing links for a particular note. See [note map](../../Advanced%20Usage/Note%20Map%20\(Link%20map%2C%20Tree%20map\).md) for details.
|
Trilium provides a visualization of incoming and outgoing links for a particular note. See [note map](../../Advanced%20Usage/Note%20Map%20\(Link%20map%2C%20Tree%20map\).md) for details.
|
||||||
BIN
docs/User Guide/User Guide/Note Types/Text/Links/1_Internal (reference) links.png
vendored
Normal file
BIN
docs/User Guide/User Guide/Note Types/Text/Links/1_Internal (reference) links.png
vendored
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 178 B |
@ -1,20 +1,34 @@
|
|||||||
# Internal (reference) links
|
# Internal (reference) links
|
||||||
Unlike external notes, internal links (links to other notes) can be created at the current position by :
|
Internal links are links to other notes within Trilium.
|
||||||
|
|
||||||
1. Pressing <kbd>Ctrl</kbd> + <kbd>L</kbd> or the <img src="Internal (reference) links.png" width="20" height="17"> button from the <a class="reference-link" href="../Formatting%20toolbar.md">Formatting toolbar</a>.
|
You can open an internal link by clicking it. You can also see a read-only preview of an internal link's contents by hovering over it.
|
||||||
2. Filling in the desired note to link. It's also possible to create notes from this dialog by typing a non-existing note title and selecting _Create and link child note_.
|
|
||||||
|
|
||||||
There are two link types, adjustable when creating the link to the note:
|
## Inserting internal links
|
||||||
|
|
||||||
1. _link title mirrors the note's current title_
|
Internal links can be created at the current position in a text note by:
|
||||||
|
|
||||||
|
1. Pressing <kbd>Ctrl</kbd> + <kbd>L</kbd> or the <img src="Internal (reference) links.png" width="20" height="17"> button underneath the <img src="1_Internal (reference) links.png" width="34" height="16"> menu in the <a class="reference-link" href="../Formatting%20toolbar.md">Formatting toolbar</a>.
|
||||||
|
2. Searching for the title of the desired note to link. It's also possible to create new notes from this dialog by typing a non-existing note title and selecting _Create and link child note_.
|
||||||
|
|
||||||
|
There are two link types which you can select when creating the link to the note:
|
||||||
|
|
||||||
|
1. _Link title mirrors the note's current title_
|
||||||
1. This is sometimes also called "reference link".
|
1. This is sometimes also called "reference link".
|
||||||
2. Title of such links cannot be changed, instead it is always mirroring the title of linked note.
|
2. The title of these links cannot be changed. Instead, it will always show the current title of linked note.
|
||||||
3. The icon of the note is also displayed.
|
3. The icon of the linked note will also be displayed.
|
||||||
4. The link title will automatically update if the title of the note is changed.
|
2. _Link title can be changed arbitrarily_
|
||||||
2. _link title can be changed arbitrarily_
|
1. This will create a traditional hyperlink, where the text of the link can be different from the note title.
|
||||||
1. This is the traditional hyperlink, where the text of the link can be different to the note title.
|
|
||||||
|
|
||||||
Once an internal link is created:
|
## In-place linking
|
||||||
|
|
||||||
* You can follow the note link by double clicking it.
|
You can also insert internal links “inline” by using the `@` symbol:
|
||||||
* Alternatively if you only wish to quickly preview the content, you can hover over the link and will see read only preview.
|
|
||||||
|
1. Type `@` in a text note, which will open the note search menu.
|
||||||
|
2. Search for the desired note's title by typing a few characters. Use <kbd>Up</kbd> and <kbd>Down</kbd> to select the correct note, and press <kbd>Enter</kbd> or <kbd>Tab</kbd> to create the link. It's also possible to create new notes with this method by typing a non-existing note title and selecting _Create and link child note_.
|
||||||
|
|
||||||
|
## Pasting internal links
|
||||||
|
|
||||||
|
You can also insert internal links by copying a note from the note tree.
|
||||||
|
|
||||||
|
1. In the <a class="reference-link" href="../../../Basic%20Concepts%20and%20Features/UI%20Elements/Note%20Tree.md">Note Tree</a>, select a note and press <kbd>Ctrl</kbd> + <kbd>C</kbd>.
|
||||||
|
2. In a text note, paste the link by pressing <kbd>Ctrl</kbd> + <kbd>V</kbd>.
|
||||||
Loading…
x
Reference in New Issue
Block a user