Note: An alternative skin, TW4MW (work in progress), is available from the user preferences.

TiddlyWiki Community Wiki

• Plugins are a TW core-supported feature that works "out of the box".
• Plugins are tiddlers that contain ONLY pure javascript code. Any wiki syntax it contains must be wrapped inside a javascript comment block.
• Plugins are tagged with "systemConfig", which tells TW to run them ONCE, when the document is first loaded into the browser.
• Plugins typically install macro definitions or other 'handler functions' that are then triggered later on as a result of other activities.
• Plugins are optional modules extending the functionality of TiddlyWiki.
• Plugins are usually written by third-party developers and released under an open-source license.
• Plugins are usually just a tiddler containing JavaScript code (see Installation below).

[edit] Installation

Ideally, plugin tiddlers should be imported from their original location into the TiddlyWiki document.

In order to be processed on startup, plugins need to be assigned the systemConfig tag.

In general, plugins are processed in alpha-numeric order (by tiddler title), using case-sensitive ASCII sort order (i.e. A-Z precedes a-z).

[edit] Dependency Handling

Plugins support the use of a Requires slice to determine load order. If a plugin contains such a slice, its value is processed as a space-separated, bracketed list of tiddler titles, and any plugin tiddlers listed there will be loaded first, regardless of the sort order of the titles.

[edit] Example

If PluginA requires PluginB to be loaded first, it should contain the following directive:

|Requires|PluginB|

This will force an override of the normal load sequence and ensure that PluginB is loaded before PluginA is processed.

[edit] See Also

• Category:Plugins
• Plugin Installation
• Plugin Repositories
• Plugin Questions
• Macros
• Dev:Best_Practices