mirror of
https://github.com/Jermolene/TiddlyWiki5
synced 2024-11-18 07:44:51 +00:00
8af7054efa
* Doc restructuring Plugin Install using core Libraries and with Node.js * fixing typos and concerns raised by Jeremy
56 lines
2.3 KiB
Plaintext
56 lines
2.3 KiB
Plaintext
created: 20161015113519246
|
|
modified: 20220613123551803
|
|
tags: PluginMechanism
|
|
title: PluginFolders
|
|
type: text/vnd.tiddlywiki
|
|
|
|
! Working with Plugin Folders
|
|
|
|
* Arrange the [[PluginFolders]] containing the plugins in a convenient shared location
|
|
|
|
* Use [[environment variables|Environment Variables on Node.js]] to tell TiddlyWiki to search those folders.
|
|
|
|
*The plugins can be referenced in `tiddlywiki.info` by their name (e.g. `tiddlytools/magic`)
|
|
|
|
* Place the PluginFolders containing the plugins in a `plugins` folder within the [[wiki folder|TiddlyWikiFolders]]. TiddlyWiki will attempt to include every subfolder as a plugin. Do not add the plugin names to `tiddlywiki.info`. Do not add the PluginFolders under a specific namespace:
|
|
|
|
```
|
|
├── plugins/
|
|
│ ├── relink/
|
|
│ │ ├── js/
|
|
│ │ ├── tiddlers/
|
|
│ │ └── plugin.info
|
|
│ └── relink-markdown/
|
|
│ ├── js/
|
|
│ ├── plugin.info
|
|
│ └── readme.tid
|
|
├── tiddlers/
|
|
└── tiddlywiki.info
|
|
```
|
|
|
|
! Plugin.info File
|
|
|
|
On the server, plugins can be stored as ordinary JSON tiddlers but it is often more convenient to store them as separate tiddler files within folders. Plugin folders must contain a `plugin.info` file that contains the metadata for the plugin. It can also optionally identify files external to the plugin folder that should be loaded as tiddlers.
|
|
|
|
The `plugin.info` file should contain the following JSON structure:
|
|
|
|
The JSON structure for plugin tiddlers is as follows:
|
|
|
|
```
|
|
{
|
|
"title": "$:/plugins/publisher/name",
|
|
"name": "name",
|
|
"description": "An exemplary plugin for demonstration purposes",
|
|
"author": "JeremyRuston",
|
|
"version": "1.2.3-alpha3",
|
|
"core-version": ">=5.0.0",
|
|
"source": "https://tiddlywiki.com/MyPlugin",
|
|
"plugin-type": "plugin",
|
|
"list": "readme license history"
|
|
}
|
|
```
|
|
|
|
By convention, the titles of the individual tiddlers are prefixed with the title of the containing plugin, but they are not restricted to do so.
|
|
|
|
Note that if the `version` field is omitted from a `plugin.info` file when the plugin folder is packed then it is automatically filled in by the core to the current core version number. This is to ensure that all the core plugins carry the correct version number. Generally plugin authors will want to ensure that they do explicitly specify a version number.
|