FR: Plugins should have links to help and code

Features
15

I've never used Evernote and I seriously don't care. But if you scroll down just a little bit, you'll see the following (it can't be clearer than that, unless people can't read, but then they don't need Joplin in the first place):

Edit/Update: I don't want to be argumentative either, but scrolling a web page and reading can't be too much for a non technical person.

Joplin Persistent Editor Layout

Persistent Editor Layout is a plugin to extend the UX of Joplin's desktop application.

It allows to persist the editor layout for each note separately with special tags.

:warning: CAUTION - Requires Joplin v1.7.4 or newer

Table of contents

Features

  • Persist the editor layout (editor / split view / viewer / rich text) for each note separately
  • Using special tags
    • So persisted layout is synced across devices
    • Requires the plugin to be installed

Installation

Automatic (Joplin v1.6.4 and newer)

  • Open Joplin and navigate to Tools > Options > Plugins
  • Search for persistent editor layout and press install
  • Restart Joplin to enable the plugin

Manual

  • Download the latest released JPL package (*.jpl) from here
  • Open Joplin and navigate to Tools > Options > Plugins
  • Press Install plugin and select the previously downloaded jpl file
  • Confirm selection
  • Restart Joplin to enable the plugin

Uninstall

  • Open Joplin and navigate to Tools > Options > Plugins
  • Search for the Persistent Editor Layout plugin
  • Press Delete to remove the plugin completely
    • Alternatively you can also disable the plugin by clicking on the toggle button
  • Restart Joplin

Usage

Persist layout for a note

To persist the layout for a note simply add one of the following tags as specified:

Tag Layout
layout:editor Markdown: editor view
layout:split Markdown: Split view
layout:viewer Markdown: Rendered view
layout:richtext Rich text (WYSIWYG) editor

This can be done by manually adding them to the notes or via the command.

  • The setting View > Layout button sequence must be set according to the tags used.
    That means, if the tag layout:viewer is set in at least one note, the setting must also contain Viewer.
    Otherwise layout will not be changed to the expected one.
  • When the selected note is changed, the editor layout is changed also.
  • If none of the tags is specified, the default layout from user option Default editor layout will be used.
    • If None is selected, the currently active layout will be kept.
  • If more than one is specified, they are checked in the order above and the first matching one is used.

Commands

This plugin provides additional commands as described in the following table.

Command Label Command ID Description Menu contexts
Persist editor layout persistEditorLayout Persist the current active editor layout for the selected note(s) Tools, NoteListContext, Command palette

Keyboard shortcuts

Keyboard shortcuts can be assigned in user options via Tools > Options > Keyboard Shortcuts to all commands which are assigned to the Tools menu context.
In the keyboard shortcut editor, search for the command label where shortcuts shall be added.

User options

This plugin adds provides user options which can be changed via Tools > Options > Persistent Layout.

Feedback

  • :question: Need help?
  • :bulb: An idea to improve or enhance the plugin?
  • :bug: Found a bug?
    • Check the Forum if anyone else already reported the same issue. Otherwise report it by yourself.

Support

You like this plugin as much as I do and it improves your daily work with Joplin?

Then I would be very happy if you buy me a beer via PayPal :wink::beer:

Development

The npm package of the plugin can be found here.

Building the plugin

If you want to build the plugin by your own simply run npm run dist.

Updating the plugin framework

To update the plugin framework, run npm run update.

Changes

See CHANGELOG for details.

License

Copyright (c) 2021 Benjamin Seifert

MIT License. See LICENSE for more information.

1 Like