1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
|
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
|
#### Other fields
Some examples of other `key:` names one could use.
| **References**|
| `url:` | `http://fossil.example.org/wiki/plugin` <br> Usually just used for the main script, as project homepage link. |
| `doc:` | `http://doc.example.org/` <br> link to manual |
| `api-docs:` | `http://doc.example.org/` <br> link to manual |
| `src:` | `http://stackoverflow.com/questions/*` <br> Code origin reference |
| **Menu / Icons** |
| `icon:` | `fire.png` <br> Could be relative file reference, or some application-level fixed icons/ dir. |
| `png:` | `iVBORw0KGgoAAAANSUhEUgAAABQAAAAPCAY…` <br> base64 embedded icon (as used in streamtuner2) |
| `img:` | Either embedded or file reference / just an alias |
| `hidden:` | e.g. hide plugin entry from main menu |
| `keycode:` | `Alt+F4` <br> Keycombinations for GUI apps |
| `key:` | `cp│copy` <br> Regex aliases for CLI interfaces |
| **Plugin management** |
| `sort:` | `-100` <br> Ordering for plugin loading, if they're instantiated on startup but some are pre-dependencies. |
| `priority:` | `core` <br> How essentional is this plugin (`core`, `default`, `optional`, `contrib`, `obsolete`). Can be utiized for grouping plugins in admin UI. |
| `support:` | `none` <br> Indicate if plugin is actively supported, or unmainted contrib/ |
Coincidentally, the format syntax overlaps and jives well with other e.g.
Python tool use:
| **Tooling overlap** |
| `format:` | black formatter option |
| `pylint:` | flags |
| **Packaging** |
| `classifiers:` | trove |
| `console-scripts:` | setup.py/flit wrapper |
| `suggests:` | softer dependencies |
| `pack:` | fpm/xpm relative file references/renames/target |
| `architecture:` | fpm/xpm |
|