Build your personal knowledge base with Trilium Notes
TypeScript electronelectron-appknowledge-baseknowledge-graphknowledge-managementknowledge-management-graphlocal-firstnote-managmentnote-takernote-takingnotebooknotesnotes-apppersonal-knowledge-basepersonal-wikiscriptableself-hostedself-hostingwiki
docs(user): improve font description given the changes
Elian Doran64de8092f81b
diff --git a/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Basic Concepts and Features/Themes/Personalizing the font.html b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Basic Concepts and Features/Themes/Personalizing the font.htmlindex b40c39517a..b7e48caaa0 100644--- a/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Basic Concepts and Features/Themes/Personalizing the font.html+++ b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Basic Concepts and Features/Themes/Personalizing the font.html@@ -15,10 +15,33 @@<p>Each area also has its own <em>Size</em>. The note tree and document sizesare relative to the interface size, so changing the interface size movesthem along with it.</p>-<p>Alongside the named families, the list offers <em>Theme defined</em>, which- leaves the choice to the current theme, and <em>System default</em>, which- follows the operating system. Named families are not installed on every- device; where one is missing, the text falls back to a font that is.</p>+<p>The list of fonts contains the following items:</p>+<ul>+ <li class="ck-list-marker-bold"><strong>Generic fonts</strong>+ <ul>+ <li><em>Theme defined</em> which uses the font that is embedded with the current+ <a+ href="#root/_help_Wy267RK4M69c">theme</a>. For example on the default modern theme, the font is <em>Inter</em>.+ This does not require the font to be installed.</li>+ <li><em>System default</em> which uses a combination of fonts that works best+ for the <a href="#root/_help_poXkQfguuA0U">desktop app</a>.+ For example on Windows it will use <em>Segoe UI</em>.</li>+ <li>Generic font selections for fonts with serifs (e.g. <em>Times New Roman</em>-like),+ no serifs and monospace.</li>+ </ul>+ </li>+ <li><strong>Web fonts</strong> which appear on the <a class="reference-link"+ href="#root/_help_WOcw2SLH6tbX">Server Installation</a>,+ which is a predefined list of fonts and grouped into Sans-serif, serif,+ monospace and handwriting. The fonts that are not supported by your system+ (i.e. not installed) are not displayed.</li>+ <li><strong>System fonts</strong> which appear on the <a class="reference-link"+ href="#root/_help_poXkQfguuA0U">Desktop Installation</a>.+ Unlike the server fonts which are predefined, the system fonts are listed+ from your operating system.</li>+ <li><strong>Custom fonts</strong>, allowing any font to be used provided it's+ imported into Trilium. See the section below for more information.</li>+</ul><p>Font changes take effect after a reload; the section offers a <em>Reload to apply changes</em> buttononce something has been changed.</p><h2>Custom fonts</h2>@@ -27,10 +50,9 @@<h3>Adding a font</h3><ol><li>Import the font file, by dragging it into the <a class="reference-link"- href="#root/_help_oPVyFC7WL2Lp">Note Tree</a> or- through <em>Import into note</em>. TrueType (<code spellcheck="false">.ttf</code>),- OpenType (<code spellcheck="false">.otf</code>) and Web Open Font Format- (<code spellcheck="false">.woff</code>, <code spellcheck="false">.woff2</code>)+ href="#root/_help_oPVyFC7WL2Lp">Note Tree</a> or through <em>Import into note</em>.+ TrueType (<code spellcheck="false">.ttf</code>), OpenType (<code spellcheck="false">.otf</code>)+ and Web Open Font Format (<code spellcheck="false">.woff</code>, <code spellcheck="false">.woff2</code>)files are recognized; the note takes the font's name without its extensionand is marked with a font icon (an “A” icon).</li><li>Select the resulting note where a preview of a font will be displayed:@@ -56,8 +78,8 @@it to your other devices. The choice of font is not synced: appearancesettings are deliberately kept per-device, so on another device the fontis already there and only needs to be selected again.</li>- <li>A font kept in a <a href="#root/_help_bwg0e8ewQMak">protected note</a> can- only be previewed and used while the protected session is open.</li>+ <li>A font kept in a <a href="#root/_help_bwg0e8ewQMak">protected note</a> can only+ be previewed and used while the protected session is open.</li></ul><p>For theme authors, a font can also be embedded in a theme's CSS through <adiff --git a/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Installation & Setup/Desktop Installation/System Requirements.html b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Installation & Setup/Desktop Installation/System Requirements.htmlindex dccd6c556f..1cff099fae 100644--- a/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Installation & Setup/Desktop Installation/System Requirements.html+++ b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Installation & Setup/Desktop Installation/System Requirements.html@@ -14,7 +14,7 @@</li><li>macOS<ul>- <li>Minimum supported operating system: macOS Monterey</li>+ <li>Minimum supported operating system: macOS Ventura</li><li>Both Intel and Apple Silicon devices are supported.</li></ul></li>diff --git a/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/File.html b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/File.htmlindex 122209bb77..90170c9da0 100644--- a/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/File.html+++ b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/File.html@@ -88,24 +88,14 @@ class="image"><h3>Fonts</h3><p>Supported font formats will show an interactive preview of the font:</p><ul>- <li>- <p>A field to type in a custom text.</p>- </li>- <li>- <p>A slider to change the font size of the preview.</p>- </li>- <li>- <p>A preview of the text at the given size.</p>- </li>- <li>- <p>A sampling of various font sizes for this font.</p>- </li>- <li>- <p>The Latin alphabet.</p>- </li>+ <li>A field to type in a custom text.</li>+ <li>A slider to change the font size of the preview.</li>+ <li>A preview of the text at the given size.</li>+ <li>A sampling of various font sizes for this font.</li>+ <li>The Latin alphabet.</li></ul><p>Additionally, enabling <em>In font picker</em> will make the font available- in the <a class="reference-link" href="#root/_help_4TIF1oA4VQRO">Options</a> → <em>Appearance </em>font+ in the <a class="reference-link" href="#root/_help_4TIF1oA4VQRO">Options</a> → <em>Appearance</em> fontselection. See <a class="reference-link" href="#root/_help_w4rMEhJsALlA">Personalizing the font</a> formore information.</p><h3>Unknown file types</h3>@@ -136,16 +126,18 @@ class="image"><li><p>Files are also displayed in the <a class="reference-link" href="#root/_help_0ESUbbAxVnoK">Note List</a> basedon their type:</p>- <p>- <img class="image_resized" style="aspect-ratio:853/315;width:50%;" src="5_File_image.png"- width="853" height="315">- </p>+ <img class="image_resized" style="aspect-ratio:853/315;width:50%;"+ src="5_File_image.png" width="853" height="315">+ </li>+ <li>+ <p>Non-image files can be embedded into text notes as read-only widgets via+ the <a class="reference-link" href="#root/_help_nBAXQFj20hS1">Include Note</a> functionality.</p>+ </li>+ <li>+ <p>Image files can be embedded into text notes like normal images via + <a+ class="reference-link" href="#root/_help_0Ofbk1aSuVRu">Image references</a>.</p></li>- <li>Non-image files can be embedded into text notes as read-only widgets via- the <a class="reference-link" href="#root/_help_nBAXQFj20hS1">Include Note</a> functionality.</li>- <li>Image files can be embedded into text notes like normal images via - <a- class="reference-link" href="#root/_help_0Ofbk1aSuVRu">Image references</a>.</li></ul><h2>File size limit</h2><p>An individual file cannot be bigger than 374 MiB. For more informationdiff --git a/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Theme development/Creating an icon pack.html b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Theme development/Creating an icon pack.htmlindex 315ecc805c..22d4dc7a9d 100644--- a/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Theme development/Creating an icon pack.html+++ b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Theme development/Creating an icon pack.html@@ -99,8 +99,8 @@<ul><li>You can supply glyph as the escaped <code spellcheck="false">\uXXXX</code> sequenceor as the actual UTF‑8 character. The CSS form (<code spellcheck="false">\ea3f</code>,- as written in a stylesheet's <code spellcheck="false">content</code>) is accepted- too, so glyphs copied out of the font's own CSS work as they stand.</li>+ as written in a stylesheet's <code spellcheck="false">content</code>) is+ accepted too, so glyphs copied out of the font's own CSS work as they stand.</li><li>It is also possible to use the unescaped glyph inside the JSON. It willappear strange (e.g. ), but it will be rendered properly regardless.</li><li>The manifest keys (e.g. <code spellcheck="false">ph-acorn</code>) should@@ -109,7 +109,7 @@only letters, digits, hyphens, underscores and non-ASCII characters. Punctuationand whitespace (e.g. <code spellcheck="false">ph.acorn</code> or <code spellcheck="false">ph acorn</code>)are not usable as class names; icons with such a key are skipped and an- error is logged in <a class="reference-link" href="#root/_help_bnyigUA2UK7s">Backend (server) logs</a>,+ error is logged in <a class="reference-link" href="#root/_help_bnyigUA2UK7s">Backend (server) logs</a>,while the rest of the pack still loads.</li></ul></aside>@@ -188,8 +188,8 @@ processIconPack("light");</code></pre>when compared to JSON (<code spellcheck="false">"\uea3f"</code>). Noticehow the JSON escape is <code spellcheck="false">\u</code> and not <code spellcheck="false">\</code>.Both forms are accepted: keep the CSS escape by writing the backslash itself- as <code spellcheck="false">"\\ea3f"</code> in the JSON, or convert it to the- JSON escape <code spellcheck="false">"\uea3f"</code>.</p>+ as <code spellcheck="false">"\\ea3f"</code> in the JSON, or convert it to+ the JSON escape <code spellcheck="false">"\uea3f"</code>.</p><p>As a more compact alternative, provide the un-escaped character directly,as UTF-8 is supported.</p></aside>@@ -208,9 +208,10 @@ processIconPack("light");</code></pre>since it also matches the prefix set in the original CSS. So in this caseit would be <code spellcheck="false">#iconPack=ph</code>.</p><aside class="admonition important">- <p>The prefix must consist of only letters, digits, hyphens, underscores and- non-ASCII characters. If the prefix doesn't match these constraints, the icon pack will be ignored- and an error will be logged in <a class="reference-link" href="#root/_help_bnyigUA2UK7s">Backend (server) logs</a>.</p>+ <p>The prefix must consist of only letters, digits, hyphens, underscores+ and non-ASCII characters. If the prefix doesn't match these constraints,+ the icon pack will be ignored and an error will be logged in <a class="reference-link"+ href="#root/_help_bnyigUA2UK7s">Backend (server) logs</a>.</p></aside><h2>Creating the Trilium icon pack note</h2><ol>@@ -275,7 +276,7 @@ processIconPack("light");</code></pre><li>Make sure the prefix consists only of letters, digits, hyphens, underscoresand non-ASCII characters.</li><li>If the pack loads but individual icons are missing, check the logs for- <code spellcheck="false">Skipping icon '<key>' of icon pack</code> —- that key uses characters outside the allowed set and needs renaming in the- manifest.</li>+ <code+ spellcheck="false">Skipping icon '<key>' of icon pack</code>— that key uses characters+ outside the allowed set and needs renaming in the manifest.</li></ul>\ No newline at end of filediff --git a/docs/User Guide/User Guide/Basic Concepts and Features/Themes/Personalizing the font.md b/docs/User Guide/User Guide/Basic Concepts and Features/Themes/Personalizing the font.mdindex 746d0b5c62..ba9addadaf 100644--- a/docs/User Guide/User Guide/Basic Concepts and Features/Themes/Personalizing the font.md+++ b/docs/User Guide/User Guide/Basic Concepts and Features/Themes/Personalizing the font.md@@ -12,7 +12,15 @@ The font can be personalized for the following areas of the application:Each area also has its own _Size_. The note tree and document sizes are relative to the interface size, so changing the interface size moves them along with it.-Alongside the named families, the list offers _Theme defined_, which leaves the choice to the current theme, and _System default_, which follows the operating system. Named families are not installed on every device; where one is missing, the text falls back to a font that is.+The list of fonts contains the following items:++* **Generic fonts**+ * _Theme defined_ which uses the font that is embedded with the current [theme](../Themes.md). For example on the default modern theme, the font is _Inter_. This does not require the font to be installed.+ * _System default_ which uses a combination of fonts that works best for the [desktop app](../../Installation%20%26%20Setup/Desktop%20Installation.md). For example on Windows it will use _Segoe UI_.+ * Generic font selections for fonts with serifs (e.g. _Times New Roman_\-like), no serifs and monospace.+* **Web fonts** which appear on the <a class="reference-link" href="../../Installation%20%26%20Setup/Server%20Installation.md">Server Installation</a>, which is a predefined list of fonts and grouped into Sans-serif, serif, monospace and handwriting. The fonts that are not supported by your system (i.e. not installed) are not displayed.+* **System fonts** which appear on the <a class="reference-link" href="../../Installation%20%26%20Setup/Desktop%20Installation.md">Desktop Installation</a>. Unlike the server fonts which are predefined, the system fonts are listed from your operating system.+* **Custom fonts**, allowing any font to be used provided it's imported into Trilium. See the section below for more information.Font changes take effect after a reload; the section offers a _Reload to apply changes_ button once something has been changed.