self-hosted/joplin
1
0
Fork 0
mirror of https://github.com/laurent22/joplin.git synced 2024-12-24 10:27:10 +02:00
Code Issues Releases Activity

Doc: Fixed plugin demo links

Browse Source
This commit is contained in:
Laurent Cozic 2020-10-09 22:00:03 +01:00
parent a0de8582e6
commit b326ffc41c
20 changed files with 20 additions and 20 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
ReactNativeClient/lib/services/plugins/api/JoplinCommands.ts
View File

@ -5,7 +5,7 @@ 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/CliClient/tests/support/plugins/register_command)
* [View the demo plugin](https://github.com/laurent22/joplin/tree/dev/CliClient/tests/support/plugins/register_command)
*
* ## Executing Joplin's internal commands
*

2
ReactNativeClient/lib/services/plugins/api/JoplinData.ts
View File

@ -8,7 +8,7 @@ import { Path } from './types';
*
* This is also what you would use to search notes, via the `search` endpoint.
*
* [View the demo plugin](https://github.com/laurent22/joplin/CliClient/tests/support/plugins/simple)
* [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:

2
ReactNativeClient/lib/services/plugins/api/JoplinInterop.ts
View File

@ -5,7 +5,7 @@ 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/CliClient/tests/support/plugins/json_export)
* [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.

2
ReactNativeClient/lib/services/plugins/api/JoplinSettings.ts
View File

@ -9,7 +9,7 @@ import { SettingItem, SettingSection } from './types';
*
* 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/CliClient/tests/support/plugins/settings)
* [View the demo plugin](https://github.com/laurent22/joplin/tree/dev/CliClient/tests/support/plugins/settings)
*/
export default class JoplinSettings {
private plugin_:Plugin = null;

2
ReactNativeClient/lib/services/plugins/api/JoplinViewsDialogs.ts
View File

@ -8,7 +8,7 @@ import { ButtonSpec, ViewHandle, ButtonId } from './types';
* 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/CliClient/tests/support/plugins/dialog)
* [View the demo plugin](https://github.com/laurent22/joplin/tree/dev/CliClient/tests/support/plugins/dialog)
*/
export default class JoplinViewsDialogs {

2
ReactNativeClient/lib/services/plugins/api/JoplinViewsMenuItems.ts
View File

@ -7,7 +7,7 @@ import createViewHandle from '../utils/createViewHandle';
/**
* Allows creating and managing menu items.
*
* [View the demo plugin](https://github.com/laurent22/joplin/CliClient/tests/support/plugins/register_command)
* [View the demo plugin](https://github.com/laurent22/joplin/tree/dev/CliClient/tests/support/plugins/register_command)
*/
export default class JoplinViewsMenuItems {

2
ReactNativeClient/lib/services/plugins/api/JoplinViewsPanels.ts
View File

@ -7,7 +7,7 @@ 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/CliClient/tests/support/plugins/toc)
* [View the demo plugin](https://github.com/laurent22/joplin/tree/dev/CliClient/tests/support/plugins/toc)
*/
export default class JoplinViewsPanels {

2
ReactNativeClient/lib/services/plugins/api/JoplinViewsToolbarButtons.ts
View File

@ -6,7 +6,7 @@ import createViewHandle from '../utils/createViewHandle';
/**
* Allows creating and managing toolbar buttons.
*
* [View the demo plugin](https://github.com/laurent22/joplin/CliClient/tests/support/plugins/register_command)
* [View the demo plugin](https://github.com/laurent22/joplin/tree/dev/CliClient/tests/support/plugins/register_command)
*/
export default class JoplinViewsToolbarButtons {

2
ReactNativeClient/lib/services/plugins/api/JoplinWorkspace.ts
View File

@ -9,7 +9,7 @@ const Note = require('lib/models/Note');
* 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/CliClient/tests/support/plugins)
* [View the demo plugin](https://github.com/laurent22/joplin/tree/dev/CliClient/tests/support/plugins)
*/
export default class JoplinWorkspace {
// TODO: unregister events when plugin is closed or disabled

2
ReactNativeClient/lib/services/plugins/api/types.ts
View File

@ -26,7 +26,7 @@ export enum ImportModuleOutputFormat {
}
/**
* Used to implement a module to export data from Joplin. [View the demo plugin](https://github.com/laurent22/joplin/CliClient/tests/support/plugins/json_export) for an example.
* 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.
*

2
docs/api/references/plugin_api/classes/joplincommands.html
View File

@ -70,7 +70,7 @@
<p>This class allows executing or registering new Joplin commands. Commands can be executed or associated with
<a href="joplinviewstoolbarbuttons.html">toolbar buttons</a> or <a href="joplinviewsmenuitems.html">menu items</a>.</p>
</div>
<p><a href="https://github.com/laurent22/joplin/CliClient/tests/support/plugins/register_command">View the demo plugin</a></p>
<p><a href="https://github.com/laurent22/joplin/tree/dev/CliClient/tests/support/plugins/register_command">View the demo plugin</a></p>
<a href="#executing-joplin39s-internal-commands" id="executing-joplin39s-internal-commands" style="color: inherit; text-decoration: none;">
<h2>Executing Joplin&#39;s internal commands</h2>
</a>

2
docs/api/references/plugin_api/classes/joplindata.html
View File

@ -72,7 +72,7 @@
or to update them or delete them.</p>
</div>
<p>This is also what you would use to search notes, via the <code>search</code> endpoint.</p>
<p><a href="https://github.com/laurent22/joplin/CliClient/tests/support/plugins/simple">View the demo plugin</a></p>
<p><a href="https://github.com/laurent22/joplin/tree/dev/CliClient/tests/support/plugins/simple">View the demo plugin</a></p>
<p>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:</p>
<ul>

2
docs/api/references/plugin_api/classes/joplininterop.html
View File

@ -69,7 +69,7 @@
<div class="lead">
<p>Provides a way to create modules to import external data into Joplin or to export notes into any arbitrary format.</p>
</div>
<p><a href="https://github.com/laurent22/joplin/CliClient/tests/support/plugins/json_export">View the demo plugin</a></p>
<p><a href="https://github.com/laurent22/joplin/tree/dev/CliClient/tests/support/plugins/json_export">View the demo plugin</a></p>
<p>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.</p>
<p>See the documentation of the <a href="../interfaces/exportmodule.html">ExportModule</a> and <a href="../interfaces/importmodule.html">ImportModule</a> for more information.</p>

2
docs/api/references/plugin_api/classes/joplinsettings.html
View File

@ -71,7 +71,7 @@
</div>
<p>Settings are essentially key/value pairs.</p>
<p>Note: Currently this API does <strong>not</strong> provide access to Joplin&#39;s built-in settings. This is by design as plugins that modify user settings could give unexpected results</p>
<p><a href="https://github.com/laurent22/joplin/CliClient/tests/support/plugins/settings">View the demo plugin</a></p>
<p><a href="https://github.com/laurent22/joplin/tree/dev/CliClient/tests/support/plugins/settings">View the demo plugin</a></p>
</div>
</section>
<!--

2
docs/api/references/plugin_api/classes/joplinviewsdialogs.html
View File

@ -71,7 +71,7 @@
Dialogs are hidden by default and you need to call <code>open()</code> to open them. Once the user clicks on a button, the <code>open</code> call will return and provide the button ID that was
clicked on. There is currently no &quot;close&quot; method since the dialog should be thought as a modal one and thus can only be closed by clicking on one of the buttons.</p>
</div>
<p><a href="https://github.com/laurent22/joplin/CliClient/tests/support/plugins/dialog">View the demo plugin</a></p>
<p><a href="https://github.com/laurent22/joplin/tree/dev/CliClient/tests/support/plugins/dialog">View the demo plugin</a></p>
</div>
</section>
<!--

2
docs/api/references/plugin_api/classes/joplinviewsmenuitems.html
View File

@ -69,7 +69,7 @@
<div class="lead">
<p>Allows creating and managing menu items.</p>
</div>
<p><a href="https://github.com/laurent22/joplin/CliClient/tests/support/plugins/register_command">View the demo plugin</a></p>
<p><a href="https://github.com/laurent22/joplin/tree/dev/CliClient/tests/support/plugins/register_command">View the demo plugin</a></p>
</div>
</section>
<!--

2
docs/api/references/plugin_api/classes/joplinviewspanels.html
View File

@ -70,7 +70,7 @@
<p>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.</p>
</div>
<p><a href="https://github.com/laurent22/joplin/CliClient/tests/support/plugins/toc">View the demo plugin</a></p>
<p><a href="https://github.com/laurent22/joplin/tree/dev/CliClient/tests/support/plugins/toc">View the demo plugin</a></p>
</div>
</section>
<!--

2
docs/api/references/plugin_api/classes/joplinviewstoolbarbuttons.html
View File

@ -69,7 +69,7 @@
<div class="lead">
<p>Allows creating and managing toolbar buttons.</p>
</div>
<p><a href="https://github.com/laurent22/joplin/CliClient/tests/support/plugins/register_command">View the demo plugin</a></p>
<p><a href="https://github.com/laurent22/joplin/tree/dev/CliClient/tests/support/plugins/register_command">View the demo plugin</a></p>
</div>
</section>
<!--

2
docs/api/references/plugin_api/classes/joplinworkspace.html
View File

@ -70,7 +70,7 @@
<p>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.</p>
</div>
<p><a href="https://github.com/laurent22/joplin/CliClient/tests/support/plugins">View the demo plugin</a></p>
<p><a href="https://github.com/laurent22/joplin/tree/dev/CliClient/tests/support/plugins">View the demo plugin</a></p>
</div>
</section>
<!--

2
docs/api/references/plugin_api/interfaces/exportmodule.html
View File

@ -67,7 +67,7 @@
<section class="tsd-panel tsd-comment">
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Used to implement a module to export data from Joplin. <a href="https://github.com/laurent22/joplin/CliClient/tests/support/plugins/json_export">View the demo plugin</a> for an example.</p>
<p>Used to implement a module to export data from Joplin. <a href="https://github.com/laurent22/joplin/tree/dev/CliClient/tests/support/plugins/json_export">View the demo plugin</a> for an example.</p>
</div>
<p>In general, all the event handlers you&#39;ll need to implement take a <code>context</code> 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.</p>
<p>To get a better sense of what it will contain it can be useful to print it using <code>console.info(context)</code>.</p>