tiddlywiki 5.1.21 → 5.2.1

package/editions/tw5.com/tiddlers/mechanisms/PluginMechanism.tid

@@ -1,26 +1,36 @@
 created: 20130826122000000
-modified: 20161015122959346
+modified: 20190928082000464
 tags: Mechanisms
 title: PluginMechanism
 type: text/vnd.tiddlywiki
 
 ! Introduction
 
-[[Plugins]] are bundles of tiddlers that are distributed and managed as a single unit by being packed into a single JSON tiddler. Users can install them with drag and drop, or using the [[plugin library|Installing a plugin from the plugin library]].
+[[Plugins]] are bundles of tiddlers that are distributed and managed as a single unit. Users can install them with drag and drop, or using the [[plugin library|Installing a plugin from the plugin library]].
 
-The tiddlers within registered plugins behave as ShadowTiddlers: they can be freely overwritten by creating a tiddler with the same title, but deleting that tiddler restores the underlying tiddler value from the plugin.
+<<.from-version "5.1.22">> Plugins that contain JavaScript modules require a reload of the wiki before they will work. Plugins that do not contain JavaScript modules are automatically dynamically loaded and unloaded. 
 
-Plugins have a `plugin-type` field that may take the following values:
+Plugins can be used to package any tiddler content, including JavaScript [[modules|Modules]] that extend and enhance the core TiddlyWiki5 functionality. The tiddlers within registered plugins are ShadowTiddlers: they can be freely overwritten by creating a tiddler with the same title, but deleting that tiddler restores the underlying tiddler value from the plugin.
 
-* `plugin` //(default)// - a plain plugin
-* `theme` - a theme plugin (see ThemeMechanism)
-* `language` - for translations only
+By convention, plugin titles have the form `$:/plugins/<publisher>/<name>`. Plugins that are part of the core TiddlyWiki distribution have titles of the form `$:/plugins/tiddlywiki/<name>`.
 
-Plugins can be used to package ordinary content, or can include JavaScript [[modules|Modules]] that extend and enhance the core TiddlyWiki5 functionality.
+When [[running TiddlyWiki under Node.js|TiddlyWiki on Node.js]], plugins can also be stored as individual tiddler files in [[PluginFolders]].
 
-Plugins conventionally have a title of the form `$:/plugins/publisher/name`. Plugins that are part of the core TiddlyWiki distribution have titles of the form `$:/plugins/tiddlywiki/name`.
+! Plugin Types
 
-When [[running TiddlyWiki under Node.js|TiddlyWiki on Node.js]], plugins can also be stored as individual tiddler files in [[PluginFolders]].
+{{Plugin Types}}
+
+! Plugin Dependencies
+
+{{Plugin Dependencies}}
+
+! Plugin Ordering
+
+{{Plugin Ordering}}
+
+! Plugin Fields
+
+{{Plugin Fields}}
 
 ! More information
 

package/editions/tw5.com/tiddlers/mechanisms/RefreshMechanism.tid

@@ -0,0 +1,13 @@
+created: 20191012152414236
+modified: 20191014091753894
+tags: Mechanisms
+title: RefreshMechanism
+type: text/vnd.tiddlywiki
+
+The refresh mechanism is the part of the WikificationMechanism concerned with updating a rendering when there are changes in the tiddler store.
+
+The refresh mechanism is notified of changes to the tiddler store asynchronously. This is done so that multiple consecutive changes can be coalesced into a single change notification. Thus, a series of action widgets modifying several different tiddlers will only trigger a single refresh cycle.
+
+When changes occur, the rendering is updated by calling the "refresh" method of the root widget. The refresh  method determines whether the widget needs to be updated to reflect the incoming changes, and then recursively calls into the refresh methods of each child widget
+
+The refresh cycle is inherently fairly slow because it involves visiting every node in the render tree. To maintain performance there is a RefreshThrottling mechanism that enables refresh processing to be deferred when rapid changes occur to the same tiddler.

package/editions/tw5.com/tiddlers/mechanisms/RefreshThrottling.tid

@@ -0,0 +1,17 @@
+created: 20191013095916159
+modified: 20211117232644028
+tags: RefreshMechanism Mechanisms
+title: RefreshThrottling
+type: text/vnd.tiddlywiki
+
+The RefreshMechanism allows the refresh cycle to be throttled (or deferred) when rapid changes occur to the same tiddler. It is used to maintain responsiveness while editing a draft tiddler, but can also be used on other tiddlers.
+
+The rules governing refresh throttling are:
+
+* When a change notification occurs, throttling will only take place if all of the modified tiddlers meet at least one of these criteria:
+** Has the field `draft.of`
+** Has the field `throttle.refresh`
+** Has a title prefixed with `$:/temp/volatile/`
+* If the refresh cycle is to be throttled, a timer is set for the internal specified in [[$:/config/Drafts/TypingTimeout|Hidden Setting: Typing Refresh Delay]] (cancelling any preciously set timer)
+** When the timer fires, the refresh cycle is triggered, passing the aggregated titles of all the deferred refresh cycles
+

package/editions/tw5.com/tiddlers/mechanisms/StateMechanism.tid

@@ -1,5 +1,5 @@
 created: 20131228164411884
-modified: 20150221225557000
+modified: 20211127033939415
 tags: Mechanisms
 title: StateMechanism
 type: text/vnd.tiddlywiki
@@ -17,7 +17,7 @@ The stack of templates that make up the TiddlyWiki display are complex but we'll
 Breaking down the attributes applied to the list widget:
 
 * ''filter'': selects the list of tiddlers in the `list` field of the tiddler [[$:/StoryList]]. If a tiddler is added or removed from that list then it is automatically reflected in the displayed list
-* ''history'': references the tiddler to be used to store the history stack (see the NavigationMechanism)
+* ''history'': references the tiddler to be used to store the history stack (see the HistoryMechanism)
 * ''template'': identifies a template tiddler to be used for rendering each tiddler in the list
 * ''editTemplate'': identifies a different template tiddler to be used for rendering tiddlers that are in [[draft mode|DraftMechanism]]
 * ''storyview'': specifies the story view to be used (eg classic, or zoomin)
@@ -28,7 +28,7 @@ Note how this approach makes the ''open'' tab in the sidebar very easy to implem
 
 ```
 <$list filter="[list[$:/StoryList]]" history="$:/HistoryList" storyview="pop">
-<$button message="tm-close-tiddler" class="tc-btn-invisible tc-btn-mini">&times;</$button> <$link to={{!!title}}><$view field="title"/></$link>
+<$button message="tm-close-tiddler" class="tc-btn-invisible tc-btn-mini">&times;</$button> <$link/>
 </$list>
 ```
 

package/editions/tw5.com/tiddlers/mechanisms/WikificationMechanism.tid

@@ -0,0 +1,28 @@
+created: 20191012080221911
+modified: 20191013094002890
+tags: Mechanisms
+title: WikificationMechanism
+type: text/vnd.tiddlywiki
+
+"Wikification" is a general term for the dynamic process of converting tiddlers containing WikiText into the HTML DOM representation needed by the browser, and updating that representation if the underlying tiddlers change.
+
+It is composed of several distinct steps:
+
+* ParserMechanism: reading the text of tiddlers and scanning for wikitext constructions, outputting a tree representation of the resulting structure. It is an expensive process so parse trees are cached, and only need to be updated if the corresponding tiddler is changed
+* WidgetMechanism: starting with a specified root tiddler, recursively instantiate a widget for each parse tree node making a rendering tree. Widgets can optionally also create DOM nodes
+* RefreshMechanism: handling changes to the tiddler store by selectively and efficiently updating a rendering tree
+
+This mechanism is used in the browser to build TiddlyWiki's main interactive page. At startup, the tiddler $:/core/ui/PageTemplate is parsed and rendered to the DOM, recursively pulling in other tiddlers to build the entire user interface. Any user interactions -- following a link, clicking a button, or typing in a text box -- trigger a change in the tiddler store which then automatically propagates through the widget tree.  For example, if the user clicks a link to navigate to a new tiddler, the following steps take place:
+
+# Clicking the link triggers the action of the LinkWidget which by default is to add the target tiddler to the list field of the tiddler $:/StoryList
+# The modification to the tiddler store asynchronously triggers the refresh cycle. The asynchronous triggering ensures that the refresh cycle is only run once even if multiple tiddlers were modified in succession
+# The refresh cycle recursively visits each node of the render tree giving them the chance to update themselves in the light of the accumulated changes to the tiddler store. In this case, the ListWidget of the main story river notices that a single tiddler needs to be added to the river, and renders that newly displayed tiddler without disturbing the other tiddlers
+
+The performance of the entire wikification process is critical. If the refresh cycle takes more than about 400ms then the user will notice a delay between their actions and the effects. See [[Performance]] for some discussion of how to optimise performance.
+
+The rendering process is also aggressively reused in other parts of TiddlyWiki, both in the browser and on the server:
+
+* Generating TiddlyWiki's standalone HTML representation
+* Creating static HTML renderings of tiddlers
+* Dynamically rendering CSS stylesheet tiddlers
+

package/editions/tw5.com/tiddlers/menubar/gettingstarted.tid

@@ -0,0 +1,6 @@
+title: $:/editions/tw5.com/menuitems/gettingstarted
+caption: ~GettingStarted
+description: Link to ~GettingStarted
+tags: $:/tags/MenuBar
+target: GettingStarted
+

package/editions/tw5.com/tiddlers/menubar/tagsMenuBar.tid

@@ -0,0 +1,2 @@
+title: $:/tags/MenuBar
+list:$:/plugins/tiddlywiki/menubar/items/hamburger $:/plugins/tiddlywiki/menubar/items/topleftbar $:/editions/tw5.com/menuitems/gettingstarted $:/plugins/tiddlywiki/menubar/items/contents $:/plugins/tiddlywiki/menubar/items/search $:/plugins/tiddlywiki/menubar/items/pagecontrols $:/plugins/tiddlywiki/menubar/items/server $:/plugins/tiddlywiki/menubar/items/toprightbar

package/editions/tw5.com/tiddlers/messages/SampleModal.tid

@@ -1,7 +1,8 @@
 created: 20140912145537860
 footer: <$button message="tm-close-tiddler">Close</$button>
-modified: 20140912145537861
+modified: 20211117224341543
 subtitle: This is a modal created especially for <<yourName>>
+tags: [[Message Examples]]
 title: SampleModal
 type: text/vnd.tiddlywiki
 

package/editions/tw5.com/tiddlers/messages/SampleWindowTemplate.tid

@@ -0,0 +1,10 @@
+created: 20211109165213041
+modified: 20211117224321325
+tags: [[Message Examples]]
+title: SampleWindowTemplate
+
+
+| ''Name:'' |<$edit field=name tag="input" />|
+|''Rank:'' |<$edit field=rank tag="input" />|
+
+''Variable 'something' contains:''<<something>>

package/editions/tw5.com/tiddlers/messages/WidgetMessage_ tm-edit-text-operation.tid

@@ -1,6 +1,6 @@
 caption: tm-edit-text-operation
 created: 20160424211339792
-modified: 20180630073432471
+modified: 20210520053923011
 tags: Messages
 title: WidgetMessage: tm-edit-text-operation
 type: text/vnd.tiddlywiki
@@ -93,6 +93,29 @@ Saves the text of the current //selection// into the provided <<.param "tiddler"
 </div>
 \end
 
+\define makeLinkDescription()
+<div>
+
+Creates a wiki text link to the tiddler specified in <<.param "text">>. If there is a selection, it is used as the text of the link. 
+
+|!Name |!Description |
+|text |Tiddler title to which the link will be created |
+
+</div>
+\end
+
+\define insertTextDescription()
+<div>
+
+Inserts the text specified in <<.param "text">> at the caret position. If there is a selection, it is replaced. 
+
+|!Name |!Description |
+|text |Text to be inserted |
+
+</div>
+\end
+
+\define focusEditorDescription() Simply focuses the Text Editor
 
 A `tm-edit-text-operation` invokes one of the available operations on a __surrounding__ text editor. Therefore the message has to be dispatched within the editor in order for it to catch it. The following properties on the `event` object are required:
 
@@ -114,6 +137,9 @@ At this point the following text operations have been implemented:
 |<<.def "wrap-lines">>|<<wrapLinesDescription>> |
 |<<.def "wrap-selection">>|<<wrapSelectionDescription>> |
 |<<.def "save-selection">>|<<saveSelectionDescription>> |
+|<<.def "make-link">>|<<makeLinkDescription>> |
+|<<.def "insert-text">>|<<insertTextDescription>>|
+|<<.def "focus-editor">>|<<.from-version 5.2.0>> <<focusEditorDescription>> |
 
 
 !Example

package/editions/tw5.com/tiddlers/messages/WidgetMessage_ tm-fold-all-tiddlers.tid

@@ -1,6 +1,6 @@
 caption: tm-fold-all-tiddlers
 created: 20160424230908388
-modified: 20190205154007291
+modified: 20191028113838596
 tags: Messages
 title: WidgetMessage: tm-fold-all-tiddlers
 type: text/vnd.tiddlywiki

package/editions/tw5.com/tiddlers/messages/WidgetMessage_ tm-fold-other-tiddlers.tid

@@ -1,6 +1,6 @@
 caption: tm-fold-other-tiddlers
 created: 20160424232355215
-modified: 20160424233338710
+modified: 20191028113932268
 tags: Messages
 title: WidgetMessage: tm-fold-other-tiddlers
 type: text/vnd.tiddlywiki
@@ -11,8 +11,8 @@ The `tm-fold-other-tiddlers` message folds all tiddlers in the current story lis
 |param|Title of the tiddler that should be ignored by the fold operation. |
 |foldedStatePrefix |Prefix for the state tiddler in which the fold state is stored. |
 
-<<.tip "The core uses a foldStatePrefix of '$:/state/folded/' to store the fold states for the default story view.">>
-<<.warning "The state tiddlers title is computed as 'foldStatePrefix + TiddlerTitle'. If the foldStatePrefix is not set, it will overwrite the text of the tiddler(s) itself, resulting in data loss. ">>
+<<.tip "The core uses a foldStatePrefix of `$:/state/folded/` to store the fold states for the default story view.">>
+<<.warning "The state tiddlers title is computed as `foldStatePrefix + TiddlerTitle`. If the foldStatePrefix is not set, it will overwrite the text of the tiddler(s) itself, resulting in data loss. ">>
 
 
 The `tm-fold-other-tiddlers` message is usually generated with the ButtonWidget and is handled by the surrounding NavigatorWidget.

package/editions/tw5.com/tiddlers/messages/WidgetMessage_ tm-fold-tiddler.tid

@@ -1,16 +1,24 @@
 caption: tm-fold-tiddler
 created: 20160424232749223
-modified: 20160424233102003
+modified: 20191028113537119
 tags: Messages
 title: WidgetMessage: tm-fold-tiddler
 type: text/vnd.tiddlywiki
 
-The `tm-fold-tiddler` message folds the tiddler specified in the `param` parameter. It does so by setting the text of a state tiddler to either "<<.value "show">>" or "<<.value "hide">>", according to the fold state.
+The `tm-fold-tiddler` message toggles the value of a state tiddler. It does so by setting the text of a state tiddler to either "<<.value "show">>" or "<<.value "hide">>", according to the fold state.
 
 |!Name |!Description |
-|param|Title of the tiddler that should be folded. If the tiddler is already folded, it will be unfolded instead. |
-|foldedStatePrefix |Prefix for the state tiddler in which the fold state is stored. If no state prefix is provided, `tm-fold-tiddler` will do nothing. |
+|param |ignored ... foldedState must be used |
+|foldedState |State tiddler in which the fold state is stored |
 
-<<.tip "The core uses a foldStatePrefix of '$:/state/folded/' to store the fold states for the default story view.">>
+<<.tip "The core uses a foldState prefix of `$:/state/folded/` + `tiddler title` to store the fold states for the default story view.">>
 
 The `tm-fold-tiddler` message is usually generated with the ButtonWidget and is handled by the surrounding NavigatorWidget.
+
+The core $:/core/ui/ViewTemplate defines a global variable `folded-state`, that is used with every tiddler. It's created like this: 
+
+```
+\define folded-state()
+$:/state/folded/$(currentTiddler)$
+\end
+```

package/editions/tw5.com/tiddlers/messages/WidgetMessage_ tm-import-tiddlers.tid

@@ -9,6 +9,8 @@ The `tm-import-tiddlers` message inserts a list of tiddlers into the pending imp
 
 |!Name |!Description |
 |param |JSON text of the array of tiddlers to be imported |
+|autoOpenOnImport |<<.from-version "5.1.23">> Optional value "no" or "yes" that can override tv-auto-open-on-import |
+|importTitle|<<.from-version "5.1.23">> optional tiddler title to use for import process instead of ~$:/Import |
 
 The import tiddlers message is usually generated with the DropzoneWidget or the BrowseWidget, and is handled by the NavigatorWidget.
 

package/editions/tw5.com/tiddlers/messages/WidgetMessage_ tm-login.tid

@@ -1,5 +1,5 @@
 created: 20140811112445887
-modified: 20140811113336694
+modified: 20201025163134940
 tags: Messages
 title: WidgetMessage: tm-login
 type: text/vnd.tiddlywiki
@@ -9,3 +9,4 @@ The login message prompts the user for a username and password and attempts to l
 
 The login message is handled by the TiddlyWiki core SyncMechanism which invokes the current [[SyncAdaptorModule|SyncAdaptorModules]] (typically the ''tiddlywiki/tiddlywebadaptor'' plugin).
 
+<<.from-version "5.1.23">> The login message can optionally accept parameters called ''username'' and ''password'' that immediately attempts to login with the specified credentials without displaying the prompt

package/editions/tw5.com/tiddlers/messages/WidgetMessage_ tm-modal.tid

@@ -1,22 +1,25 @@
+caption: tm-modal
 created: 20140811112133701
-modified: 20141107142803042
+modified: 20201117081247738
 tags: Messages
 title: WidgetMessage: tm-modal
 type: text/vnd.tiddlywiki
-caption: tm-modal
 
 |!Name |!Description |
 |param |Title of the tiddler to be displayed |
-|paramObject |Hashmap of variables to be provided to the modal |
+|paramObject |Hashmap of variables to be provided to the modal, contains all extra parameters passed to the widget sending the message. |
 |rootwindow |<<.from-version 5.1.18>> ''yes'' or ''true'' will always display a modal in the wiki-root-window |
 
 The "currentTiddler" variable is set to the title of the modal tiddler, but can be overridden by specifying a different value in `paramObject`.
 
 The modal message is usually generated with the ButtonWidget. The modal message is handled by the TiddlyWiki core.
 
+[[Fields within the tiddler|Modals]] being displayed in the modal can be used to customize its appearance.
+
 ! Example
 
 Here is an example of displaying a modal and passing parameters to it:
+(Note how all parameters to `action-sendmessage` other than `$param` and `$message` are available as variables within the modal.)
 
 <$macrocall $name='wikitext-example-without-html'
 src='Your name: <$edit-text tiddler="$:/temp/yourName" tag="input" default="Your name"/>
@@ -29,5 +32,9 @@ Your message:
 Click me!
 </$button>'/>
 
+
 <<.tip """<$macrocall $name=".from-version" version="5.1.18"/> if triggered from within a ''new window'', the above examples will be displayed within that window. The <$macrocall $name=".attr" _="rootwindow"/> attribute can be set to ''yes'' or ''true'' to inherit this behavior and to display the Modal within the ''root'' window""">>
 
+<<.tip """<$macrocall $name=".from-version" version="5.1.23"/> Links to tiddlers within a modal will open in the same story as the widget that sent the `tm-modal` message. You can override this by specifying values for the variables `tv-story-list` and `tv-history-list` when sending the `tm-modal` message.
+
+""">>

package/editions/tw5.com/tiddlers/messages/WidgetMessage_ tm-navigate.tid

@@ -1,5 +1,5 @@
 created: 20140226085215941
-modified: 20140226085454346
+modified: 20210705094948968
 tags: Messages
 title: WidgetMessage: tm-navigate
 type: text/vnd.tiddlywiki
@@ -13,6 +13,12 @@ The navigate message requires the following properties on the `event` object:
 |navigateTo |Title of the tiddler that is being navigated |
 |navigateFromTitle |Title of the tiddler from which the navigation was initiated |
 |navigateFromClientRect |Bounding rectangle in client page coordinates of the element initiating the navigation |
+|navigateFromClientTop |<<<<.from-version "5.2.0">> Y coordinate of top edge of bounding client rectangle |
+|navigateFromClientLeft |<<<<.from-version "5.2.0">> X coordinate of left edge of bounding client rectangle |
+|navigateFromClientWidth |<<<<.from-version "5.2.0">> Width of bounding client rectangle |
+|navigateFromClientRight |<<<<.from-version "5.2.0">> X coordinate of right edge of bounding client rectangle |
+|navigateFromClientBottom |<<<<.from-version "5.2.0">> Y coordinate of bottom edge of bounding client rectangle |
+|navigateFromClientHeight |<<<<.from-version "5.2.0">> Height of bounding client rectangle |
 |navigateSuppressNavigation |''true'' causes the new tiddler to only be added to the story, and not the history stack. This suppresses the scrolling associated with navigating to a tiddler |
 
 The navigate message can be generated by the LinkWidget, the ActionNavigateWidget and the ButtonWidget, and is handled by the NavigatorWidget.

package/editions/tw5.com/tiddlers/messages/WidgetMessage_ tm-open-external-window.tid

@@ -7,10 +7,10 @@ type: text/vnd.tiddlywiki
 
 <<.from-version "5.1.14">>
 
-The `tm-open-external-window` message opens an external link eg: "http://tiddlywiki.com" in a new //browser// window. If no parameters are specified, it opens the help tiddler. Any additional parameters passed via the <<.param "paramObject">> are being provided as variables to the new window.
+The `tm-open-external-window` message opens an external link eg: "https://tiddlywiki.com" in a new //browser// window. If no parameters are specified, it opens the help tiddler. Any additional parameters passed via the <<.param "paramObject">> are being provided as variables to the new window.
 
 |!Name |!Description |
-|param |URL of the tiddler to be opened in a new browser window, defaults to the [[TiddlyWiki help|http://tiddlywiki.com/#WidgetMessage%3A%20tm-open-external-window if empty]] |
+|param |URL of the tiddler to be opened in a new browser window, defaults to the [[TiddlyWiki help|https://tiddlywiki.com/#WidgetMessage%3A%20tm-open-external-window if empty]] |
 |paramObject |Optional: Hashmap of variables that will be provided to the window. see below |
 
 ''parmObject''
@@ -25,7 +25,7 @@ The `tm-open-external-window` message is usually generated with the ButtonWidget
 
 <$macrocall $name='wikitext-example-without-html'
 src='<$button>
-<$action-sendmessage $message="tm-open-external-window" $param="http://tiddlywiki.com" windowName="_tiddlywiki" windowFeatures="height=500, width=900"/>
+<$action-sendmessage $message="tm-open-external-window" $param="https://tiddlywiki.com" windowName="_tiddlywiki" windowFeatures="height=500, width=900"/>
 Open ~TiddlyWiki - Action
 </$button>
 
@@ -34,6 +34,6 @@ Open ~TiddlyWiki - Action
 Open Mozilla Help - Action
 </$button>
 
-<$button message="tm-open-external-window" param="http://tiddlywiki.com" >
+<$button message="tm-open-external-window" param="https://tiddlywiki.com" >
 Open ~TiddlyWiki - Button
 </$button>'/>

package/editions/tw5.com/tiddlers/messages/WidgetMessage_ tm-open-window.tid

@@ -1,11 +1,11 @@
 caption: tm-open-window
 created: 20160424181447704
-modified: 20190704145627537
+modified: 20211117042202771
 tags: Messages
 title: WidgetMessage: tm-open-window
 type: text/vnd.tiddlywiki
 
-The `tm-open-window` message opens a tiddler in a new //browser// window. If no parameters are specified, the current tiddler is opened in a new window. Similiar to `tm-modal` any additional parameters passed via the <<.param "paramObject">> are being provided as variables to the new window.
+The `tm-open-window` [[message|Message]] opens a tiddler in a new //browser// window. If no parameters are specified, the current tiddler is opened in a new window. Similiar to `tm-modal` any additional parameters passed via the <<.param "paramObject">> are provided as variables to the new window.
 
 |!Name |!Description |
 |param |Title of the tiddler to be opened in a new browser window, defaults to <<.var "currentTiddler">> if empty |
@@ -13,7 +13,25 @@ The `tm-open-window` message opens a tiddler in a new //browser// window. If no
 |windowTitle |Title string for the opened window |
 |width |Width of the new browser window |
 |height |Height of the new browser window |
-|paramObject |Hashmap of variables that will be provided to the window  |
+|paramObject |Hashmap of variables to be provided to the modal, contains all extra parameters passed to the widget sending the message. |
 
+The `tm-open-window` message is best generated with the ActionSendMessageWidget, which in turn is triggered by a widget such as the ButtonWidget. It is handled by the core itself.
+
+<<.tip """When used with the ActionSendMessage Widget, <<.param 'param'>> becomes <<.param '$param'>> """>>
+<<.tip """Parameters <<.param template>>, <<.param windowTitle>>, <<.param width>>, and <<.param height>> require the ActionSendMessageWidget.""">>
+
+
+<$macrocall $name='wikitext-example-without-html'
+src="""
+<$button>Open Window
+<$action-sendmessage 
+  $message="tm-open-window" 
+  $param="$:/temp/openme" 
+  template="SampleWindowTemplate" 
+  windowTitle="My Window Title"
+  width="100em"
+  height="50em"
+  something="I just in over in a variable, and boy is my Hashmap tired." />
+</$button>
+""" />
 
-The `tm-open-window` message is usually generated with the ButtonWidget and is handled by the core itself.

package/editions/tw5.com/tiddlers/messages/WidgetMessage_ tm-rename-tiddler.tid

@@ -10,5 +10,27 @@ The `tm-rename-tiddler` message renames a tiddler by deleting it and recreating
 |!Name |!Description |
 |from |Current title of tiddler  |
 |to |New title of tiddler  |
+|renameInTags |<<.from-version "5.1.23">> Optional value "no" to disable renaming in tags fields of other tiddlers (defaults to "yes") |
+|renameInLists |<<.from-version "5.1.23">> Optional value "no" to disable renaming in list fields of other tiddlers (defaults to "yes") |
 
 The rename tiddler message is usually generated with the ButtonWidget and is handled by the NavigatorWidget.
+
+! Examples
+
+To rename a tiddler called Tiddler1 to Tiddler2 and also renaming Tiddler1 in tags and list fields of other tiddlers:
+
+```
+<$action-sendmessage $message="tm-rename-tiddler" from="Tiddler1" to="Tiddler2" />
+```
+
+To rename a tiddler called Tiddler1 to Tiddler2 and not rename Tiddler1 in tags and list fields of other tiddlers:
+
+```
+<$action-sendmessage $message="tm-rename-tiddler" from="Tiddler1" to="Tiddler2" renameInTags="no" renameInLists="no"/>
+```
+
+To rename a tiddler called Tiddler1 to Tiddler2 and respect the setting in the tiddler $:/config/RelinkOnRename for whether to rename Tiddler1 in tags and list fields of other tiddlers:
+
+```
+<$action-sendmessage $message="tm-rename-tiddler" from="Tiddler1" to="Tiddler2" renameInTags={{$:/config/RelinkOnRename}} renameInLists={{$:/config/RelinkOnRename}}/>
+```

package/editions/tw5.com/tiddlers/messages/WidgetMessage_ tm-scroll.tid

@@ -1,6 +1,6 @@
 caption: tm-scroll
 created: 20160425000906330
-modified: 20160425001655166
+modified: 20201014152456174
 tags: Messages
 title: WidgetMessage: tm-scroll
 type: text/vnd.tiddlywiki
@@ -8,6 +8,5 @@ type: text/vnd.tiddlywiki
 The `tm-scroll` message causes the surrounding scrollable container to scroll to the specified DOM node into view. The `tm-scroll` is handled in various places in the core itself, but can also be handled by a [[ScrollableWidget]].
 
 |!Name |!Description |
-|target |Target DOM node the scrollable container should scroll to. |
-
-Due to the nature of the parameter, the `tm-scroll` can only be generated within javascript code.
+|target |Target DOM node the scrollable container should scroll to (note that this parameter can only be set via JavaScript code) |
+|selector |<<.from-version "5.1.23">> Optional string [[CSS selector|https://developer.mozilla.org/en-US/docs/Web/CSS/CSS_Selectors]] as an alternate means of identifying the target DOM node |

package/editions/tw5.com/tiddlers/messages/WidgetMessage_ tm-unfold-all-tiddlers.tid

@@ -1,16 +1,16 @@
 caption: tm-unfold-all-tiddlers
 created: 20160424233133261
-modified: 20160424233427308
+modified: 20191028113810219
 tags: Messages
 title: WidgetMessage: tm-unfold-all-tiddlers
 type: text/vnd.tiddlywiki
 
-The `tm-unfold-all-tiddlers` message unfolds all tiddlers in the current story list. It does so by setting the text of a state tiddler to either "<<.value "show">>" or "<<.value "hide">>", according to the fold state.
+The `tm-unfold-all-tiddlers` message unfolds all tiddlers in the current story list. It does so by setting the text of all state tiddlers to: "<<.value "show">>".
 
 |!Name |!Description |
 |foldedStatePrefix |Prefix for the state tiddler in which the fold state is stored. |
 
-<<.tip "The core uses a foldStatePrefix of '$:/state/folded/' to store the fold states for the default story view.">>
-<<.warning "The state tiddlers title is computed as 'foldStatePrefix + TiddlerTitle'. If the foldStatePrefix is not set, it will overwrite the text of the tiddler(s) itself, resulting in data loss. ">>
+<<.tip "The core uses a foldStatePrefix of `$:/state/folded/` to store the fold states for the default story view.">>
+<<.warning "The state tiddlers title is computed as `foldStatePrefix + TiddlerTitle`. If the foldStatePrefix is not set, it will overwrite the text of the tiddler(s) itself, resulting in data loss. ">>
 
 The `tm-unfold-all-tiddlers` message is usually generated with the ButtonWidget and is handled by the surrounding NavigatorWidget.

package/editions/tw5.com/tiddlers/messages/WidgetMessage_ tm-unload-plugin-library.tid

@@ -0,0 +1,18 @@
+caption: tm-unload-plugin-library
+created: 20191004112527669
+modified: 20191004113621714
+tags: Messages
+title: WidgetMessage: tm-unload-plugin-library
+type: text/vnd.tiddlywiki
+
+The `tm-unload-plugin-library` message unloads the specified plugin library and deletes associated temporary tiddlers.
+
+|!Name |!Description |
+|url |Url specifying the plugin library to be unloaded |
+
+Unloading a plugin library deletes the following tiddlers:
+
+* The tiddler titled `$:/temp/ServerConnection/` + `<url>`
+* All tiddlers with the prefix `$:/temp/RemoteAssetInfo/` + `<url>` + `/`
+
+The `tm-unload-plugin-library` message is usually generated with the ButtonWidget and is handled by the core itself.

package/editions/tw5.com/tiddlers/nodejs/Customising Tiddler File Naming.tid

@@ -1,25 +1,56 @@
 created: 20160424181300000
-modified: 20160424181300000
+modified: 20210803204659026
 tags: [[TiddlyWiki on Node.js]]
 title: Customising Tiddler File Naming
 type: text/vnd.tiddlywiki
 
-By default, a [[TiddlyWiki on Node.js]] instance using a [[wiki folder|TiddlyWikiFolders]] will create new tiddler files by using the sanitised and disambiguated title as filename.
+By default, a [[TiddlyWiki on Node.js]] instance using a [[wiki folder|TiddlyWikiFolders]] will create new tiddler files by using the sanitised and disambiguated title as filename. All filepath operations are relative to a `default-tiddler-location` which defaults to the wiki folder's `tiddlers/` directory. This can be overridden by mapping a path in the wiki's tiddlywiki.info file, by using a `default-tiddler-location` property in the `config` object.
 
-This can be customised by creating a tiddler [[$:/config/FileSystemPaths]] containing one or more [[filter expressions|Filter Syntax]], each on a line of its own. Newly created tiddlers are matched to each filter in turn, and the first output of the first filter to produce any output is taken as a logical path to be used for the tiddler file. Logical paths don't include the `.tid` extension, and they can use `/` or `\` as directory separator (when generating the physical path, this is replaced by the correct separator for the platform ~TiddlyWiki is running on). If none of the filters matches, the logical path is simply the title with all occurences of `/` replaced by `_` (for backwards compatibility).
+The default file extension of `.tid` is used for tiddlers that are missing the `type` field, or for tiddlers of type "text/vnd.tiddlywiki". Tidders of other types are saved according to their MIME types (defined at boot startup).
 
-In both cases, the characters `<>:"\|?*^` are replaced by `_` in order to guarantee that the resulting path is legal on all supported platforms.
+Both the logical path (directory and file name) and the file extension can be customised independently by creating optional tiddlers [[$:/config/FileSystemPaths]] and [[$:/config/FileSystemExtensions]].
+
+! File System Paths
+
+The logical path can be customised by creating a [[$:/config/FileSystemPaths]] tiddler containing one or more [[filter expressions|Filter Syntax]], each on a line of its own. Every time a tiddler is saved to disk it is tested against each filter in turn, and the first output of the first filter to produce any output is taken as a logical path to be used for the tiddler file. If the logical path has changed a new file is created and the old file is deleted.
+
+Tiddlers are limited to being written to the [[wiki folder|TiddlyWikiFolders]], the path defined in the `default-tiddler-location` setting, or the specific path saved in the $:/config/OriginalTiddlerPaths tiddler (see [[tiddlywiki.files Files]]). Any error saving a tiddler to disk, with a logical path that does not start with the wiki folder's path the most common error, causes the filepath to be encoded via Javascript's `encodeURIComponent()` method and the tiddler is saved as this file in the wiki folder's `default-tiddler-location`.
+
+Logical paths do not include the file-on-disk's extension (see below), and they can use `/` or `\` as directory separator (when generating the physical path, this is replaced by the correct separator for the platform ~TiddlyWiki is running on). If none of the filters match, the logical path is simply the title with all occurrences of the characters `/\<>~:"|?*^` replaced by `_` in order to guarantee that the resulting path is legal on all supported platforms. Logical paths are also  limited to 200 characters. If a file with this name already exists, a space and a number will be appended to the final filepath, and with the number incremented until an unused path is found.
 
 !! Example
 
 ```
-[is[system]removeprefix[$:/]addprefix[_system/]]
+[is[system]!has[draft.of]removeprefix[$:/]addprefix[_system/]]
+[is[draft]search-replace:g:regexp[/|\\],[_]addprefix[drafts/]]
 [tag[task]addprefix[mytasks/]]
-[!has[draft.of]]
+[!tag[externalnote]addprefix[wiki/]]
 ```
 
-This will store newly created system tiddlers in `tiddlers/_system` (after stripping the `$:/` prefix), tiddlers tagged [[task]] in a subdirectory `tiddlers/mytasks`, and also create subdirectory structures for all other non-draft tiddlers.
+<<.note "All paths are relative to the wiki's `default-tiddler-location`.">>
+
+This will store newly created system tiddlers that are not drafts of other tiddlers in `./_system/` (after stripping the `$:/` prefix). Next, all drafts have the path separator characters in their titles replaced by "_" and are stored in `./drafts/`. Then tiddlers tagged [[task]] are stored in a subdirectory `./mytasks/`. Finally, all tidders not tagged with "externalnote" will match the final `[!tag[externalnote]addprefix[wiki/]]` storing these in `./wiki/`. In this example, tiddlers tagged with "externalnote" have been imported using [[tiddlywiki.files Files]] with an "isEditableFile" flag set to true, causing the server to remember their original file path in the $:/config/OriginalTiddlerPaths tiddler.
+
+Whenever a tiddler generates a $:/config/FileSystemPaths filter match, any `/` or `\` in the tiddler title is mapped to a path separator. With the above filters, the non-system, non-draft tiddler titled `some/thing/entirely/new` (with no tags) will be saved to `./wiki/some/thing/entirely/new.tid` (ie, the file `new.tid` in a directory called `entirely/`). Thus, $:/config/FileSystemPaths itself will end up in `./_system/config/FileSystemPaths.tid` or `.\_system\config\FileSystemPaths.tid`, depending on the platform.
+
+! File System Extensions
+
+Normally, the file system extension of a tiddler on disk is determined by the presence of field values containing newlines or field values that start or end with whitespace (other than the text field), in which case the single file ".json" tiddler file format is used.
+
+If the tiddler does not have such field values, then the `type` field is referenced to find a matching file-type, with `.tid` used for tiddlers without a type value. The boot engine defines a set of these tiddler-type to file-type relationships in the [[$:/boot/boot.js]] tiddler. Search for `// Add file extension information` to find the section of code that defines these relationships.
+
+The file extension of individual tidders can be customised by creating a tiddler [[$:/config/FileSystemExtensions]] containing one or more [[filter expressions|Filter Syntax]], each on a line of its own. Every time a tiddler is saved to disk it is tested against these filters, and the first output of the first filter to produce any output is taken as the file extension to be used for the tiddler file. Extensions should always start with a leading dot (see example).  If no filter matches, the default extension is used. If the extension has changed a new file is created and the old file is deleted.
+
+<<.note """A result of ".tid" will force the tiddler to be written to disk as a single-file text tiddler. A result of ".json" will force the tiddler to be written to disk as a single file tiddler in json-format (a single tiddler fields object in an array), NOT as a tiddler of type "application/json". All other recognised file-types will be saved using their defined extension along with an accompanying *.meta file of the same name which describes all fields but the "text" field.""">>
+
+!! Example
+
+```
+[tag[.txt]then[.txt]]
+[tag[.json]then[.json]]
+[tag[.tid]then[.tid]]
+```
 
-Thus, $:/config/FileSystemPaths itself will end up in `tiddlers/_system/config/FileSystemPaths.tid` or `tiddlers\_system\config\FileSystemPaths.tid`, depending on the platform.
+This will cause all tidders that have the tag ".txt" to be saved at the filepath determined by the File System Paths filters, but with their text field saved as a *.txt file, and all other fields saved as a *.txt.meta file.
 
-The final `[!has[draft.of]]` will match all remaining non-draft tiddlers. Because there was a match, any `/` or `\` in the tiddler title is mapped to a path separator. Thus, `some/thing/entirely/new` will be saved to `tiddlers/some/thing/entirely/new.tid` (ie, the file `new.tid` in a directory called `entirely`).
+Next, all tiddlers that have the ".json" tag are saved as *.json files. Finally, all tiddlers that have tag ".tid" are saved as single files. If a tiddler matches none of the filters, the default extension determined by the tiddlers `type` field would be used.