mirror of
https://github.com/Jermolene/TiddlyWiki5
synced 2024-12-27 10:30:28 +00:00
22 lines
1.1 KiB
Plaintext
22 lines
1.1 KiB
Plaintext
|
title: PluginFormat
|
||
|
|
modifier: blaine
|
||
|
|
created: 20110211110657
|
||
|
|
modified: 20110211131019
|
||
|
|
creator: psd
|
||
|
|
|
||
|
|
It is recommended that [[Plugins]] start with some standard information in TiddlerSlicing format. For example, see the ExamplePlugin:
|
||
|
|
{{{
|
||
|
|
|''Name:''|ExamplePlugin|
|
||
|
|
|''Description:''|To demonstrate how to write TiddlyWiki plugins|
|
||
|
|
|''Version:''|2.0.2|
|
||
|
|
|''Date:''|Jul 12, 2006|
|
||
|
|
|''Source:''|http://www.tiddlywiki.com/#ExamplePlugin|
|
||
|
|
|''Author:''|JeremyRuston (jeremy (at) osmosoft (dot) com)|
|
||
|
|
|''License:''|[[BSD open source license]]|
|
||
|
|
|''~CoreVersion:''|2.1.0|
|
||
|
|
|''Browser:''|Firefox 1.0.4+; Firefox 1.5; InternetExplorer 6.0|
|
||
|
|
}}}
|
||
|
|
At the moment, only ~CoreVersion affects how [[Plugins]] are processed: if the ~CoreVersion is specified for a plugin, TiddlyWiki will only execute the plugin if the core code version matches or exceeds the version specified. For example, if you specify a ~CoreVersion of 2.2, version 2.1.x of TiddlyWiki will refuse to execute the plugin.
|
||
|
|
|
||
|
|
To indicate an error, plugins should just {{{throw}}} an exception. The text of the exception will be displayed in the PluginManager.
|