1
0
mirror of https://github.com/laurent22/joplin.git synced 2024-12-24 10:27:10 +02:00

Merge branch 'dev' into rn_63

This commit is contained in:
Laurent Cozic 2020-10-16 16:24:07 +01:00
commit 2fb6cee901
153 changed files with 9498 additions and 987 deletions

View File

@ -70,6 +70,7 @@ CliClient/tests/services_CommandService.js
CliClient/tests/services_InteropService.js
CliClient/tests/services_PluginService.js
CliClient/tests/services_rest_Api.js
CliClient/tests/services/plugins/api/JoplinSetting.js
CliClient/tests/services/plugins/sandboxProxy.js
CliClient/tests/synchronizer_LockHandler.js
CliClient/tests/synchronizer_MigrationHandler.js
@ -273,11 +274,13 @@ ReactNativeClient/lib/services/plugins/api/JoplinSettings.js
ReactNativeClient/lib/services/plugins/api/JoplinViews.js
ReactNativeClient/lib/services/plugins/api/JoplinViewsDialogs.js
ReactNativeClient/lib/services/plugins/api/JoplinViewsMenuItems.js
ReactNativeClient/lib/services/plugins/api/JoplinViewsMenus.js
ReactNativeClient/lib/services/plugins/api/JoplinViewsPanels.js
ReactNativeClient/lib/services/plugins/api/JoplinViewsToolbarButtons.js
ReactNativeClient/lib/services/plugins/api/JoplinWorkspace.js
ReactNativeClient/lib/services/plugins/api/types.js
ReactNativeClient/lib/services/plugins/BasePluginRunner.js
ReactNativeClient/lib/services/plugins/MenuController.js
ReactNativeClient/lib/services/plugins/MenuItemController.js
ReactNativeClient/lib/services/plugins/Plugin.js
ReactNativeClient/lib/services/plugins/PluginService.js

3
.gitignore vendored
View File

@ -64,6 +64,7 @@ CliClient/tests/services_CommandService.js
CliClient/tests/services_InteropService.js
CliClient/tests/services_PluginService.js
CliClient/tests/services_rest_Api.js
CliClient/tests/services/plugins/api/JoplinSetting.js
CliClient/tests/services/plugins/sandboxProxy.js
CliClient/tests/synchronizer_LockHandler.js
CliClient/tests/synchronizer_MigrationHandler.js
@ -267,11 +268,13 @@ ReactNativeClient/lib/services/plugins/api/JoplinSettings.js
ReactNativeClient/lib/services/plugins/api/JoplinViews.js
ReactNativeClient/lib/services/plugins/api/JoplinViewsDialogs.js
ReactNativeClient/lib/services/plugins/api/JoplinViewsMenuItems.js
ReactNativeClient/lib/services/plugins/api/JoplinViewsMenus.js
ReactNativeClient/lib/services/plugins/api/JoplinViewsPanels.js
ReactNativeClient/lib/services/plugins/api/JoplinViewsToolbarButtons.js
ReactNativeClient/lib/services/plugins/api/JoplinWorkspace.js
ReactNativeClient/lib/services/plugins/api/types.js
ReactNativeClient/lib/services/plugins/BasePluginRunner.js
ReactNativeClient/lib/services/plugins/MenuController.js
ReactNativeClient/lib/services/plugins/MenuItemController.js
ReactNativeClient/lib/services/plugins/Plugin.js
ReactNativeClient/lib/services/plugins/PluginService.js

View File

@ -0,0 +1,16 @@
// import Setting from 'lib/models/Setting';
// const { asyncTest, setupDatabaseAndSynchronizer, switchClient, expectThrow, expectNotThrow } = require('../test-utils.js');
// describe('plugin_api_JoplinSetting', function() {
// beforeEach(async (done) => {
// await setupDatabaseAndSynchronizer(1);
// await switchClient(1);
// done();
// });
// it('should get and set plugin-specific values', asyncTest(async () => {
// await
// }));
// });

View File

@ -2,7 +2,7 @@ import PluginRunner from '../app/services/plugins/PluginRunner';
import PluginService from 'lib/services/plugins/PluginService';
require('app-module-path').addPath(__dirname);
const { asyncTest, setupDatabaseAndSynchronizer, switchClient } = require('test-utils.js');
const { asyncTest, setupDatabaseAndSynchronizer, switchClient, expectThrow } = require('test-utils.js');
const Note = require('lib/models/Note');
const Folder = require('lib/models/Folder');
@ -40,8 +40,7 @@ describe('services_PluginService', function() {
it('should load and run a simple plugin', asyncTest(async () => {
const service = newPluginService();
const plugin = await service.loadPlugin(`${testPluginDir}/simple`);
await service.runPlugin(plugin);
await service.loadAndRunPlugins([`${testPluginDir}/simple`]);
const allFolders = await Folder.all();
expect(allFolders.length).toBe(1);
@ -55,9 +54,9 @@ describe('services_PluginService', function() {
it('should load and run a plugin that uses external packages', asyncTest(async () => {
const service = newPluginService();
const plugin = await service.loadPlugin(`${testPluginDir}/withExternalModules`);
await service.loadAndRunPlugins([`${testPluginDir}/withExternalModules`]);
const plugin = service.pluginById('withexternalmodules');
expect(plugin.id).toBe('withexternalmodules');
await service.runPlugin(plugin);
const allFolders = await Folder.all();
expect(allFolders.length).toBe(1);
@ -78,4 +77,75 @@ describe('services_PluginService', function() {
expect(allFolders.map((f:any) => f.title).sort().join(', ')).toBe('multi - simple1, multi - simple2');
}));
it('should load plugins from JS bundles', asyncTest(async () => {
const service = newPluginService();
const plugin = await service.loadPluginFromString('example', '/tmp', `
/* joplin-manifest:
{
"manifest_version": 1,
"name": "JS Bundle test",
"description": "JS Bundle Test plugin",
"version": "1.0.0",
"author": "Laurent Cozic",
"homepage_url": "https://joplinapp.org"
}
*/
joplin.plugins.register({
onStart: async function() {
await joplin.data.post(['folders'], null, { title: "my plugin folder" });
},
});
`);
await service.runPlugin(plugin);
expect(plugin.manifest.manifest_version).toBe(1);
expect(plugin.manifest.name).toBe('JS Bundle test');
const allFolders = await Folder.all();
expect(allFolders.length).toBe(1);
}));
it('should load plugins from JS bundle files', asyncTest(async () => {
const service = newPluginService();
await service.loadAndRunPlugins(`${testPluginDir}/jsbundles`);
expect(!!service.pluginById('example')).toBe(true);
expect((await Folder.all()).length).toBe(1);
}));
it('should validate JS bundles', asyncTest(async () => {
const invalidJsBundles = [
`
/* joplin-manifest:
{
"not_a_valid_manifest_at_all": 1
}
*/
joplin.plugins.register({
onStart: async function() {},
});
`, `
/* joplin-manifest:
*/
joplin.plugins.register({
onStart: async function() {},
});
`, `
joplin.plugins.register({
onStart: async function() {},
});
`, '',
];
const service = newPluginService();
for (const jsBundle of invalidJsBundles) {
await expectThrow(async () => await service.loadPluginFromString('example', '/tmp', jsBundle));
}
}));
});

View File

@ -3,6 +3,7 @@
"spec_files": [
"*.js",
"services/plugins/*.js",
"services/plugins/api/*.js",
"!test-utils.js"
],
"stopSpecOnExpectationFailure": false,

View File

@ -0,0 +1,16 @@
/* joplin-manifest:
{
"manifest_version": 1,
"name": "JS Bundle test",
"description": "JS Bundle Test plugin",
"version": "1.0.0",
"author": "Laurent Cozic",
"homepage_url": "https://joplinapp.org"
}
*/
joplin.plugins.register({
onStart: async function() {
await joplin.data.post(['folders'], null, { title: "my plugin folder" });
},
});

View File

@ -0,0 +1,2 @@
dist/*
node_modules/

View File

@ -0,0 +1,14 @@
# Joplin Plugin
This is a template to create a new Joplin plugin.
The main two files you will want to look at are:
- `/src/index.ts`, which contains the entry point for the plugin source code.
- `/src/manifest.json`, which is the plugin manifest. It contains information such as the plugin a name, version, etc.
The plugin is built using webpack, which create the compiled code in `/dist`. The project is setup to use TypeScript, although you can change the configuration to use plain JavaScript.
## Building the plugin
To build the plugin, simply run `npm run dist`.

View File

@ -0,0 +1,15 @@
import Plugin from '../Plugin';
import Joplin from './Joplin';
import Logger from 'lib/Logger';
/**
* @ignore
*/
export default class Global {
private joplin_;
private requireWhiteList_;
constructor(logger: Logger, implementation: any, plugin: Plugin, store: any);
get joplin(): Joplin;
private requireWhiteList;
require(filePath: string): any;
get process(): any;
}

View File

@ -0,0 +1,38 @@
import Plugin from '../Plugin';
import JoplinData from './JoplinData';
import JoplinPlugins from './JoplinPlugins';
import JoplinWorkspace from './JoplinWorkspace';
import JoplinFilters from './JoplinFilters';
import JoplinCommands from './JoplinCommands';
import JoplinViews from './JoplinViews';
import JoplinInterop from './JoplinInterop';
import JoplinSettings from './JoplinSettings';
import Logger from 'lib/Logger';
/**
* This is the main entry point to the Joplin API. You can access various services using the provided accessors.
*/
export default class Joplin {
private data_;
private plugins_;
private workspace_;
private filters_;
private commands_;
private views_;
private interop_;
private settings_;
constructor(logger: Logger, implementation: any, plugin: Plugin, store: any);
get data(): JoplinData;
get plugins(): JoplinPlugins;
get workspace(): JoplinWorkspace;
/**
* @ignore
*
* Not sure if it's the best way to hook into the app
* so for now disable filters.
*/
get filters(): JoplinFilters;
get commands(): JoplinCommands;
get views(): JoplinViews;
get interop(): JoplinInterop;
get settings(): JoplinSettings;
}

View File

@ -0,0 +1,51 @@
import { Command } from './types';
/**
* This class allows executing or registering new Joplin commands. Commands can be executed or associated with
* {@link JoplinViewsToolbarButtons | toolbar buttons} or {@link JoplinViewsMenuItems | menu items}.
*
* [View the demo plugin](https://github.com/laurent22/joplin/tree/dev/CliClient/tests/support/plugins/register_command)
*
* ## Executing Joplin's internal commands
*
* It is also possible to execute internal Joplin's commands which, as of now, are not well documented.
* You can find the list directly on GitHub though at the following locations:
*
* https://github.com/laurent22/joplin/tree/dev/ElectronClient/gui/MainScreen/commands
* https://github.com/laurent22/joplin/tree/dev/ElectronClient/commands
* https://github.com/laurent22/joplin/tree/dev/ElectronClient/gui/NoteEditor/commands/editorCommandDeclarations.ts
*
* To view what arguments are supported, you can open any of these files and look at the `execute()` command.
*/
export default class JoplinCommands {
/**
* <span class="platform-desktop">desktop</span> Executes the given command.
* The `props` are the arguments passed to the command, and they vary based on the command
*
* ```typescript
* // Create a new note in the current notebook:
* await joplin.commands.execute('newNote');
*
* // Create a new sub-notebook under the provided notebook
* // Note: internally, notebooks are called "folders".
* await joplin.commands.execute('newFolder', { parent_id: "SOME_FOLDER_ID" });
* ```
*/
execute(commandName: string, props?: any): Promise<any>;
/**
* <span class="platform-desktop">desktop</span> Registers a new command.
*
* ```typescript
* // Register a new commmand called "testCommand1"
*
* await joplin.commands.register({
* name: 'testCommand1',
* label: 'My Test Command 1',
* iconName: 'fas fa-music',
* execute: () => {
* alert('Testing plugin command 1');
* },
* });
* ```
*/
register(command: Command): Promise<void>;
}

View File

@ -0,0 +1,47 @@
import { Path } from './types';
/**
* This module provides access to the Joplin data API: https://joplinapp.org/api/references/rest_api/
* This is the main way to retrieve data, such as notes, notebooks, tags, etc.
* or to update them or delete them.
*
* This is also what you would use to search notes, via the `search` endpoint.
*
* [View the demo plugin](https://github.com/laurent22/joplin/tree/dev/CliClient/tests/support/plugins/simple)
*
* In general you would use the methods in this class as if you were using a REST API. There are four methods that map to GET, POST, PUT and DELETE calls.
* And each method takes these parameters:
*
* * `path`: This is an array that represents the path to the resource in the form `["resouceName", "resourceId", "resourceLink"]` (eg. ["tags", ":id", "notes"]). The "resources" segment is the name of the resources you want to access (eg. "notes", "folders", etc.). If not followed by anything, it will refer to all the resources in that collection. The optional "resourceId" points to a particular resources within the collection. Finally, an optional "link" can be present, which links the resource to a collection of resources. This can be used in the API for example to retrieve all the notes associated with a tag.
* * `query`: (Optional) The query parameters. In a URL, this is the part after the question mark "?". In this case, it should be an object with key/value pairs.
* * `data`: (Optional) Applies to PUT and POST calls only. The request body contains the data you want to create or modify, for example the content of a note or folder.
* * `files`: (Optional) Used to create new resources and associate them with files.
*
* Please refer to the [Joplin API documentation](https://joplinapp.org/api/references/rest_api/) for complete details about each call. As the plugin runs within the Joplin application **you do not need an authorisation token** to use this API.
*
* For example:
*
* ```typescript
* // Get a note ID, title and body
* const noteId = 'some_note_id';
* const note = await joplin.data.get(['notes', noteId], { fields: ['id', 'title', 'body'] });
*
* // Get all folders
* const folders = await joplin.data.get(['folders']);
*
* // Set the note body
* await joplin.data.put(['notes', noteId], null, { body: "New note body" });
*
* // Create a new note under one of the folders
* await joplin.data.post(['notes'], null, { body: "my new note", title: "some title", parent_id: folders[0].id });
* ```
*/
export default class JoplinData {
private api_;
private pathSegmentRegex_;
private serializeApiBody;
private pathToString;
get(path: Path, query?: any): Promise<any>;
post(path: Path, query?: any, body?: any, files?: any[]): Promise<any>;
put(path: Path, query?: any, body?: any, files?: any[]): Promise<any>;
delete(path: Path, query?: any): Promise<any>;
}

View File

@ -0,0 +1,10 @@
/**
* @ignore
*
* Not sure if it's the best way to hook into the app
* so for now disable filters.
*/
export default class JoplinFilters {
on(name: string, callback: Function): Promise<void>;
off(name: string, callback: Function): Promise<void>;
}

View File

@ -0,0 +1,17 @@
import { ExportModule, ImportModule } from './types';
/**
* Provides a way to create modules to import external data into Joplin or to export notes into any arbitrary format.
*
* [View the demo plugin](https://github.com/laurent22/joplin/tree/dev/CliClient/tests/support/plugins/json_export)
*
* To implement an import or export module, you would simply define an object with various event handlers that are called
* by the application during the import/export process.
*
* See the documentation of the [[ExportModule]] and [[ImportModule]] for more information.
*
* You may also want to refer to the Joplin API documentation to see the list of properties for each item (note, notebook, etc.) - https://joplinapp.org/api/references/rest_api/
*/
export default class JoplinInterop {
registerExportModule(module: ExportModule): Promise<void>;
registerImportModule(module: ImportModule): Promise<void>;
}

View File

@ -0,0 +1,24 @@
import Plugin from '../Plugin';
import Logger from 'lib/Logger';
import { Script } from './types';
/**
* This class provides access to plugin-related features.
*/
export default class JoplinPlugins {
private logger;
private plugin;
constructor(logger: Logger, plugin: Plugin);
/**
* Registers a new plugin. This is the entry point when creating a plugin. You should pass a simple object with an `onStart` method to it.
* That `onStart` method will be executed as soon as the plugin is loaded.
*
* ```typescript
* joplin.plugins.register({
* onStart: async function() {
* // Run your plugin code here
* }
* });
* ```
*/
register(script: Script): Promise<void>;
}

View File

@ -0,0 +1,43 @@
import Plugin from '../Plugin';
import { SettingItem, SettingSection } from './types';
/**
* This API allows registering new settings and setting sections, as well as getting and setting settings. Once a setting has been registered it will appear in the config screen and be editable by the user.
*
* Settings are essentially key/value pairs.
*
* Note: Currently this API does **not** provide access to Joplin's built-in settings. This is by design as plugins that modify user settings could give unexpected results
*
* [View the demo plugin](https://github.com/laurent22/joplin/tree/dev/CliClient/tests/support/plugins/settings)
*/
export default class JoplinSettings {
private plugin_;
constructor(plugin: Plugin);
private namespacedKey;
/**
* Registers a new setting. Note that registering a setting item is dynamic and will be gone next time Joplin starts.
* What it means is that you need to register the setting every time the plugin starts (for example in the onStart event).
* The setting value however will be preserved from one launch to the next so there is no risk that it will be lost even if for some
* reason the plugin fails to start at some point.
*/
registerSetting(key: string, settingItem: SettingItem): Promise<void>;
/**
* Registers a new setting section. Like for registerSetting, it is dynamic and needs to be done every time the plugin starts.
*/
registerSection(name: string, section: SettingSection): Promise<void>;
/**
* Gets a setting value (only applies to setting you registered from your plugin)
*/
value(key: string): Promise<any>;
/**
* Sets a setting value (only applies to setting you registered from your plugin)
*/
setValue(key: string, value: any): Promise<void>;
/**
* Gets a global setting value, including app-specific settings and those set by other plugins.
*
* The list of available settings is not documented yet, but can be found by looking at the source code:
*
* https://github.com/laurent22/joplin/blob/3539a452a359162c461d2849829d2d42973eab50/ReactNativeClient/lib/models/Setting.ts#L142
*/
globalValue(key: string): Promise<any>;
}

View File

@ -0,0 +1,28 @@
import Plugin from '../Plugin';
import JoplinViewsDialogs from './JoplinViewsDialogs';
import JoplinViewsMenuItems from './JoplinViewsMenuItems';
import JoplinViewsMenus from './JoplinViewsMenus';
import JoplinViewsToolbarButtons from './JoplinViewsToolbarButtons';
import JoplinViewsPanels from './JoplinViewsPanels';
/**
* This namespace provides access to view-related services.
*
* All view services provide a `create()` method which you would use to create the view object, whether it's a dialog, a toolbar button or a menu item.
* In some cases, the `create()` method will return a [[ViewHandle]], which you would use to act on the view, for example to set certain properties or call some methods.
*/
export default class JoplinViews {
private store;
private plugin;
private dialogs_;
private panels_;
private menuItems_;
private menus_;
private toolbarButtons_;
private implementation_;
constructor(implementation: any, plugin: Plugin, store: any);
get dialogs(): JoplinViewsDialogs;
get panels(): JoplinViewsPanels;
get menuItems(): JoplinViewsMenuItems;
get menus(): JoplinViewsMenus;
get toolbarButtons(): JoplinViewsToolbarButtons;
}

View File

@ -0,0 +1,36 @@
import Plugin from '../Plugin';
import { ButtonSpec, ViewHandle, ButtonId } from './types';
/**
* Allows creating and managing dialogs. A dialog is modal window that contains a webview and a row of buttons. You can update the update the webview using the `setHtml` method.
* Dialogs are hidden by default and you need to call `open()` to open them. Once the user clicks on a button, the `open` call will return and provide the button ID that was
* clicked on. There is currently no "close" method since the dialog should be thought as a modal one and thus can only be closed by clicking on one of the buttons.
*
* [View the demo plugin](https://github.com/laurent22/joplin/tree/dev/CliClient/tests/support/plugins/dialog)
*/
export default class JoplinViewsDialogs {
private store;
private plugin;
private implementation_;
constructor(implementation: any, plugin: Plugin, store: any);
private controller;
/**
* Creates a new dialog
*/
create(): Promise<ViewHandle>;
/**
* Displays a message box with OK/Cancel buttons. Returns the button index that was clicked - "0" for OK and "1" for "Cancel"
*/
showMessageBox(message: string): Promise<number>;
/**
* Sets the dialog HTML content
*/
setHtml(handle: ViewHandle, html: string): Promise<string>;
/**
* Sets the dialog buttons.
*/
setButtons(handle: ViewHandle, buttons: ButtonSpec[]): Promise<ButtonSpec[]>;
/**
* Opens the dialog
*/
open(handle: ViewHandle): Promise<ButtonId>;
}

View File

@ -0,0 +1,16 @@
import { CreateMenuItemOptions, MenuItemLocation } from './types';
import Plugin from '../Plugin';
/**
* Allows creating and managing menu items.
*
* [View the demo plugin](https://github.com/laurent22/joplin/tree/dev/CliClient/tests/support/plugins/register_command)
*/
export default class JoplinViewsMenuItems {
private store;
private plugin;
constructor(plugin: Plugin, store: any);
/**
* Creates a new menu item and associate it with the given command. You can specify under which menu the item should appear using the `location` parameter.
*/
create(commandName: string, location?: MenuItemLocation, options?: CreateMenuItemOptions): Promise<void>;
}

View File

@ -0,0 +1,18 @@
import { MenuItem, MenuItemLocation } from './types';
import Plugin from '../Plugin';
/**
* Allows creating menus.
*
* [View the demo plugin](https://github.com/laurent22/joplin/tree/dev/CliClient/tests/support/plugins/menu)
*/
export default class JoplinViewsMenus {
private store;
private plugin;
constructor(plugin: Plugin, store: any);
private registerCommandAccelerators;
/**
* Creates a new menu from the provided menu items and place it at the given location. As of now, it is only possible to place the
* menu as a sub-menu of the application build-in menus.
*/
create(label: string, menuItems: MenuItem[], location?: MenuItemLocation): Promise<void>;
}

View File

@ -0,0 +1,30 @@
import Plugin from '../Plugin';
import { ViewHandle } from './types';
/**
* Allows creating and managing view panels. View panels currently are displayed at the right of the sidebar and allows displaying any HTML content (within a webview) and update it in real-time. For example
* it could be used to display a table of content for the active note, or display various metadata or graph.
*
* [View the demo plugin](https://github.com/laurent22/joplin/tree/dev/CliClient/tests/support/plugins/toc)
*/
export default class JoplinViewsPanels {
private store;
private plugin;
constructor(plugin: Plugin, store: any);
private controller;
/**
* Creates a new panel
*/
create(): Promise<ViewHandle>;
/**
* Sets the panel webview HTML
*/
setHtml(handle: ViewHandle, html: string): Promise<string>;
/**
* Adds and loads a new JS or CSS files into the panel.
*/
addScript(handle: ViewHandle, scriptPath: string): Promise<void>;
/**
* Called when a message is sent from the webview (using postMessage).
*/
onMessage(handle: ViewHandle, callback: Function): Promise<void>;
}

View File

@ -0,0 +1,16 @@
import { ToolbarButtonLocation } from './types';
import Plugin from '../Plugin';
/**
* Allows creating and managing toolbar buttons.
*
* [View the demo plugin](https://github.com/laurent22/joplin/tree/dev/CliClient/tests/support/plugins/register_command)
*/
export default class JoplinViewsToolbarButtons {
private store;
private plugin;
constructor(plugin: Plugin, store: any);
/**
* Creates a new toolbar button and associate it with the given command.
*/
create(commandName: string, location: ToolbarButtonLocation): Promise<void>;
}

View File

@ -0,0 +1,34 @@
/**
* The workspace service provides access to all the parts of Joplin that are being worked on - i.e. the currently selected notes or notebooks as well
* as various related events, such as when a new note is selected, or when the note content changes.
*
* [View the demo plugin](https://github.com/laurent22/joplin/tree/dev/CliClient/tests/support/plugins)
*/
export default class JoplinWorkspace {
private store;
constructor(_implementation: any, store: any);
/**
* Called when a new note or notes are selected.
*/
onNoteSelectionChange(callback: Function): Promise<void>;
/**
* Called when the content of a note changes.
*/
onNoteContentChange(callback: Function): Promise<void>;
/**
* Called when an alarm associated with a to-do is triggered.
*/
onNoteAlarmTrigger(callback: Function): Promise<void>;
/**
* Called when the synchronisation process has finished.
*/
onSyncComplete(callback: Function): Promise<void>;
/**
* Gets the currently selected note
*/
selectedNote(): Promise<any>;
/**
* Gets the IDs of the selected notes (can be zero, one, or many). Use the data API to retrieve information about these notes.
*/
selectedNoteIds(): Promise<string[]>;
}

View File

@ -0,0 +1,5 @@
import type Joplin from './Joplin';
declare const joplin:Joplin;
export default joplin;

View File

@ -0,0 +1,263 @@
// =================================================================
// Command API types
// =================================================================
export interface Command {
name: string
label: string
iconName?: string,
execute(props:any):Promise<any>
isEnabled?(props:any):boolean
mapStateToProps?(state:any):any
}
// =================================================================
// Interop API types
// =================================================================
export enum FileSystemItem {
File = 'file',
Directory = 'directory',
}
export enum ImportModuleOutputFormat {
Markdown = 'md',
Html = 'html',
}
/**
* Used to implement a module to export data from Joplin. [View the demo plugin](https://github.com/laurent22/joplin/tree/dev/CliClient/tests/support/plugins/json_export) for an example.
*
* In general, all the event handlers you'll need to implement take a `context` object as a first argument. This object will contain the export or import path as well as various optional properties, such as which notes or notebooks need to be exported.
*
* To get a better sense of what it will contain it can be useful to print it using `console.info(context)`.
*/
export interface ExportModule {
/**
* The format to be exported, eg "enex", "jex", "json", etc.
*/
format: string,
/**
* The description that will appear in the UI, for example in the menu item.
*/
description: string,
/**
* Whether the module will export a single file or multiple files in a directory. It affects the open dialog that will be presented to the user when using your exporter.
*/
target: FileSystemItem,
/**
* Only applies to single file exporters or importers
* It tells whether the format can package multiple notes into one file.
* For example JEX or ENEX can, but HTML cannot.
*/
isNoteArchive: boolean,
/**
* The extensions of the files exported by your module. For example, it is `["htm", "html"]` for the HTML module, and just `["jex"]` for the JEX module.
*/
fileExtensions?: string[],
/**
* Called when the export process starts.
*/
onInit(context:ExportContext): Promise<void>;
/**
* Called when an item needs to be processed. An "item" can be any Joplin object, such as a note, a folder, a notebook, etc.
*/
onProcessItem(context:ExportContext, itemType:number, item:any):Promise<void>;
/**
* Called when a resource file needs to be exported.
*/
onProcessResource(context:ExportContext, resource:any, filePath:string):Promise<void>;
/**
* Called when the export process is done.
*/
onClose(context:ExportContext):Promise<void>;
}
export interface ImportModule {
/**
* The format to be exported, eg "enex", "jex", "json", etc.
*/
format: string,
/**
* The description that will appear in the UI, for example in the menu item.
*/
description: string,
/**
* Only applies to single file exporters or importers
* It tells whether the format can package multiple notes into one file.
* For example JEX or ENEX can, but HTML cannot.
*/
isNoteArchive: boolean,
/**
* The type of sources that are supported by the module. Tells whether the module can import files or directories or both.
*/
sources: FileSystemItem[],
/**
* Tells the file extensions of the exported files.
*/
fileExtensions?: string[],
/**
* Tells the type of notes that will be generated, either HTML or Markdown (default).
*/
outputFormat?: ImportModuleOutputFormat,
/**
* Called when the import process starts. There is only one event handler within which you should import the complete data.
*/
onExec(context:ImportContext): Promise<void>;
}
export interface ExportOptions {
format?: string,
path?:string,
sourceFolderIds?: string[],
sourceNoteIds?: string[],
modulePath?:string,
target?:FileSystemItem,
}
export interface ExportContext {
destPath: string,
options: ExportOptions,
/**
* You can attach your own custom data using this propery - it will then be passed to each event handler, allowing you to keep state from one event to the next.
*/
userData?: any,
}
export interface ImportContext {
sourcePath: string,
options: any,
warnings: string[],
}
// =================================================================
// Misc types
// =================================================================
export interface Script {
onStart?(event:any):Promise<void>,
}
// =================================================================
// Menu types
// =================================================================
export interface CreateMenuItemOptions {
accelerator: string,
}
export enum MenuItemLocation {
File = 'file',
Edit = 'edit',
View = 'view',
Note = 'note',
Tools = 'tools',
Help = 'help',
Context = 'context',
}
export interface MenuItem {
commandName?: string,
accelerator?: string,
submenu?: MenuItem[],
label?: string,
}
// =================================================================
// View API types
// =================================================================
export interface ButtonSpec {
id: ButtonId,
title?: string,
onClick?():void,
}
export type ButtonId = string;
export enum ToolbarButtonLocation {
/**
* This toolbar in the top right corner of the application. It applies to the note as a whole, including its metadata.
*/
NoteToolbar = 'noteToolbar',
/**
* This toolbar is right above the text editor. It applies to the note body only.
*/
EditorToolbar = 'editorToolbar',
}
export type ViewHandle = string;
export interface EditorCommand {
name: string;
value?: any;
}
// =================================================================
// Settings types
// =================================================================
export enum SettingItemType {
Int = 1,
String = 2,
Bool = 3,
Array = 4,
Object = 5,
Button = 6,
}
// Redefine a simplified interface to mask internal details
// and to remove function calls as they would have to be async.
export interface SettingItem {
value: any,
type: SettingItemType,
public: boolean,
label:string,
description?:string,
isEnum?: boolean,
section?: string,
options?:any,
appTypes?:string[],
secure?: boolean,
advanced?: boolean,
minimum?: number,
maximum?: number,
step?: number,
}
export interface SettingSection {
label: string,
iconName?: string,
description?: string,
name?: string,
}
// =================================================================
// Data API types
// =================================================================
/**
* An array of at least one element and at most three elements.
*
* [0]: Resource name (eg. "notes", "folders", "tags", etc.)
* [1]: (Optional) Resource ID.
* [2]: (Optional) Resource link.
*/
export type Path = string[];

File diff suppressed because it is too large Load Diff

View File

@ -0,0 +1,20 @@
{
"name": "joplin_plugin",
"version": "1.0.0",
"description": "",
"scripts": {
"dist": "webpack",
"postinstall": "npm run dist"
},
"keywords": [],
"author": "",
"license": "MIT",
"devDependencies": {
"@types/node": "^14.0.14",
"copy-webpack-plugin": "^6.1.0",
"ts-loader": "^7.0.5",
"typescript": "^3.9.3",
"webpack": "^4.43.0",
"webpack-cli": "^3.3.11"
}
}

View File

@ -0,0 +1,25 @@
import joplin from 'api';
joplin.plugins.register({
onStart: async function() {
await joplin.views.menus.create('My Menu', [
{
commandName: "newNote",
},
{
commandName: "newFolder",
},
{
label: 'My sub-menu',
submenu: [
{
commandName: 'print',
},
{
commandName: 'setTags',
},
],
},
]);
},
});

View File

@ -0,0 +1,8 @@
{
"manifest_version": 1,
"name": "Menu Test",
"description": "",
"version": "1.0.0",
"author": "",
"homepage_url": ""
}

View File

@ -0,0 +1,10 @@
{
"compilerOptions": {
"outDir": "./dist/",
"module": "commonjs",
"target": "es2015",
"jsx": "react",
"allowJs": true,
"baseUrl": "."
}
}

View File

@ -0,0 +1,44 @@
const path = require('path');
const CopyPlugin = require('copy-webpack-plugin');
module.exports = {
mode: 'production',
entry: './src/index.ts',
target: 'node',
module: {
rules: [
{
test: /\.tsx?$/,
use: 'ts-loader',
exclude: /node_modules/,
},
],
},
resolve: {
alias: {
api: path.resolve(__dirname, 'api')
},
extensions: [ '.tsx', '.ts', '.js' ],
},
output: {
filename: 'index.js',
path: path.resolve(__dirname, 'dist'),
},
plugins: [
new CopyPlugin({
patterns: [
{
from: "**/*",
context: path.resolve(__dirname, 'src'),
to: path.resolve(__dirname, 'dist'),
globOptions: {
ignore: [
'**/*.ts',
'**/*.tsx',
],
},
},
],
}),
],
};

View File

@ -466,14 +466,14 @@ class Application extends BaseApplication {
async start(argv:string[]):Promise<any> {
const electronIsDev = require('electron-is-dev');
await fs.mkdirp(Setting.value('templateDir'), 0o755);
// If running inside a package, the command line, instead of being "node.exe <path> <flags>" is "joplin.exe <flags>" so
// insert an extra argument so that they can be processed in a consistent way everywhere.
if (!electronIsDev) argv.splice(1, 0, '.');
argv = await super.start(argv);
await fs.mkdirp(Setting.value('templateDir'), 0o755);
await this.applySettingsSideEffects();
if (Setting.value('sync.upgradeState') === Setting.SYNC_UPGRADE_STATE_MUST_DO) {

View File

@ -4,7 +4,7 @@ import { _ } from 'lib/locale';
export const declaration:CommandDeclaration = {
name: 'toggleNoteList',
label: () => _('Toggle note list'),
iconName: 'fa-align-justify',
iconName: 'fas fa-align-justify',
};
export const runtime = (comp:any):CommandRuntime => {
@ -14,8 +14,5 @@ export const runtime = (comp:any):CommandRuntime => {
type: 'NOTELIST_VISIBILITY_TOGGLE',
});
},
title: () => {
return _('Toggle note list');
},
};
};

View File

@ -4,7 +4,7 @@ import { _ } from 'lib/locale';
export const declaration:CommandDeclaration = {
name: 'toggleSidebar',
label: () => _('Toggle sidebar'),
iconName: 'fa-bars',
iconName: 'fas fa-bars',
};
export const runtime = (comp:any):CommandRuntime => {
@ -14,8 +14,5 @@ export const runtime = (comp:any):CommandRuntime => {
type: 'SIDEBAR_VISIBILITY_TOGGLE',
});
},
title: () => {
return _('Toggle sidebar');
},
};
};

View File

@ -5,14 +5,14 @@ import { stateUtils } from 'lib/reducer';
import CommandService from 'lib/services/CommandService';
import MenuUtils from 'lib/services/commands/MenuUtils';
import KeymapService from 'lib/services/KeymapService';
import { utils as pluginUtils, ViewInfo } from 'lib/services/plugins/reducer';
import { PluginStates, utils as pluginUtils } from 'lib/services/plugins/reducer';
import shim from 'lib/shim';
import Setting from 'lib/models/Setting';
import versionInfo from 'lib/versionInfo';
import { Module } from 'lib/services/interop/types';
import InteropServiceHelper from '../InteropServiceHelper';
import { _ } from 'lib/locale';
import { MenuItemLocation } from 'lib/services/plugins/api/types';
import { MenuItem, MenuItemLocation } from 'lib/services/plugins/api/types';
const { connect } = require('react-redux');
const { reg } = require('lib/registry.js');
@ -23,6 +23,51 @@ const Menu = bridge().Menu;
const PluginManager = require('lib/services/PluginManager');
const TemplateUtils = require('lib/TemplateUtils');
const menuUtils = new MenuUtils(CommandService.instance());
function pluginMenuItemsCommandNames(menuItems:MenuItem[]):string[] {
let output:string[] = [];
for (const menuItem of menuItems) {
if (menuItem.submenu) {
output = output.concat(pluginMenuItemsCommandNames(menuItem.submenu));
} else {
if (menuItem.commandName) output.push(menuItem.commandName);
}
}
return output;
}
function pluginCommandNames(plugins:PluginStates):string[] {
let output:string[] = [];
for (const view of pluginUtils.viewsByType(plugins, 'menu')) {
output = output.concat(pluginMenuItemsCommandNames(view.menuItems));
}
for (const view of pluginUtils.viewsByType(plugins, 'menuItem')) {
if (view.commandName) output.push(view.commandName);
}
return output;
}
function createPluginMenuTree(label:string, menuItems:MenuItem[], onMenuItemClick:Function) {
const output:any = {
label: label,
submenu: [],
};
for (const menuItem of menuItems) {
if (menuItem.submenu) {
output.submenu.push(createPluginMenuTree(menuItem.label, menuItem.submenu, onMenuItemClick));
} else {
output.submenu.push(menuUtils.commandToMenuItem(menuItem.commandName, onMenuItemClick));
}
}
return output;
}
interface Props {
dispatch: Function,
menuItemProps: any,
@ -36,7 +81,8 @@ interface Props {
showNoteCounts: boolean,
uncompletedTodosOnTop: boolean,
showCompletedTodos: boolean,
pluginMenuItemInfos: ViewInfo[],
pluginMenuItems: any[],
pluginMenus: any[],
}
const commandNames:string[] = [
@ -85,8 +131,6 @@ function menuItemSetEnabled(id:string, enabled:boolean) {
menuItem.enabled = enabled;
}
const menuUtils = new MenuUtils(CommandService.instance());
function useMenu(props:Props) {
const [menu, setMenu] = useState(null);
const [keymapLastChangeTime, setKeymapLastChangeTime] = useState(Date.now());
@ -143,7 +187,7 @@ function useMenu(props:Props) {
useEffect(() => {
const keymapService = KeymapService.instance();
const pluginCommandNames = props.pluginMenuItemInfos.map((viewInfo:ViewInfo) => viewInfo.view.commandName);
const pluginCommandNames = props.pluginMenuItems.map((view:any) => view.commandName);
const menuItemDic = menuUtils.commandsToMenuItems(commandNames.concat(pluginCommandNames), (commandName:string) => onMenuItemClickRef.current(commandName));
const quitMenuItem = {
@ -397,12 +441,16 @@ function useMenu(props:Props) {
}, shim.isMac() ? noItem : printItem, {
type: 'separator',
platforms: ['darwin'],
}, {
},
shim.isMac() ? {
label: _('Hide %s', 'Joplin'),
platforms: ['darwin'],
accelerator: shim.isMac() && keymapService.getAccelerator('hideApp'),
click: () => { bridge().electronApp().hide(); },
}, {
} : noItem,
{
type: 'separator',
},
quitMenuItem],
@ -641,26 +689,36 @@ function useMenu(props:Props) {
rootMenus[key].submenu = cleanUpSeparators(rootMenus[key].submenu);
}
const pluginMenuItems = PluginManager.instance().menuItems();
for (const item of pluginMenuItems) {
const itemParent = rootMenus[item.parent] ? rootMenus[item.parent] : 'tools';
itemParent.submenu.push(item);
{
// This is for GotoAnything only - should be refactored since this plugin manager is not used otherwise
const pluginMenuItems = PluginManager.instance().menuItems();
for (const item of pluginMenuItems) {
const itemParent = rootMenus[item.parent] ? rootMenus[item.parent] : 'tools';
itemParent.submenu.push(item);
}
}
// TODO: test
const pluginViewInfos = props.pluginMenuItemInfos;
for (const info of pluginViewInfos) {
const location:MenuItemLocation = info.view.location;
for (const view of props.pluginMenuItems) {
const location:MenuItemLocation = view.location;
if (location === MenuItemLocation.Context) continue;
const itemParent = rootMenus[location];
if (!itemParent) {
reg.logger().error('Menu item location does not exist: ', location, info);
reg.logger().error('Menu item location does not exist: ', location, view);
} else {
itemParent.submenu.push(menuItemDic[info.view.commandName]);
itemParent.submenu.push(menuItemDic[view.commandName]);
}
}
for (const view of props.pluginMenus) {
if (view.location === MenuItemLocation.Context) continue;
const itemParent = rootMenus[view.location];
if (!itemParent) {
reg.logger().error('Menu location does not exist: ', location, view);
} else {
itemParent.submenu.push(createPluginMenuTree(view.label, view.menuItems, (commandName:string) => onMenuItemClickRef.current(commandName)));
}
}
@ -725,7 +783,7 @@ function useMenu(props:Props) {
} else {
setMenu(Menu.buildFromTemplate(template));
}
}, [props.routeName, props.pluginMenuItemInfos, keymapLastChangeTime, modulesLastChangeTime]);
}, [props.routeName, props.pluginMenuItems, props.pluginMenus, keymapLastChangeTime, modulesLastChangeTime]);
useEffect(() => {
for (const commandName in props.menuItemProps) {
@ -735,7 +793,7 @@ function useMenu(props:Props) {
const layoutButtonSequenceOptions = Setting.enumOptions('layoutButtonSequence');
for (const value in layoutButtonSequenceOptions) {
menuItemSetEnabled(`layoutButtonSequence_${value}`, props.layoutButtonSequence === Number(value));
menuItemSetChecked(`layoutButtonSequence_${value}`, props.layoutButtonSequence === Number(value));
}
function applySortItemCheckState(type:string) {
@ -801,7 +859,7 @@ function MenuBar(props:Props):JSX.Element {
const mapStateToProps = (state:AppState) => {
return {
menuItemProps: menuUtils.commandsToMenuItemProps(state, commandNames),
menuItemProps: menuUtils.commandsToMenuItemProps(state, commandNames.concat(pluginCommandNames(state.pluginService.plugins))),
routeName: state.route.routeName,
selectedFolderId: state.selectedFolderId,
layoutButtonSequence: state.settings.layoutButtonSequence,
@ -812,7 +870,8 @@ const mapStateToProps = (state:AppState) => {
showNoteCounts: state.settings.showNoteCounts,
uncompletedTodosOnTop: state.settings.uncompletedTodosOnTop,
showCompletedTodos: state.settings.showCompletedTodos,
pluginMenuItemInfos: stateUtils.selectArrayShallow({ array: pluginUtils.viewInfosByType(state.pluginService.plugins, 'menuItem') }, 'menuBar.pluginMenuItemInfos'),
pluginMenuItems: stateUtils.selectArrayShallow({ array: pluginUtils.viewsByType(state.pluginService.plugins, 'menuItem') }, 'menuBar.pluginMenuItems'),
pluginMenus: stateUtils.selectArrayShallow({ array: pluginUtils.viewsByType(state.pluginService.plugins, 'menu') }, 'menuBar.pluginMenus'),
};
};

View File

@ -1,6 +1,6 @@
{
"name": "Joplin",
"version": "1.3.1",
"version": "1.3.2",
"lockfileVersion": 1,
"requires": true,
"dependencies": {
@ -1535,8 +1535,7 @@
},
"mkdirp": {
"version": "0.5.1",
"resolved": "https://registry.npmjs.org/mkdirp/-/mkdirp-0.5.1.tgz",
"integrity": "sha1-MAV0OOrGz3+MR2fzhkjWaX11yQM=",
"resolved": "",
"dev": true,
"optional": true,
"requires": {
@ -1701,8 +1700,7 @@
"dependencies": {
"minimist": {
"version": "1.2.0",
"resolved": "https://registry.npmjs.org/minimist/-/minimist-1.2.0.tgz",
"integrity": "sha1-o1AIsg9BOD7sH7kU9M1d95omQoQ=",
"resolved": "",
"dev": true,
"optional": true
}
@ -1817,8 +1815,7 @@
},
"tar": {
"version": "4.4.8",
"resolved": "https://registry.npmjs.org/tar/-/tar-4.4.8.tgz",
"integrity": "sha512-LzHF64s5chPQQS0IYBn9IN5h3i98c12bo4NCO7e0sGM2llXQ3p2FGC5sdENN4cTW48O915Sh+x+EXx7XW96xYQ==",
"resolved": "",
"dev": true,
"optional": true,
"requires": {
@ -5924,9 +5921,7 @@
"minimist": {
"version": "0.0.8",
"resolved": false,
"integrity": "sha1-hX/Kv8M5fSYluCKCYuhqp6ARsF0=",
"dev": true,
"optional": true
"integrity": "sha1-hX/Kv8M5fSYluCKCYuhqp6ARsF0="
},
"minipass": {
"version": "2.9.0",
@ -5950,14 +5945,9 @@
}
},
"mkdirp": {
"version": "0.5.1",
"resolved": false,
"integrity": "sha1-MAV0OOrGz3+MR2fzhkjWaX11yQM=",
"version": "0.5.5",
"dev": true,
"optional": true,
"requires": {
"minimist": "0.0.8"
}
"optional": true
},
"ms": {
"version": "2.1.2",
@ -6127,8 +6117,7 @@
"dependencies": {
"minimist": {
"version": "1.2.0",
"resolved": "https://registry.npmjs.org/minimist/-/minimist-1.2.0.tgz",
"integrity": "sha1-o1AIsg9BOD7sH7kU9M1d95omQoQ=",
"resolved": "",
"dev": true,
"optional": true
}

View File

@ -1,6 +1,6 @@
{
"name": "Joplin",
"version": "1.3.1",
"version": "1.3.2",
"description": "Joplin for Desktop",
"main": "main.js",
"scripts": {

View File

@ -1,4 +1,5 @@
#!/bin/bash
#!/usr/bin/env bash
set -e
#-----------------------------------------------------

View File

@ -100,7 +100,7 @@ The Web Clipper is a browser extension that allows you to save web pages and scr
- [Note History spec](https://github.com/laurent22/joplin/blob/dev/readme/spec/history.md)
- [Sync Lock spec](https://github.com/laurent22/joplin/blob/dev/readme/spec/sync_lock.md)
- [Plugin Architecture spec](https://github.com/laurent22/joplin/blob/dev/readme/spec/plugins.md)
- [Search Sorting spec](https://github.com/laurent22/joplin/blob/dev/readme/spec/search_sorting.md)
- [Search Sorting spec](https://github.com/laurent22/joplin/blob/dev/readme/spec/search_sorting.md)
- Google Summer of Code 2020

View File

@ -25,7 +25,6 @@ export interface CommandRuntime {
// Used for the (optional) toolbar button title
title?(props:any):string,
// props?:any
}
export interface CommandDeclaration {

View File

@ -172,12 +172,14 @@ export default class KeymapService extends BaseService {
.replace(/Alt/g, this.platform === 'darwin' ? 'Option' : 'Alt');
}
registerCommandAccelerator(commandName:string, accelerator:string) {
public registerCommandAccelerator(commandName:string, accelerator:string) {
// If the command is already registered, we don't register it again and
// we don't update the accelerator. This is because it might have been
// modified by the user and we don't want the plugin to overwrite this.
if (this.keymap[commandName]) return;
if (!commandName) throw new Error('Cannot register an accelerator without a command name');
const validatedAccelerator = this.convertToPlatform(accelerator);
this.validateAccelerator(validatedAccelerator);

View File

@ -69,7 +69,7 @@ export default class MenuUtils {
return KeymapService.instance();
}
private commandToMenuItem(commandName:string, onClick:Function):MenuItem {
public commandToMenuItem(commandName:string, onClick:Function):MenuItem {
const command = this.service.commandByName(commandName);
const item:MenuItem = {
@ -88,10 +88,9 @@ export default class MenuUtils {
}
public commandToStatefulMenuItem(commandName:string, props:any = null):MenuItem {
const output = this.commandsToMenuItems([commandName], () => {
return this.commandToMenuItem(commandName, () => {
return this.service.execute(commandName, props ? props : {});
});
return output[commandName];
}
public commandsToMenuItems(commandNames:string[], onClick:Function):MenuItems {

View File

@ -103,7 +103,7 @@ export default class InteropService_Exporter_Html extends InteropService_Exporte
// The source path is a bit hard-coded but shouldn't change.
for (let i = 0; i < result.pluginAssets.length; i++) {
const asset = result.pluginAssets[i];
const filePath = `${dirname(dirname(__dirname))}/gui/note-viewer/pluginAssets/${asset.name}`;
const filePath = `${dirname(dirname(dirname(__dirname)))}/gui/note-viewer/pluginAssets/${asset.name}`;
const destPath = `${dirname(noteFilePath)}/pluginAssets/${asset.name}`;
await shim.fsDriver().mkdir(dirname(destPath));
await shim.fsDriver().copy(filePath, destPath);

View File

@ -0,0 +1,26 @@
import { MenuItem, MenuItemLocation } from './api/types';
import ViewController from './ViewController';
export default class MenuController extends ViewController {
constructor(id:string, pluginId:string, store:any, label:string, menuItems: MenuItem[], location:MenuItemLocation) {
super(id, pluginId, store);
this.store.dispatch({
type: 'PLUGIN_VIEW_ADD',
pluginId: pluginId,
view: {
id: this.handle,
type: this.type,
label: label,
menuItems: menuItems,
location: location,
},
});
}
public get type():string {
return 'menu';
}
}

View File

@ -4,7 +4,7 @@ import Global from 'lib/services/plugins/api/Global';
import BasePluginRunner from 'lib/services/plugins/BasePluginRunner';
import BaseService from '../BaseService';
import shim from 'lib/shim';
const { filename } = require('lib/path-utils');
const { filename, dirname } = require('lib/path-utils');
const nodeSlug = require('slug');
interface Plugins {
@ -49,9 +49,52 @@ export default class PluginService extends BaseService {
return this.plugins_[id];
}
async loadPlugin(path:string):Promise<Plugin> {
private async parsePluginJsBundle(jsBundleString:string) {
const scriptText = jsBundleString;
const lines = scriptText.split('\n');
const manifestText:string[] = [];
const StateStarted = 1;
const StateInManifest = 2;
let state:number = StateStarted;
for (let line of lines) {
line = line.trim();
if (state !== StateInManifest) {
if (line === '/* joplin-manifest:') {
state = StateInManifest;
}
continue;
}
if (state === StateInManifest) {
if (line.indexOf('*/') === 0) {
break;
} else {
manifestText.push(line);
}
}
}
if (!manifestText.length) throw new Error('Could not find manifest');
return {
scriptText: scriptText,
manifestText: manifestText.join('\n'),
};
}
public async loadPluginFromString(pluginId:string, baseDir:string, jsBundleString:string):Promise<Plugin> {
const r = await this.parsePluginJsBundle(jsBundleString);
return this.loadPlugin(pluginId, baseDir, r.manifestText, r.scriptText);
}
private async loadPluginFromPath(path:string):Promise<Plugin> {
const fsDriver = shim.fsDriver();
if (path.toLowerCase().endsWith('.js')) return this.loadPluginFromString(filename(path), dirname(path), await fsDriver.readFile(path));
let distPath = path;
if (!(await fsDriver.exists(`${distPath}/manifest.json`))) {
distPath = `${path}/dist`;
@ -59,19 +102,22 @@ export default class PluginService extends BaseService {
this.logger().info(`PluginService: Loading plugin from ${path}`);
const manifestPath = `${distPath}/manifest.json`;
const indexPath = `${distPath}/index.js`;
const manifestContent = await fsDriver.readFile(manifestPath);
const manifest = manifestFromObject(JSON.parse(manifestContent));
const scriptText = await fsDriver.readFile(indexPath);
const scriptText = await fsDriver.readFile(`${distPath}/index.js`);
const manifestText = await fsDriver.readFile(`${distPath}/manifest.json`);
const pluginId = makePluginId(filename(path));
return this.loadPlugin(pluginId, distPath, manifestText, scriptText);
}
private async loadPlugin(pluginId:string, baseDir:string, manifestText:string, scriptText:string):Promise<Plugin> {
const manifest = manifestFromObject(JSON.parse(manifestText));
// After transforming the plugin path to an ID, multiple plugins might end up with the same ID. For
// example "MyPlugin" and "myplugin" would have the same ID. Technically it's possible to have two
// such folders but to keep things sane we disallow it.
if (this.plugins_[pluginId]) throw new Error(`There is already a plugin with this ID: ${pluginId}`);
const plugin = new Plugin(pluginId, distPath, manifest, scriptText, this.logger());
const plugin = new Plugin(pluginId, baseDir, manifest, scriptText, this.logger());
this.store_.dispatch({
type: 'PLUGIN_ADD',
@ -84,14 +130,14 @@ export default class PluginService extends BaseService {
return plugin;
}
async loadAndRunPlugins(pluginDirOrPaths:string | string[]) {
public async loadAndRunPlugins(pluginDirOrPaths:string | string[]) {
let pluginPaths = [];
if (Array.isArray(pluginDirOrPaths)) {
pluginPaths = pluginDirOrPaths;
} else {
pluginPaths = (await shim.fsDriver().readDirStats(pluginDirOrPaths))
.filter((stat:any) => stat.isDirectory())
.filter((stat:any) => (stat.isDirectory() || stat.path.toLowerCase().endsWith('.js')))
.map((stat:any) => `${pluginDirOrPaths}/${stat.path}`);
}
@ -102,7 +148,7 @@ export default class PluginService extends BaseService {
}
try {
const plugin = await this.loadPlugin(pluginPath);
const plugin = await this.loadPluginFromPath(pluginPath);
await this.runPlugin(plugin);
} catch (error) {
this.logger().error(`PluginService: Could not load plugin: ${pluginPath}`, error);
@ -110,7 +156,7 @@ export default class PluginService extends BaseService {
}
}
async runPlugin(plugin:Plugin) {
public async runPlugin(plugin:Plugin) {
this.plugins_[plugin.id] = plugin;
const pluginApi = new Global(this.logger(), this.platformImplementation_, plugin, this.store_);
return this.runner_.run(plugin, pluginApi);

View File

@ -73,4 +73,15 @@ export default class JoplinSettings {
async setValue(key:string, value:any) {
return Setting.setValue(this.namespacedKey(key), value);
}
/**
* Gets a global setting value, including app-specific settings and those set by other plugins.
*
* The list of available settings is not documented yet, but can be found by looking at the source code:
*
* https://github.com/laurent22/joplin/blob/3539a452a359162c461d2849829d2d42973eab50/ReactNativeClient/lib/models/Setting.ts#L142
*/
async globalValue(key:string):Promise<any> {
return Setting.value(key);
}
}

View File

@ -1,6 +1,7 @@
import Plugin from '../Plugin';
import JoplinViewsDialogs from './JoplinViewsDialogs';
import JoplinViewsMenuItems from './JoplinViewsMenuItems';
import JoplinViewsMenus from './JoplinViewsMenus';
import JoplinViewsToolbarButtons from './JoplinViewsToolbarButtons';
import JoplinViewsPanels from './JoplinViewsPanels';
@ -18,6 +19,7 @@ export default class JoplinViews {
private dialogs_:JoplinViewsDialogs = null;
private panels_:JoplinViewsPanels = null;
private menuItems_:JoplinViewsMenuItems = null;
private menus_:JoplinViewsMenus = null;
private toolbarButtons_:JoplinViewsToolbarButtons = null;
private implementation_:any = null;
@ -42,6 +44,11 @@ export default class JoplinViews {
return this.menuItems_;
}
public get menus():JoplinViewsMenus {
if (!this.menus_) this.menus_ = new JoplinViewsMenus(this.plugin, this.store);
return this.menus_;
}
public get toolbarButtons():JoplinViewsToolbarButtons {
if (!this.toolbarButtons_) this.toolbarButtons_ = new JoplinViewsToolbarButtons(this.plugin, this.store);
return this.toolbarButtons_;

View File

@ -0,0 +1,45 @@
import KeymapService from 'lib/services/KeymapService';
import { MenuItem, MenuItemLocation } from './types';
import MenuController from '../MenuController';
import Plugin from '../Plugin';
import createViewHandle from '../utils/createViewHandle';
/**
* Allows creating menus.
*
* [View the demo plugin](https://github.com/laurent22/joplin/tree/dev/CliClient/tests/support/plugins/menu)
*/
export default class JoplinViewsMenus {
private store: any;
private plugin: Plugin;
constructor(plugin: Plugin, store: any) {
this.store = store;
this.plugin = plugin;
}
private registerCommandAccelerators(menuItems:MenuItem[]) {
for (const menuItem of menuItems) {
if (menuItem.accelerator) {
KeymapService.instance().registerCommandAccelerator(menuItem.commandName, menuItem.accelerator);
}
if (menuItem.submenu) {
this.registerCommandAccelerators(menuItem.submenu);
}
}
}
/**
* Creates a new menu from the provided menu items and place it at the given location. As of now, it is only possible to place the
* menu as a sub-menu of the application build-in menus.
*/
public async create(label:string, menuItems:MenuItem[], location:MenuItemLocation = MenuItemLocation.Tools) {
const handle = createViewHandle(this.plugin);
const controller = new MenuController(handle, this.plugin.id, this.store, label, menuItems, location);
this.plugin.addViewController(controller);
this.registerCommandAccelerators(menuItems);
}
}

View File

@ -154,17 +154,9 @@ export interface Script {
}
// =================================================================
// View API types
// Menu types
// =================================================================
export type ButtonId = string;
export interface ButtonSpec {
id: ButtonId,
title?: string,
onClick?():void,
}
export interface CreateMenuItemOptions {
accelerator: string,
}
@ -179,6 +171,41 @@ export enum MenuItemLocation {
Context = 'context',
}
export interface MenuItem {
/**
* Command that should be associated with the menu item. All menu item should
* have a command associated with them unless they are a sub-menu.
*/
commandName?: string,
/**
* Accelerator associated with the menu item
*/
accelerator?: string,
/**
* Menu items that should appear below this menu item. Allows creating a menu tree.
*/
submenu?: MenuItem[],
/**
* Menu item label. If not specified, the command label will be used instead.
*/
label?: string,
}
// =================================================================
// View API types
// =================================================================
export interface ButtonSpec {
id: ButtonId,
title?: string,
onClick?():void,
}
export type ButtonId = string;
export enum ToolbarButtonLocation {
/**
* This toolbar in the top right corner of the application. It applies to the note as a whole, including its metadata.

View File

@ -34,6 +34,9 @@ export const defaultState:State = {
};
export const utils = {
// It is best to use viewsByType instead as this method creates new objects
// which might trigger unecessary renders even when plugin and views haven't changed.
viewInfosByType: function(plugins:PluginStates, type:string):ViewInfo[] {
const output:ViewInfo[] = [];
@ -53,6 +56,22 @@ export const utils = {
return output;
},
viewsByType: function(plugins:PluginStates, type:string):any[] {
const output:any[] = [];
for (const pluginId in plugins) {
const plugin = plugins[pluginId];
for (const viewId in plugin.views) {
const view = plugin.views[viewId];
if (view.type !== type) continue;
output.push(view);
}
}
return output;
},
commandNamesFromViews: function(plugins:PluginStates, toolbarType:string):string[] {
const infos = utils.viewInfosByType(plugins, 'toolbarButton');

View File

@ -23,7 +23,7 @@ export default function manifestFromObject(o:any):PluginManifest {
name: getString('name', true),
version: getString('version', true),
description: getString('description', false),
homepage_url: getString('homepage_url'),
homepage_url: getString('homepage_url', false),
permissions: permissions,
};

View File

@ -33,6 +33,15 @@ https://github.com/laurent22/joplin/blob/dev/{{{sourceMarkdownFile}}}
background-color: #F1F1F1;
color: #333333;
}
.root {
overflow: hidden;
}
a[href^="mailto:"] {
word-break: break-all;
}
table {
margin-bottom: 1em;
}
@ -77,6 +86,7 @@ https://github.com/laurent22/joplin/blob/dev/{{{sourceMarkdownFile}}}
background-color: #eee;
border: 1px solid #ccc;
font-size: .85em;
word-break: break-all;
}
pre code {
border: none;
@ -189,8 +199,9 @@ https://github.com/laurent22/joplin/blob/dev/{{{sourceMarkdownFile}}}
}
.nav {
background-color: black;
display: table;
width: inherit;
display: flex;
flex-direction: row;
align-items: center;
}
.nav.sticky {
position:fixed;
@ -207,9 +218,8 @@ https://github.com/laurent22/joplin/blob/dev/{{{sourceMarkdownFile}}}
padding-left: 2em;
margin-bottom: 0;
display: table-cell;
/* min-width: 250px; */
/* For GSoC: */
min-width: 470px;
display: flex;
width: 100%;
}
.nav ul li {
display: inline-block;
@ -220,11 +230,11 @@ https://github.com/laurent22/joplin/blob/dev/{{{sourceMarkdownFile}}}
font-weight: bold;
}
.nav-right {
display: table-cell;
width: 100%;
display: flex;
text-align: right;
vertical-align: middle;
line-height: 0;
margin-right: 10px;
}
.nav-right .share-btn {
display: none;
@ -233,7 +243,7 @@ https://github.com/laurent22/joplin/blob/dev/{{{sourceMarkdownFile}}}
display: none;
}
.footer {
padding-top: 1em;
padding: 2em;
border-top: 1px solid #d4d4d4;
margin-top: 2em;
color: gray;
@ -259,6 +269,23 @@ https://github.com/laurent22/joplin/blob/dev/{{{sourceMarkdownFile}}}
opacity: 1;
}
@media (min-width: 992px) {
.content{
display: flex;
}
#toc{
display: block!important;
align-self: flex-start;
width: 300px;
position: sticky; top: 20px; left: 0;
}
.main{
width: calc(100% - 300px);
}
}
.bottom-links {
display: flex;
justify-content: center;
@ -280,7 +307,7 @@ https://github.com/laurent22/joplin/blob/dev/{{{sourceMarkdownFile}}}
<body>
<div class="container page-{{sourceMarkdownName}}">
<div class="container root page-{{sourceMarkdownName}}">
<div class="header">
<a class="forkme" href="https://github.com/laurent22/joplin"><img src="{{{imageBaseUrl}}}/ForkMe.png"/></a>
@ -308,11 +335,15 @@ https://github.com/laurent22/joplin/blob/dev/{{{sourceMarkdownFile}}}
<div class="content">
{{{tocHtml}}}
<div class="main">
`;
const footerHtmlTemplate = `
</div></div>
<div class="footer">
Copyright (c) 2016-YYYY Laurent Cozic
Copyright (C) 2016-YYYY Laurent Cozic
</div>
</body>
</html>

View File

@ -9,7 +9,7 @@ This file was auto-generated from readme/api/get_started/plugins.md and any manu
made to it will be overwritten. To make a change to this file please modify
the source Markdown file:
https://github.com/laurent22/joplin/blob/master/readme/api/get_started/plugins.md
https://github.com/laurent22/joplin/blob/dev/readme/api/get_started/plugins.md
-->
@ -28,6 +28,15 @@ https://github.com/laurent22/joplin/blob/master/readme/api/get_started/plugins.m
background-color: #F1F1F1;
color: #333333;
}
.root {
overflow: hidden;
}
a[href^="mailto:"] {
word-break: break-all;
}
table {
margin-bottom: 1em;
}
@ -72,6 +81,7 @@ https://github.com/laurent22/joplin/blob/master/readme/api/get_started/plugins.m
background-color: #eee;
border: 1px solid #ccc;
font-size: .85em;
word-break: break-all;
}
pre code {
border: none;
@ -184,8 +194,9 @@ https://github.com/laurent22/joplin/blob/master/readme/api/get_started/plugins.m
}
.nav {
background-color: black;
display: table;
width: inherit;
display: flex;
flex-direction: row;
align-items: center;
}
.nav.sticky {
position:fixed;
@ -202,9 +213,8 @@ https://github.com/laurent22/joplin/blob/master/readme/api/get_started/plugins.m
padding-left: 2em;
margin-bottom: 0;
display: table-cell;
/* min-width: 250px; */
/* For GSoC: */
min-width: 470px;
display: flex;
width: 100%;
}
.nav ul li {
display: inline-block;
@ -215,11 +225,11 @@ https://github.com/laurent22/joplin/blob/master/readme/api/get_started/plugins.m
font-weight: bold;
}
.nav-right {
display: table-cell;
width: 100%;
display: flex;
text-align: right;
vertical-align: middle;
line-height: 0;
margin-right: 10px;
}
.nav-right .share-btn {
display: none;
@ -228,7 +238,7 @@ https://github.com/laurent22/joplin/blob/master/readme/api/get_started/plugins.m
display: none;
}
.footer {
padding-top: 1em;
padding: 2em;
border-top: 1px solid #d4d4d4;
margin-top: 2em;
color: gray;
@ -254,6 +264,23 @@ https://github.com/laurent22/joplin/blob/master/readme/api/get_started/plugins.m
opacity: 1;
}
@media (min-width: 992px) {
.content{
display: flex;
}
#toc{
display: block!important;
align-self: flex-start;
width: 300px;
position: sticky; top: 20px; left: 0;
}
.main{
width: calc(100% - 300px);
}
}
.bottom-links {
display: flex;
justify-content: center;
@ -275,7 +302,7 @@ https://github.com/laurent22/joplin/blob/master/readme/api/get_started/plugins.m
<body>
<div class="container page-plugins">
<div class="container root page-plugins">
<div class="header">
<a class="forkme" href="https://github.com/laurent22/joplin"><img src="https://joplinapp.org/images/ForkMe.png"/></a>
@ -341,7 +368,7 @@ https://github.com/laurent22/joplin/blob/master/readme/api/get_started/plugins.m
<li><a href="https://joplinapp.org/spec/history/">Note History spec</a></li>
<li><a href="https://joplinapp.org/spec/sync_lock/">Sync Lock spec</a></li>
<li><a href="https://joplinapp.org/spec/plugins/">Plugin Architecture spec</a></li>
<li><a href="https://github.com/laurent22/joplin/blob/master/readme/spec/search_sorting.md">Search Sorting spec</a></li>
<li><a href="https://joplinapp.org/spec/search_sorting/">Search Sorting spec</a></li>
</ul>
</li>
<li>
@ -362,9 +389,11 @@ https://github.com/laurent22/joplin/blob/master/readme/api/get_started/plugins.m
</li>
</ul>
</div>
<div class="main">
<h1>Getting started with plugin development<a name="getting-started-with-plugin-development" href="#getting-started-with-plugin-development" class="heading-anchor">🔗</a></h1>
<p>In this article you will learn the basic steps to build and test a plugin in Joplin.</p>
<p>## Setting up your environment</p>
<h2>Setting up your environment<a name="setting-up-your-environment" href="#setting-up-your-environment" class="heading-anchor">🔗</a></h2>
<p>First you need to setup your environment:</p>
<ul>
<li>Make sure you have <a href="https://nodejs.org/">Node.js</a> and <a href="https://git-scm.com">git</a> installed.</li>
@ -391,12 +420,12 @@ https://github.com/laurent22/joplin/blob/master/readme/api/get_started/plugins.m
<p>Restart the app, and Joplin should load the plugin and execute its <code>onStart</code> handler. If all went well you should see the test message in the plugin console: &quot;Test plugin started!&quot;.</p>
<h1>Next steps<a name="next-steps" href="#next-steps" class="heading-anchor">🔗</a></h1>
<ul>
<li>You might want to check the <a href="https://github.com/laurent22/joplin/blob/dev/readme/api/tutorials/toc_plugin/">plugin tutorial</a> to get a good overview of how to create a complete plugin and how to use the plugin API.</li>
<li>You might want to check the <a href="https://joplinapp.org/api/tutorials/toc_plugin/">plugin tutorial</a> to get a good overview of how to create a complete plugin and how to use the plugin API.</li>
<li>For more information about the plugin API, check the <a href="https://joplinapp.org/api/references/plugin_api/classes/joplin.html">Plugin API reference</a>.</li>
</ul>
<div class="bottom-links">
<a href="https://github.com/laurent22/joplin/blob/master/readme/api/get_started/plugins.md">
<a href="https://github.com/laurent22/joplin/blob/dev/readme/api/get_started/plugins.md">
<i class="fa fa-github"></i> Improve this doc
</a>
</div>
@ -430,8 +459,10 @@ https://github.com/laurent22/joplin/blob/master/readme/api/get_started/plugins.m
ga('send', 'pageview');
</script>
</div></div>
<div class="footer">
Copyright (c) 2016-2020 Laurent Cozic
Copyright (C) 2016-2020 Laurent Cozic
</div>
</body>
</html>

View File

@ -9,7 +9,7 @@ This file was auto-generated from readme/api/overview.md and any manual change
made to it will be overwritten. To make a change to this file please modify
the source Markdown file:
https://github.com/laurent22/joplin/blob/master/readme/api/overview.md
https://github.com/laurent22/joplin/blob/dev/readme/api/overview.md
-->
@ -28,6 +28,15 @@ https://github.com/laurent22/joplin/blob/master/readme/api/overview.md
background-color: #F1F1F1;
color: #333333;
}
.root {
overflow: hidden;
}
a[href^="mailto:"] {
word-break: break-all;
}
table {
margin-bottom: 1em;
}
@ -72,6 +81,7 @@ https://github.com/laurent22/joplin/blob/master/readme/api/overview.md
background-color: #eee;
border: 1px solid #ccc;
font-size: .85em;
word-break: break-all;
}
pre code {
border: none;
@ -184,8 +194,9 @@ https://github.com/laurent22/joplin/blob/master/readme/api/overview.md
}
.nav {
background-color: black;
display: table;
width: inherit;
display: flex;
flex-direction: row;
align-items: center;
}
.nav.sticky {
position:fixed;
@ -202,9 +213,8 @@ https://github.com/laurent22/joplin/blob/master/readme/api/overview.md
padding-left: 2em;
margin-bottom: 0;
display: table-cell;
/* min-width: 250px; */
/* For GSoC: */
min-width: 470px;
display: flex;
width: 100%;
}
.nav ul li {
display: inline-block;
@ -215,11 +225,11 @@ https://github.com/laurent22/joplin/blob/master/readme/api/overview.md
font-weight: bold;
}
.nav-right {
display: table-cell;
width: 100%;
display: flex;
text-align: right;
vertical-align: middle;
line-height: 0;
margin-right: 10px;
}
.nav-right .share-btn {
display: none;
@ -228,7 +238,7 @@ https://github.com/laurent22/joplin/blob/master/readme/api/overview.md
display: none;
}
.footer {
padding-top: 1em;
padding: 2em;
border-top: 1px solid #d4d4d4;
margin-top: 2em;
color: gray;
@ -254,6 +264,23 @@ https://github.com/laurent22/joplin/blob/master/readme/api/overview.md
opacity: 1;
}
@media (min-width: 992px) {
.content{
display: flex;
}
#toc{
display: block!important;
align-self: flex-start;
width: 300px;
position: sticky; top: 20px; left: 0;
}
.main{
width: calc(100% - 300px);
}
}
.bottom-links {
display: flex;
justify-content: center;
@ -275,7 +302,7 @@ https://github.com/laurent22/joplin/blob/master/readme/api/overview.md
<body>
<div class="container page-overview">
<div class="container root page-overview">
<div class="header">
<a class="forkme" href="https://github.com/laurent22/joplin"><img src="https://joplinapp.org/images/ForkMe.png"/></a>
@ -341,7 +368,7 @@ https://github.com/laurent22/joplin/blob/master/readme/api/overview.md
<li><a href="https://joplinapp.org/spec/history/">Note History spec</a></li>
<li><a href="https://joplinapp.org/spec/sync_lock/">Sync Lock spec</a></li>
<li><a href="https://joplinapp.org/spec/plugins/">Plugin Architecture spec</a></li>
<li><a href="https://github.com/laurent22/joplin/blob/master/readme/spec/search_sorting.md">Search Sorting spec</a></li>
<li><a href="https://joplinapp.org/spec/search_sorting/">Search Sorting spec</a></li>
</ul>
</li>
<li>
@ -362,6 +389,8 @@ https://github.com/laurent22/joplin/blob/master/readme/api/overview.md
</li>
</ul>
</div>
<div class="main">
<h1>Extending Joplin<a name="extending-joplin" href="#extending-joplin" class="heading-anchor">🔗</a></h1>
<p>Joplin provides a number of extension points to allow third-party applications to access its data, or to develop plugins.</p>
<p>The two main extension points are:</p>
@ -370,7 +399,7 @@ https://github.com/laurent22/joplin/blob/master/readme/api/overview.md
<p>The <a href="https://joplinapp.org/api/references/rest_api/">data API</a>, which is a server that provides access to Joplin data to external applications. It is possible, using standard HTTP calls, to create, modify or delete notes, notebooks, tags, etc. as well as attach files to notes and retrieve these files. This is for example how the web clipper communicates with Joplin.</p>
</li>
<li>
<p>The <a href="https://joplinapp.org/api/references/plugin_api/classes/joplin.html">plugin API</a>, which allows directly modifying Joplin by adding new features to the application. Using this API, you can:</p>
<p>The <a href="https://joplinapp.org/api/get_started/plugins/">plugin API</a>, which allows directly modifying Joplin by adding new features to the application. Using this API, you can:</p>
<ul>
<li>Access notes, folders, etc. via the data API</li>
<li>Add a view to display custom data using HTML/CSS/JS</li>
@ -386,7 +415,7 @@ https://github.com/laurent22/joplin/blob/master/readme/api/overview.md
</ul>
<div class="bottom-links">
<a href="https://github.com/laurent22/joplin/blob/master/readme/api/overview.md">
<a href="https://github.com/laurent22/joplin/blob/dev/readme/api/overview.md">
<i class="fa fa-github"></i> Improve this doc
</a>
</div>
@ -420,8 +449,10 @@ https://github.com/laurent22/joplin/blob/master/readme/api/overview.md
ga('send', 'pageview');
</script>
</div></div>
<div class="footer">
Copyright (c) 2016-2020 Laurent Cozic
Copyright (C) 2016-2020 Laurent Cozic
</div>
</body>
</html>

View File

@ -9,7 +9,7 @@ This file was auto-generated from readme/api/references/development_mode.md and
made to it will be overwritten. To make a change to this file please modify
the source Markdown file:
https://github.com/laurent22/joplin/blob/master/readme/api/references/development_mode.md
https://github.com/laurent22/joplin/blob/dev/readme/api/references/development_mode.md
-->
@ -28,6 +28,15 @@ https://github.com/laurent22/joplin/blob/master/readme/api/references/developmen
background-color: #F1F1F1;
color: #333333;
}
.root {
overflow: hidden;
}
a[href^="mailto:"] {
word-break: break-all;
}
table {
margin-bottom: 1em;
}
@ -72,6 +81,7 @@ https://github.com/laurent22/joplin/blob/master/readme/api/references/developmen
background-color: #eee;
border: 1px solid #ccc;
font-size: .85em;
word-break: break-all;
}
pre code {
border: none;
@ -184,8 +194,9 @@ https://github.com/laurent22/joplin/blob/master/readme/api/references/developmen
}
.nav {
background-color: black;
display: table;
width: inherit;
display: flex;
flex-direction: row;
align-items: center;
}
.nav.sticky {
position:fixed;
@ -202,9 +213,8 @@ https://github.com/laurent22/joplin/blob/master/readme/api/references/developmen
padding-left: 2em;
margin-bottom: 0;
display: table-cell;
/* min-width: 250px; */
/* For GSoC: */
min-width: 470px;
display: flex;
width: 100%;
}
.nav ul li {
display: inline-block;
@ -215,11 +225,11 @@ https://github.com/laurent22/joplin/blob/master/readme/api/references/developmen
font-weight: bold;
}
.nav-right {
display: table-cell;
width: 100%;
display: flex;
text-align: right;
vertical-align: middle;
line-height: 0;
margin-right: 10px;
}
.nav-right .share-btn {
display: none;
@ -228,7 +238,7 @@ https://github.com/laurent22/joplin/blob/master/readme/api/references/developmen
display: none;
}
.footer {
padding-top: 1em;
padding: 2em;
border-top: 1px solid #d4d4d4;
margin-top: 2em;
color: gray;
@ -254,6 +264,23 @@ https://github.com/laurent22/joplin/blob/master/readme/api/references/developmen
opacity: 1;
}
@media (min-width: 992px) {
.content{
display: flex;
}
#toc{
display: block!important;
align-self: flex-start;
width: 300px;
position: sticky; top: 20px; left: 0;
}
.main{
width: calc(100% - 300px);
}
}
.bottom-links {
display: flex;
justify-content: center;
@ -275,7 +302,7 @@ https://github.com/laurent22/joplin/blob/master/readme/api/references/developmen
<body>
<div class="container page-development_mode">
<div class="container root page-development_mode">
<div class="header">
<a class="forkme" href="https://github.com/laurent22/joplin"><img src="https://joplinapp.org/images/ForkMe.png"/></a>
@ -341,7 +368,7 @@ https://github.com/laurent22/joplin/blob/master/readme/api/references/developmen
<li><a href="https://joplinapp.org/spec/history/">Note History spec</a></li>
<li><a href="https://joplinapp.org/spec/sync_lock/">Sync Lock spec</a></li>
<li><a href="https://joplinapp.org/spec/plugins/">Plugin Architecture spec</a></li>
<li><a href="https://github.com/laurent22/joplin/blob/master/readme/spec/search_sorting.md">Search Sorting spec</a></li>
<li><a href="https://joplinapp.org/spec/search_sorting/">Search Sorting spec</a></li>
</ul>
</li>
<li>
@ -362,12 +389,14 @@ https://github.com/laurent22/joplin/blob/master/readme/api/references/developmen
</li>
</ul>
</div>
<div class="main">
<h1>Development mode<a name="development-mode" href="#development-mode" class="heading-anchor">🔗</a></h1>
<p>When experimenting with Joplin, for example when developing a plugin or trying a theme, you might want to run Joplin in development mode. Doing so means that Joplin will run using a different profile, so you can experiment without risking to accidentally change or delete your data.</p>
<p>To enable Development Mode, open Joplin as normal, then go to <strong>Help =&gt; Copy dev mode command to clipboard</strong>. This will copy a command to the clipboard. Now close Joplin, and start it again in dev mode using the command you've just copied.</p>
<div class="bottom-links">
<a href="https://github.com/laurent22/joplin/blob/master/readme/api/references/development_mode.md">
<a href="https://github.com/laurent22/joplin/blob/dev/readme/api/references/development_mode.md">
<i class="fa fa-github"></i> Improve this doc
</a>
</div>
@ -401,8 +430,10 @@ https://github.com/laurent22/joplin/blob/master/readme/api/references/developmen
ga('send', 'pageview');
</script>
</div></div>
<div class="footer">
Copyright (c) 2016-2020 Laurent Cozic
Copyright (C) 2016-2020 Laurent Cozic
</div>
</body>
</html>

File diff suppressed because one or more lines are too long

View File

@ -320,6 +320,9 @@
<li class=" tsd-kind-class">
<a href="joplinviewsmenuitems.html" class="tsd-kind-icon">joplin.views.menuItems</a>
</li>
<li class=" tsd-kind-class">
<a href="joplinviewsmenus.html" class="tsd-kind-icon">joplin.views.menus</a>
</li>
<li class=" tsd-kind-class">
<a href="joplinviewspanels.html" class="tsd-kind-icon">joplin.views.panels</a>
</li>
@ -356,6 +359,9 @@
<li class=" tsd-kind-interface">
<a href="../interfaces/importmodule.html" class="tsd-kind-icon">ImportModule</a>
</li>
<li class=" tsd-kind-interface">
<a href="../interfaces/menuitem.html" class="tsd-kind-icon">MenuItem</a>
</li>
<li class=" tsd-kind-interface">
<a href="../interfaces/script.html" class="tsd-kind-icon">Script</a>
</li>

View File

@ -256,6 +256,9 @@
<li class=" tsd-kind-class">
<a href="joplinviewsmenuitems.html" class="tsd-kind-icon">joplin.views.menuItems</a>
</li>
<li class=" tsd-kind-class">
<a href="joplinviewsmenus.html" class="tsd-kind-icon">joplin.views.menus</a>
</li>
<li class=" tsd-kind-class">
<a href="joplinviewspanels.html" class="tsd-kind-icon">joplin.views.panels</a>
</li>
@ -292,6 +295,9 @@
<li class=" tsd-kind-interface">
<a href="../interfaces/importmodule.html" class="tsd-kind-icon">ImportModule</a>
</li>
<li class=" tsd-kind-interface">
<a href="../interfaces/menuitem.html" class="tsd-kind-icon">MenuItem</a>
</li>
<li class=" tsd-kind-interface">
<a href="../interfaces/script.html" class="tsd-kind-icon">Script</a>
</li>

View File

@ -321,6 +321,9 @@
<li class=" tsd-kind-class">
<a href="joplinviewsmenuitems.html" class="tsd-kind-icon">joplin.views.menuItems</a>
</li>
<li class=" tsd-kind-class">
<a href="joplinviewsmenus.html" class="tsd-kind-icon">joplin.views.menus</a>
</li>
<li class=" tsd-kind-class">
<a href="joplinviewspanels.html" class="tsd-kind-icon">joplin.views.panels</a>
</li>
@ -357,6 +360,9 @@
<li class=" tsd-kind-interface">
<a href="../interfaces/importmodule.html" class="tsd-kind-icon">ImportModule</a>
</li>
<li class=" tsd-kind-interface">
<a href="../interfaces/menuitem.html" class="tsd-kind-icon">MenuItem</a>
</li>
<li class=" tsd-kind-interface">
<a href="../interfaces/script.html" class="tsd-kind-icon">Script</a>
</li>

View File

@ -220,6 +220,9 @@
<li class=" tsd-kind-class">
<a href="joplinviewsmenuitems.html" class="tsd-kind-icon">joplin.views.menuItems</a>
</li>
<li class=" tsd-kind-class">
<a href="joplinviewsmenus.html" class="tsd-kind-icon">joplin.views.menus</a>
</li>
<li class=" tsd-kind-class">
<a href="joplinviewspanels.html" class="tsd-kind-icon">joplin.views.panels</a>
</li>
@ -256,6 +259,9 @@
<li class=" tsd-kind-interface">
<a href="../interfaces/importmodule.html" class="tsd-kind-icon">ImportModule</a>
</li>
<li class=" tsd-kind-interface">
<a href="../interfaces/menuitem.html" class="tsd-kind-icon">MenuItem</a>
</li>
<li class=" tsd-kind-interface">
<a href="../interfaces/script.html" class="tsd-kind-icon">Script</a>
</li>

View File

@ -205,6 +205,9 @@
<li class=" tsd-kind-class">
<a href="joplinviewsmenuitems.html" class="tsd-kind-icon">joplin.views.menuItems</a>
</li>
<li class=" tsd-kind-class">
<a href="joplinviewsmenus.html" class="tsd-kind-icon">joplin.views.menus</a>
</li>
<li class=" tsd-kind-class">
<a href="joplinviewspanels.html" class="tsd-kind-icon">joplin.views.panels</a>
</li>
@ -241,6 +244,9 @@
<li class=" tsd-kind-interface">
<a href="../interfaces/importmodule.html" class="tsd-kind-icon">ImportModule</a>
</li>
<li class=" tsd-kind-interface">
<a href="../interfaces/menuitem.html" class="tsd-kind-icon">MenuItem</a>
</li>
<li class=" tsd-kind-interface">
<a href="../interfaces/script.html" class="tsd-kind-icon">Script</a>
</li>

View File

@ -95,6 +95,7 @@
<section class="tsd-index-section ">
<h3>Methods</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-method tsd-parent-kind-class"><a href="joplinsettings.html#globalvalue" class="tsd-kind-icon">global<wbr>Value</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="joplinsettings.html#registersection" class="tsd-kind-icon">register<wbr>Section</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="joplinsettings.html#registersetting" class="tsd-kind-icon">register<wbr>Setting</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="joplinsettings.html#setvalue" class="tsd-kind-icon">set<wbr>Value</a></li>
@ -108,6 +109,37 @@
</section>
<section class="tsd-panel-group tsd-member-group ">
<h2>Methods</h2>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="globalvalue" class="tsd-anchor"></a>
<h3>global<wbr>Value</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">global<wbr>Value<span class="tsd-signature-symbol">(</span>key<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Gets a global setting value, including app-specific settings and those set by other plugins.</p>
</div>
<p>The list of available settings is not documented yet, but can be found by looking at the source code:</p>
<p><a href="https://github.com/laurent22/joplin/blob/3539a452a359162c461d2849829d2d42973eab50/ReactNativeClient/lib/models/Setting.ts#L142">https://github.com/laurent22/joplin/blob/3539a452a359162c461d2849829d2d42973eab50/ReactNativeClient/lib/models/Setting.ts#L142</a></p>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>key: <span class="tsd-signature-type">string</span></h5>
</li>
</ul>
<!-- JOPLINCHANGE
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span></h4>
-->
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="registersection" class="tsd-anchor"></a>
<h3>register<wbr>Section</h3>
@ -288,6 +320,9 @@
<li class=" tsd-kind-constructor tsd-parent-kind-class">
<a href="joplinsettings.html#constructor" class="tsd-kind-icon">constructor</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="joplinsettings.html#globalvalue" class="tsd-kind-icon">global<wbr>Value</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="joplinsettings.html#registersection" class="tsd-kind-icon">register<wbr>Section</a>
</li>
@ -313,6 +348,9 @@
<li class=" tsd-kind-class">
<a href="joplinviewsmenuitems.html" class="tsd-kind-icon">joplin.views.menuItems</a>
</li>
<li class=" tsd-kind-class">
<a href="joplinviewsmenus.html" class="tsd-kind-icon">joplin.views.menus</a>
</li>
<li class=" tsd-kind-class">
<a href="joplinviewspanels.html" class="tsd-kind-icon">joplin.views.panels</a>
</li>
@ -349,6 +387,9 @@
<li class=" tsd-kind-interface">
<a href="../interfaces/importmodule.html" class="tsd-kind-icon">ImportModule</a>
</li>
<li class=" tsd-kind-interface">
<a href="../interfaces/menuitem.html" class="tsd-kind-icon">MenuItem</a>
</li>
<li class=" tsd-kind-interface">
<a href="../interfaces/script.html" class="tsd-kind-icon">Script</a>
</li>

View File

@ -96,6 +96,7 @@
<ul class="tsd-index-list">
<li class="tsd-kind-get-signature tsd-parent-kind-class"><a href="joplinviews.html#dialogs" class="tsd-kind-icon">dialogs</a></li>
<li class="tsd-kind-get-signature tsd-parent-kind-class"><a href="joplinviews.html#menuitems" class="tsd-kind-icon">menu<wbr>Items</a></li>
<li class="tsd-kind-get-signature tsd-parent-kind-class"><a href="joplinviews.html#menus" class="tsd-kind-icon">menus</a></li>
<li class="tsd-kind-get-signature tsd-parent-kind-class"><a href="joplinviews.html#panels" class="tsd-kind-icon">panels</a></li>
<li class="tsd-kind-get-signature tsd-parent-kind-class"><a href="joplinviews.html#toolbarbuttons" class="tsd-kind-icon">toolbar<wbr>Buttons</a></li>
</ul>
@ -139,6 +140,24 @@
<h4 class="tsd-returns-title">Returns <a href="joplinviewsmenuitems.html" class="tsd-signature-type">joplin.views.menuItems</a></h4>
-->
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class">
<a name="menus" class="tsd-anchor"></a>
<h3>menus</h3>
<ul class="tsd-signatures tsd-kind-get-signature tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> menus<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="joplinviewsmenus.html" class="tsd-signature-type">joplin.views.menus</a></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
</aside>
<!-- JOPLINCHANGE
<h4 class="tsd-returns-title">Returns <a href="joplinviewsmenus.html" class="tsd-signature-type">joplin.views.menus</a></h4>
-->
</li>
</ul>
@ -240,6 +259,9 @@
<li class=" tsd-kind-get-signature tsd-parent-kind-class">
<a href="joplinviews.html#menuitems" class="tsd-kind-icon">menu<wbr>Items</a>
</li>
<li class=" tsd-kind-get-signature tsd-parent-kind-class">
<a href="joplinviews.html#menus" class="tsd-kind-icon">menus</a>
</li>
<li class=" tsd-kind-get-signature tsd-parent-kind-class">
<a href="joplinviews.html#panels" class="tsd-kind-icon">panels</a>
</li>
@ -256,6 +278,9 @@
<li class=" tsd-kind-class">
<a href="joplinviewsmenuitems.html" class="tsd-kind-icon">joplin.views.menuItems</a>
</li>
<li class=" tsd-kind-class">
<a href="joplinviewsmenus.html" class="tsd-kind-icon">joplin.views.menus</a>
</li>
<li class=" tsd-kind-class">
<a href="joplinviewspanels.html" class="tsd-kind-icon">joplin.views.panels</a>
</li>
@ -292,6 +317,9 @@
<li class=" tsd-kind-interface">
<a href="../interfaces/importmodule.html" class="tsd-kind-icon">ImportModule</a>
</li>
<li class=" tsd-kind-interface">
<a href="../interfaces/menuitem.html" class="tsd-kind-icon">MenuItem</a>
</li>
<li class=" tsd-kind-interface">
<a href="../interfaces/script.html" class="tsd-kind-icon">Script</a>
</li>

View File

@ -334,6 +334,9 @@
<li class=" tsd-kind-class">
<a href="joplinviewsmenuitems.html" class="tsd-kind-icon">joplin.views.menuItems</a>
</li>
<li class=" tsd-kind-class">
<a href="joplinviewsmenus.html" class="tsd-kind-icon">joplin.views.menus</a>
</li>
<li class=" tsd-kind-class">
<a href="joplinviewspanels.html" class="tsd-kind-icon">joplin.views.panels</a>
</li>
@ -370,6 +373,9 @@
<li class=" tsd-kind-interface">
<a href="../interfaces/importmodule.html" class="tsd-kind-icon">ImportModule</a>
</li>
<li class=" tsd-kind-interface">
<a href="../interfaces/menuitem.html" class="tsd-kind-icon">MenuItem</a>
</li>
<li class=" tsd-kind-interface">
<a href="../interfaces/script.html" class="tsd-kind-icon">Script</a>
</li>

View File

@ -206,6 +206,9 @@
</li>
</ul>
<ul class="after-current">
<li class=" tsd-kind-class">
<a href="joplinviewsmenus.html" class="tsd-kind-icon">joplin.views.menus</a>
</li>
<li class=" tsd-kind-class">
<a href="joplinviewspanels.html" class="tsd-kind-icon">joplin.views.panels</a>
</li>
@ -242,6 +245,9 @@
<li class=" tsd-kind-interface">
<a href="../interfaces/importmodule.html" class="tsd-kind-icon">ImportModule</a>
</li>
<li class=" tsd-kind-interface">
<a href="../interfaces/menuitem.html" class="tsd-kind-icon">MenuItem</a>
</li>
<li class=" tsd-kind-interface">
<a href="../interfaces/script.html" class="tsd-kind-icon">Script</a>
</li>

View File

@ -0,0 +1,299 @@
<!doctype html>
<html class="default no-js">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>joplin.views.menus | Joplin Plugin API Documentation</title>
<meta name="description" content="Documentation for Joplin Plugin API Documentation">
<meta name="viewport" content="width=device-width, initial-scale=1">
<link rel="stylesheet" href="../assets/css/main.css">
</head>
<body>
<header>
<div class="tsd-page-toolbar">
<div class="container">
<div class="table-wrap">
<div class="table-cell" id="tsd-search" data-index="../assets/js/search.json" data-base="..">
<div class="field">
<label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
<input id="tsd-search-field" type="text" />
</div>
<ul class="results">
<li class="state loading">Preparing search index...</li>
<li class="state failure">The search index is not available</li>
</ul>
<a href="joplin.html" class="title">Joplin Plugin API Documentation</a>
</div>
<div class="table-cell" id="tsd-widgets">
<div id="tsd-filter">
<a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a>
<div class="tsd-filter-group">
<div class="tsd-select" id="tsd-filter-visibility">
<span class="tsd-select-label">All</span>
<ul class="tsd-select-list">
<li data-value="public">Public</li>
<li data-value="protected">Public/Protected</li>
<li data-value="private" class="selected">All</li>
</ul>
</div>
<input type="checkbox" id="tsd-filter-inherited" checked />
<label class="tsd-widget" for="tsd-filter-inherited">Inherited</label>
</div>
</div>
<a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a>
</div>
</div>
</div>
</div>
<div class="tsd-page-title">
<div class="container">
<ul class="tsd-breadcrumb">
<!--
<li>
<a href="../globals.html">Globals</a>
</li>
-->
<li>
<a href="joplinviewsmenus.html">joplin.views.menus</a>
</li>
</ul>
<h1><!-- Class -->joplin.views.menus</h1>
</div>
</div>
</header>
<div class="container container-main">
<div class="row">
<div class="col-8 col-content">
<section class="tsd-panel tsd-comment">
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Allows creating menus.</p>
</div>
<p><a href="https://github.com/laurent22/joplin/tree/dev/CliClient/tests/support/plugins/menu">View the demo plugin</a></p>
</div>
</section>
<!--
<section class="tsd-panel tsd-hierarchy">
<h3>Hierarchy</h3>
<ul class="tsd-hierarchy">
<li>
<span class="target">JoplinViewsMenus</span>
</li>
</ul>
</section>
-->
<section class="tsd-panel-group tsd-index-group">
<h2>Index</h2>
<section class="tsd-panel tsd-index-panel">
<div class="tsd-index-content">
<section class="tsd-index-section ">
</section>
<section class="tsd-index-section ">
<h3>Methods</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-method tsd-parent-kind-class"><a href="joplinviewsmenus.html#create" class="tsd-kind-icon">create</a></li>
</ul>
</section>
</div>
</section>
</section>
<section class="tsd-panel-group tsd-member-group ">
</section>
<section class="tsd-panel-group tsd-member-group ">
<h2>Methods</h2>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="create" class="tsd-anchor"></a>
<h3>create</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">create<span class="tsd-signature-symbol">(</span>label<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, menuItems<span class="tsd-signature-symbol">: </span><a href="../interfaces/menuitem.html" class="tsd-signature-type">MenuItem</a><span class="tsd-signature-symbol">[]</span>, location<span class="tsd-signature-symbol">?: </span><a href="../enums/menuitemlocation.html" class="tsd-signature-type">MenuItemLocation</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Creates a new menu from the provided menu items and place it at the given location. As of now, it is only possible to place the
menu as a sub-menu of the application build-in menus.</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>label: <span class="tsd-signature-type">string</span></h5>
</li>
<li>
<h5>menuItems: <a href="../interfaces/menuitem.html" class="tsd-signature-type">MenuItem</a><span class="tsd-signature-symbol">[]</span></h5>
</li>
<li>
<h5><span class="tsd-flag ts-flagDefault value">Default value</span> location: <a href="../enums/menuitemlocation.html" class="tsd-signature-type">MenuItemLocation</a><span class="tsd-signature-symbol"> = MenuItemLocation.Tools</span></h5>
</li>
</ul>
<!-- JOPLINCHANGE
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></h4>
-->
</li>
</ul>
</section>
</section>
</div>
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
<!--
<nav class="tsd-navigation primary">
<ul>
<li class="globals ">
<a href="../globals.html"><em>Globals</em></a>
</li>
</ul>
</nav>
-->
<nav class="tsd-navigation secondary menu-sticky">
<ul class="before-current">
<li class=" tsd-kind-enum">
<a href="../enums/filesystemitem.html" class="tsd-kind-icon">FileSystemItem</a>
</li>
<li class=" tsd-kind-enum">
<a href="../enums/importmoduleoutputformat.html" class="tsd-kind-icon">ImportModuleOutputFormat</a>
</li>
<li class=" tsd-kind-enum">
<a href="../enums/menuitemlocation.html" class="tsd-kind-icon">MenuItemLocation</a>
</li>
<li class=" tsd-kind-enum">
<a href="../enums/settingitemtype.html" class="tsd-kind-icon">SettingItemType</a>
</li>
<li class=" tsd-kind-enum">
<a href="../enums/toolbarbuttonlocation.html" class="tsd-kind-icon">ToolbarButtonLocation</a>
</li>
<li class=" tsd-kind-class">
<a href="joplin.html" class="tsd-kind-icon">joplin</a>
</li>
<li class=" tsd-kind-class">
<a href="joplincommands.html" class="tsd-kind-icon">joplin.commands</a>
</li>
<li class=" tsd-kind-class">
<a href="joplindata.html" class="tsd-kind-icon">joplin.data</a>
</li>
<li class=" tsd-kind-class">
<a href="joplininterop.html" class="tsd-kind-icon">joplin.interop</a>
</li>
<li class=" tsd-kind-class">
<a href="joplinplugins.html" class="tsd-kind-icon">joplin.plugins</a>
</li>
<li class=" tsd-kind-class">
<a href="joplinsettings.html" class="tsd-kind-icon">joplin.settings</a>
</li>
<li class=" tsd-kind-class">
<a href="joplinviews.html" class="tsd-kind-icon">joplin.views</a>
</li>
<li class=" tsd-kind-class">
<a href="joplinviewsdialogs.html" class="tsd-kind-icon">joplin.views.dialogs</a>
</li>
<li class=" tsd-kind-class">
<a href="joplinviewsmenuitems.html" class="tsd-kind-icon">joplin.views.menuItems</a>
</li>
</ul>
<ul class="current">
<li class="current tsd-kind-class">
<a href="joplinviewsmenus.html" class="tsd-kind-icon">joplin.views.menus</a>
<ul>
<li class=" tsd-kind-constructor tsd-parent-kind-class">
<a href="joplinviewsmenus.html#constructor" class="tsd-kind-icon">constructor</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="joplinviewsmenus.html#create" class="tsd-kind-icon">create</a>
</li>
</ul>
</li>
</ul>
<ul class="after-current">
<li class=" tsd-kind-class">
<a href="joplinviewspanels.html" class="tsd-kind-icon">joplin.views.panels</a>
</li>
<li class=" tsd-kind-class">
<a href="joplinviewstoolbarbuttons.html" class="tsd-kind-icon">joplin.views.toolbarButtons</a>
</li>
<li class=" tsd-kind-class">
<a href="joplinworkspace.html" class="tsd-kind-icon">joplin.workspace</a>
</li>
<li class=" tsd-kind-interface">
<a href="../interfaces/buttonspec.html" class="tsd-kind-icon">ButtonSpec</a>
</li>
<li class=" tsd-kind-interface">
<a href="../interfaces/command.html" class="tsd-kind-icon">Command</a>
</li>
<li class=" tsd-kind-interface">
<a href="../interfaces/createmenuitemoptions.html" class="tsd-kind-icon">CreateMenuItemOptions</a>
</li>
<li class=" tsd-kind-interface">
<a href="../interfaces/editorcommand.html" class="tsd-kind-icon">EditorCommand</a>
</li>
<li class=" tsd-kind-interface">
<a href="../interfaces/exportcontext.html" class="tsd-kind-icon">ExportContext</a>
</li>
<li class=" tsd-kind-interface">
<a href="../interfaces/exportmodule.html" class="tsd-kind-icon">ExportModule</a>
</li>
<li class=" tsd-kind-interface">
<a href="../interfaces/exportoptions.html" class="tsd-kind-icon">ExportOptions</a>
</li>
<li class=" tsd-kind-interface">
<a href="../interfaces/importcontext.html" class="tsd-kind-icon">ImportContext</a>
</li>
<li class=" tsd-kind-interface">
<a href="../interfaces/importmodule.html" class="tsd-kind-icon">ImportModule</a>
</li>
<li class=" tsd-kind-interface">
<a href="../interfaces/menuitem.html" class="tsd-kind-icon">MenuItem</a>
</li>
<li class=" tsd-kind-interface">
<a href="../interfaces/script.html" class="tsd-kind-icon">Script</a>
</li>
<li class=" tsd-kind-interface">
<a href="../interfaces/settingitem.html" class="tsd-kind-icon">SettingItem</a>
</li>
<li class=" tsd-kind-interface">
<a href="../interfaces/settingsection.html" class="tsd-kind-icon">SettingSection</a>
</li>
<li class=" tsd-kind-type-alias">
<a href="../globals.html#buttonid" class="tsd-kind-icon">ButtonId</a>
</li>
<li class=" tsd-kind-type-alias">
<a href="../globals.html#path" class="tsd-kind-icon">Path</a>
</li>
<li class=" tsd-kind-type-alias">
<a href="../globals.html#viewhandle" class="tsd-kind-icon">ViewHandle</a>
</li>
</ul>
</nav>
</div>
</div>
</div>
<!-- JOPLINCHANGE
<footer class="with-border-bottom">
<div class="container">
<h2>Legend</h2>
<div class="tsd-legend-group">
<ul class="tsd-legend">
<li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
<li class="tsd-kind-method tsd-parent-kind-interface"><span class="tsd-kind-icon">Method</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li>
<li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li>
</ul>
</div>
</div>
</footer>
<div class="container tsd-generator">
<p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p>
</div>
-->
<div class="overlay"></div>
<script src="../assets/js/main.js"></script>
</body>
</html>

View File

@ -282,6 +282,9 @@
<li class=" tsd-kind-class">
<a href="joplinviewsmenuitems.html" class="tsd-kind-icon">joplin.views.menuItems</a>
</li>
<li class=" tsd-kind-class">
<a href="joplinviewsmenus.html" class="tsd-kind-icon">joplin.views.menus</a>
</li>
</ul>
<ul class="current">
<li class="current tsd-kind-class">
@ -339,6 +342,9 @@
<li class=" tsd-kind-interface">
<a href="../interfaces/importmodule.html" class="tsd-kind-icon">ImportModule</a>
</li>
<li class=" tsd-kind-interface">
<a href="../interfaces/menuitem.html" class="tsd-kind-icon">MenuItem</a>
</li>
<li class=" tsd-kind-interface">
<a href="../interfaces/script.html" class="tsd-kind-icon">Script</a>
</li>

View File

@ -191,6 +191,9 @@
<li class=" tsd-kind-class">
<a href="joplinviewsmenuitems.html" class="tsd-kind-icon">joplin.views.menuItems</a>
</li>
<li class=" tsd-kind-class">
<a href="joplinviewsmenus.html" class="tsd-kind-icon">joplin.views.menus</a>
</li>
<li class=" tsd-kind-class">
<a href="joplinviewspanels.html" class="tsd-kind-icon">joplin.views.panels</a>
</li>
@ -239,6 +242,9 @@
<li class=" tsd-kind-interface">
<a href="../interfaces/importmodule.html" class="tsd-kind-icon">ImportModule</a>
</li>
<li class=" tsd-kind-interface">
<a href="../interfaces/menuitem.html" class="tsd-kind-icon">MenuItem</a>
</li>
<li class=" tsd-kind-interface">
<a href="../interfaces/script.html" class="tsd-kind-icon">Script</a>
</li>

View File

@ -327,6 +327,9 @@
<li class=" tsd-kind-class">
<a href="joplinviewsmenuitems.html" class="tsd-kind-icon">joplin.views.menuItems</a>
</li>
<li class=" tsd-kind-class">
<a href="joplinviewsmenus.html" class="tsd-kind-icon">joplin.views.menus</a>
</li>
<li class=" tsd-kind-class">
<a href="joplinviewspanels.html" class="tsd-kind-icon">joplin.views.panels</a>
</li>
@ -390,6 +393,9 @@
<li class=" tsd-kind-interface">
<a href="../interfaces/importmodule.html" class="tsd-kind-icon">ImportModule</a>
</li>
<li class=" tsd-kind-interface">
<a href="../interfaces/menuitem.html" class="tsd-kind-icon">MenuItem</a>
</li>
<li class=" tsd-kind-interface">
<a href="../interfaces/script.html" class="tsd-kind-icon">Script</a>
</li>

View File

@ -162,6 +162,9 @@
<li class=" tsd-kind-class">
<a href="../classes/joplinviewsmenuitems.html" class="tsd-kind-icon">joplin.views.menuItems</a>
</li>
<li class=" tsd-kind-class">
<a href="../classes/joplinviewsmenus.html" class="tsd-kind-icon">joplin.views.menus</a>
</li>
<li class=" tsd-kind-class">
<a href="../classes/joplinviewspanels.html" class="tsd-kind-icon">joplin.views.panels</a>
</li>
@ -198,6 +201,9 @@
<li class=" tsd-kind-interface">
<a href="../interfaces/importmodule.html" class="tsd-kind-icon">ImportModule</a>
</li>
<li class=" tsd-kind-interface">
<a href="../interfaces/menuitem.html" class="tsd-kind-icon">MenuItem</a>
</li>
<li class=" tsd-kind-interface">
<a href="../interfaces/script.html" class="tsd-kind-icon">Script</a>
</li>

View File

@ -162,6 +162,9 @@
<li class=" tsd-kind-class">
<a href="../classes/joplinviewsmenuitems.html" class="tsd-kind-icon">joplin.views.menuItems</a>
</li>
<li class=" tsd-kind-class">
<a href="../classes/joplinviewsmenus.html" class="tsd-kind-icon">joplin.views.menus</a>
</li>
<li class=" tsd-kind-class">
<a href="../classes/joplinviewspanels.html" class="tsd-kind-icon">joplin.views.panels</a>
</li>
@ -198,6 +201,9 @@
<li class=" tsd-kind-interface">
<a href="../interfaces/importmodule.html" class="tsd-kind-icon">ImportModule</a>
</li>
<li class=" tsd-kind-interface">
<a href="../interfaces/menuitem.html" class="tsd-kind-icon">MenuItem</a>
</li>
<li class=" tsd-kind-interface">
<a href="../interfaces/script.html" class="tsd-kind-icon">Script</a>
</li>

View File

@ -217,6 +217,9 @@
<li class=" tsd-kind-class">
<a href="../classes/joplinviewsmenuitems.html" class="tsd-kind-icon">joplin.views.menuItems</a>
</li>
<li class=" tsd-kind-class">
<a href="../classes/joplinviewsmenus.html" class="tsd-kind-icon">joplin.views.menus</a>
</li>
<li class=" tsd-kind-class">
<a href="../classes/joplinviewspanels.html" class="tsd-kind-icon">joplin.views.panels</a>
</li>
@ -253,6 +256,9 @@
<li class=" tsd-kind-interface">
<a href="../interfaces/importmodule.html" class="tsd-kind-icon">ImportModule</a>
</li>
<li class=" tsd-kind-interface">
<a href="../interfaces/menuitem.html" class="tsd-kind-icon">MenuItem</a>
</li>
<li class=" tsd-kind-interface">
<a href="../interfaces/script.html" class="tsd-kind-icon">Script</a>
</li>

View File

@ -206,6 +206,9 @@
<li class=" tsd-kind-class">
<a href="../classes/joplinviewsmenuitems.html" class="tsd-kind-icon">joplin.views.menuItems</a>
</li>
<li class=" tsd-kind-class">
<a href="../classes/joplinviewsmenus.html" class="tsd-kind-icon">joplin.views.menus</a>
</li>
<li class=" tsd-kind-class">
<a href="../classes/joplinviewspanels.html" class="tsd-kind-icon">joplin.views.panels</a>
</li>
@ -242,6 +245,9 @@
<li class=" tsd-kind-interface">
<a href="../interfaces/importmodule.html" class="tsd-kind-icon">ImportModule</a>
</li>
<li class=" tsd-kind-interface">
<a href="../interfaces/menuitem.html" class="tsd-kind-icon">MenuItem</a>
</li>
<li class=" tsd-kind-interface">
<a href="../interfaces/script.html" class="tsd-kind-icon">Script</a>
</li>

View File

@ -172,6 +172,9 @@
<li class=" tsd-kind-class">
<a href="../classes/joplinviewsmenuitems.html" class="tsd-kind-icon">joplin.views.menuItems</a>
</li>
<li class=" tsd-kind-class">
<a href="../classes/joplinviewsmenus.html" class="tsd-kind-icon">joplin.views.menus</a>
</li>
<li class=" tsd-kind-class">
<a href="../classes/joplinviewspanels.html" class="tsd-kind-icon">joplin.views.panels</a>
</li>
@ -208,6 +211,9 @@
<li class=" tsd-kind-interface">
<a href="../interfaces/importmodule.html" class="tsd-kind-icon">ImportModule</a>
</li>
<li class=" tsd-kind-interface">
<a href="../interfaces/menuitem.html" class="tsd-kind-icon">MenuItem</a>
</li>
<li class=" tsd-kind-interface">
<a href="../interfaces/script.html" class="tsd-kind-icon">Script</a>
</li>

View File

@ -87,6 +87,7 @@
<li class="tsd-kind-class"><a href="classes/joplinviews.html" class="tsd-kind-icon">Joplin<wbr>Views</a></li>
<li class="tsd-kind-class"><a href="classes/joplinviewsdialogs.html" class="tsd-kind-icon">Joplin<wbr>Views<wbr>Dialogs</a></li>
<li class="tsd-kind-class"><a href="classes/joplinviewsmenuitems.html" class="tsd-kind-icon">Joplin<wbr>Views<wbr>Menu<wbr>Items</a></li>
<li class="tsd-kind-class"><a href="classes/joplinviewsmenus.html" class="tsd-kind-icon">Joplin<wbr>Views<wbr>Menus</a></li>
<li class="tsd-kind-class"><a href="classes/joplinviewspanels.html" class="tsd-kind-icon">Joplin<wbr>Views<wbr>Panels</a></li>
<li class="tsd-kind-class"><a href="classes/joplinviewstoolbarbuttons.html" class="tsd-kind-icon">Joplin<wbr>Views<wbr>Toolbar<wbr>Buttons</a></li>
<li class="tsd-kind-class"><a href="classes/joplinworkspace.html" class="tsd-kind-icon">Joplin<wbr>Workspace</a></li>
@ -104,6 +105,7 @@
<li class="tsd-kind-interface"><a href="interfaces/exportoptions.html" class="tsd-kind-icon">Export<wbr>Options</a></li>
<li class="tsd-kind-interface"><a href="interfaces/importcontext.html" class="tsd-kind-icon">Import<wbr>Context</a></li>
<li class="tsd-kind-interface"><a href="interfaces/importmodule.html" class="tsd-kind-icon">Import<wbr>Module</a></li>
<li class="tsd-kind-interface"><a href="interfaces/menuitem.html" class="tsd-kind-icon">Menu<wbr>Item</a></li>
<li class="tsd-kind-interface"><a href="interfaces/script.html" class="tsd-kind-icon">Script</a></li>
<li class="tsd-kind-interface"><a href="interfaces/settingitem.html" class="tsd-kind-icon">Setting<wbr>Item</a></li>
<li class="tsd-kind-interface"><a href="interfaces/settingsection.html" class="tsd-kind-icon">Setting<wbr>Section</a></li>
@ -207,6 +209,9 @@
<li class=" tsd-kind-class">
<a href="classes/joplinviewsmenuitems.html" class="tsd-kind-icon">joplin.views.menuItems</a>
</li>
<li class=" tsd-kind-class">
<a href="classes/joplinviewsmenus.html" class="tsd-kind-icon">joplin.views.menus</a>
</li>
<li class=" tsd-kind-class">
<a href="classes/joplinviewspanels.html" class="tsd-kind-icon">joplin.views.panels</a>
</li>
@ -243,6 +248,9 @@
<li class=" tsd-kind-interface">
<a href="interfaces/importmodule.html" class="tsd-kind-icon">ImportModule</a>
</li>
<li class=" tsd-kind-interface">
<a href="interfaces/menuitem.html" class="tsd-kind-icon">MenuItem</a>
</li>
<li class=" tsd-kind-interface">
<a href="interfaces/script.html" class="tsd-kind-icon">Script</a>
</li>

View File

@ -122,6 +122,9 @@
<li class=" tsd-kind-class">
<a href="classes/joplinviewsmenuitems.html" class="tsd-kind-icon">joplin.views.menuItems</a>
</li>
<li class=" tsd-kind-class">
<a href="classes/joplinviewsmenus.html" class="tsd-kind-icon">joplin.views.menus</a>
</li>
<li class=" tsd-kind-class">
<a href="classes/joplinviewspanels.html" class="tsd-kind-icon">joplin.views.panels</a>
</li>
@ -158,6 +161,9 @@
<li class=" tsd-kind-interface">
<a href="interfaces/importmodule.html" class="tsd-kind-icon">ImportModule</a>
</li>
<li class=" tsd-kind-interface">
<a href="interfaces/menuitem.html" class="tsd-kind-icon">MenuItem</a>
</li>
<li class=" tsd-kind-interface">
<a href="interfaces/script.html" class="tsd-kind-icon">Script</a>
</li>

View File

@ -189,6 +189,9 @@
<li class=" tsd-kind-class">
<a href="../classes/joplinviewsmenuitems.html" class="tsd-kind-icon">joplin.views.menuItems</a>
</li>
<li class=" tsd-kind-class">
<a href="../classes/joplinviewsmenus.html" class="tsd-kind-icon">joplin.views.menus</a>
</li>
<li class=" tsd-kind-class">
<a href="../classes/joplinviewspanels.html" class="tsd-kind-icon">joplin.views.panels</a>
</li>
@ -240,6 +243,9 @@
<li class=" tsd-kind-interface">
<a href="importmodule.html" class="tsd-kind-icon">ImportModule</a>
</li>
<li class=" tsd-kind-interface">
<a href="menuitem.html" class="tsd-kind-icon">MenuItem</a>
</li>
<li class=" tsd-kind-interface">
<a href="script.html" class="tsd-kind-icon">Script</a>
</li>

View File

@ -253,6 +253,9 @@
<li class=" tsd-kind-class">
<a href="../classes/joplinviewsmenuitems.html" class="tsd-kind-icon">joplin.views.menuItems</a>
</li>
<li class=" tsd-kind-class">
<a href="../classes/joplinviewsmenus.html" class="tsd-kind-icon">joplin.views.menus</a>
</li>
<li class=" tsd-kind-class">
<a href="../classes/joplinviewspanels.html" class="tsd-kind-icon">joplin.views.panels</a>
</li>
@ -313,6 +316,9 @@
<li class=" tsd-kind-interface">
<a href="importmodule.html" class="tsd-kind-icon">ImportModule</a>
</li>
<li class=" tsd-kind-interface">
<a href="menuitem.html" class="tsd-kind-icon">MenuItem</a>
</li>
<li class=" tsd-kind-interface">
<a href="script.html" class="tsd-kind-icon">Script</a>
</li>

View File

@ -154,6 +154,9 @@
<li class=" tsd-kind-class">
<a href="../classes/joplinviewsmenuitems.html" class="tsd-kind-icon">joplin.views.menuItems</a>
</li>
<li class=" tsd-kind-class">
<a href="../classes/joplinviewsmenus.html" class="tsd-kind-icon">joplin.views.menus</a>
</li>
<li class=" tsd-kind-class">
<a href="../classes/joplinviewspanels.html" class="tsd-kind-icon">joplin.views.panels</a>
</li>
@ -199,6 +202,9 @@
<li class=" tsd-kind-interface">
<a href="importmodule.html" class="tsd-kind-icon">ImportModule</a>
</li>
<li class=" tsd-kind-interface">
<a href="menuitem.html" class="tsd-kind-icon">MenuItem</a>
</li>
<li class=" tsd-kind-interface">
<a href="script.html" class="tsd-kind-icon">Script</a>
</li>

View File

@ -162,6 +162,9 @@
<li class=" tsd-kind-class">
<a href="../classes/joplinviewsmenuitems.html" class="tsd-kind-icon">joplin.views.menuItems</a>
</li>
<li class=" tsd-kind-class">
<a href="../classes/joplinviewsmenus.html" class="tsd-kind-icon">joplin.views.menus</a>
</li>
<li class=" tsd-kind-class">
<a href="../classes/joplinviewspanels.html" class="tsd-kind-icon">joplin.views.panels</a>
</li>
@ -210,6 +213,9 @@
<li class=" tsd-kind-interface">
<a href="importmodule.html" class="tsd-kind-icon">ImportModule</a>
</li>
<li class=" tsd-kind-interface">
<a href="menuitem.html" class="tsd-kind-icon">MenuItem</a>
</li>
<li class=" tsd-kind-interface">
<a href="script.html" class="tsd-kind-icon">Script</a>
</li>

View File

@ -175,6 +175,9 @@
<li class=" tsd-kind-class">
<a href="../classes/joplinviewsmenuitems.html" class="tsd-kind-icon">joplin.views.menuItems</a>
</li>
<li class=" tsd-kind-class">
<a href="../classes/joplinviewsmenus.html" class="tsd-kind-icon">joplin.views.menus</a>
</li>
<li class=" tsd-kind-class">
<a href="../classes/joplinviewspanels.html" class="tsd-kind-icon">joplin.views.panels</a>
</li>
@ -226,6 +229,9 @@
<li class=" tsd-kind-interface">
<a href="importmodule.html" class="tsd-kind-icon">ImportModule</a>
</li>
<li class=" tsd-kind-interface">
<a href="menuitem.html" class="tsd-kind-icon">MenuItem</a>
</li>
<li class=" tsd-kind-interface">
<a href="script.html" class="tsd-kind-icon">Script</a>
</li>

View File

@ -362,6 +362,9 @@
<li class=" tsd-kind-class">
<a href="../classes/joplinviewsmenuitems.html" class="tsd-kind-icon">joplin.views.menuItems</a>
</li>
<li class=" tsd-kind-class">
<a href="../classes/joplinviewsmenus.html" class="tsd-kind-icon">joplin.views.menus</a>
</li>
<li class=" tsd-kind-class">
<a href="../classes/joplinviewspanels.html" class="tsd-kind-icon">joplin.views.panels</a>
</li>
@ -431,6 +434,9 @@
<li class=" tsd-kind-interface">
<a href="importmodule.html" class="tsd-kind-icon">ImportModule</a>
</li>
<li class=" tsd-kind-interface">
<a href="menuitem.html" class="tsd-kind-icon">MenuItem</a>
</li>
<li class=" tsd-kind-interface">
<a href="script.html" class="tsd-kind-icon">Script</a>
</li>

View File

@ -194,6 +194,9 @@
<li class=" tsd-kind-class">
<a href="../classes/joplinviewsmenuitems.html" class="tsd-kind-icon">joplin.views.menuItems</a>
</li>
<li class=" tsd-kind-class">
<a href="../classes/joplinviewsmenus.html" class="tsd-kind-icon">joplin.views.menus</a>
</li>
<li class=" tsd-kind-class">
<a href="../classes/joplinviewspanels.html" class="tsd-kind-icon">joplin.views.panels</a>
</li>
@ -254,6 +257,9 @@
<li class=" tsd-kind-interface">
<a href="importmodule.html" class="tsd-kind-icon">ImportModule</a>
</li>
<li class=" tsd-kind-interface">
<a href="menuitem.html" class="tsd-kind-icon">MenuItem</a>
</li>
<li class=" tsd-kind-interface">
<a href="script.html" class="tsd-kind-icon">Script</a>
</li>

View File

@ -170,6 +170,9 @@
<li class=" tsd-kind-class">
<a href="../classes/joplinviewsmenuitems.html" class="tsd-kind-icon">joplin.views.menuItems</a>
</li>
<li class=" tsd-kind-class">
<a href="../classes/joplinviewsmenus.html" class="tsd-kind-icon">joplin.views.menus</a>
</li>
<li class=" tsd-kind-class">
<a href="../classes/joplinviewspanels.html" class="tsd-kind-icon">joplin.views.panels</a>
</li>
@ -221,6 +224,9 @@
<li class=" tsd-kind-interface">
<a href="importmodule.html" class="tsd-kind-icon">ImportModule</a>
</li>
<li class=" tsd-kind-interface">
<a href="menuitem.html" class="tsd-kind-icon">MenuItem</a>
</li>
<li class=" tsd-kind-interface">
<a href="script.html" class="tsd-kind-icon">Script</a>
</li>

View File

@ -264,6 +264,9 @@
<li class=" tsd-kind-class">
<a href="../classes/joplinviewsmenuitems.html" class="tsd-kind-icon">joplin.views.menuItems</a>
</li>
<li class=" tsd-kind-class">
<a href="../classes/joplinviewsmenus.html" class="tsd-kind-icon">joplin.views.menus</a>
</li>
<li class=" tsd-kind-class">
<a href="../classes/joplinviewspanels.html" class="tsd-kind-icon">joplin.views.panels</a>
</li>
@ -327,6 +330,9 @@
</li>
</ul>
<ul class="after-current">
<li class=" tsd-kind-interface">
<a href="menuitem.html" class="tsd-kind-icon">MenuItem</a>
</li>
<li class=" tsd-kind-interface">
<a href="script.html" class="tsd-kind-icon">Script</a>
</li>

View File

@ -0,0 +1,309 @@
<!doctype html>
<html class="default no-js">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>MenuItem | Joplin Plugin API Documentation</title>
<meta name="description" content="Documentation for Joplin Plugin API Documentation">
<meta name="viewport" content="width=device-width, initial-scale=1">
<link rel="stylesheet" href="../assets/css/main.css">
</head>
<body>
<header>
<div class="tsd-page-toolbar">
<div class="container">
<div class="table-wrap">
<div class="table-cell" id="tsd-search" data-index="../assets/js/search.json" data-base="..">
<div class="field">
<label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
<input id="tsd-search-field" type="text" />
</div>
<ul class="results">
<li class="state loading">Preparing search index...</li>
<li class="state failure">The search index is not available</li>
</ul>
<a href="../classes/joplin.html" class="title">Joplin Plugin API Documentation</a>
</div>
<div class="table-cell" id="tsd-widgets">
<div id="tsd-filter">
<a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a>
<div class="tsd-filter-group">
<div class="tsd-select" id="tsd-filter-visibility">
<span class="tsd-select-label">All</span>
<ul class="tsd-select-list">
<li data-value="public">Public</li>
<li data-value="protected">Public/Protected</li>
<li data-value="private" class="selected">All</li>
</ul>
</div>
<input type="checkbox" id="tsd-filter-inherited" checked />
<label class="tsd-widget" for="tsd-filter-inherited">Inherited</label>
</div>
</div>
<a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a>
</div>
</div>
</div>
</div>
<div class="tsd-page-title">
<div class="container">
<ul class="tsd-breadcrumb">
<!--
<li>
<a href="../globals.html">Globals</a>
</li>
-->
<li>
<a href="menuitem.html">MenuItem</a>
</li>
</ul>
<h1><!-- Interface -->MenuItem</h1>
</div>
</div>
</header>
<div class="container container-main">
<div class="row">
<div class="col-8 col-content">
<!--
<section class="tsd-panel tsd-hierarchy">
<h3>Hierarchy</h3>
<ul class="tsd-hierarchy">
<li>
<span class="target">MenuItem</span>
</li>
</ul>
</section>
-->
<section class="tsd-panel-group tsd-index-group">
<h2>Index</h2>
<section class="tsd-panel tsd-index-panel">
<div class="tsd-index-content">
<section class="tsd-index-section ">
<h3>Properties</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="menuitem.html#accelerator" class="tsd-kind-icon">accelerator</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="menuitem.html#commandname" class="tsd-kind-icon">command<wbr>Name</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="menuitem.html#label" class="tsd-kind-icon">label</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="menuitem.html#submenu" class="tsd-kind-icon">submenu</a></li>
</ul>
</section>
</div>
</section>
</section>
<section class="tsd-panel-group tsd-member-group ">
<h2>Properties</h2>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="accelerator" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> accelerator</h3>
<div class="tsd-signature tsd-kind-icon">accelerator<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Accelerator associated with the menu item</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="commandname" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> command<wbr>Name</h3>
<div class="tsd-signature tsd-kind-icon">command<wbr>Name<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Command that should be associated with the menu item. All menu item should
have a command associated with them unless they are a sub-menu.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="label" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> label</h3>
<div class="tsd-signature tsd-kind-icon">label<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Menu item label. If not specified, the command label will be used instead.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="submenu" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> submenu</h3>
<div class="tsd-signature tsd-kind-icon">submenu<span class="tsd-signature-symbol">:</span> <a href="menuitem.html" class="tsd-signature-type">MenuItem</a><span class="tsd-signature-symbol">[]</span></div>
<aside class="tsd-sources">
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Menu items that should appear below this menu item. Allows creating a menu tree.</p>
</div>
</div>
</section>
</section>
</div>
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
<!--
<nav class="tsd-navigation primary">
<ul>
<li class="globals ">
<a href="../globals.html"><em>Globals</em></a>
</li>
</ul>
</nav>
-->
<nav class="tsd-navigation secondary menu-sticky">
<ul class="before-current">
<li class=" tsd-kind-enum">
<a href="../enums/filesystemitem.html" class="tsd-kind-icon">FileSystemItem</a>
</li>
<li class=" tsd-kind-enum">
<a href="../enums/importmoduleoutputformat.html" class="tsd-kind-icon">ImportModuleOutputFormat</a>
</li>
<li class=" tsd-kind-enum">
<a href="../enums/menuitemlocation.html" class="tsd-kind-icon">MenuItemLocation</a>
</li>
<li class=" tsd-kind-enum">
<a href="../enums/settingitemtype.html" class="tsd-kind-icon">SettingItemType</a>
</li>
<li class=" tsd-kind-enum">
<a href="../enums/toolbarbuttonlocation.html" class="tsd-kind-icon">ToolbarButtonLocation</a>
</li>
<li class=" tsd-kind-class">
<a href="../classes/joplin.html" class="tsd-kind-icon">joplin</a>
</li>
<li class=" tsd-kind-class">
<a href="../classes/joplincommands.html" class="tsd-kind-icon">joplin.commands</a>
</li>
<li class=" tsd-kind-class">
<a href="../classes/joplindata.html" class="tsd-kind-icon">joplin.data</a>
</li>
<li class=" tsd-kind-class">
<a href="../classes/joplininterop.html" class="tsd-kind-icon">joplin.interop</a>
</li>
<li class=" tsd-kind-class">
<a href="../classes/joplinplugins.html" class="tsd-kind-icon">joplin.plugins</a>
</li>
<li class=" tsd-kind-class">
<a href="../classes/joplinsettings.html" class="tsd-kind-icon">joplin.settings</a>
</li>
<li class=" tsd-kind-class">
<a href="../classes/joplinviews.html" class="tsd-kind-icon">joplin.views</a>
</li>
<li class=" tsd-kind-class">
<a href="../classes/joplinviewsdialogs.html" class="tsd-kind-icon">joplin.views.dialogs</a>
</li>
<li class=" tsd-kind-class">
<a href="../classes/joplinviewsmenuitems.html" class="tsd-kind-icon">joplin.views.menuItems</a>
</li>
<li class=" tsd-kind-class">
<a href="../classes/joplinviewsmenus.html" class="tsd-kind-icon">joplin.views.menus</a>
</li>
<li class=" tsd-kind-class">
<a href="../classes/joplinviewspanels.html" class="tsd-kind-icon">joplin.views.panels</a>
</li>
<li class=" tsd-kind-class">
<a href="../classes/joplinviewstoolbarbuttons.html" class="tsd-kind-icon">joplin.views.toolbarButtons</a>
</li>
<li class=" tsd-kind-class">
<a href="../classes/joplinworkspace.html" class="tsd-kind-icon">joplin.workspace</a>
</li>
<li class=" tsd-kind-interface">
<a href="buttonspec.html" class="tsd-kind-icon">ButtonSpec</a>
</li>
<li class=" tsd-kind-interface">
<a href="command.html" class="tsd-kind-icon">Command</a>
</li>
<li class=" tsd-kind-interface">
<a href="createmenuitemoptions.html" class="tsd-kind-icon">CreateMenuItemOptions</a>
</li>
<li class=" tsd-kind-interface">
<a href="editorcommand.html" class="tsd-kind-icon">EditorCommand</a>
</li>
<li class=" tsd-kind-interface">
<a href="exportcontext.html" class="tsd-kind-icon">ExportContext</a>
</li>
<li class=" tsd-kind-interface">
<a href="exportmodule.html" class="tsd-kind-icon">ExportModule</a>
</li>
<li class=" tsd-kind-interface">
<a href="exportoptions.html" class="tsd-kind-icon">ExportOptions</a>
</li>
<li class=" tsd-kind-interface">
<a href="importcontext.html" class="tsd-kind-icon">ImportContext</a>
</li>
<li class=" tsd-kind-interface">
<a href="importmodule.html" class="tsd-kind-icon">ImportModule</a>
</li>
</ul>
<ul class="current">
<li class="current tsd-kind-interface">
<a href="menuitem.html" class="tsd-kind-icon">MenuItem</a>
<ul>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="menuitem.html#accelerator" class="tsd-kind-icon">accelerator</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="menuitem.html#commandname" class="tsd-kind-icon">command<wbr>Name</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="menuitem.html#label" class="tsd-kind-icon">label</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="menuitem.html#submenu" class="tsd-kind-icon">submenu</a>
</li>
</ul>
</li>
</ul>
<ul class="after-current">
<li class=" tsd-kind-interface">
<a href="script.html" class="tsd-kind-icon">Script</a>
</li>
<li class=" tsd-kind-interface">
<a href="settingitem.html" class="tsd-kind-icon">SettingItem</a>
</li>
<li class=" tsd-kind-interface">
<a href="settingsection.html" class="tsd-kind-icon">SettingSection</a>
</li>
<li class=" tsd-kind-type-alias">
<a href="../globals.html#buttonid" class="tsd-kind-icon">ButtonId</a>
</li>
<li class=" tsd-kind-type-alias">
<a href="../globals.html#path" class="tsd-kind-icon">Path</a>
</li>
<li class=" tsd-kind-type-alias">
<a href="../globals.html#viewhandle" class="tsd-kind-icon">ViewHandle</a>
</li>
</ul>
</nav>
</div>
</div>
</div>
<!-- JOPLINCHANGE
<footer class="with-border-bottom">
<div class="container">
<h2>Legend</h2>
<div class="tsd-legend-group">
<ul class="tsd-legend">
<li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
<li class="tsd-kind-method tsd-parent-kind-interface"><span class="tsd-kind-icon">Method</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li>
<li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li>
</ul>
</div>
</div>
</footer>
<div class="container tsd-generator">
<p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p>
</div>
-->
<div class="overlay"></div>
<script src="../assets/js/main.js"></script>
</body>
</html>

View File

@ -171,6 +171,9 @@
<li class=" tsd-kind-class">
<a href="../classes/joplinviewsmenuitems.html" class="tsd-kind-icon">joplin.views.menuItems</a>
</li>
<li class=" tsd-kind-class">
<a href="../classes/joplinviewsmenus.html" class="tsd-kind-icon">joplin.views.menus</a>
</li>
<li class=" tsd-kind-class">
<a href="../classes/joplinviewspanels.html" class="tsd-kind-icon">joplin.views.panels</a>
</li>
@ -207,6 +210,9 @@
<li class=" tsd-kind-interface">
<a href="importmodule.html" class="tsd-kind-icon">ImportModule</a>
</li>
<li class=" tsd-kind-interface">
<a href="menuitem.html" class="tsd-kind-icon">MenuItem</a>
</li>
</ul>
<ul class="current">
<li class="current tsd-kind-interface">

View File

@ -258,6 +258,9 @@
<li class=" tsd-kind-class">
<a href="../classes/joplinviewsmenuitems.html" class="tsd-kind-icon">joplin.views.menuItems</a>
</li>
<li class=" tsd-kind-class">
<a href="../classes/joplinviewsmenus.html" class="tsd-kind-icon">joplin.views.menus</a>
</li>
<li class=" tsd-kind-class">
<a href="../classes/joplinviewspanels.html" class="tsd-kind-icon">joplin.views.panels</a>
</li>
@ -294,6 +297,9 @@
<li class=" tsd-kind-interface">
<a href="importmodule.html" class="tsd-kind-icon">ImportModule</a>
</li>
<li class=" tsd-kind-interface">
<a href="menuitem.html" class="tsd-kind-icon">MenuItem</a>
</li>
<li class=" tsd-kind-interface">
<a href="script.html" class="tsd-kind-icon">Script</a>
</li>

View File

@ -178,6 +178,9 @@
<li class=" tsd-kind-class">
<a href="../classes/joplinviewsmenuitems.html" class="tsd-kind-icon">joplin.views.menuItems</a>
</li>
<li class=" tsd-kind-class">
<a href="../classes/joplinviewsmenus.html" class="tsd-kind-icon">joplin.views.menus</a>
</li>
<li class=" tsd-kind-class">
<a href="../classes/joplinviewspanels.html" class="tsd-kind-icon">joplin.views.panels</a>
</li>
@ -214,6 +217,9 @@
<li class=" tsd-kind-interface">
<a href="importmodule.html" class="tsd-kind-icon">ImportModule</a>
</li>
<li class=" tsd-kind-interface">
<a href="menuitem.html" class="tsd-kind-icon">MenuItem</a>
</li>
<li class=" tsd-kind-interface">
<a href="script.html" class="tsd-kind-icon">Script</a>
</li>

View File

@ -9,7 +9,7 @@ This file was auto-generated from readme/api/references/plugin_manifest.md and a
made to it will be overwritten. To make a change to this file please modify
the source Markdown file:
https://github.com/laurent22/joplin/blob/master/readme/api/references/plugin_manifest.md
https://github.com/laurent22/joplin/blob/dev/readme/api/references/plugin_manifest.md
-->
@ -28,6 +28,15 @@ https://github.com/laurent22/joplin/blob/master/readme/api/references/plugin_man
background-color: #F1F1F1;
color: #333333;
}
.root {
overflow: hidden;
}
a[href^="mailto:"] {
word-break: break-all;
}
table {
margin-bottom: 1em;
}
@ -72,6 +81,7 @@ https://github.com/laurent22/joplin/blob/master/readme/api/references/plugin_man
background-color: #eee;
border: 1px solid #ccc;
font-size: .85em;
word-break: break-all;
}
pre code {
border: none;
@ -184,8 +194,9 @@ https://github.com/laurent22/joplin/blob/master/readme/api/references/plugin_man
}
.nav {
background-color: black;
display: table;
width: inherit;
display: flex;
flex-direction: row;
align-items: center;
}
.nav.sticky {
position:fixed;
@ -202,9 +213,8 @@ https://github.com/laurent22/joplin/blob/master/readme/api/references/plugin_man
padding-left: 2em;
margin-bottom: 0;
display: table-cell;
/* min-width: 250px; */
/* For GSoC: */
min-width: 470px;
display: flex;
width: 100%;
}
.nav ul li {
display: inline-block;
@ -215,11 +225,11 @@ https://github.com/laurent22/joplin/blob/master/readme/api/references/plugin_man
font-weight: bold;
}
.nav-right {
display: table-cell;
width: 100%;
display: flex;
text-align: right;
vertical-align: middle;
line-height: 0;
margin-right: 10px;
}
.nav-right .share-btn {
display: none;
@ -228,7 +238,7 @@ https://github.com/laurent22/joplin/blob/master/readme/api/references/plugin_man
display: none;
}
.footer {
padding-top: 1em;
padding: 2em;
border-top: 1px solid #d4d4d4;
margin-top: 2em;
color: gray;
@ -254,6 +264,23 @@ https://github.com/laurent22/joplin/blob/master/readme/api/references/plugin_man
opacity: 1;
}
@media (min-width: 992px) {
.content{
display: flex;
}
#toc{
display: block!important;
align-self: flex-start;
width: 300px;
position: sticky; top: 20px; left: 0;
}
.main{
width: calc(100% - 300px);
}
}
.bottom-links {
display: flex;
justify-content: center;
@ -275,7 +302,7 @@ https://github.com/laurent22/joplin/blob/master/readme/api/references/plugin_man
<body>
<div class="container page-plugin_manifest">
<div class="container root page-plugin_manifest">
<div class="header">
<a class="forkme" href="https://github.com/laurent22/joplin"><img src="https://joplinapp.org/images/ForkMe.png"/></a>
@ -341,7 +368,7 @@ https://github.com/laurent22/joplin/blob/master/readme/api/references/plugin_man
<li><a href="https://joplinapp.org/spec/history/">Note History spec</a></li>
<li><a href="https://joplinapp.org/spec/sync_lock/">Sync Lock spec</a></li>
<li><a href="https://joplinapp.org/spec/plugins/">Plugin Architecture spec</a></li>
<li><a href="https://github.com/laurent22/joplin/blob/master/readme/spec/search_sorting.md">Search Sorting spec</a></li>
<li><a href="https://joplinapp.org/spec/search_sorting/">Search Sorting spec</a></li>
</ul>
</li>
<li>
@ -362,6 +389,8 @@ https://github.com/laurent22/joplin/blob/master/readme/api/references/plugin_man
</li>
</ul>
</div>
<div class="main">
<h1>Plugin Manifest<a name="plugin-manifest" href="#plugin-manifest" class="heading-anchor">🔗</a></h1>
<p>The manifest file is a JSON file that describes various properties of the plugin. If you use the Yeoman generator, it should be automatically generated based on the answers you've provided. The supported properties are:</p>
<ul>
@ -382,7 +411,7 @@ https://github.com/laurent22/joplin/blob/master/readme/api/references/plugin_man
</code></pre>
<div class="bottom-links">
<a href="https://github.com/laurent22/joplin/blob/master/readme/api/references/plugin_manifest.md">
<a href="https://github.com/laurent22/joplin/blob/dev/readme/api/references/plugin_manifest.md">
<i class="fa fa-github"></i> Improve this doc
</a>
</div>
@ -416,8 +445,10 @@ https://github.com/laurent22/joplin/blob/master/readme/api/references/plugin_man
ga('send', 'pageview');
</script>
</div></div>
<div class="footer">
Copyright (c) 2016-2020 Laurent Cozic
Copyright (C) 2016-2020 Laurent Cozic
</div>
</body>
</html>

View File

@ -9,7 +9,7 @@ This file was auto-generated from readme/api/references/rest_api.md and any manu
made to it will be overwritten. To make a change to this file please modify
the source Markdown file:
https://github.com/laurent22/joplin/blob/master/readme/api/references/rest_api.md
https://github.com/laurent22/joplin/blob/dev/readme/api/references/rest_api.md
-->
@ -28,6 +28,15 @@ https://github.com/laurent22/joplin/blob/master/readme/api/references/rest_api.m
background-color: #F1F1F1;
color: #333333;
}
.root {
overflow: hidden;
}
a[href^="mailto:"] {
word-break: break-all;
}
table {
margin-bottom: 1em;
}
@ -72,6 +81,7 @@ https://github.com/laurent22/joplin/blob/master/readme/api/references/rest_api.m
background-color: #eee;
border: 1px solid #ccc;
font-size: .85em;
word-break: break-all;
}
pre code {
border: none;
@ -184,8 +194,9 @@ https://github.com/laurent22/joplin/blob/master/readme/api/references/rest_api.m
}
.nav {
background-color: black;
display: table;
width: inherit;
display: flex;
flex-direction: row;
align-items: center;
}
.nav.sticky {
position:fixed;
@ -202,9 +213,8 @@ https://github.com/laurent22/joplin/blob/master/readme/api/references/rest_api.m
padding-left: 2em;
margin-bottom: 0;
display: table-cell;
/* min-width: 250px; */
/* For GSoC: */
min-width: 470px;
display: flex;
width: 100%;
}
.nav ul li {
display: inline-block;
@ -215,11 +225,11 @@ https://github.com/laurent22/joplin/blob/master/readme/api/references/rest_api.m
font-weight: bold;
}
.nav-right {
display: table-cell;
width: 100%;
display: flex;
text-align: right;
vertical-align: middle;
line-height: 0;
margin-right: 10px;
}
.nav-right .share-btn {
display: none;
@ -228,7 +238,7 @@ https://github.com/laurent22/joplin/blob/master/readme/api/references/rest_api.m
display: none;
}
.footer {
padding-top: 1em;
padding: 2em;
border-top: 1px solid #d4d4d4;
margin-top: 2em;
color: gray;
@ -254,6 +264,23 @@ https://github.com/laurent22/joplin/blob/master/readme/api/references/rest_api.m
opacity: 1;
}
@media (min-width: 992px) {
.content{
display: flex;
}
#toc{
display: block!important;
align-self: flex-start;
width: 300px;
position: sticky; top: 20px; left: 0;
}
.main{
width: calc(100% - 300px);
}
}
.bottom-links {
display: flex;
justify-content: center;
@ -275,7 +302,7 @@ https://github.com/laurent22/joplin/blob/master/readme/api/references/rest_api.m
<body>
<div class="container page-rest_api">
<div class="container root page-rest_api">
<div class="header">
<a class="forkme" href="https://github.com/laurent22/joplin"><img src="https://joplinapp.org/images/ForkMe.png"/></a>
@ -341,7 +368,7 @@ https://github.com/laurent22/joplin/blob/master/readme/api/references/rest_api.m
<li><a href="https://joplinapp.org/spec/history/">Note History spec</a></li>
<li><a href="https://joplinapp.org/spec/sync_lock/">Sync Lock spec</a></li>
<li><a href="https://joplinapp.org/spec/plugins/">Plugin Architecture spec</a></li>
<li><a href="https://github.com/laurent22/joplin/blob/master/readme/spec/search_sorting.md">Search Sorting spec</a></li>
<li><a href="https://joplinapp.org/spec/search_sorting/">Search Sorting spec</a></li>
</ul>
</li>
<li>
@ -362,6 +389,8 @@ https://github.com/laurent22/joplin/blob/master/readme/api/references/rest_api.m
</li>
</ul>
</div>
<div class="main">
<h1>Joplin Data API<a name="joplin-data-api" href="#joplin-data-api" class="heading-anchor">🔗</a></h1>
<p>This API is available when the clipper server is running. It provides access to the notes, notebooks, tags and other Joplin object via a REST API. Plugins can also access this API even when the clipper server is not running.</p>
<p>In order to use it, you'll first need to find on which port the service is running. To do so, open the Web Clipper Options in Joplin and if the service is running it should tell you on which port. Normally it runs on port <strong>41184</strong>. If you want to find it programmatically, you may follow this kind of algorithm:</p>
@ -941,7 +970,7 @@ for (let portToTest = 41184; portToTest &lt;= 41194; portToTest++) {
<p>Remove the tag from the note.</p>
<div class="bottom-links">
<a href="https://github.com/laurent22/joplin/blob/master/readme/api/references/rest_api.md">
<a href="https://github.com/laurent22/joplin/blob/dev/readme/api/references/rest_api.md">
<i class="fa fa-github"></i> Improve this doc
</a>
</div>
@ -975,8 +1004,10 @@ for (let portToTest = 41184; portToTest &lt;= 41194; portToTest++) {
ga('send', 'pageview');
</script>
</div></div>
<div class="footer">
Copyright (c) 2016-2020 Laurent Cozic
Copyright (C) 2016-2020 Laurent Cozic
</div>
</body>
</html>

View File

@ -9,7 +9,7 @@ This file was auto-generated from readme/api/tutorials/toc_plugin.md and any man
made to it will be overwritten. To make a change to this file please modify
the source Markdown file:
https://github.com/laurent22/joplin/blob/master/readme/api/tutorials/toc_plugin.md
https://github.com/laurent22/joplin/blob/dev/readme/api/tutorials/toc_plugin.md
-->
@ -28,6 +28,15 @@ https://github.com/laurent22/joplin/blob/master/readme/api/tutorials/toc_plugin.
background-color: #F1F1F1;
color: #333333;
}
.root {
overflow: hidden;
}
a[href^="mailto:"] {
word-break: break-all;
}
table {
margin-bottom: 1em;
}
@ -72,6 +81,7 @@ https://github.com/laurent22/joplin/blob/master/readme/api/tutorials/toc_plugin.
background-color: #eee;
border: 1px solid #ccc;
font-size: .85em;
word-break: break-all;
}
pre code {
border: none;
@ -184,8 +194,9 @@ https://github.com/laurent22/joplin/blob/master/readme/api/tutorials/toc_plugin.
}
.nav {
background-color: black;
display: table;
width: inherit;
display: flex;
flex-direction: row;
align-items: center;
}
.nav.sticky {
position:fixed;
@ -202,9 +213,8 @@ https://github.com/laurent22/joplin/blob/master/readme/api/tutorials/toc_plugin.
padding-left: 2em;
margin-bottom: 0;
display: table-cell;
/* min-width: 250px; */
/* For GSoC: */
min-width: 470px;
display: flex;
width: 100%;
}
.nav ul li {
display: inline-block;
@ -215,11 +225,11 @@ https://github.com/laurent22/joplin/blob/master/readme/api/tutorials/toc_plugin.
font-weight: bold;
}
.nav-right {
display: table-cell;
width: 100%;
display: flex;
text-align: right;
vertical-align: middle;
line-height: 0;
margin-right: 10px;
}
.nav-right .share-btn {
display: none;
@ -228,7 +238,7 @@ https://github.com/laurent22/joplin/blob/master/readme/api/tutorials/toc_plugin.
display: none;
}
.footer {
padding-top: 1em;
padding: 2em;
border-top: 1px solid #d4d4d4;
margin-top: 2em;
color: gray;
@ -254,6 +264,23 @@ https://github.com/laurent22/joplin/blob/master/readme/api/tutorials/toc_plugin.
opacity: 1;
}
@media (min-width: 992px) {
.content{
display: flex;
}
#toc{
display: block!important;
align-self: flex-start;
width: 300px;
position: sticky; top: 20px; left: 0;
}
.main{
width: calc(100% - 300px);
}
}
.bottom-links {
display: flex;
justify-content: center;
@ -275,7 +302,7 @@ https://github.com/laurent22/joplin/blob/master/readme/api/tutorials/toc_plugin.
<body>
<div class="container page-toc_plugin">
<div class="container root page-toc_plugin">
<div class="header">
<a class="forkme" href="https://github.com/laurent22/joplin"><img src="https://joplinapp.org/images/ForkMe.png"/></a>
@ -341,7 +368,7 @@ https://github.com/laurent22/joplin/blob/master/readme/api/tutorials/toc_plugin.
<li><a href="https://joplinapp.org/spec/history/">Note History spec</a></li>
<li><a href="https://joplinapp.org/spec/sync_lock/">Sync Lock spec</a></li>
<li><a href="https://joplinapp.org/spec/plugins/">Plugin Architecture spec</a></li>
<li><a href="https://github.com/laurent22/joplin/blob/master/readme/spec/search_sorting.md">Search Sorting spec</a></li>
<li><a href="https://joplinapp.org/spec/search_sorting/">Search Sorting spec</a></li>
</ul>
</li>
<li>
@ -362,6 +389,8 @@ https://github.com/laurent22/joplin/blob/master/readme/api/tutorials/toc_plugin.
</li>
</ul>
</div>
<div class="main">
<h1>Creating a table of content plugin<a name="creating-a-table-of-content-plugin" href="#creating-a-table-of-content-plugin" class="heading-anchor">🔗</a></h1>
<p>This tutorial will guide you through the steps to create a table of content plugin for Joplin. It will display a view next to the current note that will contain links to the sections of a note. It will be possible to click on one of the header to jump to the relevant section.</p>
<p>Through this tutorial you will learn about several aspect of the Joplin API, including:</p>
@ -370,8 +399,8 @@ https://github.com/laurent22/joplin/blob/master/readme/api/tutorials/toc_plugin.
<li>How to create a webview</li>
<li>How to listen to changes in the user interface</li>
</ul>
<p>## Setting up your environment</p>
<p>Before getting any further, make sure your environment is setup correctly as described in the <a href="https://github.com/laurent22/joplin/blob/dev/readme/api/get_started/plugins/">Get Started guide</a>.</p>
<h2>Setting up your environment<a name="setting-up-your-environment" href="#setting-up-your-environment" class="heading-anchor">🔗</a></h2>
<p>Before getting any further, make sure your environment is setup correctly as described in the <a href="https://joplinapp.org/api/get_started/plugins/">Get Started guide</a>.</p>
<h2>Registering the plugin<a name="registering-the-plugin" href="#registering-the-plugin" class="heading-anchor">🔗</a></h2>
<p>All plugins must <a href="https://joplinapp.org/api/references/plugin_api/classes/joplinplugins.html">register themselves</a> and declare what events they can handle. To do so, open <code>src/index.ts</code> and register the plugin as below. We'll also need to run some initialisation code when the plugin starts, so add the <code>onStart()</code> event handler too:</p>
<pre><code class="language-typescript">// Import the Joplin API
@ -640,7 +669,7 @@ document.addEventListener('click', event =&gt; {
<p>Various improvements can be made such as improving the styling, making the header collapsible, etc. but that tutorial should provide the basic building blocks to do so. You might also want to check the <a href="https://joplinapp.org/api/references/plugin_api/classes/joplin.html">plugin API</a> for further information or head to the <a href="https://discourse.joplinapp.org/c/development/6">development forum</a> for support.</p>
<div class="bottom-links">
<a href="https://github.com/laurent22/joplin/blob/master/readme/api/tutorials/toc_plugin.md">
<a href="https://github.com/laurent22/joplin/blob/dev/readme/api/tutorials/toc_plugin.md">
<i class="fa fa-github"></i> Improve this doc
</a>
</div>
@ -674,8 +703,10 @@ document.addEventListener('click', event =&gt; {
ga('send', 'pageview');
</script>
</div></div>
<div class="footer">
Copyright (c) 2016-2020 Laurent Cozic
Copyright (C) 2016-2020 Laurent Cozic
</div>
</body>
</html>

View File

@ -9,7 +9,7 @@ This file was auto-generated from readme/blog/20180621-182112.md and any manual
made to it will be overwritten. To make a change to this file please modify
the source Markdown file:
https://github.com/laurent22/joplin/blob/master/readme/blog/20180621-182112.md
https://github.com/laurent22/joplin/blob/dev/readme/blog/20180621-182112.md
-->
@ -28,6 +28,15 @@ https://github.com/laurent22/joplin/blob/master/readme/blog/20180621-182112.md
background-color: #F1F1F1;
color: #333333;
}
.root {
overflow: hidden;
}
a[href^="mailto:"] {
word-break: break-all;
}
table {
margin-bottom: 1em;
}
@ -72,6 +81,7 @@ https://github.com/laurent22/joplin/blob/master/readme/blog/20180621-182112.md
background-color: #eee;
border: 1px solid #ccc;
font-size: .85em;
word-break: break-all;
}
pre code {
border: none;
@ -184,8 +194,9 @@ https://github.com/laurent22/joplin/blob/master/readme/blog/20180621-182112.md
}
.nav {
background-color: black;
display: table;
width: inherit;
display: flex;
flex-direction: row;
align-items: center;
}
.nav.sticky {
position:fixed;
@ -202,9 +213,8 @@ https://github.com/laurent22/joplin/blob/master/readme/blog/20180621-182112.md
padding-left: 2em;
margin-bottom: 0;
display: table-cell;
/* min-width: 250px; */
/* For GSoC: */
min-width: 470px;
display: flex;
width: 100%;
}
.nav ul li {
display: inline-block;
@ -215,11 +225,11 @@ https://github.com/laurent22/joplin/blob/master/readme/blog/20180621-182112.md
font-weight: bold;
}
.nav-right {
display: table-cell;
width: 100%;
display: flex;
text-align: right;
vertical-align: middle;
line-height: 0;
margin-right: 10px;
}
.nav-right .share-btn {
display: none;
@ -228,7 +238,7 @@ https://github.com/laurent22/joplin/blob/master/readme/blog/20180621-182112.md
display: none;
}
.footer {
padding-top: 1em;
padding: 2em;
border-top: 1px solid #d4d4d4;
margin-top: 2em;
color: gray;
@ -254,6 +264,23 @@ https://github.com/laurent22/joplin/blob/master/readme/blog/20180621-182112.md
opacity: 1;
}
@media (min-width: 992px) {
.content{
display: flex;
}
#toc{
display: block!important;
align-self: flex-start;
width: 300px;
position: sticky; top: 20px; left: 0;
}
.main{
width: calc(100% - 300px);
}
}
.bottom-links {
display: flex;
justify-content: center;
@ -275,7 +302,7 @@ https://github.com/laurent22/joplin/blob/master/readme/blog/20180621-182112.md
<body>
<div class="container page-20180621-182112">
<div class="container root page-20180621-182112">
<div class="header">
<a class="forkme" href="https://github.com/laurent22/joplin"><img src="https://joplinapp.org/images/ForkMe.png"/></a>
@ -341,7 +368,7 @@ https://github.com/laurent22/joplin/blob/master/readme/blog/20180621-182112.md
<li><a href="https://joplinapp.org/spec/history/">Note History spec</a></li>
<li><a href="https://joplinapp.org/spec/sync_lock/">Sync Lock spec</a></li>
<li><a href="https://joplinapp.org/spec/plugins/">Plugin Architecture spec</a></li>
<li><a href="https://github.com/laurent22/joplin/blob/master/readme/spec/search_sorting.md">Search Sorting spec</a></li>
<li><a href="https://joplinapp.org/spec/search_sorting/">Search Sorting spec</a></li>
</ul>
</li>
<li>
@ -362,6 +389,8 @@ https://github.com/laurent22/joplin/blob/master/readme/blog/20180621-182112.md
</li>
</ul>
</div>
<div class="main">
<h1>Web Clipper now available on Firefox and Chrome<a name="web-clipper-now-available-on-firefox-and-chrome" href="#web-clipper-now-available-on-firefox-and-chrome" class="heading-anchor">🔗</a></h1>
<p><a href="https://github.com/laurent22/joplin/issues/135">One of the most requested feature</a>, the Web Clipper, is now available on the Firefox and Chrome store. It is possible to save a whole web page, or a simplified version of it, or a screenshot directly from the browser to Joplin. Like the rest of Joplin, the HTML page will be converted to Markdown, which means it can be easily edited and read even without a special viewer, and, since it's plain text, it also makes it easier to search and share the content.</p>
<p>Have a look at the <a href="https://joplinapp.org/clipper/">Web Clipper documentation</a> for more information.</p>
@ -371,7 +400,7 @@ https://github.com/laurent22/joplin/blob/master/readme/blog/20180621-182112.md
published_at: 2018-06-21T17:21:12.000+00:00</p>
<div class="bottom-links">
<a href="https://github.com/laurent22/joplin/blob/master/readme/blog/20180621-182112.md">
<a href="https://github.com/laurent22/joplin/blob/dev/readme/blog/20180621-182112.md">
<i class="fa fa-github"></i> Improve this doc
</a>
</div>
@ -405,8 +434,10 @@ published_at: 2018-06-21T17:21:12.000+00:00</p>
ga('send', 'pageview');
</script>
</div></div>
<div class="footer">
Copyright (c) 2016-2020 Laurent Cozic
Copyright (C) 2016-2020 Laurent Cozic
</div>
</body>
</html>

View File

@ -9,7 +9,7 @@ This file was auto-generated from readme/blog/20180906-111039.md and any manual
made to it will be overwritten. To make a change to this file please modify
the source Markdown file:
https://github.com/laurent22/joplin/blob/master/readme/blog/20180906-111039.md
https://github.com/laurent22/joplin/blob/dev/readme/blog/20180906-111039.md
-->
@ -28,6 +28,15 @@ https://github.com/laurent22/joplin/blob/master/readme/blog/20180906-111039.md
background-color: #F1F1F1;
color: #333333;
}
.root {
overflow: hidden;
}
a[href^="mailto:"] {
word-break: break-all;
}
table {
margin-bottom: 1em;
}
@ -72,6 +81,7 @@ https://github.com/laurent22/joplin/blob/master/readme/blog/20180906-111039.md
background-color: #eee;
border: 1px solid #ccc;
font-size: .85em;
word-break: break-all;
}
pre code {
border: none;
@ -184,8 +194,9 @@ https://github.com/laurent22/joplin/blob/master/readme/blog/20180906-111039.md
}
.nav {
background-color: black;
display: table;
width: inherit;
display: flex;
flex-direction: row;
align-items: center;
}
.nav.sticky {
position:fixed;
@ -202,9 +213,8 @@ https://github.com/laurent22/joplin/blob/master/readme/blog/20180906-111039.md
padding-left: 2em;
margin-bottom: 0;
display: table-cell;
/* min-width: 250px; */
/* For GSoC: */
min-width: 470px;
display: flex;
width: 100%;
}
.nav ul li {
display: inline-block;
@ -215,11 +225,11 @@ https://github.com/laurent22/joplin/blob/master/readme/blog/20180906-111039.md
font-weight: bold;
}
.nav-right {
display: table-cell;
width: 100%;
display: flex;
text-align: right;
vertical-align: middle;
line-height: 0;
margin-right: 10px;
}
.nav-right .share-btn {
display: none;
@ -228,7 +238,7 @@ https://github.com/laurent22/joplin/blob/master/readme/blog/20180906-111039.md
display: none;
}
.footer {
padding-top: 1em;
padding: 2em;
border-top: 1px solid #d4d4d4;
margin-top: 2em;
color: gray;
@ -254,6 +264,23 @@ https://github.com/laurent22/joplin/blob/master/readme/blog/20180906-111039.md
opacity: 1;
}
@media (min-width: 992px) {
.content{
display: flex;
}
#toc{
display: block!important;
align-self: flex-start;
width: 300px;
position: sticky; top: 20px; left: 0;
}
.main{
width: calc(100% - 300px);
}
}
.bottom-links {
display: flex;
justify-content: center;
@ -275,7 +302,7 @@ https://github.com/laurent22/joplin/blob/master/readme/blog/20180906-111039.md
<body>
<div class="container page-20180906-111039">
<div class="container root page-20180906-111039">
<div class="header">
<a class="forkme" href="https://github.com/laurent22/joplin"><img src="https://joplinapp.org/images/ForkMe.png"/></a>
@ -341,7 +368,7 @@ https://github.com/laurent22/joplin/blob/master/readme/blog/20180906-111039.md
<li><a href="https://joplinapp.org/spec/history/">Note History spec</a></li>
<li><a href="https://joplinapp.org/spec/sync_lock/">Sync Lock spec</a></li>
<li><a href="https://joplinapp.org/spec/plugins/">Plugin Architecture spec</a></li>
<li><a href="https://github.com/laurent22/joplin/blob/master/readme/spec/search_sorting.md">Search Sorting spec</a></li>
<li><a href="https://joplinapp.org/spec/search_sorting/">Search Sorting spec</a></li>
</ul>
</li>
<li>
@ -362,6 +389,8 @@ https://github.com/laurent22/joplin/blob/master/readme/blog/20180906-111039.md
</li>
</ul>
</div>
<div class="main">
<h1>New iOS release with improved attachment support<a name="new-ios-release-with-improved-attachment-support" href="#new-ios-release-with-improved-attachment-support" class="heading-anchor">🔗</a></h1>
<p><img src="images/20180906-111039_0.png" alt=""></p>
<p>The iOS version for iPhone, iPad and iPod sometimes lags behind the Android one due to the App Store release process being more complex. However it eventually catches up, as is the case with the latest release, which includes all the features and bug fixes from the past few months.</p>
@ -372,7 +401,7 @@ https://github.com/laurent22/joplin/blob/master/readme/blog/20180906-111039.md
published_at: 2018-09-06T10:10:39.000+00:00</p>
<div class="bottom-links">
<a href="https://github.com/laurent22/joplin/blob/master/readme/blog/20180906-111039.md">
<a href="https://github.com/laurent22/joplin/blob/dev/readme/blog/20180906-111039.md">
<i class="fa fa-github"></i> Improve this doc
</a>
</div>
@ -406,8 +435,10 @@ published_at: 2018-09-06T10:10:39.000+00:00</p>
ga('send', 'pageview');
</script>
</div></div>
<div class="footer">
Copyright (c) 2016-2020 Laurent Cozic
Copyright (C) 2016-2020 Laurent Cozic
</div>
</body>
</html>

View File

@ -9,7 +9,7 @@ This file was auto-generated from readme/blog/20180916-210431.md and any manual
made to it will be overwritten. To make a change to this file please modify
the source Markdown file:
https://github.com/laurent22/joplin/blob/master/readme/blog/20180916-210431.md
https://github.com/laurent22/joplin/blob/dev/readme/blog/20180916-210431.md
-->
@ -28,6 +28,15 @@ https://github.com/laurent22/joplin/blob/master/readme/blog/20180916-210431.md
background-color: #F1F1F1;
color: #333333;
}
.root {
overflow: hidden;
}
a[href^="mailto:"] {
word-break: break-all;
}
table {
margin-bottom: 1em;
}
@ -72,6 +81,7 @@ https://github.com/laurent22/joplin/blob/master/readme/blog/20180916-210431.md
background-color: #eee;
border: 1px solid #ccc;
font-size: .85em;
word-break: break-all;
}
pre code {
border: none;
@ -184,8 +194,9 @@ https://github.com/laurent22/joplin/blob/master/readme/blog/20180916-210431.md
}
.nav {
background-color: black;
display: table;
width: inherit;
display: flex;
flex-direction: row;
align-items: center;
}
.nav.sticky {
position:fixed;
@ -202,9 +213,8 @@ https://github.com/laurent22/joplin/blob/master/readme/blog/20180916-210431.md
padding-left: 2em;
margin-bottom: 0;
display: table-cell;
/* min-width: 250px; */
/* For GSoC: */
min-width: 470px;
display: flex;
width: 100%;
}
.nav ul li {
display: inline-block;
@ -215,11 +225,11 @@ https://github.com/laurent22/joplin/blob/master/readme/blog/20180916-210431.md
font-weight: bold;
}
.nav-right {
display: table-cell;
width: 100%;
display: flex;
text-align: right;
vertical-align: middle;
line-height: 0;
margin-right: 10px;
}
.nav-right .share-btn {
display: none;
@ -228,7 +238,7 @@ https://github.com/laurent22/joplin/blob/master/readme/blog/20180916-210431.md
display: none;
}
.footer {
padding-top: 1em;
padding: 2em;
border-top: 1px solid #d4d4d4;
margin-top: 2em;
color: gray;
@ -254,6 +264,23 @@ https://github.com/laurent22/joplin/blob/master/readme/blog/20180916-210431.md
opacity: 1;
}
@media (min-width: 992px) {
.content{
display: flex;
}
#toc{
display: block!important;
align-self: flex-start;
width: 300px;
position: sticky; top: 20px; left: 0;
}
.main{
width: calc(100% - 300px);
}
}
.bottom-links {
display: flex;
justify-content: center;
@ -275,7 +302,7 @@ https://github.com/laurent22/joplin/blob/master/readme/blog/20180916-210431.md
<body>
<div class="container page-20180916-210431">
<div class="container root page-20180916-210431">
<div class="header">
<a class="forkme" href="https://github.com/laurent22/joplin"><img src="https://joplinapp.org/images/ForkMe.png"/></a>
@ -341,7 +368,7 @@ https://github.com/laurent22/joplin/blob/master/readme/blog/20180916-210431.md
<li><a href="https://joplinapp.org/spec/history/">Note History spec</a></li>
<li><a href="https://joplinapp.org/spec/sync_lock/">Sync Lock spec</a></li>
<li><a href="https://joplinapp.org/spec/plugins/">Plugin Architecture spec</a></li>
<li><a href="https://github.com/laurent22/joplin/blob/master/readme/spec/search_sorting.md">Search Sorting spec</a></li>
<li><a href="https://joplinapp.org/spec/search_sorting/">Search Sorting spec</a></li>
</ul>
</li>
<li>
@ -362,6 +389,8 @@ https://github.com/laurent22/joplin/blob/master/readme/blog/20180916-210431.md
</li>
</ul>
</div>
<div class="main">
<h1>Note properties in desktop application<a name="note-properties-in-desktop-application" href="#note-properties-in-desktop-application" class="heading-anchor">🔗</a></h1>
<p><img src="images/20180916-210431_0.png" alt=""></p>
<p>The new desktop version of Joplin for Windows, macOS and Linux features a new dialog box to view and edit the note properties, such as the updated date, created date, source URL or even location. It's a small change but it can be useful. This dialog can be accessed by clicking on the Information icon in the toolbar.</p>
@ -371,7 +400,7 @@ https://github.com/laurent22/joplin/blob/master/readme/blog/20180916-210431.md
published_at: 2018-09-16T20:04:31.000+00:00</p>
<div class="bottom-links">
<a href="https://github.com/laurent22/joplin/blob/master/readme/blog/20180916-210431.md">
<a href="https://github.com/laurent22/joplin/blob/dev/readme/blog/20180916-210431.md">
<i class="fa fa-github"></i> Improve this doc
</a>
</div>
@ -405,8 +434,10 @@ published_at: 2018-09-16T20:04:31.000+00:00</p>
ga('send', 'pageview');
</script>
</div></div>
<div class="footer">
Copyright (c) 2016-2020 Laurent Cozic
Copyright (C) 2016-2020 Laurent Cozic
</div>
</body>
</html>

View File

@ -9,7 +9,7 @@ This file was auto-generated from readme/blog/20180929-121053.md and any manual
made to it will be overwritten. To make a change to this file please modify
the source Markdown file:
https://github.com/laurent22/joplin/blob/master/readme/blog/20180929-121053.md
https://github.com/laurent22/joplin/blob/dev/readme/blog/20180929-121053.md
-->
@ -28,6 +28,15 @@ https://github.com/laurent22/joplin/blob/master/readme/blog/20180929-121053.md
background-color: #F1F1F1;
color: #333333;
}
.root {
overflow: hidden;
}
a[href^="mailto:"] {
word-break: break-all;
}
table {
margin-bottom: 1em;
}
@ -72,6 +81,7 @@ https://github.com/laurent22/joplin/blob/master/readme/blog/20180929-121053.md
background-color: #eee;
border: 1px solid #ccc;
font-size: .85em;
word-break: break-all;
}
pre code {
border: none;
@ -184,8 +194,9 @@ https://github.com/laurent22/joplin/blob/master/readme/blog/20180929-121053.md
}
.nav {
background-color: black;
display: table;
width: inherit;
display: flex;
flex-direction: row;
align-items: center;
}
.nav.sticky {
position:fixed;
@ -202,9 +213,8 @@ https://github.com/laurent22/joplin/blob/master/readme/blog/20180929-121053.md
padding-left: 2em;
margin-bottom: 0;
display: table-cell;
/* min-width: 250px; */
/* For GSoC: */
min-width: 470px;
display: flex;
width: 100%;
}
.nav ul li {
display: inline-block;
@ -215,11 +225,11 @@ https://github.com/laurent22/joplin/blob/master/readme/blog/20180929-121053.md
font-weight: bold;
}
.nav-right {
display: table-cell;
width: 100%;
display: flex;
text-align: right;
vertical-align: middle;
line-height: 0;
margin-right: 10px;
}
.nav-right .share-btn {
display: none;
@ -228,7 +238,7 @@ https://github.com/laurent22/joplin/blob/master/readme/blog/20180929-121053.md
display: none;
}
.footer {
padding-top: 1em;
padding: 2em;
border-top: 1px solid #d4d4d4;
margin-top: 2em;
color: gray;
@ -254,6 +264,23 @@ https://github.com/laurent22/joplin/blob/master/readme/blog/20180929-121053.md
opacity: 1;
}
@media (min-width: 992px) {
.content{
display: flex;
}
#toc{
display: block!important;
align-self: flex-start;
width: 300px;
position: sticky; top: 20px; left: 0;
}
.main{
width: calc(100% - 300px);
}
}
.bottom-links {
display: flex;
justify-content: center;
@ -275,7 +302,7 @@ https://github.com/laurent22/joplin/blob/master/readme/blog/20180929-121053.md
<body>
<div class="container page-20180929-121053">
<div class="container root page-20180929-121053">
<div class="header">
<a class="forkme" href="https://github.com/laurent22/joplin"><img src="https://joplinapp.org/images/ForkMe.png"/></a>
@ -341,7 +368,7 @@ https://github.com/laurent22/joplin/blob/master/readme/blog/20180929-121053.md
<li><a href="https://joplinapp.org/spec/history/">Note History spec</a></li>
<li><a href="https://joplinapp.org/spec/sync_lock/">Sync Lock spec</a></li>
<li><a href="https://joplinapp.org/spec/plugins/">Plugin Architecture spec</a></li>
<li><a href="https://github.com/laurent22/joplin/blob/master/readme/spec/search_sorting.md">Search Sorting spec</a></li>
<li><a href="https://joplinapp.org/spec/search_sorting/">Search Sorting spec</a></li>
</ul>
</li>
<li>
@ -362,6 +389,8 @@ https://github.com/laurent22/joplin/blob/master/readme/blog/20180929-121053.md
</li>
</ul>
</div>
<div class="main">
<h1>New release and many bug fixes<a name="new-release-and-many-bug-fixes" href="#new-release-and-many-bug-fixes" class="heading-anchor">🔗</a></h1>
<p>Reliability and stability is an important feature of Joplin as the application can potentially manage thousands of notes spanning many years (My oldest note, imported from another software, is from October 1999!). A stable interface without too many glitches also makes for a more pleasant user experience. For these reasons, bug fixes are always given high priority in this project, and are usually worked on before any new feature is added. The latest release for instance pretty much only contains bug fixes - eight of them, including one security fix.</p>
<p>Joplin is not bug free yet, there are still a few issues here and there, that sometimes depend on the user's hardware or configuration, and others that are hard to replicate or fix, but the app is getting there - more stable with each new release.</p>
@ -371,7 +400,7 @@ https://github.com/laurent22/joplin/blob/master/readme/blog/20180929-121053.md
published_at: 2018-09-29T11:10:53.000+00:00</p>
<div class="bottom-links">
<a href="https://github.com/laurent22/joplin/blob/master/readme/blog/20180929-121053.md">
<a href="https://github.com/laurent22/joplin/blob/dev/readme/blog/20180929-121053.md">
<i class="fa fa-github"></i> Improve this doc
</a>
</div>
@ -405,8 +434,10 @@ published_at: 2018-09-29T11:10:53.000+00:00</p>
ga('send', 'pageview');
</script>
</div></div>
<div class="footer">
Copyright (c) 2016-2020 Laurent Cozic
Copyright (C) 2016-2020 Laurent Cozic
</div>
</body>
</html>

View File

@ -9,7 +9,7 @@ This file was auto-generated from readme/blog/20181004-091123.md and any manual
made to it will be overwritten. To make a change to this file please modify
the source Markdown file:
https://github.com/laurent22/joplin/blob/master/readme/blog/20181004-091123.md
https://github.com/laurent22/joplin/blob/dev/readme/blog/20181004-091123.md
-->
@ -28,6 +28,15 @@ https://github.com/laurent22/joplin/blob/master/readme/blog/20181004-091123.md
background-color: #F1F1F1;
color: #333333;
}
.root {
overflow: hidden;
}
a[href^="mailto:"] {
word-break: break-all;
}
table {
margin-bottom: 1em;
}
@ -72,6 +81,7 @@ https://github.com/laurent22/joplin/blob/master/readme/blog/20181004-091123.md
background-color: #eee;
border: 1px solid #ccc;
font-size: .85em;
word-break: break-all;
}
pre code {
border: none;
@ -184,8 +194,9 @@ https://github.com/laurent22/joplin/blob/master/readme/blog/20181004-091123.md
}
.nav {
background-color: black;
display: table;
width: inherit;
display: flex;
flex-direction: row;
align-items: center;
}
.nav.sticky {
position:fixed;
@ -202,9 +213,8 @@ https://github.com/laurent22/joplin/blob/master/readme/blog/20181004-091123.md
padding-left: 2em;
margin-bottom: 0;
display: table-cell;
/* min-width: 250px; */
/* For GSoC: */
min-width: 470px;
display: flex;
width: 100%;
}
.nav ul li {
display: inline-block;
@ -215,11 +225,11 @@ https://github.com/laurent22/joplin/blob/master/readme/blog/20181004-091123.md
font-weight: bold;
}
.nav-right {
display: table-cell;
width: 100%;
display: flex;
text-align: right;
vertical-align: middle;
line-height: 0;
margin-right: 10px;
}
.nav-right .share-btn {
display: none;
@ -228,7 +238,7 @@ https://github.com/laurent22/joplin/blob/master/readme/blog/20181004-091123.md
display: none;
}
.footer {
padding-top: 1em;
padding: 2em;
border-top: 1px solid #d4d4d4;
margin-top: 2em;
color: gray;
@ -254,6 +264,23 @@ https://github.com/laurent22/joplin/blob/master/readme/blog/20181004-091123.md
opacity: 1;
}
@media (min-width: 992px) {
.content{
display: flex;
}
#toc{
display: block!important;
align-self: flex-start;
width: 300px;
position: sticky; top: 20px; left: 0;
}
.main{
width: calc(100% - 300px);
}
}
.bottom-links {
display: flex;
justify-content: center;
@ -275,7 +302,7 @@ https://github.com/laurent22/joplin/blob/master/readme/blog/20181004-091123.md
<body>
<div class="container page-20181004-091123">
<div class="container root page-20181004-091123">
<div class="header">
<a class="forkme" href="https://github.com/laurent22/joplin"><img src="https://joplinapp.org/images/ForkMe.png"/></a>
@ -341,7 +368,7 @@ https://github.com/laurent22/joplin/blob/master/readme/blog/20181004-091123.md
<li><a href="https://joplinapp.org/spec/history/">Note History spec</a></li>
<li><a href="https://joplinapp.org/spec/sync_lock/">Sync Lock spec</a></li>
<li><a href="https://joplinapp.org/spec/plugins/">Plugin Architecture spec</a></li>
<li><a href="https://github.com/laurent22/joplin/blob/master/readme/spec/search_sorting.md">Search Sorting spec</a></li>
<li><a href="https://joplinapp.org/spec/search_sorting/">Search Sorting spec</a></li>
</ul>
</li>
<li>
@ -362,6 +389,8 @@ https://github.com/laurent22/joplin/blob/master/readme/blog/20181004-091123.md
</li>
</ul>
</div>
<div class="main">
<h1>Joplin and Hacktobertfest 2018 🎃<a name="joplin-and-hacktobertfest-2018" href="#joplin-and-hacktobertfest-2018" class="heading-anchor">🔗</a></h1>
<p>The <a href="https://hacktoberfest.digitalocean.com/">Hacktobertfest event</a>  has started - it allows you to contribute to Joplin and, at the end of  the month, after having done 5 PR, you'll earn a limited edition  T-shirt.</p>
<p>To participate, go on <a href="https://hacktoberfest.digitalocean.com/">https://hacktoberfest.digitalocean.com/</a>  log in (with you github account) and you are ready to get in.</p>
@ -373,7 +402,7 @@ https://github.com/laurent22/joplin/blob/master/readme/blog/20181004-091123.md
published_at: 2018-10-04T08:11:23.000+00:00</p>
<div class="bottom-links">
<a href="https://github.com/laurent22/joplin/blob/master/readme/blog/20181004-091123.md">
<a href="https://github.com/laurent22/joplin/blob/dev/readme/blog/20181004-091123.md">
<i class="fa fa-github"></i> Improve this doc
</a>
</div>
@ -407,8 +436,10 @@ published_at: 2018-10-04T08:11:23.000+00:00</p>
ga('send', 'pageview');
</script>
</div></div>
<div class="footer">
Copyright (c) 2016-2020 Laurent Cozic
Copyright (C) 2016-2020 Laurent Cozic
</div>
</body>
</html>

View File

@ -9,7 +9,7 @@ This file was auto-generated from readme/blog/20181101-174335.md and any manual
made to it will be overwritten. To make a change to this file please modify
the source Markdown file:
https://github.com/laurent22/joplin/blob/master/readme/blog/20181101-174335.md
https://github.com/laurent22/joplin/blob/dev/readme/blog/20181101-174335.md
-->
@ -28,6 +28,15 @@ https://github.com/laurent22/joplin/blob/master/readme/blog/20181101-174335.md
background-color: #F1F1F1;
color: #333333;
}
.root {
overflow: hidden;
}
a[href^="mailto:"] {
word-break: break-all;
}
table {
margin-bottom: 1em;
}
@ -72,6 +81,7 @@ https://github.com/laurent22/joplin/blob/master/readme/blog/20181101-174335.md
background-color: #eee;
border: 1px solid #ccc;
font-size: .85em;
word-break: break-all;
}
pre code {
border: none;
@ -184,8 +194,9 @@ https://github.com/laurent22/joplin/blob/master/readme/blog/20181101-174335.md
}
.nav {
background-color: black;
display: table;
width: inherit;
display: flex;
flex-direction: row;
align-items: center;
}
.nav.sticky {
position:fixed;
@ -202,9 +213,8 @@ https://github.com/laurent22/joplin/blob/master/readme/blog/20181101-174335.md
padding-left: 2em;
margin-bottom: 0;
display: table-cell;
/* min-width: 250px; */
/* For GSoC: */
min-width: 470px;
display: flex;
width: 100%;
}
.nav ul li {
display: inline-block;
@ -215,11 +225,11 @@ https://github.com/laurent22/joplin/blob/master/readme/blog/20181101-174335.md
font-weight: bold;
}
.nav-right {
display: table-cell;
width: 100%;
display: flex;
text-align: right;
vertical-align: middle;
line-height: 0;
margin-right: 10px;
}
.nav-right .share-btn {
display: none;
@ -228,7 +238,7 @@ https://github.com/laurent22/joplin/blob/master/readme/blog/20181101-174335.md
display: none;
}
.footer {
padding-top: 1em;
padding: 2em;
border-top: 1px solid #d4d4d4;
margin-top: 2em;
color: gray;
@ -254,6 +264,23 @@ https://github.com/laurent22/joplin/blob/master/readme/blog/20181101-174335.md
opacity: 1;
}
@media (min-width: 992px) {
.content{
display: flex;
}
#toc{
display: block!important;
align-self: flex-start;
width: 300px;
position: sticky; top: 20px; left: 0;
}
.main{
width: calc(100% - 300px);
}
}
.bottom-links {
display: flex;
justify-content: center;
@ -275,7 +302,7 @@ https://github.com/laurent22/joplin/blob/master/readme/blog/20181101-174335.md
<body>
<div class="container page-20181101-174335">
<div class="container root page-20181101-174335">
<div class="header">
<a class="forkme" href="https://github.com/laurent22/joplin"><img src="https://joplinapp.org/images/ForkMe.png"/></a>
@ -341,7 +368,7 @@ https://github.com/laurent22/joplin/blob/master/readme/blog/20181101-174335.md
<li><a href="https://joplinapp.org/spec/history/">Note History spec</a></li>
<li><a href="https://joplinapp.org/spec/sync_lock/">Sync Lock spec</a></li>
<li><a href="https://joplinapp.org/spec/plugins/">Plugin Architecture spec</a></li>
<li><a href="https://github.com/laurent22/joplin/blob/master/readme/spec/search_sorting.md">Search Sorting spec</a></li>
<li><a href="https://joplinapp.org/spec/search_sorting/">Search Sorting spec</a></li>
</ul>
</li>
<li>
@ -362,6 +389,8 @@ https://github.com/laurent22/joplin/blob/master/readme/blog/20181101-174335.md
</li>
</ul>
</div>
<div class="main">
<h1>Hacktoberfest has now ended<a name="hacktoberfest-has-now-ended" href="#hacktoberfest-has-now-ended" class="heading-anchor">🔗</a></h1>
<p>Hacktoberfest has now ended - many thanks to all those who have contributed. Some of the pull requests are not merged yet but they will be soon. For information, this is the number of pull requests per month on the project, so there was approximately a 30% increase in October:</p>
<p>Oct - 26</p>
@ -376,7 +405,7 @@ https://github.com/laurent22/joplin/blob/master/readme/blog/20181101-174335.md
published_at: 2018-11-01T17:43:35.000+00:00</p>
<div class="bottom-links">
<a href="https://github.com/laurent22/joplin/blob/master/readme/blog/20181101-174335.md">
<a href="https://github.com/laurent22/joplin/blob/dev/readme/blog/20181101-174335.md">
<i class="fa fa-github"></i> Improve this doc
</a>
</div>
@ -410,8 +439,10 @@ published_at: 2018-11-01T17:43:35.000+00:00</p>
ga('send', 'pageview');
</script>
</div></div>
<div class="footer">
Copyright (c) 2016-2020 Laurent Cozic
Copyright (C) 2016-2020 Laurent Cozic
</div>
</body>
</html>

View File

@ -9,7 +9,7 @@ This file was auto-generated from readme/blog/20181213-173459.md and any manual
made to it will be overwritten. To make a change to this file please modify
the source Markdown file:
https://github.com/laurent22/joplin/blob/master/readme/blog/20181213-173459.md
https://github.com/laurent22/joplin/blob/dev/readme/blog/20181213-173459.md
-->
@ -28,6 +28,15 @@ https://github.com/laurent22/joplin/blob/master/readme/blog/20181213-173459.md
background-color: #F1F1F1;
color: #333333;
}
.root {
overflow: hidden;
}
a[href^="mailto:"] {
word-break: break-all;
}
table {
margin-bottom: 1em;
}
@ -72,6 +81,7 @@ https://github.com/laurent22/joplin/blob/master/readme/blog/20181213-173459.md
background-color: #eee;
border: 1px solid #ccc;
font-size: .85em;
word-break: break-all;
}
pre code {
border: none;
@ -184,8 +194,9 @@ https://github.com/laurent22/joplin/blob/master/readme/blog/20181213-173459.md
}
.nav {
background-color: black;
display: table;
width: inherit;
display: flex;
flex-direction: row;
align-items: center;
}
.nav.sticky {
position:fixed;
@ -202,9 +213,8 @@ https://github.com/laurent22/joplin/blob/master/readme/blog/20181213-173459.md
padding-left: 2em;
margin-bottom: 0;
display: table-cell;
/* min-width: 250px; */
/* For GSoC: */
min-width: 470px;
display: flex;
width: 100%;
}
.nav ul li {
display: inline-block;
@ -215,11 +225,11 @@ https://github.com/laurent22/joplin/blob/master/readme/blog/20181213-173459.md
font-weight: bold;
}
.nav-right {
display: table-cell;
width: 100%;
display: flex;
text-align: right;
vertical-align: middle;
line-height: 0;
margin-right: 10px;
}
.nav-right .share-btn {
display: none;
@ -228,7 +238,7 @@ https://github.com/laurent22/joplin/blob/master/readme/blog/20181213-173459.md
display: none;
}
.footer {
padding-top: 1em;
padding: 2em;
border-top: 1px solid #d4d4d4;
margin-top: 2em;
color: gray;
@ -254,6 +264,23 @@ https://github.com/laurent22/joplin/blob/master/readme/blog/20181213-173459.md
opacity: 1;
}
@media (min-width: 992px) {
.content{
display: flex;
}
#toc{
display: block!important;
align-self: flex-start;
width: 300px;
position: sticky; top: 20px; left: 0;
}
.main{
width: calc(100% - 300px);
}
}
.bottom-links {
display: flex;
justify-content: center;
@ -275,7 +302,7 @@ https://github.com/laurent22/joplin/blob/master/readme/blog/20181213-173459.md
<body>
<div class="container page-20181213-173459">
<div class="container root page-20181213-173459">
<div class="header">
<a class="forkme" href="https://github.com/laurent22/joplin"><img src="https://joplinapp.org/images/ForkMe.png"/></a>
@ -341,7 +368,7 @@ https://github.com/laurent22/joplin/blob/master/readme/blog/20181213-173459.md
<li><a href="https://joplinapp.org/spec/history/">Note History spec</a></li>
<li><a href="https://joplinapp.org/spec/sync_lock/">Sync Lock spec</a></li>
<li><a href="https://joplinapp.org/spec/plugins/">Plugin Architecture spec</a></li>
<li><a href="https://github.com/laurent22/joplin/blob/master/readme/spec/search_sorting.md">Search Sorting spec</a></li>
<li><a href="https://joplinapp.org/spec/search_sorting/">Search Sorting spec</a></li>
</ul>
</li>
<li>
@ -362,6 +389,8 @@ https://github.com/laurent22/joplin/blob/master/readme/blog/20181213-173459.md
</li>
</ul>
</div>
<div class="main">
<h1>Joplin is now featured on <a href="http://PrivacyTools.io">PrivacyTools.io</a><a name="joplin-is-now-featured-on-privacytools-io" href="#joplin-is-now-featured-on-privacytools-io" class="heading-anchor">🔗</a></h1>
<p>Joplin is now <a href="https://www.privacytools.io/#notebook">featured on PrivacyTools.io</a>, a site dedicated to providing knowledge and tools to protect people's privacy against global mass surveillance. The app was kindly submitted by <a href="https://github.com/privacytoolsIO/privacytools.io/pull/659">Mats Estensen on GitHub</a> and accepted soon after.</p>
<p>Since day one the Joplin project has indeed been concerned with privacy - offering End To End Encryption and supporting open standards, including WebDAV for synchronisation. Setting up Joplin synchronisation can be more complicated than other existing note applications, but the advantage is that once it is done you 100% own the data and even the infrastructure if you use Nextcloud on your own server.</p>
@ -374,7 +403,7 @@ https://github.com/laurent22/joplin/blob/master/readme/blog/20181213-173459.md
published_at: 2018-12-13T17:34:59.000+00:00</p>
<div class="bottom-links">
<a href="https://github.com/laurent22/joplin/blob/master/readme/blog/20181213-173459.md">
<a href="https://github.com/laurent22/joplin/blob/dev/readme/blog/20181213-173459.md">
<i class="fa fa-github"></i> Improve this doc
</a>
</div>
@ -408,8 +437,10 @@ published_at: 2018-12-13T17:34:59.000+00:00</p>
ga('send', 'pageview');
</script>
</div></div>
<div class="footer">
Copyright (c) 2016-2020 Laurent Cozic
Copyright (C) 2016-2020 Laurent Cozic
</div>
</body>
</html>

View File

@ -9,7 +9,7 @@ This file was auto-generated from readme/blog/20190130-230218.md and any manual
made to it will be overwritten. To make a change to this file please modify
the source Markdown file:
https://github.com/laurent22/joplin/blob/master/readme/blog/20190130-230218.md
https://github.com/laurent22/joplin/blob/dev/readme/blog/20190130-230218.md
-->
@ -28,6 +28,15 @@ https://github.com/laurent22/joplin/blob/master/readme/blog/20190130-230218.md
background-color: #F1F1F1;
color: #333333;
}
.root {
overflow: hidden;
}
a[href^="mailto:"] {
word-break: break-all;
}
table {
margin-bottom: 1em;
}
@ -72,6 +81,7 @@ https://github.com/laurent22/joplin/blob/master/readme/blog/20190130-230218.md
background-color: #eee;
border: 1px solid #ccc;
font-size: .85em;
word-break: break-all;
}
pre code {
border: none;
@ -184,8 +194,9 @@ https://github.com/laurent22/joplin/blob/master/readme/blog/20190130-230218.md
}
.nav {
background-color: black;
display: table;
width: inherit;
display: flex;
flex-direction: row;
align-items: center;
}
.nav.sticky {
position:fixed;
@ -202,9 +213,8 @@ https://github.com/laurent22/joplin/blob/master/readme/blog/20190130-230218.md
padding-left: 2em;
margin-bottom: 0;
display: table-cell;
/* min-width: 250px; */
/* For GSoC: */
min-width: 470px;
display: flex;
width: 100%;
}
.nav ul li {
display: inline-block;
@ -215,11 +225,11 @@ https://github.com/laurent22/joplin/blob/master/readme/blog/20190130-230218.md
font-weight: bold;
}
.nav-right {
display: table-cell;
width: 100%;
display: flex;
text-align: right;
vertical-align: middle;
line-height: 0;
margin-right: 10px;
}
.nav-right .share-btn {
display: none;
@ -228,7 +238,7 @@ https://github.com/laurent22/joplin/blob/master/readme/blog/20190130-230218.md
display: none;
}
.footer {
padding-top: 1em;
padding: 2em;
border-top: 1px solid #d4d4d4;
margin-top: 2em;
color: gray;
@ -254,6 +264,23 @@ https://github.com/laurent22/joplin/blob/master/readme/blog/20190130-230218.md
opacity: 1;
}
@media (min-width: 992px) {
.content{
display: flex;
}
#toc{
display: block!important;
align-self: flex-start;
width: 300px;
position: sticky; top: 20px; left: 0;
}
.main{
width: calc(100% - 300px);
}
}
.bottom-links {
display: flex;
justify-content: center;
@ -275,7 +302,7 @@ https://github.com/laurent22/joplin/blob/master/readme/blog/20190130-230218.md
<body>
<div class="container page-20190130-230218">
<div class="container root page-20190130-230218">
<div class="header">
<a class="forkme" href="https://github.com/laurent22/joplin"><img src="https://joplinapp.org/images/ForkMe.png"/></a>
@ -341,7 +368,7 @@ https://github.com/laurent22/joplin/blob/master/readme/blog/20190130-230218.md
<li><a href="https://joplinapp.org/spec/history/">Note History spec</a></li>
<li><a href="https://joplinapp.org/spec/sync_lock/">Sync Lock spec</a></li>
<li><a href="https://joplinapp.org/spec/plugins/">Plugin Architecture spec</a></li>
<li><a href="https://github.com/laurent22/joplin/blob/master/readme/spec/search_sorting.md">Search Sorting spec</a></li>
<li><a href="https://joplinapp.org/spec/search_sorting/">Search Sorting spec</a></li>
</ul>
</li>
<li>
@ -362,6 +389,8 @@ https://github.com/laurent22/joplin/blob/master/readme/blog/20190130-230218.md
</li>
</ul>
</div>
<div class="main">
<h1>New search engine in Joplin<a name="new-search-engine-in-joplin" href="#new-search-engine-in-joplin" class="heading-anchor">🔗</a></h1>
<p>The original search engine in Joplin was pretty limited - it would search for your exact query and that is it. For example if you search for &quot;recipe cake&quot; it would return results that contain exactly this word in this order and nothing else - it would not return &quot;apple cake recipe&quot; or &quot;recipe for birthday cake&quot;, thus forcing you to try various queries.</p>
<p>The last versions of Joplin include a new search engine that provides much better results, and also allow better specifying search queries.</p>
@ -374,7 +403,7 @@ https://github.com/laurent22/joplin/blob/master/readme/blog/20190130-230218.md
published_at: 2019-01-30T23:02:18.000+00:00</p>
<div class="bottom-links">
<a href="https://github.com/laurent22/joplin/blob/master/readme/blog/20190130-230218.md">
<a href="https://github.com/laurent22/joplin/blob/dev/readme/blog/20190130-230218.md">
<i class="fa fa-github"></i> Improve this doc
</a>
</div>
@ -408,8 +437,10 @@ published_at: 2019-01-30T23:02:18.000+00:00</p>
ga('send', 'pageview');
</script>
</div></div>
<div class="footer">
Copyright (c) 2016-2020 Laurent Cozic
Copyright (C) 2016-2020 Laurent Cozic
</div>
</body>
</html>

Some files were not shown because too many files have changed in this diff Show More