TiddlyWiki5/editions/tw5.com/tiddlers/plugins/Plugins.tid

created: 20140910215514237
modified: 20140910215514237
tags: Concepts TableOfContents
title: Plugins
type: text/vnd.tiddlywiki

! Available Plugins

The following plugins are distributed on tiddlywiki.com as part of the main TiddlyWiki distribution.

<<list-links "[tag[Plugins]]">>

! What is a plugin?

A plugin in TiddlyWiki5 is a bundle of tiddlers packaged together as a single tiddler. Plugins are used to distribute optional, custom components for TiddlyWiki.

The tiddlers within a plugin appear as ShadowTiddlers.

Plugins can contain JavaScript modules, style sheets, and templates to extend the functionality of TiddlyWiki itself. Plugins can also be used to distribute ordinary text, images or other content. Plugins can be updated from their source as a unit.

See the PluginMechanism discussion for more details about how plugins are implemented internally.

! How to install a plugin

# Create a backup of your current TiddlyWiki HTML file ([[just in case|The First Rule of Using TiddlyWiki]])
# Open your TiddlyWiki in a browser
# In another browser window, find a link to the plugin, e.g. [[$:/plugins/tiddlywiki/example]]. You will typically find links to plugins on the home page of the plugin (for example, http://tiddlywiki.com/plugins/tiddlywiki/katex/)
# Drag the link [[$:/plugins/tiddlywiki/example]] to the browser window containing your TiddlyWiki
# Save your TiddlyWiki
# ''Refresh the window to automatically create the shadow tiddlers that are provided by the plugin in order for it to work correctly''
# The plugin should now be available for use

! How to uninstall / delete a plugin

# Create a backup of your current TiddlyWiki HTML file ([[just in case|The First Rule of Using TiddlyWiki]])
# Open the controlpanel and go to the plugin tab
# Click on the plugin you want to delete to open its tiddler
# Click the edit-mode icon then delete the tiddler
# Save your TiddlyWiki
# ''Refresh the window to automatically delete the shadow tiddlers created by the plugin''
# The plugin should now be deleted
Update filter docs 2014-09-10 22:42:13 +00:00			`created: 20140910215514237`
			`modified: 20140910215514237`
Add plugins to TOC on tw5.com 2014-09-22 09:41:34 +00:00			`tags: Concepts TableOfContents`
Docs updates Trying to get the plugin documentation into shape 2012-08-30 12:55:28 +00:00			`title: Plugins`
Update filter docs 2014-09-10 22:42:13 +00:00			`type: text/vnd.tiddlywiki`
Docs updates Trying to get the plugin documentation into shape 2012-08-30 12:55:28 +00:00
Add plugins to TOC on tw5.com 2014-09-22 09:41:34 +00:00			`! Available Plugins`

			`The following plugins are distributed on tiddlywiki.com as part of the main TiddlyWiki distribution.`

Fix list macro typo in tw5 Plugins.tid 2014-09-23 13:57:32 +00:00			`<<list-links "[tag[Plugins]]">>`
Add plugins to TOC on tw5.com 2014-09-22 09:41:34 +00:00
			`! What is a plugin?`

Docs updates 2013-08-09 15:51:49 +00:00			`A plugin in TiddlyWiki5 is a bundle of tiddlers packaged together as a single tiddler. Plugins are used to distribute optional, custom components for TiddlyWiki.`

			`The tiddlers within a plugin appear as ShadowTiddlers.`

			`Plugins can contain JavaScript modules, style sheets, and templates to extend the functionality of TiddlyWiki itself. Plugins can also be used to distribute ordinary text, images or other content. Plugins can be updated from their source as a unit.`
Docs updates Trying to get the plugin documentation into shape 2012-08-30 12:55:28 +00:00
			`See the PluginMechanism discussion for more details about how plugins are implemented internally.`
add how to install plugin 2014-10-06 14:36:02 +00:00
Doc tweaks 2014-10-07 12:16:04 +00:00			`! How to install a plugin`
add how to install plugin 2014-10-06 14:36:02 +00:00
Doc tweaks 2014-10-07 12:16:04 +00:00			`# Create a backup of your current TiddlyWiki HTML file ([[just in case\|The First Rule of Using TiddlyWiki]])`
			`# Open your TiddlyWiki in a browser`
Docs tweaks 2014-10-07 12:16:24 +00:00			`# In another browser window, find a link to the plugin, e.g. [[$:/plugins/tiddlywiki/example]]. You will typically find links to plugins on the home page of the plugin (for example, http://tiddlywiki.com/plugins/tiddlywiki/katex/)`
			`# Drag the link [[$:/plugins/tiddlywiki/example]] to the browser window containing your TiddlyWiki`
add how to install plugin 2014-10-06 14:36:02 +00:00			`# Save your TiddlyWiki`
Enhancements to plugin installation and new entry for uninstallation I have added bold markup to emphase and explain the need to refresh. 2015-02-01 11:41:52 +00:00			`# ''Refresh the window to automatically create the shadow tiddlers that are provided by the plugin in order for it to work correctly''`
Doc tweaks 2014-10-07 12:16:04 +00:00			`# The plugin should now be available for use`
Enhancements to plugin installation and new entry for uninstallation I have added bold markup to emphase and explain the need to refresh. 2015-02-01 11:41:52 +00:00
			`! How to uninstall / delete a plugin`

			`# Create a backup of your current TiddlyWiki HTML file ([[just in case\|The First Rule of Using TiddlyWiki]])`
			`# Open the controlpanel and go to the plugin tab`
			`# Click on the plugin you want to delete to open its tiddler`
			`# Click the edit-mode icon then delete the tiddler`
			`# Save your TiddlyWiki`
			`# ''Refresh the window to automatically delete the shadow tiddlers created by the plugin''`
			`# The plugin should now be deleted`