Note: An alternative skin, TW4MW (work in progress), is available from the user preferences.
Plugin Installation
TiddlyWiki Community Wiki
Contents |
[edit] ImportTiddlers Method
[edit] Copy & Paste Method
[edit] Locate the plugin you want to install
- It's a good idea to get it from the plugin author's site so you know you have the latest version
[edit] Copy the source of the plugin tiddler
- To do this you need to click the tiddler's 'edit' button. Sometimes instead of an 'edit' button there is a 'view' or 'source' button instead, but either way it should show you the source of the plugin tiddler.
- Click in the text box and do an "Edit", "Select All" from your browser menu, or press Ctrl-A (Cmd-A for Mac users) to select the entire contents. Often the tiddlers contents is already selected for you so you may be able to skip this step.
- Do an "Edit", "Copy", or press Ctrl-C (Cmd-C for Mac users) to copy the entire contents of the tiddler.
[edit] Create the plugin tiddler in your TiddlyWiki
- Back in your own TiddlyWiki, click 'new tiddler' to create a tiddler.
- You can name the tiddler anything you like but to save confusion give it the same as the plugin you are installing.
- Do an "Edit", "Paste", or Ctrl-V/Cmd-V to paste the plugin source code into your new plugin tiddler.
- (Note if you updating a plugin you already have you can just edit it, do a select all, delete to clear the contents before you paste in the new contents).
[edit] Add the "systemConfig" tag
- Before you save the new plugin tiddler, add the tag "systemConfig" to the tags box. It must start with a lowercase 's'. This is what tells TiddlyWiki to execute the code in the plugin tiddler when starting.
[edit] Save and reload
- The plugin is not active until you save and reload your TiddlyWiki so click 'save changes', then click reload in your browser.
[edit] Testing
- Now your plugin should be active and working. Check that it is doing what it should be doing.
[edit] Troubleshooting
cf. Troubleshooting
[edit] If it's not working but you don't get an error
Check the following
- Did you remember the systemConfig tag? It must be spelt correctly and it is case sensitive.
- Did you save and reload?
[edit] You get javascript error messages (check your Javascript Console in Firefox)
- It means that there are errors in the plugin code.
- Check that you copied the entire plugin source code and that you clicked edit (or view or source) before copying.
- It's possible that the plugin is buggy. If you email the plugin author or post to the TiddlyWiki Google Group you may get some help. Mention your browser your OS and the details of the problem you're having.

