mirrors/TiddlyWiki5
1
0
Fork 0
mirror of https://github.com/Jermolene/TiddlyWiki5 synced 2024-11-23 18:17:20 +00:00
Code Issues Releases Wiki Activity

Update docs for installing/uninstalling plugins

Browse Source
This commit is contained in:
Jermolene 2016-07-20 16:02:04 +01:00
parent e49d310ea9
commit 6499fe5d3d
2 changed files with 58 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

32
editions/tw5.com/tiddlers/plugins/Installing a plugin from the plugin library.tid
View File

@ -1,9 +1,13 @@
created: 20160107222352710 created: 20160107222352710
modified: 20160624124005475 modified: 20160720145836265
tags: Plugins tags: Plugins
title: Installing a plugin from the plugin library title: Installing a plugin from the plugin library
type: text/vnd.tiddlywiki type: text/vnd.tiddlywiki
! Standalone Configuration
Follow these instructions when using TiddlyWiki as a standalone HTML file:
# Create a backup of your current TiddlyWiki HTML file ([[just in case|The First Rule of Using TiddlyWiki]]) # 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 your TiddlyWiki in a browser
# Open the [[control panel|$:/ControlPanel]] {{$:/core/images/options-button}}, click on the ''Plugins'' tab and then the {{$:/core/images/download-button}} ''Get more plugins'' button # Open the [[control panel|$:/ControlPanel]] {{$:/core/images/options-button}}, click on the ''Plugins'' tab and then the {{$:/core/images/download-button}} ''Get more plugins'' button
@ -12,6 +16,28 @@ type: text/vnd.tiddlywiki
## Use the tab to select between ''plugins'', ''themes'' and ''languages'' ## Use the tab to select between ''plugins'', ''themes'' and ''languages''
## Use the ''search'' box to search the plugin details ## Use the ''search'' box to search the plugin details
# Click the ''install'' button to install a plugin # Click the ''install'' button to install a plugin
# Save your TiddlyWiki ({{$:/core/images/save-button}}) # Save your TiddlyWiki {{$:/core/images/save-button}}
# ''Refresh the page so that TiddlyWiki loads the new plugin'' ({{$:/core/images/refresh-button}}) # ''Refresh the page so that TiddlyWiki loads the new plugin'' {{$:/core/images/refresh-button}}
# The plugin should now be available for use # The plugin should now be available for use
! Client-Server Configuration
Follow these instructions when using TiddlyWiki under Node.js:
# Identify the plugins you want to install using the ''Plugins'' tab of [[control panel|$:/ControlPanel]] (''don't'' install the plugins from here, though). Plugins are identified by their type (ie language, theme or plugin) and their publisher and title. For example, the plugin `$:/plugins/tiddlywiki/internals` is referred to as ''tiddlywiki/internals''
# Quit the server if it is running
# Edit the `tiddlywiki.info` file (it is in JSON format) and locate the `plugins` and `themes` section (see below)
# Add entries corresponding to the plugins you wish to add. Take care to retain commas to separate items, but do not terminate the last item in a list with a comma
# Restart the server
```
{
"plugins": [
"tiddlywiki/codemirror"
],
"themes": [
"tiddlywiki/vanilla",
"tiddlywiki/snowwhite"
]
}
```

31
editions/tw5.com/tiddlers/plugins/Uninstalling a plugin.tid
View File

@ -1,13 +1,38 @@
created: 20160107222504269 created: 20160107222504269
modified: 20160617105002662 modified: 20160720145839711
tags: Plugins tags: Plugins
title: Uninstalling a plugin title: Uninstalling a plugin
type: text/vnd.tiddlywiki type: text/vnd.tiddlywiki
! Standalone Configuration
Follow these instructions when using TiddlyWiki as a standalone HTML file:
# Create a backup of your current TiddlyWiki HTML file ([[just in case|The First Rule of Using TiddlyWiki]]) # Create a backup of your current TiddlyWiki HTML file ([[just in case|The First Rule of Using TiddlyWiki]])
# Open the [[control panel|$:/ControlPanel]] {{$:/core/images/options-button}} and go to the ''Plugins'' tab # Open the [[control panel|$:/ControlPanel]] {{$:/core/images/options-button}} and go to the ''Plugins'' tab
# Click on the plugin you want to delete to open its tiddler # Click on the plugin you want to delete to open its tiddler
# Click the {{$:/core/images/down-arrow}} ''more'' button and {{$:/core/images/delete-button}} ''delete'' the tiddler # Click the {{$:/core/images/down-arrow}} ''more'' button and {{$:/core/images/delete-button}} ''delete'' the tiddler
# Save your TiddlyWiki ({{$:/core/images/save-button}}) # Save your TiddlyWiki {{$:/core/images/save-button}}
# ''Refresh the window so that TiddlyWiki completely removes the plugin'' ({{$:/core/images/refresh-button}}) # ''Refresh the window so that TiddlyWiki completely removes the plugin'' {{$:/core/images/refresh-button}}
# The plugin should now be deleted # The plugin should now be deleted
! Client-Server Configuration
Follow these instructions when using TiddlyWiki under Node.js:
# Quit the server if it is running
# Edit the `tiddlywiki.info` file (it is in JSON format) and locate the `plugins` and `themes` section (see below)
# Remove the entries corresponding to the plugins you wish to remove. Take care to retain commas to separate items, but do not terminate the last item in a list with a comma
# Restart the server
```
{
"plugins": [
"tiddlywiki/codemirror"
],
"themes": [
"tiddlywiki/vanilla",
"tiddlywiki/snowwhite"
]
}
```