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

created: 20140910215514237
modified: 20150313101514237
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.

! Installing a plugin from the plugin library

# Create a backup of your current TiddlyWiki HTML file ([[just in case|The First Rule of Using TiddlyWiki]])
# Open your TiddlyWiki in a browser
# Open the [[$:/ControlPanel]] and click on the ''Plugins'' tab and then the ''Add'' tab
# Click ''open plugin library'' to open the official plugin library
# When the library listing is loaded:
## Use the dropdown to select between ''plugins'', ''themes'' and ''languages''
## Use the ''search'' box to search the plugin details
# Click the ''install'' button to install a plugin
# Save your TiddlyWiki
# ''Refresh the page so that TiddlyWiki loads the new plugin''
# The plugin should now be available for use

! Manually installing 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 these links 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 page so that TiddlyWiki loads the new plugin''
# 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 ''Plugins'' tab
# Click on the plugin you want to delete to open its tiddler
# Click the edit icon and then delete the tiddler
# Save your TiddlyWiki
# ''Refresh the window so that TiddlyWiki completely removes the plugin''
# The plugin should now be deleted
Update filter docs 2014-09-10 22:42:13 +00:00			`created: 20140910215514237`
Update plugin installation instructions 2015-03-13 10:18:42 +00:00			`modified: 20150313101514237`
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
Update plugin installation instructions 2015-03-13 10:18:42 +00:00			`! Installing a plugin from the plugin library`
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`
Update plugin installation instructions 2015-03-13 10:18:42 +00:00			`# Open the [[$:/ControlPanel]] and click on the ''Plugins'' tab and then the ''Add'' tab`
			`# Click ''open plugin library'' to open the official plugin library`
			`# When the library listing is loaded:`
			`## Use the dropdown to select between ''plugins'', ''themes'' and ''languages''`
			`## Use the ''search'' box to search the plugin details`
			`# Click the ''install'' button to install a plugin`
			`# Save your TiddlyWiki`
			`# ''Refresh the page so that TiddlyWiki loads the new plugin''`
			`# The plugin should now be available for use`

			`! Manually installing 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 these links on the home page of the plugin (for example, http://tiddlywiki.com/plugins/tiddlywiki/katex/)`
Docs tweaks 2014-10-07 12:16:24 +00:00			`# 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`
Update plugin installation instructions 2015-03-13 10:18:42 +00:00			`# ''Refresh the page so that TiddlyWiki loads the new plugin''`
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]])`
Update plugin installation instructions 2015-03-13 10:18:42 +00:00			`# Open the [[$:/ControlPanel]] and go to the ''Plugins'' tab`
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			`# Click on the plugin you want to delete to open its tiddler`
Update plugin installation instructions 2015-03-13 10:18:42 +00:00			`# Click the edit icon and then delete the tiddler`
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			`# Save your TiddlyWiki`
Update plugin installation instructions 2015-03-13 10:18:42 +00:00			`# ''Refresh the window so that TiddlyWiki completely removes the plugin''`
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			`# The plugin should now be deleted`