|
1 |
| -# Note extensions |
| 1 | +# Joplin Note Extensions |
2 | 2 |
|
3 |
| -_note-extensions_ is a plugin to extend the UX and UI of [Joplin](https://joplinapp.org/)'s desktop application. |
| 3 | +_joplin-note-ext_ is a plugin to extend the UX [Joplin](https://joplinapp.org/)'s desktop application. |
4 | 4 |
|
5 |
| -It provides a collection of [commands](#commands) and [UI enhancements](#ui-enhancements) for working with notes and to-dos. |
| 5 | +It provides a collection of [new commands](#new-commands) and adapts some [existing commands](#mapped-commands) to enhance working with notes and to-dos. |
6 | 6 |
|
7 | 7 | > **NOTE** - This plugin requires at least Joplin v1.3.9!
|
8 | 8 |
|
9 | 9 | ## Table of contents
|
10 | 10 |
|
11 |
| -* [Features](#features) |
12 |
| - * [Commands](#commands) |
13 |
| - * [UI enhancements](#ui-enhancements) |
14 |
| - * [User options](#user-options) |
15 |
| -* [Installation](#installation) |
16 |
| -* [UI tweaks](#ui-tweaks) |
17 |
| -* [Support](#support) |
18 |
| -* [License](#license) |
| 11 | +- [Features](#features) |
| 12 | +- [New commands](#commands) |
| 13 | +- [Mapped commands](#mapped-commands) |
| 14 | +- [User options](#user-options) |
| 15 | +- [Installation](#installation) |
| 16 | +- [Uninstallation](#uninstallation) |
| 17 | +- [UI tweaks](#ui-tweaks) |
| 18 | +- [Support](#support) |
| 19 | +- [Changes](#changes) |
| 20 | +- [License](#license) |
19 | 21 |
|
20 | 22 | ## Features
|
21 | 23 |
|
22 |
| -### Commands |
| 24 | +TODO |
23 | 25 |
|
24 |
| -> TODO - describe new commands (if available). For example: |
| 26 | +- new commands |
| 27 | +- mapped commands |
| 28 | +- new commands user options |
25 | 29 |
|
26 |
| -- Add new Note (`addNewNote`) |
27 |
| - - Adds a new note to the list |
| 30 | +## New Commands |
28 | 31 |
|
29 |
| -### UI enhancements |
| 32 | +> **NOTE** - Default keyboard shortcuts can be changed in user options. |
| 33 | +> Navigate to `Tools > Options > Keyboard Shortcuts` and search for the command label to be changed. |
30 | 34 |
|
31 |
| -> TODO - describe additions to the UI (with images, if available)\ |
32 |
| -> New panels, views, dialogs, ... in sub-chapters |
| 35 | +### Toggle to-do state |
33 | 36 |
|
34 |
| -- Adds context menu entry: `Add new Note` |
| 37 | +| Command | Command ID | Default Key | |
| 38 | +| ----------------- | ----------------- | ----------------------- | |
| 39 | +| Touch to-do state | `toggleTodoState` | `CmdOrCtrl+Shift+Space` | |
35 | 40 |
|
36 |
| -To get the best result, check out the [UI tweaks](#ui-tweaks). |
| 41 | +TODO describe more detailed... |
37 | 42 |
|
38 |
| -### User options |
| 43 | +### Touch note |
39 | 44 |
|
40 |
| -> TODO - describe added User options (if available) |
| 45 | +| Command | Command ID | Default Key | |
| 46 | +| ---------- | ----------- | ----------- | |
| 47 | +| Touch note | `touchNote` | - | |
41 | 48 |
|
42 |
| -## Installation |
| 49 | +TODO describe more detailed... |
| 50 | + |
| 51 | +### Set URL |
| 52 | + |
| 53 | +| Command | Command ID | Default Key | |
| 54 | +| ------- | ---------- | ----------- | |
| 55 | +| Set URL | `editURL` | - | |
| 56 | + |
| 57 | +TODO describe more detailed... |
| 58 | + |
| 59 | +### Move notes |
| 60 | + |
| 61 | +| Command | Command ID | Default Key | |
| 62 | +| ------------------- | ------------------ | ---------------------- | |
| 63 | +| Move note to top | `moveNoteToTop` | `CmdOrCtrl+Alt+Up` | |
| 64 | +| Move note up | `moveNoteUp` | `CmdOrCtrl+Shift+Up` | |
| 65 | +| Move note down | `moveNoteDown` | `CmdOrCtrl+Shift+Down` | |
| 66 | +| Move note to bottom | `moveNoteToBottom` | `CmdOrCtrl+Alt+Down` | |
| 67 | + |
| 68 | +TODO describe more detailed... |
| 69 | + |
| 70 | +> **NOTE** TODO works only in custom order mode |
43 | 71 |
|
44 |
| -> TODO - steps to install the plugin |
| 72 | +## Mapped commands |
45 | 73 |
|
46 |
| -## UI tweaks |
| 74 | +## User options |
47 | 75 |
|
48 |
| -> TODO - describe how to change `webview.css` or `userchrome.css` (if available) |
| 76 | +This plugin adds the following user options which can be accessed via `Tools > Options > Note Extensions`. |
49 | 77 |
|
50 |
| -### General styles |
| 78 | +> **NOTE** - TODO changing requires restart |
51 | 79 |
|
52 |
| -E.g. to not show something which is displayed elsewhere via the new plugin). |
| 80 | +- Show [Toggle to-do state](#toggle-to-do-state) button on note toolbar:\ |
| 81 | + _Select whether an button for the command shall be shown on the note toolbar (next to note title) or not_ |
| 82 | + |
| 83 | +> TODO - Add user options here... |
| 84 | +
|
| 85 | +### UI enhancements |
| 86 | + |
| 87 | +This plugin adds the following elements to the UI. |
| 88 | + |
| 89 | +To get the best result, check out the [UI tweaks](#ui-tweaks) also. |
| 90 | + |
| 91 | +> TODO - describe additions to the UI (with screenshots, if available) |
| 92 | +> New panels, views, dialogs, ... in sub-chapters |
| 93 | +> Otherwise remove chapters |
| 94 | +
|
| 95 | +## Installation |
53 | 96 |
|
54 |
| -### Rendered Markdown |
| 97 | +> TODO - Add steps to install the plugin here... |
55 | 98 |
|
| 99 | +## Uninstallation |
56 | 100 |
|
| 101 | +> TODO - Add steps to uninstall the plugin here... |
57 | 102 |
|
58 | 103 | ## Support
|
59 | 104 |
|
60 |
| -If you need help or found a bug, open an issue on [GitHub](https://github.com/benji300-joplin-extensions/note-extensions/issues). |
| 105 | +If you need help or found a bug, open an issue on [GitHub](https://github.com/benji300/joplin-note-ext/issues). |
61 | 106 |
|
62 | 107 | ## Changes
|
63 | 108 |
|
|
0 commit comments