TiddlyWiki5/editions/tw5.com/tiddlers/mechanisms/PluginMechanism.tid

created: 20130826122000000
modified: 20161015122959346
tags: Mechanisms
title: PluginMechanism
type: text/vnd.tiddlywiki

! Introduction

[[Plugins]] are bundles of tiddlers that are distributed and managed as a single unit by being packed into a single JSON tiddler. Users can install them with drag and drop, or using the [[plugin library|Installing a plugin from the plugin library]].

The tiddlers within registered plugins behave as ShadowTiddlers: they can be freely overwritten by creating a tiddler with the same title, but deleting that tiddler restores the underlying tiddler value from the plugin.

Plugins have a `plugin-type` field that may take the following values:

* `plugin` //(default)// - a plain plugin
* `theme` - a theme plugin (see ThemeMechanism)
* `language` - for translations only

Plugins can be used to package ordinary content, or can include JavaScript [[modules|Modules]] that extend and enhance the core TiddlyWiki5 functionality.

Plugins conventionally have a title of the form `$:/plugins/publisher/name`. Plugins that are part of the core TiddlyWiki distribution have titles of the form `$:/plugins/tiddlywiki/name`.

When [[running TiddlyWiki under Node.js|TiddlyWiki on Node.js]], plugins can also be stored as individual tiddler files in [[PluginFolders]].

! More information

<<list-links "[tag[PluginMechanism]]">>
Adjusted plugin encoding so that the JSON text no longer duplicates the fields 2013-12-14 09:46:02 +00:00			`created: 20130826122000000`
Improve support for bulk loading tiddlers under Node.js Fixes #2610 2016-10-15 15:21:51 +00:00			`modified: 20161015122959346`
Add mechanisms to the reference docs 2014-09-11 19:12:25 +00:00			`tags: Mechanisms`
Ensure that the core plugins inherit their version number from the main `package.info` 2013-08-26 12:28:23 +00:00			`title: PluginMechanism`
Adjusted plugin encoding so that the JSON text no longer duplicates the fields 2013-12-14 09:46:02 +00:00			`type: text/vnd.tiddlywiki`
Initial tranche of the plugin implementation This first commit adds some of the code needed for the plugin mechanism, but it isn't all fully operational yet. I'm merging the branch so that I can get some other pre-requisites done quickly on the main branch, and then plan to return to this branch. 2012-08-06 21:34:16 +00:00
Improve support for bulk loading tiddlers under Node.js Fixes #2610 2016-10-15 15:21:51 +00:00			`! Introduction`
Initial tranche of the plugin implementation This first commit adds some of the code needed for the plugin mechanism, but it isn't all fully operational yet. I'm merging the branch so that I can get some other pre-requisites done quickly on the main branch, and then plan to return to this branch. 2012-08-06 21:34:16 +00:00
Improve support for bulk loading tiddlers under Node.js Fixes #2610 2016-10-15 15:21:51 +00:00			`[[Plugins]] are bundles of tiddlers that are distributed and managed as a single unit by being packed into a single JSON tiddler. Users can install them with drag and drop, or using the [[plugin library\|Installing a plugin from the plugin library]].`
Initial tranche of the plugin implementation This first commit adds some of the code needed for the plugin mechanism, but it isn't all fully operational yet. I'm merging the branch so that I can get some other pre-requisites done quickly on the main branch, and then plan to return to this branch. 2012-08-06 21:34:16 +00:00
Improve support for bulk loading tiddlers under Node.js Fixes #2610 2016-10-15 15:21:51 +00:00			`The tiddlers within registered plugins behave as ShadowTiddlers: they can be freely overwritten by creating a tiddler with the same title, but deleting that tiddler restores the underlying tiddler value from the plugin.`

			Plugins have a `plugin-type` field that may take the following values:
Docs updates 2013-05-01 15:02:12 +00:00
			* `plugin` //(default)// - a plain plugin
			* `theme` - a theme plugin (see ThemeMechanism)
Adding the missing 'language' type What about the 'core-version' field ? Should we add it ? Therefore we will need to add some doc about it. (how to use it correctly etc...) 2015-02-25 02:58:18 +00:00			* `language` - for translations only
Docs updates 2013-05-01 15:02:12 +00:00
			`Plugins can be used to package ordinary content, or can include JavaScript [[modules\|Modules]] that extend and enhance the core TiddlyWiki5 functionality.`

Docs updates Trying to get the plugin documentation into shape 2012-08-30 12:55:28 +00:00			Plugins conventionally have a title of the form `$:/plugins/publisher/name`. Plugins that are part of the core TiddlyWiki distribution have titles of the form `$:/plugins/tiddlywiki/name`.
Initial tranche of the plugin implementation This first commit adds some of the code needed for the plugin mechanism, but it isn't all fully operational yet. I'm merging the branch so that I can get some other pre-requisites done quickly on the main branch, and then plan to return to this branch. 2012-08-06 21:34:16 +00:00
Improve support for bulk loading tiddlers under Node.js Fixes #2610 2016-10-15 15:21:51 +00:00			`When [[running TiddlyWiki under Node.js\|TiddlyWiki on Node.js]], plugins can also be stored as individual tiddler files in [[PluginFolders]].`
Update plugin documentation 2014-08-07 14:50:02 +00:00
Improve support for bulk loading tiddlers under Node.js Fixes #2610 2016-10-15 15:21:51 +00:00			`! More information`
Update plugin documentation 2014-08-07 14:50:02 +00:00
Improve support for bulk loading tiddlers under Node.js Fixes #2610 2016-10-15 15:21:51 +00:00			`<<list-links "[tag[PluginMechanism]]">>`
Update plugin documentation 2014-08-07 14:50:02 +00:00