From d9e93cd6c477334ea403d650d5243ce4a6f8028f Mon Sep 17 00:00:00 2001 From: Laurent Cozic Date: Wed, 21 Oct 2020 01:46:53 +0100 Subject: [PATCH] Doc: Update plugin doc --- .../lib/services/plugins/api/JoplinCommands.ts | 6 +++--- ReactNativeClient/lib/services/plugins/api/types.ts | 4 +--- .../api/references/plugin_api/classes/joplincommands.html | 8 +++++--- docs/api/references/plugin_api/interfaces/command.html | 3 +-- 4 files changed, 10 insertions(+), 11 deletions(-) diff --git a/ReactNativeClient/lib/services/plugins/api/JoplinCommands.ts b/ReactNativeClient/lib/services/plugins/api/JoplinCommands.ts index af927020b7..84c98242a3 100644 --- a/ReactNativeClient/lib/services/plugins/api/JoplinCommands.ts +++ b/ReactNativeClient/lib/services/plugins/api/JoplinCommands.ts @@ -12,9 +12,9 @@ import { Command } from './types'; * 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 + * * [Main screen commands](https://github.com/laurent22/joplin/tree/dev/ElectronClient/gui/MainScreen/commands) + * * [Global commands](https://github.com/laurent22/joplin/tree/dev/ElectronClient/commands) + * * [Editor 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. */ diff --git a/ReactNativeClient/lib/services/plugins/api/types.ts b/ReactNativeClient/lib/services/plugins/api/types.ts index a0636920c1..a641b7f156 100644 --- a/ReactNativeClient/lib/services/plugins/api/types.ts +++ b/ReactNativeClient/lib/services/plugins/api/types.ts @@ -40,9 +40,7 @@ export interface Command { * Or | \|\| | "noteIsTodo \|\| noteTodoCompleted" * And | && | "oneNoteSelected && !inConflictFolder" * - * Currently the supported context variables aren't documented, but you can find the list there: - * - * https://github.com/laurent22/joplin/blob/dev/ReactNativeClient/lib/services/commands/stateToWhenClauseContext.ts + * Currently the supported context variables aren't documented, but you can [find the list here](https://github.com/laurent22/joplin/blob/dev/ReactNativeClient/lib/services/commands/stateToWhenClauseContext.ts). * * Note: Commands are enabled by default unless you use this property. */ diff --git a/docs/api/references/plugin_api/classes/joplincommands.html b/docs/api/references/plugin_api/classes/joplincommands.html index 52ae0b4e4a..87bb53d744 100644 --- a/docs/api/references/plugin_api/classes/joplincommands.html +++ b/docs/api/references/plugin_api/classes/joplincommands.html @@ -76,9 +76,11 @@

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.

diff --git a/docs/api/references/plugin_api/interfaces/command.html b/docs/api/references/plugin_api/interfaces/command.html index 5b0de323fa..de6173d9c5 100644 --- a/docs/api/references/plugin_api/interfaces/command.html +++ b/docs/api/references/plugin_api/interfaces/command.html @@ -142,8 +142,7 @@ "oneNoteSelected && !inConflictFolder" -

Currently the supported context variables aren't documented, but you can find the list there:

-

https://github.com/laurent22/joplin/blob/dev/ReactNativeClient/lib/services/commands/stateToWhenClauseContext.ts

+

Currently the supported context variables aren't documented, but you can find the list here.

Note: Commands are enabled by default unless you use this property.