mirror of https://github.com/joplin/website.git
385 lines
14 KiB
HTML
385 lines
14 KiB
HTML
<!DOCTYPE html>
|
||
<html lang="en">
|
||
|
||
<head>
|
||
<!-- Common page configuration that goes in the <head></head> tag -->
|
||
<meta charset="UTF-8">
|
||
<meta name="viewport" content="width=device-width,initial-scale=1.0,minimum-scale=1.0,viewport-fit=cover"/>
|
||
<meta http-equiv="Content-Security-Policy" content="default-src 'self'; img-src * data: ; style-src 'self' 'unsafe-inline' ; child-src 'none' ; connect-src 'self' raw.githubusercontent.com ;"/>
|
||
<link rel="icon" type="image/x-icon" href="/plugins/favicon.png" />
|
||
<link rel="stylesheet" href="/plugins/fontawesome-6.4.2/css/all.min.css" type="text/css"/>
|
||
|
||
<!-- Allow included JavaScipt files to determine the root directory of this site. -->
|
||
<script id="site-root" type="text/plain">/plugins</script>
|
||
|
||
<!-- Scripts used by all pages -->
|
||
<script src="/plugins/bundle-main.js"></script>
|
||
<script src="/plugins/bundle-components.js"></script>
|
||
<title>Joplin Plugins - Persistent Editor Layout</title>
|
||
|
||
<meta property="og:title" content="Joplin Plugin: Persistent Editor Layout"/>
|
||
<meta property="og:description" content="Save the editor layout (editor/split view/viewer/rich text) for each note separately with custom tags."/>
|
||
<meta property="og:image" content=""/>
|
||
|
||
<script src="/plugins/bundle-pluginPage.js"></script>
|
||
</head>
|
||
|
||
<body>
|
||
<nav class="navbar navbar-expand-lg bg-body-tertiary sticky-top">
|
||
<div class="container">
|
||
<a class="navbar-brand" href="https://joplinapp.org/">
|
||
<img src="/plugins/joplin-logo.png" alt="Home"/>
|
||
</a>
|
||
<button class="navbar-toggler" type="button" data-bs-toggle="collapse" data-bs-target="#navbarSupportedContent" aria-controls="navbarSupportedContent" aria-expanded="false" aria-label="Toggle navigation">
|
||
<span class="navbar-toggler-icon"></span>
|
||
</button>
|
||
<div class="collapse navbar-collapse" id="navbarSupportedContent">
|
||
<ul class="navbar-nav ms-auto me-2 mb-2 mb-lg-0">
|
||
<li class="nav-item">
|
||
<a class="nav-link active" aria-current="page" href="/plugins">Plugins</a>
|
||
</li>
|
||
<li class="nav-item">
|
||
<a class="nav-link" href="https://joplinapp.org/news/">News</a>
|
||
</li>
|
||
<li class="nav-item">
|
||
<a class="nav-link" href="https://joplinapp.org/help/">Help</a>
|
||
</li>
|
||
<li class="nav-item">
|
||
<a class="nav-link" href="https://discourse.joplinapp.org/">Forum</a>
|
||
</li>
|
||
</ul>
|
||
<div class="search-field col-12 col-lg-3 mb-3 mb-lg-0 me-lg-3">
|
||
<i class="fa-solid fa-magnifying-glass search-icon" alt=""></i>
|
||
<input
|
||
type="search"
|
||
class="form-control search-input"
|
||
placeholder="Search..."
|
||
id="search-input"/>
|
||
<div class="search-results" id="search-results-container" aria-live="polite"></div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
</nav>
|
||
<main class="plugin-details">
|
||
<nav aria-label="breadcrumb" class="container breadcrumb-container">
|
||
<ol class="breadcrumb">
|
||
<li class="breadcrumb-item">
|
||
<a href="/plugins"><i class="fas fa-home"></i> Home</a>
|
||
</li>
|
||
<li class="breadcrumb-item"><a id="current-category-nav-link" href="/plugins/">All</a></li>
|
||
<li class="breadcrumb-item active" aria-current="page">Persistent Editor Layout</li>
|
||
</ol>
|
||
</nav>
|
||
<div class="plugin-overview">
|
||
<div class="spacer">
|
||
</div>
|
||
<div class="plugin-page-header">
|
||
<div class="title plugin-page-title">
|
||
<img
|
||
class="icon plugin-icon -missing"
|
||
src=""
|
||
alt="Plugin icon"
|
||
/>
|
||
<div>
|
||
<h1 class="card-title">Persistent Editor Layout</h1>
|
||
<div class="card-title pb-2">
|
||
by
|
||
<a
|
||
href="./?search=author%3D%22Benji300%22%20max-results%3D20"
|
||
style="display: inline;"
|
||
>
|
||
Benji300
|
||
</a>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
|
||
<div class="categories">
|
||
<a href="/plugins/#recommended-section">
|
||
<span class="plugin-recommended me-2 badge"><i class="fas fa-crown"></i> Recommended</span>
|
||
</a>
|
||
<a class="plugin-category me-2 badge" href="/plugins/#tab-viewer">
|
||
<i class="fas fa-tag"></i> viewer
|
||
</a>
|
||
</div>
|
||
</div>
|
||
<div class="download-link-container">
|
||
<a
|
||
href="/plugins/downloadPlugin.html?plugin=joplin.plugin.benji.persistentLayout"
|
||
class="btn btn-primary process--append-parent-tab-to-href"
|
||
>
|
||
Install Plugin
|
||
</a>
|
||
</div>
|
||
</div>
|
||
<div class="plugin-content">
|
||
<div class="secondary-section">
|
||
<div class="content" id="screenshots-container">
|
||
<div id="raw-screenshots">
|
||
</div>
|
||
|
||
<!-- See https://getbootstrap.com/docs/5.3/components/carousel/ -->
|
||
<div id="screenshots-carousel" class="carousel slide">
|
||
<button
|
||
class="carousel-control-prev"
|
||
type="button"
|
||
data-bs-target="#screenshots-carousel"
|
||
data-bs-slide="prev"
|
||
>
|
||
<span class="carousel-control-prev-icon" aria-hidden="true"></span>
|
||
<span class="visually-hidden">Previous</span>
|
||
</button>
|
||
<button
|
||
class="carousel-control-next"
|
||
type="button"
|
||
data-bs-target="#screenshots-carousel"
|
||
data-bs-slide="next"
|
||
>
|
||
<span class="carousel-control-next-icon" aria-hidden="true"></span>
|
||
<span class="visually-hidden">Next</span>
|
||
</button>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<div class="container section">
|
||
<h3>Description</h3>
|
||
<p class="card-text pb-4">Save the editor layout (editor/split view/viewer/rich text) for each note separately with custom tags.</p>
|
||
</div>
|
||
<div class="container section">
|
||
<h3>Additional Information</h3>
|
||
<table class="additional-information-table">
|
||
<tbody>
|
||
<tr>
|
||
<th>Links:</th>
|
||
<td>
|
||
<ul class="list-group list-group-flush text-break">
|
||
<li><a href=https://github.com/benji300/joplin-persistent-layout style="display: block;"><i class="fa-solid fa-link"></i> Repository</a></li>
|
||
<li><a href=https://github.com/benji300/joplin-persistent-layout style="display: block;"><i class="fa-solid fa-link"></i> Homepage</a></li>
|
||
<li>
|
||
<a
|
||
id="view-plugin-source-link"
|
||
href="/plugins/view-source.html?plugin=joplin.plugin.benji.persistentLayout"
|
||
class="process--append-parent-tab-to-href"
|
||
>
|
||
<i class="fa-solid fa-code"></i> View source
|
||
</a>
|
||
</li>
|
||
</ul>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<th>Maintainers:</th>
|
||
<td>
|
||
<a href="./?search=maintainer%3D%22benji300%22%20max-results%3D20" class="maintainer-link">
|
||
benji300
|
||
</a>
|
||
</td>
|
||
</tr>
|
||
<tr><th>Version:</th><td>2.2.0</td></tr>
|
||
<tr><th>Minimum app version:</th><td>1.8.2</td></tr>
|
||
<tr><th>Downloads: This version:</th><td>5192</td></tr>
|
||
<tr><th>Last updated:</th><td class="process--format-as-local-time">2021-09-26T21:02:53Z</td></tr>
|
||
</tbody>
|
||
</table>
|
||
</div>
|
||
<div class="container section" id="readme" data--is-rendered-markdown>
|
||
|
||
<h1>Joplin Persistent Editor Layout</h1>
|
||
<p>Persistent Editor Layout is a plugin to extend the UX of <a href="https://joplinapp.org/">Joplin's</a> desktop application.</p>
|
||
<p>It allows to persist the editor layout for each note separately with <a href="#usage">custom tags</a>.</p>
|
||
<blockquote>
|
||
<p>:warning: <strong>CAUTION</strong> - Requires Joplin <strong>v1.8.2</strong> or newer</p>
|
||
</blockquote>
|
||
<h2>Features</h2>
|
||
<ul>
|
||
<li>Persist the editor layout (<code>editor / split view / viewer / rich text</code>) for each note separately</li>
|
||
<li>Ability to specify <a href="#usage">custom tags</a> to force a specific layout</li>
|
||
<li>Persisted layout is synced across (desktop) devices, if the plugin is installed</li>
|
||
</ul>
|
||
<h2>Installation</h2>
|
||
<h3>Automatic (Joplin v1.6.4 and newer)</h3>
|
||
<ul>
|
||
<li>Open Joplin and navigate to <code>Tools > Options > Plugins</code></li>
|
||
<li>Search for the plugin name and press install</li>
|
||
<li>Restart Joplin to enable the plugin</li>
|
||
</ul>
|
||
<h3>Manual</h3>
|
||
<ul>
|
||
<li>Download the latest released JPL package (<code>*.jpl</code>) from <a href="https://github.com/benji300/joplin-persistent-layout/releases">here</a></li>
|
||
<li>Open Joplin and navigate to <code>Tools > Options > Plugins</code></li>
|
||
<li>Press <code>Install plugin</code> and select the previously downloaded <code>jpl</code> file</li>
|
||
<li>Confirm selection</li>
|
||
<li>Restart Joplin to enable the plugin</li>
|
||
</ul>
|
||
<h3>Uninstall</h3>
|
||
<ul>
|
||
<li>Open Joplin and navigate to <code>Tools > Options > Plugins</code></li>
|
||
<li>Search for the plugin name and press <code>Delete</code> to remove the plugin completely
|
||
<ul>
|
||
<li>Alternatively you can also disable the plugin by clicking on the toggle button</li>
|
||
</ul>
|
||
</li>
|
||
<li>Restart Joplin</li>
|
||
</ul>
|
||
<h2>Usage</h2>
|
||
<p>To persist the layout for a note follow these steps:</p>
|
||
<ol>
|
||
<li>
|
||
<p>Specify the tags for which a specific layout should be used.</p>
|
||
<ul>
|
||
<li>
|
||
<p>To do this, go to the plugin's settings/options page and add the tags to the settings.</p>
|
||
</li>
|
||
<li>
|
||
<p>An example configuration could like this:</p>
|
||
<p><img src="https://raw.githubusercontent.com/benji300/joplin-persistent-layout/HEAD/assets/tags-config.png" alt="layout-tags-config" /></p>
|
||
</li>
|
||
</ul>
|
||
</li>
|
||
<li>
|
||
<p>Make sure that the correct value is selected in <code>View > Layout button sequence</code>.</p>
|
||
<ul>
|
||
<li>
|
||
<p>To be able to use the layout switching correctly, this setting must be set accordingly. Otherwise the editor layout might not be switched to the expected one.</p>
|
||
</li>
|
||
<li>
|
||
<p>For example: If a tag is specified in option <code>Tags for editor layout mode: Rendered Markdown viewer</code> and least one note uses it, the setting must also contain <code>Viewer</code>.</p>
|
||
</li>
|
||
</ul>
|
||
</li>
|
||
<li>
|
||
<p>Add the appropriate tags to the notes. If not already done.</p>
|
||
<ul>
|
||
<li>
|
||
<p>When the selected note is changed, the editor layout is switched.</p>
|
||
</li>
|
||
<li>
|
||
<p>If none of the selected note's tags matches a specified layout tag, the default layout from the option <code>Default editor layout</code> is used.</p>
|
||
<ul>
|
||
<li>If nothing is selected as default editor layout, the currently active editor layout will be kept.</li>
|
||
</ul>
|
||
</li>
|
||
<li>
|
||
<p>If more than one tag is specified for a note, the first matching one is used.</p>
|
||
</li>
|
||
</ul>
|
||
</li>
|
||
</ol>
|
||
<h2>Commands</h2>
|
||
<p>This plugin does not provide any commands.</p>
|
||
<h2>User options</h2>
|
||
<p>This plugin adds provides user options which can be changed via <code>Tools > Options > Persistent Layout</code> (Windows App).</p>
|
||
<h2>Feedback</h2>
|
||
<ul>
|
||
<li>:question: Need help?
|
||
<ul>
|
||
<li>Ask a question on the <a href="https://discourse.joplinapp.org/t/persist-editor-layout-plugin/14411">Joplin Forum</a></li>
|
||
</ul>
|
||
</li>
|
||
<li>:bulb: An idea to improve or enhance the plugin?
|
||
<ul>
|
||
<li>Start a new discussion on the <a href="https://discourse.joplinapp.org/t/persist-editor-layout-plugin/14411">Forum</a> or upvote <a href="https://github.com/benji300/joplin-persistent-layout/issues?q=is%3Aissue+is%3Aopen+label%3Aenhancement+sort%3Areactions-%2B1-desc+">popular feature requests</a></li>
|
||
</ul>
|
||
</li>
|
||
<li>:bug: Found a bug?
|
||
<ul>
|
||
<li>Check the <a href="https://discourse.joplinapp.org/t/persist-editor-layout-plugin/14411">Forum</a> if anyone else already reported the same issue. Otherwise report it by yourself.</li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
<h2>Support</h2>
|
||
<p>You like this plugin as much as I do and it improves your daily work with Joplin?</p>
|
||
<p>Then I would be very happy if you buy me a :beer: or :coffee: via <a href="https://www.paypal.com/donate?hosted_button_id=6FHDGK3PTNU22">PayPal</a> :wink:</p>
|
||
<h2>Contributing</h2>
|
||
<p>Contributions to this plugin are most welcome. Feel free to open a pull request or an issue.
|
||
Make sure to use conventional <a href="https://github.com/pvdlg/conventional-commit-types">commit messages</a> if you're creating a pull request.</p>
|
||
<h2>Development</h2>
|
||
<p>The npm package of the plugin can be found <a href="https://www.npmjs.com/package/joplin-plugin-persistent-editor-layout">here</a>.</p>
|
||
<h3>Building the plugin</h3>
|
||
<p>If you want to build the plugin by your own simply run <code>npm run dist</code>.</p>
|
||
<h3>Updating the plugin framework</h3>
|
||
<p>To update the plugin framework, run <code>npm run update</code>.</p>
|
||
<h2>Changes</h2>
|
||
<p>See <a href="https://raw.githubusercontent.com/benji300/joplin-persistent-layout/HEAD/CHANGELOG.md">CHANGELOG</a> for details.</p>
|
||
<h2>License</h2>
|
||
<p>Copyright (c) 2021 Benjamin Seifert</p>
|
||
<p>MIT License. See <a href="https://raw.githubusercontent.com/benji300/joplin-persistent-layout/HEAD/LICENSE">LICENSE</a> for more information.</p>
|
||
|
||
</div>
|
||
</div>
|
||
</main>
|
||
|
||
<footer class="page-footer">
|
||
<div class="plugin-documentation-section">
|
||
<div class="heading">
|
||
Would you like to submit or develop a plugin? Consult our documentation:
|
||
</div>
|
||
<a class="btn btn-outline-primary" href="https://joplinapp.org/help/api/get_started/plugins">
|
||
See documentation
|
||
</a>
|
||
</div>
|
||
|
||
<div class="links legal-and-about-links">
|
||
<div class="copyright">© Joplin 2023 - 2024</div>
|
||
<a class="link terms-and-conditions" href="/plugins/terms-and-conditions.html">Terms and conditions</a>
|
||
<a class="link privacy" href="/plugins/privacy-policy.html">Privacy policy</a>
|
||
</div>
|
||
|
||
|
||
<div class="site-links">
|
||
<a
|
||
class="a-github"
|
||
href="https://github.com/joplin/website-plugin-discovery"
|
||
aria-label="GitHub"
|
||
title="GitHub"
|
||
>
|
||
<i class="fab fa-github"></i>
|
||
</a>
|
||
<a
|
||
class="a-discord"
|
||
href="https://discord.com/invite/VSj7AFHvpq"
|
||
aria-label="Discord"
|
||
title="Discord"
|
||
>
|
||
<i class="fab fa-discord"></i>
|
||
</a>
|
||
<a
|
||
class="a-linkedin"
|
||
href="https://www.linkedin.com/company/joplin"
|
||
aria-label="LinkedIn"
|
||
title="LinkedIn"
|
||
>
|
||
<i class="fab fa-linkedin"></i>
|
||
</a>
|
||
<a
|
||
class="a-twitter"
|
||
href="https://twitter.com/joplinapp"
|
||
aria-label="Twitter"
|
||
title="Twitter"
|
||
>
|
||
<i class="fab fa-twitter"></i>
|
||
</a>
|
||
<a
|
||
class="a-mastodon"
|
||
href="https://mastodon.social/@joplinapp"
|
||
aria-label="Mastodon"
|
||
title="Mastodon"
|
||
>
|
||
<i class="fab fa-mastodon"></i>
|
||
</a>
|
||
<a
|
||
class="a-patreon"
|
||
href="https://www.patreon.com/joplin"
|
||
aria-label="Patreon"
|
||
title="Patreon"
|
||
>
|
||
<i class="fab fa-patreon"></i>
|
||
</a>
|
||
</div>
|
||
</footer>
|
||
|
||
</body>
|
||
|
||
</html>
|
||
|