mirrors/TiddlyWiki5
1
0
Fork 0
mirror of https://github.com/Jermolene/TiddlyWiki5 synced 2025-04-10 12:46:39 +00:00
Code Issues Releases Wiki Activity

Update plugin installation instructions

Browse Source
This commit is contained in:
Jermolene 2015-03-13 10:18:42 +00:00
parent 253859cc7c
commit 0444420346
1 changed files with 21 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

28
editions/tw5.com/tiddlers/plugins/Plugins.tid
View File

@ -1,5 +1,5 @@
created: 20140910215514237
modified: 20140910215514237
modified: 20150313101514237
tags: Concepts TableOfContents
title: Plugins
type: text/vnd.tiddlywiki
@ -20,22 +20,36 @@ Plugins can contain JavaScript modules, style sheets, and templates to extend th
See the PluginMechanism discussion for more details about how plugins are implemented internally.
! How to install a plugin
! 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
# 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/)
# 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 window to automatically create the shadow tiddlers that are provided by the plugin in order for it to work correctly''
# ''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 plugin tab
# Open the [[$:/ControlPanel]] and go to the ''Plugins'' tab
# Click on the plugin you want to delete to open its tiddler
# Click the edit-mode icon then delete the tiddler
# Click the edit icon and then delete the tiddler
# Save your TiddlyWiki
# ''Refresh the window to automatically delete the shadow tiddlers created by the plugin''
# ''Refresh the window so that TiddlyWiki completely removes the plugin''
# The plugin should now be deleted