tiddlywiki 5.2.0 → 5.2.3

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

@@ -1,51 +1,38 @@
 created: 20160107222352710
-modified: 20191022095637710
-tags: [[TiddlyWiki on Node.js]] Plugins
+modified: 20220617122143911
+tags: Plugins
 title: Installing a plugin from the plugin library
 type: text/vnd.tiddlywiki
 
-! Standalone Configuration
+\rules except wikilink
 
-Follow these instructions when using TiddlyWiki as a standalone HTML file:
+If you want to follow the steps //side by side// you can <<open-tiddler-in-window>>. 
+
+Follow these instructions when using TiddlyWiki as a standalone, single file wiki.
 
-# 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]] <<.icon $:/core/images/options-button>>, click on the ''Plugins'' tab and then the <<.icon $:/core/images/download-button>> ''Get more plugins'' button
+
+# Create a backup of your current wiki file ([[just in case|The First Rule of Using TiddlyWiki]])
+
+# Open the <<controlPanel-plugin-link>>
+
+#* 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 <<.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
+
+#* <<.from-version "5.1.22">> It is no longer necessary to refresh TiddlyWiki when deleting plugins that support dynamic loading. See the [[PluginMechanism]] for more details
+
 # 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`, `themes` or `languages` 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"
-	],
-    "languages": [
-        "es-ES",
-        "fr-FR",
-        "en-EN"
-    ]
-}
-```
-
-See also [[Installing custom plugins on Node.js]].
+<$macrocall $name=".note" _="""If you use TiddlyWiki with ''Node.js'' have a closer look at [[Installing official plugins on Node.js]]<br>An overview can be found at [[Plugins]]"""/> 

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

@@ -1,14 +1,29 @@
 created: 20160107222430613
-modified: 20190927205631648
+modified: 20220617115930635
 tags: Plugins
 title: Manually installing a plugin
 type: text/vnd.tiddlywiki
 
+\rules except wikilink
+
+If you want to follow the steps //side by side// you can <<open-external-window "https://tiddlywiki.com/plugins/tiddlywiki/katex">>. 
+
 # 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, https://tiddlywiki.com/plugins/tiddlywiki/katex/)
-# Drag the link [[$:/plugins/tiddlywiki/example]] to the browser window containing your TiddlyWiki
+
+# In another browser window, find a link to the plugin, e.g. https://tiddlywiki.com/plugins/tiddlywiki/katex. You will typically find these links on the home page of the plugin
+
+# Drag the link similar to `$:/plugins/tiddlywiki/example` to the browser window containing your TiddlyWiki
+
+# Import the new plugin shown in the $:/Import 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 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
+
+# The plugin should now be available for use
+
+<$macrocall $name=".note" _="More information about installing a plugin form the official plugin library, can be found at [[Installing a plugin from the plugin library]]<br>An overview can be found at [[Plugins]]"/>

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

@@ -1,5 +1,5 @@
 created: 20170210075109635
-modified: 20170210075709809
+modified: 20220612082350537
 tags: Plugins
 title: OfficialPlugins
 type: text/vnd.tiddlywiki
@@ -7,3 +7,5 @@ type: text/vnd.tiddlywiki
 The official TiddlyWiki plugin library contains the plugins that are part of the [[main TiddlyWiki 5 GitHub repository|Working with the TiddlyWiki5 repository]]. Install them from [[the plugin library|Installing a plugin from the plugin library]]. Plugins from the official plugin library are automatically updated as part of the [[upgrade process|UpgradeMechanism]].
 
 <<list-links "[tag[OfficialPlugins]]">>
+
+<$macrocall $name=".note" _="An overview, how to handle plugins can be found at: [[Plugins]]"/>

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

@@ -0,0 +1,47 @@
+created: 20220613115453346
+modified: 20220628160136158
+tags: PluginMechanism
+title: Plugin Ordering
+type: text/vnd.tiddlywiki
+
+Using the Node.js client-server configuration plugins are activated in the following order:
+
+# Plugins found using the OS environment variables
+#* See: [[PluginFolders]]
+#* and: [[Environment Variables on Node.js]]
+
+# Plugins stored in the wiki `/plugins` path
+#* See: [[PluginFolders]]
+
+# Plugins specified in the command line
+#* See: [[Using TiddlyWiki on Node.js]] ... the notes about <<.from-version "5.1.20">>
+
+# Plugins imported by drag and drop as wiki content
+#* See: [[Installing a plugin from the plugin library]] or [[Manually installing a plugin]]
+
+''Important:''
+
+* ''Elements lower in the list take precedence''
+
+*Including a plugin as an ordinary tiddler by drag and drop  into the browser, will result in the plugin only being active in the browser
+** It will not be available under Node.js
+
+Option 1:
+
+* Using a Node.js configuration option 1 is the most common one
+* It lowers maintenence, because all plugins can be updated in one go
+
+Option 2:
+
+* Option 2 is preferred if you want to work with a fixed configuration
+* Plugin updates only effect the corresponding wiki
+
+Option 3:
+
+* This option allows to ''add and start'' an edition without the need to overwrite an existing `tiddlywiki.info` file
+* It allows you to start any edition as a client-server edition, even if the tiddlywiki.info file didn't specify it.
+
+Option 4:
+
+* Is the exact same mechanism used for a single-file wiki
+* This mechanism should only be used in a Node.js configuration for ''testing and debugging'' purposes, since the plugins are stored in the `tiddlers/` directory

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

@@ -1,6 +1,6 @@
 created: 20190928081810311
-modified: 20190928103750812
-tags: 
+modified: 20211114222640985
+tags: PluginMechanism
 title: Plugin Types
 type: text/vnd.tiddlywiki
 

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

@@ -1,9 +1,35 @@
 created: 20161015113519246
-modified: 20190927172743140
+modified: 20220613123551803
 tags: PluginMechanism
 title: PluginFolders
 type: text/vnd.tiddlywiki
 
+! Working with Plugin Folders
+
+* Arrange the [[PluginFolders]] containing the plugins in a convenient shared location
+
+* 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:
+
+```
+├── plugins/
+│   ├── relink/
+│   │   ├── js/
+│   │   ├── tiddlers/
+│   │   └── plugin.info
+│   └── relink-markdown/
+│       ├── js/
+│       ├── plugin.info
+│       └── readme.tid
+├── tiddlers/
+└── tiddlywiki.info
+```
+
+! Plugin.info File
+
 On the server, plugins can be stored as ordinary JSON tiddlers but it is often more convenient to store them as separate tiddler files within folders. Plugin folders must contain a `plugin.info` file that contains the metadata for the plugin. It can also optionally identify files external to the plugin folder that should be loaded as tiddlers.
 
 The `plugin.info` file should contain the following JSON structure:

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

@@ -1,18 +1,30 @@
 created: 20140910215514237
-modified: 20190108000000000
+list: [[Installing a plugin from the plugin library]] [[Uninstalling a plugin]] [[Manually installing a plugin]] OfficialPlugins
+modified: 20220617133819755
 tags: Concepts TableOfContents
 title: Plugins
 type: text/vnd.tiddlywiki
 
-Plugins in TiddlyWiki5 can be used to distribute optional components that customise and extend TiddlyWiki. You can install them from the [[official plugin library|Installing a plugin from the plugin library]] or from [[community sites|Resources]].
+! Introduction
 
-{{$:/core/ui/ControlPanel/Plugins/AddPlugins}}
+Plugins in TiddlyWiki5 can be used to distribute optional components that customise and extend wiki. You can install them from the official plugin library or from community sites.
 
-Internally, plugins are a bundle of tiddlers packaged together as a single tiddler that can be installed, copied or deleted as a unit. The individual tiddlers within a plugin appear as ShadowTiddlers. See the PluginMechanism discussion for more details about how plugins are implemented internally.
+Internally, plugins are a bundle of tiddlers packaged together as a single tiddler that can be installed, copied, disabled or deleted as a unit. The individual tiddlers within a plugin appear as shadow tiddlers. 
 
-Plugins can contain JavaScript modules, style sheets, and templates. Plugins can also be used to distribute ordinary text, images or any other content.
+Plugins can contain ~JavaScript modules, style sheets, and templates. Plugins can also be used to distribute ordinary text, images or any other content.
 
+! Handling Plugins with a Single File Wiki
 
-<<list-links "[tag[Plugins]]">>
+<<list-links "[tag[Plugins]] -[has[draft.of]]">>
 
-<$macrocall $name=".note" _="There is a plugin called $:/core that contains the main core code of ~TiddlyWiki. It is always present, and it is the source of default [[Shadow tiddlers|ShadowTiddlers]]. You can see the details of this in the <<.button control-panel>> on the <<.controlpanel-tab Plugins>> sub-tab."> 
+! Handling Plugins with a Client - Server Configuration (Node.js)
+
+<<list-links "[tag[PluginsCS]] -[has[draft.of]]">>
+
+! Plugin Mechanism
+
+The PluginMechanism tiddler contains more details about how plugins are implemented internally. 
+
+You can open the plugin details in the <<controlPanel-plugin-link>> on the <<.controlpanel-tab Plugins>> sub-tab.
+
+There is a plugin called $:/core that contains the main core code of TiddlyWiki. It is always present, and it is the source of default ShadowTiddlers.

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

@@ -1,40 +1,30 @@
 created: 20160107222504269
-modified: 20190927205509760
+modified: 20220617132957241
 tags: Plugins
 title: Uninstalling a plugin
 type: text/vnd.tiddlywiki
 
-! Standalone Configuration
+\rules except wikilink
 
-Follow these instructions when using TiddlyWiki as a standalone HTML file:
+If you want to follow the steps //side by side// you can <<open-tiddler-in-window>>.
+
+
+Follow these instructions when using TiddlyWiki as a standalone, single file wiki.
 
 # Create a backup of your current TiddlyWiki HTML file ([[just in case|The First Rule of Using TiddlyWiki]])
-# Open the [[control panel|$:/ControlPanel]] and go to the ''Plugins'' tab
+
+# Open the <<controlPanel-plugin-link>> 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
 
+# Save your TiddlyWiki <<.icon $:/core/images/save-button>>
 
-! Client-Server Configuration
+# 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>>
 
-Follow these instructions when using TiddlyWiki under Node.js:
+#* <<.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
 
-# 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
+# The plugin should no longer be active or available
 
-```
-{
-	"plugins": [
-		"tiddlywiki/codemirror"
-	],
-	"themes": [
-		"tiddlywiki/vanilla",
-		"tiddlywiki/snowwhite"
-	]
-}
-```
+<$macrocall $name=".note" _="""If you use TiddlyWiki with node.js have a closer look at [[Uninstalling a plugin with Node.js]]<br>An overview of working with plugins can be found at [[Plugins]]"""/> 

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
 

package/editions/tw5.com/tiddlers/releasenotes/Release 5.1.21.tid

@@ -8,6 +8,12 @@ type: text/vnd.tiddlywiki
 
 //[[See GitHub for detailed change history of this release|https://github.com/Jermolene/TiddlyWiki5/compare/v5.1.20...v5.1.21]]//
 
+<<.banner-credits
+	credit:"""Congratulations to [[Sylvain Comte|https://github.com/sycom]] for his winning design for the banner for this release (here are the [[other entries|https://groups.google.com/g/tiddlywiki/c/l47ZZzWdDb8/m/a1dnyKG0AQAJ]]).
+"""
+	url:"https://raw.githubusercontent.com/Jermolene/TiddlyWiki5/42060acb43b329036b7436ee154bf605e90efa8e/editions/tw5.com/tiddlers/images/New%20Release%20Banner.jpg"
+>>
+
 This is a bug fix release that resolves issues introduced in the recent [[Release 5.1.20]].
 
 !! Bug Fixes

package/editions/tw5.com/tiddlers/releasenotes/Release 5.1.22.tid

@@ -8,6 +8,12 @@ type: text/vnd.tiddlywiki
 
 //[[See GitHub for detailed change history of this release|https://github.com/Jermolene/TiddlyWiki5/compare/v5.1.21...v5.1.22]]//
 
+<<.banner-credits
+	credit:"""Congratulations to [[Thomas Elmiger|https://github.com/telmiger]] for his winning design for the banner for this release (here are the [[other entries|https://groups.google.com/g/tiddlywiki/c/rYrja18_SfQ/m/IX-jFS4cBQAJ]]).
+"""
+	url:"https://raw.githubusercontent.com/Jermolene/TiddlyWiki5/1ed36adab62c117849ee29d9535136eac70d3bc7/editions/tw5.com/tiddlers/images/New%20Release%20Banner.png"
+>>
+
 ! Major Improvements
 
 !!  Dynamic Plugin Loading

package/editions/tw5.com/tiddlers/releasenotes/Release 5.1.23.tid

@@ -6,12 +6,14 @@ tags: ReleaseNotes
 title: Release 5.1.23
 type: text/vnd.tiddlywiki
 
-\define contributor(username)
-<a href="https://github.com/$username$" style="text-decoration:none;font-size:24px;" class="tc-tiddlylink-external" target="_blank" rel="noopener noreferrer"><img src="https://github.com/$username$.png?size=32" width="32" height="32"/> @<$text text=<<__username__>>/></a>
-\end
-
 //[[See GitHub for detailed change history of this release|https://github.com/Jermolene/TiddlyWiki5/compare/v5.1.22...v5.1.23]]//
 
+<<.banner-credits
+	credit:"""Congratulations to [[Atronoush|https://github.com/atronoush]] for his winning design for the banner for this release (here are the [[other entries|https://groups.google.com/g/tiddlywiki/c/cTgPWl8b_9c/m/RghSSNKXAQAJ]]).
+"""
+	url:"https://raw.githubusercontent.com/Jermolene/TiddlyWiki5/3c003364d2408eb27912187f57f023333cc4f4dd/editions/tw5.com/tiddlers/images/New%20Release%20Banner.png"
+>>
+
 ! Performance Improvements
 
 * <<.link-badge-improved "https://github.com/Jermolene/TiddlyWiki5/pull/5206">> filter execution to use a more efficient linked list structure for intermediate results
@@ -261,33 +263,35 @@ Please note that using this plugin does not guarantee compliance with any partic
 
 [[@Jermolene|https://github.com/Jermolene]] would like to thank the contributors to this release who have generously given their time to help improve TiddlyWiki:
 
-* <<contributor adithya-badidey>>
-* <<contributor Arlen22>>
-* <<contributor bimlas>>
-* <<contributor BramChen>>
-* <<contributor BurningTreeC>>
-* <<contributor danielo515>>
-* <<contributor default-kramer>>
-* <<contributor ento>>
-* <<contributor favadi>>
-* <<contributor fkohrt>>
-* <<contributor flibbles>>
-* <<contributor gera2ld>>
-* <<contributor ibnishak>>
-* <<contributor idotobi>>
-* <<contributor jdangerx>>
-* <<contributor jjduhamel>>
-* <<contributor joshuafontany>>
-* <<contributor kookma>>
-* <<contributor Kamal-Habash>>
-* <<contributor Marxsal>>
-* <<contributor mocsa>>
-* <<contributor NicolasPetton>>
-* <<contributor OmbraDiFenice>>
-* <<contributor passuf>>
-* <<contributor pmario>>
-* <<contributor rmunn>>
-* <<contributor SmilyOrg>>
-* <<contributor saqimtiaz>>
-* <<contributor twMat>>
-* <<contributor xcazin>>
+<<.contributors """
+adithya-badidey
+Arlen22
+bimlas
+BramChen
+BurningTreeC
+danielo515
+default-kramer
+ento
+favadi
+fkohrt
+flibbles
+gera2ld
+ibnishak
+idotobi
+jdangerx
+jjduhamel
+joshuafontany
+kookma
+Kamal-Habash
+Marxsal
+mocsa
+NicolasPetton
+OmbraDiFenice
+passuf
+pmario
+rmunn
+SmilyOrg
+saqimtiaz
+twMat
+xcazin
+""">>

package/editions/tw5.com/tiddlers/releasenotes/Release 5.2.0.tid

@@ -6,12 +6,14 @@ tags: ReleaseNotes
 title: Release 5.2.0
 type: text/vnd.tiddlywiki
 
-\define contributor(username)
-<a href="https://github.com/$username$" style="text-decoration:none;font-size:24px;" class="tc-tiddlylink-external" target="_blank" rel="noopener noreferrer"><img src="https://github.com/$username$.png?size=32" width="32" height="32"/> @<$text text=<<__username__>>/></a>
-\end
-
 //[[See GitHub for detailed change history of this release|https://github.com/Jermolene/TiddlyWiki5/compare/v5.1.23...v5.2.0]]//
 
+<<.banner-credits
+	credit:"""Congratulations to Frank. B for his winning design for the banner for this release (here are the [[other entries|https://groups.google.com/g/tiddlywiki/c/eccIEHZoxsI/m/_MWs3EooBAAJ]]).
+"""
+	url:"https://raw.githubusercontent.com/Jermolene/TiddlyWiki5/32b36fb2aff6bbe4f9281ee56d5bf6b8bbe5454b/editions/tw5.com/tiddlers/images/New%20Release%20Banner.png"
+>>
+
 ! Highlights
 
 !! Unrestricted Fieldnames and the New JSON Store Area
@@ -261,37 +263,39 @@ For end users, if an upgrade to v5.2.0 causes problems then consult the discussi
 
 [[@Jermolene|https://github.com/Jermolene]] would like to thank the contributors to this release who have generously given their time to help improve TiddlyWiki:
 
-* <<contributor 8d1h>>
-* <<contributor Arlen22>>
-* <<contributor BlueGreenMagick>>
-* <<contributor BramChen>>
-* <<contributor BurningTreeC>>
-* <<contributor cdruan>>
-* <<contributor clutterstack>>
-* <<contributor CodaCodr>>
-* <<contributor dixonge>>
-* <<contributor donmor>>
-* <<contributor felixhayashi>>
-* <<contributor FlashSystems>>
-* <<contributor flibbles>>
-* <<contributor FND>>
-* <<contributor hoelzro>>
-* <<contributor jeremyredhead>>
-* <<contributor joebordes>>
-* <<contributor joshuafontany>>
-* <<contributor kookma>>
-* <<contributor laomaiweng>>
-* <<contributor leehawk787>>
-* <<contributor Marxsal>>
-* <<contributor morosanuae>>
-* <<contributor neumark>>
-* <<contributor NicolasPetton>>
-* <<contributor OdinJorna>>
-* <<contributor pmario>>
-* <<contributor rryan>>
-* <<contributor saqimtiaz>>
-* <<contributor simonbaird>>
-* <<contributor slaymaker1907>>
-* <<contributor sobjornstad>>
-* <<contributor twMat>>
-* <<contributor xcazin>>
+<<.contributors """
+8d1h
+Arlen22
+BlueGreenMagick
+BramChen
+BurningTreeC
+cdruan
+clutterstack
+CodaCodr
+dixonge
+donmor
+felixhayashi
+FlashSystems
+flibbles
+FND
+hoelzro
+jeremyredhead
+joebordes
+joshuafontany
+kookma
+laomaiweng
+leehawk787
+Marxsal
+morosanuae
+neumark
+NicolasPetton
+OdinJorna
+pmario
+rryan
+saqimtiaz
+simonbaird
+slaymaker1907
+sobjornstad
+twMat
+xcazin
+""">>