mirror of
https://github.com/zadam/trilium.git
synced 2025-11-01 02:45:54 +01:00
feat(docs): document CKEditor plugin migration
This commit is contained in:
Elian Doran
@@ -1,4 +1,4 @@
|
||||
<p>Bookmarks allows creating <a href="#root/pOsGYCXsbNQG/KSZ04uQ2D1St/iPIMuisry3hd/_help_QEAPj01N5f7w">links</a> to
|
||||
<p>Bookmarks allows creating <a href="#root/_help_QEAPj01N5f7w">links</a> to
|
||||
a certain part of a note, such as referencing a particular heading.</p>
|
||||
<p>Technically, bookmarks are HTML anchors.</p>
|
||||
<p>This feature was introduced in TriliumNext 0.94.0.</p>
|
||||
@@ -8,7 +8,7 @@
|
||||
<ul>
|
||||
<li>Place the cursor at the desired position where to place the bookmark.</li>
|
||||
<li>Look for the
|
||||
<img src="Bookmarks_plus.png" width="15" height="16">button in the <a class="reference-link" href="#root/pOsGYCXsbNQG/KSZ04uQ2D1St/iPIMuisry3hd/_help_nRhnJkTT8cPs">Formatting toolbar</a>,
|
||||
<img src="Bookmarks_plus.png" width="15" height="16">button in the <a class="reference-link" href="#root/_help_nRhnJkTT8cPs">Formatting toolbar</a>,
|
||||
and then press the
|
||||
<img src="1_Bookmarks_plus.png" width="12" height="15">button.</li>
|
||||
</ul>
|
||||
@@ -16,8 +16,8 @@
|
||||
<li>To place a link to a bookmark:
|
||||
<ul>
|
||||
<li>Place the cursor at the desired position of the link.</li>
|
||||
<li>From the <a href="#root/pOsGYCXsbNQG/KSZ04uQ2D1St/iPIMuisry3hd/_help_QEAPj01N5f7w">link</a> pane,
|
||||
select the <em>Bookmarks</em> section and select the desired bookmark.</li>
|
||||
<li>From the <a href="#root/_help_QEAPj01N5f7w">link</a> pane, select the <em>Bookmarks</em> section
|
||||
and select the desired bookmark.</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
@@ -3,7 +3,7 @@
|
||||
reveal special inserable items and blocks such as symbols, Math expressions
|
||||
and separators.</p>
|
||||
<h2>Bookmarks</h2>
|
||||
<p>See the dedicated <a class="reference-link" href="#root/pOsGYCXsbNQG/KSZ04uQ2D1St/iPIMuisry3hd/_help_oSuaNgyyKnhu">Bookmarks</a> section.</p>
|
||||
<p>See the dedicated <a class="reference-link" href="#root/_help_oSuaNgyyKnhu">Bookmarks</a> section.</p>
|
||||
<h2>Emoji</h2>
|
||||
<figure class="image image-style-align-right image_resized" style="width:42.4%;">
|
||||
<img style="aspect-ratio:366/410;" src="Insert buttons_plus.png" width="366"
|
||||
@@ -15,66 +15,63 @@
|
||||
be selected via a combo box to the right.</p>
|
||||
<p>There is also the possibility of inserting emojis directly by typing <code>:</code> followed
|
||||
by a name of an emoji, triggering the display of a list of emojis. Simply
|
||||
use the arrow keys to select one and press <kbd>Enter</kbd> to insert it.
|
||||
<a
|
||||
id="emoji_keyboard"></a>
|
||||
</p>
|
||||
<p>
|
||||
<img src="1_Insert buttons_plus.png" width="272" height="187">
|
||||
</p>
|
||||
use the arrow keys to select one and press <kbd>Enter</kbd> to insert it.</p>
|
||||
<img
|
||||
src="1_Insert buttons_plus.png" width="272" height="187">
|
||||
|
||||
<h2>Symbols</h2>
|
||||
<figure class="image image-style-align-right">
|
||||
<img style="aspect-ratio:346/322;" src="1_Insert buttons_image.png" width="346"
|
||||
height="322">
|
||||
</figure>
|
||||
<p>Pressing the
|
||||
<img src="7_Insert buttons_image.png" width="18" height="15">button will reveal a popup window displaying a list of characters that
|
||||
are generally more difficult to insert directly from the keyboard, such
|
||||
as a subset of emojis, quotation characters, etc.</p>
|
||||
<p>Interaction:</p>
|
||||
<ul>
|
||||
<li>Click on a character to insert it at the current cursor position.</li>
|
||||
<li>The window can be dragged around by the top bar where the title is, to
|
||||
avoid it getting in the way of the text.</li>
|
||||
<li>Click on the <em>Category</em> selector to filter the characters.</li>
|
||||
</ul>
|
||||
<h2>Math equations</h2>
|
||||
<p>See the dedicated <a class="reference-link" href="#root/_help_YfYAtQBcfo5V">Math Equations</a> page.</p>
|
||||
<h2>Mermaid diagram</h2>
|
||||
<p>Press the
|
||||
<img src="2_Insert buttons_image.png" width="16" height="17">button to create an inline Mermaid diagram.</p>
|
||||
<p>This feature is quite similar to the <a class="reference-link" href="#root/_help_s1aBHPd79XYj">Mermaid Diagrams</a> note
|
||||
types and is meant as an alternative to it for simple diagrams. For more
|
||||
complex diagrams, use the <a class="reference-link" href="#root/_help_nBAXQFj20hS1">Include Note</a> feature
|
||||
for a dedicated Mermaid note.</p>
|
||||
<figure class="image">
|
||||
<img style="aspect-ratio:1174/358;" src="6_Insert buttons_image.png" width="1174"
|
||||
height="358">
|
||||
</figure>
|
||||
<figure class="image image-style-align-right">
|
||||
<img style="aspect-ratio:346/322;" src="1_Insert buttons_image.png" width="346"
|
||||
height="322">
|
||||
</figure>
|
||||
<p>Pressing the
|
||||
<img src="7_Insert buttons_image.png" width="18" height="15">button will reveal a popup window displaying a list of characters that
|
||||
are generally more difficult to insert directly from the keyboard, such
|
||||
as a subset of emojis, quotation characters, etc.</p>
|
||||
<p>Interaction:</p>
|
||||
<ul>
|
||||
<li>Click on a character to insert it at the current cursor position.</li>
|
||||
<li>The window can be dragged around by the top bar where the title is, to
|
||||
avoid it getting in the way of the text.</li>
|
||||
<li>Click on the <em>Category</em> selector to filter the characters.</li>
|
||||
</ul>
|
||||
<h2>Math equations</h2>
|
||||
<p>See the dedicated <a class="reference-link" href="#root/_help_YfYAtQBcfo5V">Math Equations</a> page.</p>
|
||||
<h2>Mermaid diagram</h2>
|
||||
<p>Press the
|
||||
<img src="2_Insert buttons_image.png" width="16" height="17">button to create an inline Mermaid diagram.</p>
|
||||
<p>This feature is quite similar to the <a class="reference-link" href="#root/_help_s1aBHPd79XYj">Mermaid Diagrams</a> note
|
||||
types and is meant as an alternative to it for simple diagrams. For more
|
||||
complex diagrams, use the <a class="reference-link" href="#root/_help_nBAXQFj20hS1">Include Note</a> feature
|
||||
for a dedicated Mermaid note.</p>
|
||||
<figure class="image">
|
||||
<img style="aspect-ratio:1174/358;" src="6_Insert buttons_image.png" width="1174"
|
||||
height="358">
|
||||
</figure>
|
||||
|
||||
<h2>Horizontal ruler</h2>
|
||||
<p>This feature will display a horizontal line, generally useful to separate
|
||||
different sections of the text. To do so, press the
|
||||
<img src="5_Insert buttons_image.png"
|
||||
width="18" height="16">button in the <a class="reference-link" href="#root/_help_nRhnJkTT8cPs">Formatting toolbar</a>.</p>
|
||||
<p>
|
||||
<img src="3_Insert buttons_image.png" width="502" height="95">
|
||||
</p>
|
||||
<p>Alternatively, it's possible to insert a horizontal ruler by typing <code>---</code>.</p>
|
||||
<h2>Page break</h2>
|
||||
<figure class="image image-style-align-right">
|
||||
<img style="aspect-ratio:371/79;" src="8_Insert buttons_image.png" width="371"
|
||||
height="79">
|
||||
</figure>
|
||||
<p>Page breaks provide a way to force the next paragraph or block (table,
|
||||
image, etc.) to be displayed onto the next page when printing (either to
|
||||
a real printer to <a href="#root/_help_NRnIZmSMc5sj">when exporting to PDF</a>).</p>
|
||||
<p>Page breaks are marked in the editor with the words <em>Page break</em>,
|
||||
but they will not actually be shown when printed.</p>
|
||||
<ul>
|
||||
<li>To insert a page break, press the
|
||||
<img src="Insert buttons_image.png" width="20"
|
||||
height="19">in the formatting toolbar.</li>
|
||||
<li>To insert many page breaks at once, insert a page break first, click on
|
||||
it and press <kbd>Ctrl</kbd>+<kbd>C</kbd>. Then use <kbd>Ctrl</kbd>+<kbd>V</kbd>,
|
||||
to paste as many times as needed.</li>
|
||||
</ul>
|
||||
<p>This feature will display a horizontal line, generally useful to separate
|
||||
different sections of the text. To do so, press the
|
||||
<img src="5_Insert buttons_image.png"
|
||||
width="18" height="16">button in the <a class="reference-link" href="#root/_help_nRhnJkTT8cPs">Formatting toolbar</a>.</p>
|
||||
<img
|
||||
src="3_Insert buttons_image.png" width="502" height="95">
|
||||
<p>Alternatively, it's possible to insert a horizontal ruler by typing <code>---</code>.</p>
|
||||
<h2>Page break</h2>
|
||||
<figure class="image image-style-align-right">
|
||||
<img style="aspect-ratio:371/79;" src="8_Insert buttons_image.png" width="371"
|
||||
height="79">
|
||||
</figure>
|
||||
<p>Page breaks provide a way to force the next paragraph or block (table,
|
||||
image, etc.) to be displayed onto the next page when printing (either to
|
||||
a real printer to <a href="#root/_help_NRnIZmSMc5sj">when exporting to PDF</a>).</p>
|
||||
<p>Page breaks are marked in the editor with the words <em>Page break</em>,
|
||||
but they will not actually be shown when printed.</p>
|
||||
<ul>
|
||||
<li>To insert a page break, press the
|
||||
<img src="Insert buttons_image.png" width="20"
|
||||
height="19">in the formatting toolbar.</li>
|
||||
<li>To insert many page breaks at once, insert a page break first, click on
|
||||
it and press <kbd>Ctrl</kbd>+<kbd>C</kbd>. Then use <kbd>Ctrl</kbd>+<kbd>V</kbd>,
|
||||
to paste as many times as needed.</li>
|
||||
</ul>
|
||||
@@ -59,8 +59,8 @@
|
||||
with the text inside of it.</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li>For <a href="#root/pOsGYCXsbNQG/KSZ04uQ2D1St/iPIMuisry3hd/_help_CohkqWQC1iBv">emojis</a>,
|
||||
type <code>:</code> followed by an emoji name to trigger an auto-completion.</li>
|
||||
<li>For <a href="#root/_help_CohkqWQC1iBv">emojis</a>, type <code>:</code> followed
|
||||
by an emoji name to trigger an auto-completion.</li>
|
||||
</ul>
|
||||
<p>If auto-formatting is not desirable, press <kbd>Ctrl</kbd> + <kbd>Z</kbd> to
|
||||
revert the text to its original form.</p>
|
||||
@@ -7,7 +7,8 @@
|
||||
<img src="1_Math Equations_image.png" width="20" height="15">button from the <a class="reference-link" href="#root/_help_nRhnJkTT8cPs">Formatting toolbar</a> (generally
|
||||
found under the <a class="reference-link" href="#root/_help_CohkqWQC1iBv">Insert buttons</a>).</p>
|
||||
<p>If inserting equations frequently, using the <kbd>Ctrl</kbd>+<kbd>M</kbd> keyboard
|
||||
shortcut can be more comfortable.</p>
|
||||
shortcut can be more comfortable. Alternatively, type <code>$$</code> or <code>\[</code> to
|
||||
trigger the popup directly.</p>
|
||||
<p>There is currently no quick way to insert an equation, such as surrounding
|
||||
it with <code>$</code> or pressing <kbd>Ctrl</kbd>+<kbd>M</kbd> on an already
|
||||
typed-out equation.</p>
|
||||
|
||||
Reference in New Issue
Block a user