tiddlywiki 5.1.21 → 5.2.1

package/editions/tw5.com/tiddlers/nodejs/Environment Variables on Node.js.tid

@@ -1,5 +1,5 @@
 created: 20140617211749290
-modified: 20140912141809800
+modified: 20211104172343220
 tags: [[TiddlyWiki on Node.js]]
 title: Environment Variables on Node.js
 type: text/vnd.tiddlywiki
@@ -11,7 +11,9 @@ type: text/vnd.tiddlywiki
 * `TIDDLYWIKI_LANGUAGE_PATH` - Search path for languages
 * `TIDDLYWIKI_EDITION_PATH` - Search path for editions (used by the InitCommand)
 
-''Note'': The delimiter may vary between operating systems. While on Windows a semicolon `;` is used, Linux implements a colon `:`.
+''Note 1'': The delimiter may vary between operating systems. While on Windows a semicolon `;` is used, Linux implements a colon `:`.
+
+''Note 2'': On Linux systems, it may be necessary to //''export''// the variable as well as to define it.
 
 The additional paths should each point to folders structured like the equivalent directories in the TiddlyWiki5 GitHub repository: the plugin, theme and language directories contain `publisher/pluginname/<files>` while the edition directories contain `editionname/<files>`
 

package/editions/tw5.com/tiddlers/nodejs/Installing TiddlyWiki Prerelease on Node.js.tid

@@ -1,6 +1,6 @@
 created: 20150926162849519
-modified: 20180701185329863
-tags: [[Installing TiddlyWiki on Node.js]]
+modified: 20191022095509822
+tags: [[TiddlyWiki on Node.js]]
 title: Installing TiddlyWiki Prerelease on Node.js
 type: text/vnd.tiddlywiki
 

package/editions/tw5.com/tiddlers/nodejs/Installing TiddlyWiki on Node.js.tid

@@ -1,16 +1,24 @@
 caption: Node.js
+color: #F06292
 created: 20131219100608529
 delivery: DIY
 description: Flexible hosting on your own machine or in the cloud
 method: sync
-modified: 20180701185303780
+modified: 20211003230831173
 tags: Saving [[TiddlyWiki on Node.js]] Windows Mac Linux
 title: Installing TiddlyWiki on Node.js
 type: text/vnd.tiddlywiki
 
 # Install [[Node.js]]
-#* either from your favourite package manager: typically `apt-get install nodejs` on Debian/Ubuntu Linux or [[Termux for Android|Serving TW5 from Android]], or `brew install node` on a Mac
-#* or directly from http://nodejs.org
+#* Linux: 
+#*> //Debian/Ubuntu//:<br/>`apt install nodejs`<br/>May need to be followed up by:<br/>`apt install npm`
+#*> //Arch Linux//<br/>`pacman -S tiddlywiki` <br/>(installs node and tiddlywiki)
+#* Mac
+#*> `brew install node`
+#* Android
+#*> [[Termux for Android|Serving TW5 from Android]]
+#* Other 
+#*> See http://nodejs.org
 # Open a command line terminal and type:
 #> `npm install -g tiddlywiki`
 #> If it fails with an error you may need to re-run the command as an administrator:
@@ -24,7 +32,7 @@ type: text/vnd.tiddlywiki
 ## Visit http://127.0.0.1:8080/ in your browser
 ## Try editing and creating tiddlers
 # Optionally, make an offline copy:
-#* click the {{$:/core/images/save-button}} ''save changes'' button in the sidebar, ''OR''
+#* click the <<.icon $:/core/images/save-button>> ''save changes'' button in the sidebar, ''OR''
 #* `tiddlywiki mynewwiki --build index`
 
 The `-g` flag causes TiddlyWiki to be installed globally. Without it, TiddlyWiki will only be available in the directory where you installed it.

package/editions/tw5.com/tiddlers/nodejs/Installing custom plugins on Node.js.tid

@@ -0,0 +1,27 @@
+created: 20191022095653896
+modified: 20191102131824766
+tags: [[TiddlyWiki on Node.js]]
+title: Installing custom plugins on Node.js
+type: text/vnd.tiddlywiki
+
+There are several ways in which custom plugins that are not part of TiddlyWiki's plugin library can be installed when using TiddlyWiki under Node.js. (See [[Installing a plugin from the plugin library]] for instructions on installing plugins from the library).
+
+* Arrange the PluginFolders containing the plugins in a convenient shared location and then use [[environment variables|Environment Variables on Node.js]] to tell TiddlyWiki to search those folders. The plugins can be referenced in `tiddlywiki.info` by their name (e.g. `tiddlytools/magic`)
+* Place the PluginFolders containing the plugins in a `plugins` folder within the [[wiki folder|TiddlyWikiFolders]]. TiddlyWiki will attempt to include every subfolder as a plugin. Do not add the plugin names to `tiddlywiki.info`. Do not add the PluginFolders under a specific namespace:<br><pre>.
+├── plugins
+│   ├── relink
+│   │   ├── js
+│   │   ├── plugin.info
+│   │   └── tiddlers
+│   └── relink-markdown
+│       ├── js
+│       ├── plugin.info
+│       └── readme.tid
+├── tiddlers
+└── tiddlywiki.info
+</pre>
+* Depending on how TiddlyWiki itself has been installed, plugins can also be installed by copying the plugin folders into the `plugins` folder of the repository. This is only recommended if working with a forked copy of the repo. It is not recommended if TiddlyWiki has been installed with npm because npm is liable to overwrite the installation when performing an update
+
+Note that including a plugin as an ordinary tiddler (e.g. by dragging and dropping a plugin into the browser) will result in the plugin only being active in the browser, and not available under Node.js.
+
+

package/editions/tw5.com/tiddlers/nodejs/Serving TW5 from Android.tid

@@ -1,13 +1,47 @@
-created: 20160602043529506
-modified: 20160602043531313
-tags: [[TiddlyWiki on Node.js]]
+caption: Node.js on Termux
+color: #F06292
+created: 20200501120322327
+delivery: App with DIY steps
+description: Using Node.js to serve/create flatfile wikis
+method: sync
+modified: 20200507112915801
+tags: Saving [[TiddlyWiki on Node.js]] Android
 title: Serving TW5 from Android
 type: text/vnd.tiddlywiki
 
-[[Termux|https://termux.com/]] is an open source Android application that combines a Linux system and a terminal.
+[[Termux|https://termux.com/]] is and open source android application providing limited Unix environment enabling users to install [[Node.js]] and npm modules in android. Users can install and run [[TiddlyWiki on Node.js]] using [[Termux|https://termux.com/]].
 
-Once you open //Termux// on your Android system, it is straightforward to [[install|Installing TiddlyWiki on Node.js]] and [[run|Using TiddlyWiki on Node.js]] the [[Node.js flavour of TiddlyWiki|TiddlyWiki on Node.js]] from the command line. 
+!! Instructions 
 
-From then on, as long as //Termux// is not closed, you may access your wiki anytime from your favourite Web browser pointing on the expected address and port.
+* Download and install Termux from [[Google Play Store|https://play.google.com/store/apps/details?id=com.termux]] or [[Fdroid|https://f-droid.org/en/packages/com.termux/]]
+* Open termux and run the following commands one by one
 
-> __note to contributors__: in //Termux//, you may as well install //git//, //emacs// or //vi//, in order to edit and maintain individual tiddler files. This would probably require that you also attach a more powerful keyboard to your Android, like the [[Hacker's Keyboard|https://github.com/klausw/hackerskeyboard/]] application or a Bluetooth external device.
+  ```bash
+apt update
+apt upgrade
+apt install nodejs
+npm install -g tiddlywiki
+```
+
+* If you need to create/serve ''~TiddlyWiki on Node.js'' from the internal storage, you need to give termux storage permission by running the following command in termux
+
+```
+termux-setup-storage
+```
+
+* Now you can create and serve ''~TiddlyWiki on Node.js'' from internal storage. In the example given below, user is creating a new wiki called "mynewwiki" in his internal folder.
+
+```
+cd storage/shared
+tiddlywiki mynewwiki --init server
+tiddlywiki mynewwiki --listen
+```
+* Visit http://127.0.0.1:8080/ in your browser
+* From then on, as long as //Termux// is not closed, you may access your wiki anytime from your favourite Web browser pointing on the expected address and port.
+
+---
+
+* For more information regarding ~TiddlyWiki on Node.js, please see [[Installing TiddlyWiki on Node.js]]
+* For more information and tips regarding termux, please refer to [[Termux wiki|https://wiki.termux.com/wiki/Main_Page]]
+
+<<.tip "In //Termux//, you may as well install //git//, //emacs// or //vi//, in order to edit and maintain individual tiddler files. This would probably require that you also attach a more powerful keyboard to your Android, like the [[Hacker's Keyboard|https://github.com/klausw/hackerskeyboard/]] application or a Bluetooth external device.">>

package/editions/tw5.com/tiddlers/nodejs/TiddlyWiki on Node.js.tid

@@ -1,5 +1,5 @@
 created: 20131129094353704
-modified: 20150412185457193
+modified: 20200318115527226
 tags: Platforms
 title: TiddlyWiki on Node.js
 type: text/vnd.tiddlywiki
@@ -10,14 +10,8 @@ Running TiddlyWiki on [[Node.js]] brings several important benefits over and abo
 * Individual tiddlers are stored in separate files, which you can organise as you wish
 * The ability to build multiple wikis that blend different combinations of shared and unique content
 
-There are a few file system limitations you should be aware of that are related to how TiddlyWiki was designed:
-
-* The best, most general way to interact with a running wiki is via the HTTP or JavaScript API, rather than manipulating the file store directly
-* Any modification to the contents of the wiki folder (e.g. images) might thus sometimes require that your restart the node.js server
-* TiddlyWiki might support manipulating the file store directly in the future
+<<.warning """Note that TiddlyWiki on Node.js doesn't currently support directly modifying the tiddler files via the file system while it is running. The server must be restarted in order to for changes to take effect. The recommended way to interact with a running wiki is via the HTTP or JavaScript APIs.""">>
 
 For more information see:
 
-* [[Installing TiddlyWiki on Node.js]]
-* [[Using TiddlyWiki on Node.js]]
-* [[Upgrading TiddlyWiki on Node.js]]
+<<list-links "[tag[TiddlyWiki on Node.js]]">>

package/editions/tw5.com/tiddlers/nodejs/Using TiddlyWiki on Node.js.tid

@@ -1,5 +1,5 @@
 created: 20131219100520659
-modified: $tw.loadPluginFolder(name.substring(1));
+modified: 20200523092939199
 tags: [[TiddlyWiki on Node.js]]
 title: Using TiddlyWiki on Node.js
 type: text/vnd.tiddlywiki

package/editions/tw5.com/tiddlers/nodejs/tiddlywiki.files_Files.tid

@@ -1,6 +1,6 @@
 created: 20161015114118243
-modified: 20161015170604353
-tags: TiddlyWikiFolders
+modified: 20211114101256212
+tags: TiddlyWikiFolders [[TiddlyWiki on Node.js]]
 title: tiddlywiki.files Files
 type: text/vnd.tiddlywiki
 
@@ -48,12 +48,14 @@ Directory specifications in the `directories` array may take the following forms
 
 * a ''string'' literal, specifying the absolute or relative path to the directory containing the tiddler files (relative paths are interpreted relative to the path of the `tiddlywiki.files` file). The directory is recursively searched for tiddler files
 * <<.from-version "5.1.14">> an ''object'' with the following properties:
-** ''path'' - (required) the absolute or relative path to the directory containing the tiddler files (relative paths are interpreted relative to the path of the `tiddlywiki.files` file). Note that the directory is not recursively searched; sub-directories are ignored
+** ''path'' - (required) the absolute or relative path to the directory containing the tiddler files (relative paths are interpreted relative to the path of the `tiddlywiki.files` file). Note that by default the directory is not recursively searched; sub-directories are ignored unless the //searchSubdirectories// flag is set to `true` (see below).
 ** ''filesRegExp'' - (optional) a [[regular expression|https://developer.mozilla.org/en/docs/Web/JavaScript/Guide/Regular_Expressions]] that matches the filenames of the files that should be processed within the directory
 ** ''isTiddlerFile'' - (required) if `true`, the file will be treated as a [[tiddler file|TiddlerFiles]] and deserialised to extract the tiddlers. Otherwise, the raw content of the file is assigned to the `text` field without any parsing
+** ''isEditableFile'' - <<.from-version "5.1.23">> (optional) if `true`, changes to the tiddler be saved back to the original file. The tiddler will be saved back to the original filepath as long as it does not generate a result from the $:/config/FileSystemPath filters, which will override the final filepath generated if a result is returned from a filter.
+** ''searchSubdirectories'' - <<.from-version "5.1.23">> (optional) if `true`, all subdirectories of the //path// are searched recursively for files that match the (optional) //filesRegExp//. If no //filesRegExp// is provided, all files in all subdirectoies of the //path// are loaded. Tiddler titles generated via a //source// attribute (see above) will only include the filename, not any of the subdirectories of the path. If this results in multiple files with loaded with the same tiddler title, then only the last file loaded under that tiddler title will be in memory. In order to prevent this, you must have multiple directory objects listed and customize the title field with a //prefix// or //suffix// alongside the //source// attribute.
 ** ''fields'' - (required) an object containing values that override or customise the fields provided in the tiddler file (see above)
 
-Fields can be overridden for particular files by creating a file with the same name plus the suffix `.meta` -- see TiddlerFiles.
+Fields can also be overridden for particular files by creating a file with the same name plus the suffix `.meta` -- see TiddlerFiles.
 
 ! Examples
 
@@ -63,7 +65,7 @@ There are also several examples of `tiddlywiki.files` files in the main [[Tiddly
 
 !! Importing a folder of PDFs
 
-This example retrieves all the files with the extension `.pdf` from a folder specified by a relative path. Each tiddler is set up for LazyLoading with the following fields:
+This example retrieves all the files with the extension `.pdf` from a folder specified by a relative path. This path starts with "../../../" indicating 3 directory levels above the folder holdng this confog fole. Each tiddler is set up for LazyLoading with the following fields:
 
 * ''title'' - set to the URI decoded base filename of the PDF file. [[URI decoding|https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/decodeURIComponent]] allows characters like "/" to be included in titles by URI encoding them as "%2F"
 * ''created'' - set to the creation date/time of the PDF file
@@ -93,3 +95,39 @@ This example retrieves all the files with the extension `.pdf` from a folder spe
     ]
 }
 ```
+!! Importing a folder of text files
+
+This example retrieves all the files with the extension `.txt` from a folder specified by a relative path. This folder is within the wiki's base directory, and the current config file is in a directory within the wiki's "tiddlers/" directory. So, in this case the path starts with "../../" to traverse upwards two directory levels, and then down into the "externalnotes/" directory. Each tiddler is set up with the following fields:
+
+* ''title'' - set to the URI decoded base filename of the text file. [[URI decoding|https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/decodeURIComponent]] allows characters like "/" to be included in titles by URI encoding them as "%2F"
+* ''created'' - set to the creation date/time of the text file
+* ''modified'' - set to the modification date/time of the text file
+* ''type'' - set to `text/plain`
+* ''tags'' - set to `[[note]] [[externalnote]] [[.txt]]` (using array notation)
+* ''text'' - not set, thus the content of the file is loaded as the text field
+
+```
+{
+    "directories": [
+        {
+            "path": "../../externalnotes",
+            "filesRegExp": ".+\\.txt",
+            "isTiddlerFile": false,
+            "isEditableFile": true,
+            "fields": {
+                "title": {"source": "basename-uri-decoded"},
+                "created": {"source": "created"},
+                "modified": {"source": "modified"},
+                "type": "text/plain",
+                "tags": ["note", "externalnote", ".txt"]
+            }
+        }
+  ]
+}
+```
+
+This will load all text files in the `../../externalnotes/` directory into the wiki as individual tiddlers. These can be a collection of snippets in various markup-languages. Then, the `type` field of each of these tiddlers can be changed to match their languages For example, "text/vnd.tiddlywiki" for wikitext, or "text/markdown" for markdown files. Then, using $:/config/FileSystemPaths and $:/config/FileSystemExtentions tiddlers with the following lines we can cause any changes to these tiddlers to be saved back to the directory they started from, and also as "*.txt" files with accompanying "*.txt.meta" files. These meta files will be generated as required, and will then over-ride any fields generated from the config `tiddlywiki.files` file (such as the tiddler's `type` field) when the server is restarted.
+
+From the examples in [[Customising Tiddler File Naming]] we see that the final `[!tag[externalnote]addprefix[wiki/]]` filter in the $:/config/FileSystemPaths tiddler excludes all tiddlers tagged with `externalnotes` (that have not matched an earlier filter). These tiddlers have their filepath retrieved from the $:/config/OriginalTiddlerPaths generated upon boot startup.
+
+Then, the `[tag[.txt]then[.txt]]` filter in the $:/config/FileSystemExtensions tiddler forces all these tiddlers to be saved back to disk as *.txt and accompanying *.txt.meta files (overriding the normal tiddler-type to file-type mapping). In this case, allowing the snippets of Tiddlywiki wikitext or markdown-text to be saved back to "text" *.txt files.

package/editions/tw5.com/tiddlers/nodejs/tiddlywiki.info_Files.tid

@@ -1,6 +1,6 @@
 created: 20161015114042793
-modified: 20161015121622327
-tags: TiddlyWikiFolders
+modified: 20211114101249016
+tags: TiddlyWikiFolders [[TiddlyWiki on Node.js]]
 title: tiddlywiki.info Files
 type: text/vnd.tiddlywiki
 

package/editions/tw5.com/tiddlers/platforms/TiddlyFox Apocalypse.tid

@@ -1,6 +1,6 @@
 created: 20171109170823847
-modified: 20171113161750857
-tags: Platforms
+modified: 20211124214943222
+tags: TiddlyFox
 title: TiddlyFox Apocalypse
 type: text/vnd.tiddlywiki
 

package/editions/tw5.com/tiddlers/platforms/TiddlyWiki in the Sky for TiddlyWeb.tid

@@ -1,19 +1,7 @@
 created: 20131129100250644
-modified: 20150412185535373
-tags: [[Hosting your TiddlyWiki on the web]] Platforms
+modified: 20211124214855770
+tags: $:/deprecated
 title: TiddlyWiki in the Sky for TiddlyWeb
 type: text/vnd.tiddlywiki
 
-TiddlyWiki in the Sky for TiddlyWeb allows content to be synchronised between TiddlyWiki running in the browser and a TiddlyWeb (or TiddlySpace) server. Features include:
-
-* Lazy loading
-* Two way synchronisation between the browser and the server
-** Synchronising from the server is accomplished by polling (currently every 60 seconds)
-* Throttling so that rapidly changing tiddlers don't overwhelm the server
-
-To try out TiddlyWiki in the Sky for TiddlyWeb:
-
-# If necessary, create an account at http://tiddlyspace.com/
-# Create a new space, eg `<myspace>`
-# Include the space `tw5tiddlyweb`
-# Visit `http://<myspace>.tiddlyspace.com/tw5`
+The term "TiddlyWiki in the Sky for TiddlyWeb" was used to refer to the ability for content to be synchronised between TiddlyWiki running in the browser and a TiddlyWeb server. This configuration should still work but is no longer commonly used.

package/editions/tw5.com/tiddlers/plugins/Consent Banner Plugin.tid

@@ -0,0 +1,14 @@
+created: 20201019084534263
+modified: 20201019084658478
+tags: OfficialPlugins
+title: Consent Banner Plugin
+type: text/vnd.tiddlywiki
+
+The Consent Banner Plugin helps make websites that are compliant with "cookie legislation" such as the [[EU General Data Protection Regulation|https://gdpr.eu/cookies/]].
+It presents a banner inviting the user to accept or reject cookies, keeping track of their consent in local storage so that the banner can be hidden on subsequent visits.
+
+By default, content embedded with <iframe>, <embed> and <object> is blocked unless the user consents to accept cookies.
+
+Consent status is  available via a configuration tiddler so that it is possible to construct content that behaves differently depending upon whether consent has been granted. As an example, a macro is provided for embedding ~YouTube videos that automatically uses the youtube-nocookie.com variant of video URLs unless the user has accepted cookies.
+
+Please note that using this plugin does not guarantee compliance with any particular legislation. You will need to understand the technical issues specific to your situation, and if necessary seek legal advice.

package/editions/tw5.com/tiddlers/plugins/Installing a plugin from the plugin library.tid

@@ -1,6 +1,6 @@
 created: 20160107222352710
-modified: 20160720145836265
-tags: Plugins
+modified: 20191022095637710
+tags: [[TiddlyWiki on Node.js]] Plugins
 title: Installing a plugin from the plugin library
 type: text/vnd.tiddlywiki
 
@@ -10,14 +10,15 @@ 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]])
 # 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
-# Click {{$:/core/images/chevron-right}} ''open plugin library'' to open the official plugin library
+# Open the [[control panel|$:/ControlPanel]] <<.icon $:/core/images/options-button>>, click on the ''Plugins'' tab and then the <<.icon $:/core/images/download-button>> ''Get more plugins'' button
+# Click <<.icon $:/core/images/chevron-right>> ''open plugin library'' to open the official plugin library
 # When the library listing is loaded:
 ## Use the tab 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 {{$:/core/images/save-button}}
-# ''Refresh the page so that TiddlyWiki loads the new plugin'' {{$:/core/images/refresh-button}}
+# Save your TiddlyWiki <<.icon $:/core/images/save-button>>
+# If a yellow warning bar appears at the top of the window,  refresh the window so that TiddlyWiki completes installation of the plugin <<.icon $:/core/images/refresh-button>>
+#* <<.from-version "5.1.22">> It is no longer necessary to refresh TiddlyWiki when deleting plugins that support dynamic loading. See PluginMechanism for more details
 # The plugin should now be available for use
 
 ! Client-Server Configuration
@@ -46,3 +47,5 @@ Follow these instructions when using TiddlyWiki under Node.js:
     ]
 }
 ```
+
+See also [[Installing custom plugins on Node.js]].

package/editions/tw5.com/tiddlers/plugins/JSZip Plugin.tid

@@ -0,0 +1,7 @@
+created: 20201019084712096
+modified: 20201019084824422
+tags: OfficialPlugins
+title: JSZip Plugin
+type: text/vnd.tiddlywiki
+
+This plugin provides primitives for creating Zip files in the browser. It also makes the [[JSZip|https://stuk.github.io/jszip/]] library available for use by other plugins.

package/editions/tw5.com/tiddlers/plugins/Manually installing a plugin.tid

@@ -1,5 +1,5 @@
 created: 20160107222430613
-modified: 20160617104949358
+modified: 20190927205631648
 tags: Plugins
 title: Manually installing a plugin
 type: text/vnd.tiddlywiki
@@ -8,6 +8,7 @@ type: text/vnd.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, https://tiddlywiki.com/plugins/tiddlywiki/katex/)
 # Drag the link [[$:/plugins/tiddlywiki/example]] to the browser window containing your TiddlyWiki
-# Save your TiddlyWiki ({{$:/core/images/save-button}})
-# ''Refresh the page so that TiddlyWiki loads the new plugin'' ({{$:/core/images/refresh-button}})
+# Save your TiddlyWiki (<<.icon $:/core/images/save-button>>)
+# If a yellow warning bar appears at the top of the window,  refresh the window so that TiddlyWiki completes installation of the plugin <<.icon $:/core/images/refresh-button>>
+#* <<.from-version "5.1.22">> It is no longer necessary to refresh TiddlyWiki when deleting plugins that support dynamic loading. See PluginMechanism for more details
 # The plugin should now be available for use

package/editions/tw5.com/tiddlers/plugins/Plugin Dependencies.tid

@@ -0,0 +1,13 @@
+created: 20190928081852771
+modified: 20190928082758674
+tags: PluginMechanism
+title: Plugin Dependencies
+type: text/vnd.tiddlywiki
+
+The simplest form of dependency between plugins is that one plugin can declare itself to be a sub-plugin of another plugin by specifying that plugin in the `parent-plugin` [[field|Plugin Fields]]. Sub-plugins are displayed in the control panel plugin chooser within the expandable area of their parent plugin. For example, the official plugin library includes the [[CodeMirror Plugin]] and also more than a dozen sub-plugins that extend the CodeMirror plugin with optional functionality. Note that sub-plugins cannot themselves have further sub-plugins.
+
+Plugins can also use their `dependents` [[field|Plugin Fields]] to list the titles of any other plugins that should also be installed. Note that the list is not resolved recursively: dependents of dependents will not be installed.
+
+When installing a plugin from the plugin library, both the `parent-plugin` and `dependents` fields are used to determine any additional plugins to be installed.
+
+Note that the `dependents` field is also used by the ThemeMechanism and the LanguageMechanism to switch in dependent theme/language plugins.

package/editions/tw5.com/tiddlers/plugins/Plugin Types.tid

@@ -0,0 +1,20 @@
+created: 20190928081810311
+modified: 20211114222640985
+tags: PluginMechanism
+title: Plugin Types
+type: text/vnd.tiddlywiki
+
+Plugins have a `plugin-type` field that determines how it is treated. The following values are defined by the core:
+
+* `plugin` - an ordinary plugin
+* `theme` - a theme plugin (see ThemeMechanism). Only the theme plugin named in the tiddler $:/theme is activated at any one time (along with any dependent theme plugins)
+* `language` - a language plugin (see TranslationMechanism). Only the language plugin named in the tiddler $:/language is activated at any one time (along with any dependent language plugins)
+
+The following plugin types are used internally by the core:
+
+* `import` - for the special $:/Import plugin created while importing is in progress
+* `info` - for the special $:/temp/info-plugin tiddler created by the InfoMechanism
+
+While not supported by the plugin library, it is also possible to use custom plugin types to build plugin-like behaviour with a custom user interface. Plugins with a custom type will automatically receive the same behaviour as plain plugins but can display a custom user interface using an appropriate [[view template segment|SystemTag: $:/tags/ViewTemplate]].
+
+By default, tiddlers within plugins with custom plugin types will not be registered as shadow tiddlers (the constituent tiddlers can still be addressed as subtiddlers by the TranscludeWidget, ViewWidget or the [[plugintiddlers Operator]]). Setting a configuration tiddler `$:/config/RegisterPluginType/<plugin-type>` to `yes` will cause the tiddlers within the plugin to be registered as shadow tiddlers.

package/editions/tw5.com/tiddlers/plugins/PluginFolders.tid

@@ -1,5 +1,5 @@
 created: 20161015113519246
-modified: 20161015113833256
+modified: 20190927172743140
 tags: PluginMechanism
 title: PluginFolders
 type: text/vnd.tiddlywiki
@@ -13,6 +13,7 @@ The JSON structure for plugin tiddlers is as follows:
 ```
 {
 	"title": "$:/plugins/publisher/name",
+	"name": "name",
 	"description": "An exemplary plugin for demonstration purposes",
 	"author": "JeremyRuston",
 	"version": "1.2.3-alpha3",

package/editions/tw5.com/tiddlers/plugins/Plugin_Fields.tid

@@ -1,22 +1,22 @@
 created: 20161015122718559
-modified: 20161015122719647
+modified: 20190928083018378
 tags: PluginMechanism
 title: Plugin Fields
 type: text/vnd.tiddlywiki
 
-! Plugin fields
-
 Plugins are stored as tiddlers with the following fields:
 
 |!Field |!Description |
-|title |Title of plugin |
+|author |//(optional)// Author of plugin |
+|dependents |List of dependencies: plugins that should be installed in order for this one to work |
 |description |Description of plugin |
-|author |Author of plugin |
-|version |Version string (must conform to [ext[SemanticVersioning|http://semver.org/]] convention) |
-|source |Source URL of plugin |
-|type |Must be ''application/json'' |
-|plugin-type |Can be ''plugin'' (default), ''language'' or ''theme'' |
-|text |JSON encoding of the list of tiddlers comprising the plugin |
 |list |Names of exposed plugin information tiddlers (see below) |
-|name |Name of the theme (only for themes) |
-|dependents |List of dependent plugins (currently only implemented for themes) |
+|name |Brief name of the plugin |
+|plugin-priority |//(optional)// Numerical priority (higher numbers install later, the core plugin has a priority of zero |
+|plugin-type |Generally ''plugin'', ''language'' or ''theme''; see PluginMechanism for details |
+|parent-plugin |//(optional)// <<.from-version "5.1.22">> Title of the plugin under which this plugin should be displayed as a sub-plugin in the control panel plugin chooser |
+|source |//(optional)// Source URL of plugin |
+|text |JSON encoding of the list of tiddlers comprising the plugin |
+|title |Title of plugin |
+|type |Must be ''application/json'' |
+|version |//(optional)// Version string (should conform to [ext[SemanticVersioning|http://semver.org/]] convention) |

package/editions/tw5.com/tiddlers/plugins/Share Plugin.tid

@@ -0,0 +1,12 @@
+created: 20201228143125000
+modified: 20201228143125000
+tags: OfficialPlugins
+title: Share Plugin
+type: text/vnd.tiddlywiki
+
+<div class="tc-message-box">Do not install this plugin unless you understand exactly what it does</div>
+
+This experimental plugin provides tools to share tiddlers via URLs, comprising:
+
+* The ability to load a group of tiddlers from the browser location hash at startup
+* Wizard and templates to create URLs from group of tiddlers

package/editions/tw5.com/tiddlers/plugins/Uninstalling a plugin.tid

@@ -1,5 +1,5 @@
 created: 20160107222504269
-modified: 20160720145839711
+modified: 20190927205509760
 tags: Plugins
 title: Uninstalling a plugin
 type: text/vnd.tiddlywiki
@@ -9,12 +9,14 @@ type: text/vnd.tiddlywiki
 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]])
-# 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 the {{$:/core/images/down-arrow}} ''more'' button and {{$:/core/images/delete-button}} ''delete'' the tiddler
-# Save your TiddlyWiki {{$:/core/images/save-button}}
-# ''Refresh the window so that TiddlyWiki completely removes the plugin'' {{$:/core/images/refresh-button}}
-# The plugin should now be deleted
+# Open the [[control panel|$:/ControlPanel]] and go to the ''Plugins'' tab
+# Click on the plugin you want to delete to open it as a standalone tiddler
+# Click the <<.icon $:/core/images/down-arrow>> ''more'' button and <<.icon $:/core/images/delete-button>> ''delete'' the tiddler
+# Save your TiddlyWiki <<.icon $:/core/images/save-button>>
+# If a yellow warning bar appears at the top of the window,  refresh the window so that TiddlyWiki completely removes the plugin <<.icon $:/core/images/refresh-button>>
+#* <<.from-version "5.1.22">> It is no longer necessary to refresh TiddlyWiki when deleting plugins that support dynamic loading. See PluginMechanism for more details
+# The plugin should no longer be active or available
+
 
 ! Client-Server Configuration
 

package/editions/tw5.com/tiddlers/reference/Reference.tid

@@ -4,6 +4,7 @@ modified: 20180927080640647
 tags: TableOfContents
 title: Reference
 type: text/vnd.tiddlywiki
+color: #F45757
 
 The following topics provide the canonical reference documentation for TiddlyWiki:
 

package/editions/tw5.com/tiddlers/releasenotes/BetaReleases.tid

@@ -1,6 +1,6 @@
 created: 20131109105400007
-modified: 20141010092837891
-tags: Releases
+modified: 20211117230125737
+tags: Releases BetaReleaseNotes
 title: BetaReleases
 type: text/vnd.tiddlywiki