tiddlywiki 5.1.23 → 5.2.2

package/editions/tw5.com/tiddlers/macros/examples/unusedtitle Macro (Examples 1).tid

@@ -0,0 +1,51 @@
+created: 20210227212730299
+modified: 20211118025545823
+tags: [[Macro Examples]]
+title: unusedtitle Macro (Examples 1)
+type: text/vnd.tiddlywiki
+
+\define testCreate()
+<$action-createtiddler $basetitle=<<unusedtitle template:"$count:2$-new">>/>
+\end
+
+\define testCreate1()
+<$action-createtiddler $basetitle=<<unusedtitle baseName:"new" separator:"-" template:"$count:2$$separator$$basename$">>/>
+\end
+
+\define testNew()
+<$action-sendmessage $message="tm-new-tiddler" title=<<unusedtitle baseName:"new" template:"$count:2$-$basename$">> />
+\end
+
+```
+<<unusedtitle template:"$count:2$-new">>
+```
+
+<$button actions=<<testCreate>> >
+<$action-setfield $tiddler="$:/state/tab/sidebar--595412856" text="$:/core/ui/SideBar/Recent"/>
+Create Tiddler
+</$button>
+
+```
+<<unusedtitle baseName:"new" template:"$count:2$-$basename$">>
+```
+
+<$button actions=<<testNew>>>
+<$action-setfield $tiddler="$:/state/tab/sidebar--595412856" text="$:/core/ui/SideBar/Recent"/>
+New Tiddler
+</$button>
+
+```
+<<unusedtitle baseName:"new" separator:"-" template:"$count:2$$separator$$basename$">>
+```
+
+<$button actions=<<testCreate1>>>
+<$action-setfield $tiddler="$:/state/tab/sidebar--595412856" text="$:/core/ui/SideBar/Recent"/>
+Create Tiddler
+</$button>
+
+---
+
+<details>
+    <summary>Show the code</summary>
+    <pre><code><$view><pre><code>
+</details>

package/editions/tw5.com/tiddlers/macros/examples/unusedtitle.tid

@@ -1,7 +1,16 @@
+created: 20210104143940715
+modified: 20210228141241657
 tags: [[unusedtitle Macro]] [[Macro Examples]]
 title: unusedtitle Macro (Examples)
 type: text/vnd.tiddlywiki
 
 <$macrocall $name=".example" n="1" eg="""<<unusedtitle>>"""/>
-<$macrocall $name=".example" n="2" eg="""<<unusedtitle AnotherBase>>"""/>
-<$macrocall $name=".example" n="3" eg="""<<unusedtitle TiddlyWiki>>"""/>
+''The following example works best if there is an open tiddler in draft mode, or there is a tiddler named "New Tiddler".'' So you can see the automatic numbering.
+<$macrocall $name=".example" n="2" eg="""<<unusedtitle separator:"-">>"""/>
+<$macrocall $name=".example" n="3" eg="""<<unusedtitle baseName:"anotherBase">>"""/>
+<$macrocall $name=".example" n="4" eg="""<<unusedtitle baseName:"About" separator:"-">>"""/>
+<$macrocall $name=".example" n="5" eg="""<<unusedtitle template:"$count:2$-test">>"""/>
+
+---
+
+Working buttons can be found at: [[unusedtitle Macro (Examples 1)]]. You'll have to examine the code to see, what's going on.

package/editions/tw5.com/tiddlers/macros/keyboard-driven-input_Macro.tid

@@ -20,3 +20,6 @@ The additional parameters are:
 |secondSearchFilterField |the field of the configTiddler where the second search-filter is stored. Defaults to <<.field second-search-filter>> |
 |filterMinLength |the minimum length of the user input after which items are filtered |
 
+See [[Demonstration: keyboard-driven-input Macro]] for further guidance on using this macro.
+
+

package/editions/tw5.com/tiddlers/macros/list-links-draggable Macro.tid

@@ -1,6 +1,6 @@
 caption: list-links-draggable
 created: 20170328204925306
-modified: 20170329093008550
+modified: 20211214141650488
 tags: Macros [[Core Macros]]
 title: list-links-draggable Macro
 type: text/vnd.tiddlywiki

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

@@ -1,6 +1,6 @@
 created: 20191013095916159
-modified: 20191014093837558
-tags: RefreshMechanism
+modified: 20211117232644028
+tags: RefreshMechanism Mechanisms
 title: RefreshThrottling
 type: text/vnd.tiddlywiki
 
@@ -11,6 +11,7 @@ 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)

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: 20220227211343988
+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-close-all-windows.tid

@@ -0,0 +1,20 @@
+created: 20220301162305764
+modified: 20220301180818011
+tags: Messages
+title: WidgetMessage: tm-close-all-windows
+type: text/vnd.tiddlywiki
+
+<<.from-version 5.2.2>>
+The `tm-close-all-windows` [[message|Messages]] closes all additional //browser// window that were opened with [[tm-open-window|WidgetMessage: tm-open-window]]. 
+
+The `tm-close-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.
+
+<$macrocall $name='wikitext-example-without-html'
+src="""
+<$button>Close All Windows
+<$action-sendmessage 
+  $message="tm-close-all-windows" 
+/>
+</$button>
+""" />
+

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

@@ -0,0 +1,39 @@
+caption: tm-open-window
+created: 20220228140417116
+modified: 20220301180905777
+tags: Messages
+title: WidgetMessage: tm-close-window
+type: text/vnd.tiddlywiki
+
+<<.from-version 5.2.2>>
+The `tm-close-window` [[message|Messages]] closes an additional //browser// window that was opened with [[tm-open-window|WidgetMessage: tm-open-window]]. Specify which window to close by setting the value of <<.param param>> to the string used as <<.param windowID>> when opening the window.
+
+|!Name |!Description |
+|param //{default param}//  |String used as <<.param windowID>> when opening the window |
+
+The `tm-close-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 ActionSendMessageWidget, <<.param 'param'>> becomes <<.param '$param'>> """>>
+<<.tip """To close all additional browser windows that were opened with [[tm-open-window|WidgetMessage: tm-open-window]] use [[WidgetMessage: tm-close-all-windows]]""">>
+
+<$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="400"
+  height="500"
+  windowID="window1"
+  something="I just in over in a variable, and boy is my Hashmap tired." />
+</$button>
+<$button>Close Window
+<$action-sendmessage 
+  $message="tm-close-window" 
+  $param="window1" 
+/>
+</$button>
+""" />
+

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

@@ -1,5 +1,5 @@
 created: 20140811112201235
-modified: 20141110133723696
+modified: 20220123141646321
 tags: Messages
 title: WidgetMessage: tm-download-file
 type: text/vnd.tiddlywiki
@@ -11,6 +11,11 @@ The download file message causes the current saver module to prompt the user to
 |param |Title of a tiddler to use as a template for the new tiddler |
 |paramObject |Optional hashmap of variable values to use for the rendering |
 
+The following variable names have special behaviour:
+
+|!Name |!Description |
+|filename |Filename for the downloaded file (note that this is a hint to the browser, and the actual filename used may be different) |
+
 The download file message is usually generated with the ButtonWidget.
 
 The download file message is handled by the TiddlyWiki core SyncMechanism which invokes the current [[SaverModule|SaverModules]].

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-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-window.tid

@@ -1,19 +1,41 @@
 caption: tm-open-window
 created: 20160424181447704
-modified: 20190704145627537
+modified: 20220301162140993
 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|Messages]] 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 |
-|template |Template in which the tiddler will be rendered in |
+|param //{default param}//  |Title of the tiddler to be opened in a new browser window, defaults to <<.var "currentTiddler">> if empty |
+|template |Template in which the tiddler will be rendered |
 |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  |
+|left|<<.from-version "5.2.2">> Optional, left position of new browser window|
+|top|<<.from-version "5.2.2">> Optional, top position of new browser window|
+|windowID|<<.from-version "5.2.2">> Optional, unique string used to identify the widow. Can be used with [[WidgetMessage: tm-close-window]] to close the window. Defaults to the value of <<.param param>> |
+|//{any other params}// |Any other parameters are made available as variables within the new window |
 
+The `tm-open-window` message is best generated with the ActionSendMessageWidget, which in turn is triggered by a widget such as the ButtonWidget. The message is handled by the core itself.
+
+<<.tip """When used with the ActionSendMessageWidget, <<.param 'param'>> becomes <<.param '$param'>> """>>
+<<.tip """Parameters <<.param template>>, <<.param windowTitle>>, <<.param width>>, <<.param height>>, <<.param left>> and <<.param top>> require the ActionSendMessageWidget.""">>
+<<.tip """<<.from-version 5.2.2>> To close a window opened with tm-open-window use [[WidgetMessage: tm-close-window]]""">>
+<<.tip """<<.from-version 5.2.2>> To open a tiddler in more than one new window, use a unique value for <<.param windowID>>""">>
+
+<$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="640"
+  height="480"
+  something="This is my new window. There are many like it, but this one is mine." />
+</$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-relink-tiddler.tid

@@ -0,0 +1,26 @@
+caption: tm-relink-tiddler
+created: 20220219093748993
+modified: 20220219093748993
+tags: Messages navigator-message
+title: WidgetMessage: tm-relink-tiddler
+type: text/vnd.tiddlywiki
+
+<<.from-version "5.2.2">> The `tm-relink-tiddler` message relinks a tiddler by deleting it and recreating it with a new title. Unlike the [[WidgetMessage: tm-rename-tiddler]] message, this message does not rename the tiddler, it just relinks the references to it.
+
+The relink tiddler message requires the following properties on the `event` object:
+
+|!Name |!Description |
+|from |Current title of tiddler  |
+|to |New title of tiddler  |
+|renameInTags |Optional value "no" to disable renaming in tags fields of other tiddlers (defaults to "yes") |
+|renameInLists |Optional value "no" to disable renaming in list fields of other tiddlers (defaults to "yes") |
+
+The relink tiddler message is usually generated with the ButtonWidget and is handled by the core.
+
+! Examples
+
+To relink Tiddler1 to Tiddler2 in tags and list fields of other tiddlers:
+
+```
+<$action-sendmessage $message="tm-relink-tiddler" from="Tiddler1" to="Tiddler2" />
+```

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

@@ -1,6 +1,6 @@
 caption: tm-rename-tiddler
 created: 20190909133618113
-modified: 20190909133618113
+modified: 20220219093748993
 tags: Messages navigator-message
 title: WidgetMessage: tm-rename-tiddler
 type: text/vnd.tiddlywiki
@@ -13,7 +13,9 @@ The `tm-rename-tiddler` message renames a tiddler by deleting it and recreating
 |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.
+The very similar [[WidgetMessage: tm-relink-tiddler]] message does not rename the tiddler, it just relinks the references to it.
+
+The rename tiddler message is usually generated with the ButtonWidget and is handled by the core.
 
 ! Examples
 

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

@@ -10,3 +10,6 @@ The `tm-scroll` message causes the surrounding scrollable container to scroll to
 |!Name |!Description |
 |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 |
+|animationDuration |<<.from-version "5.2.2">> Optional number specifying the animation duration in milliseconds for the scrolling. Defaults to the [[global animation duration|$:/config/AnimationDuration]]. |
+
+<<.tip "Set `animationDuration` to `0` to scroll without animation">>

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

@@ -1,22 +1,22 @@
 created: 20160424181300000
-modified: 20201201000000000
+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 and write them to the wiki folder's `tiddlers/` directory. This can be overridden by mapping a path in the wiki's tiddlywiki.info file, using a `default-tiddler-location` property in the `config` object. All filepath operations are relative to this `$tw.boot.wikiTiddlersPath` internal javacript variable.
+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.
 
-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 IMIE types (defined at boot startup). Both the logical path (directory and file name) and the file extension can be customized independently by creating optional tiddlers: [[$:/config/FileSystemPaths]] and [[$:/config/FileSystemExtensions]].
+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).
 
-! File System Paths
+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]].
 
-The logical path 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. Tiddlers are also tested against the [[$:/config/FileSystemPaths]] on every save to disk, and if the logical path has changed a new file is created and the old file deleted.
+! File System Paths
 
-Tiddlers are limited to being written to the [[wiki folder|TiddlyWikiFolders]]. 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 `$tw.boot.wikiTiddlersPath` directory.
+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.
 
-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 matches, the logical path is simply the title with all occurences of `/` replaced by `_` (for backwards compatibility).
+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`.
 
-In both cases, the characters `<>~:"\|?*^` are replaced by `_` in order to guarantee that the resulting path is legal on all supported platforms.
+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
 
@@ -27,17 +27,21 @@ In both cases, the characters `<>~:"\|?*^` are replaced by `_` in order to guara
 [!tag[externalnote]addprefix[wiki/]]
 ```
 
-This will store newly created system tiddlers that are not drafts of other tiddlers in `tiddlers/_system` (after stripping the `$:/` prefix). Next, all drafts have the path seperator characters in their titles replaced by "_" and are stored in `tiddlers/drafts/`. Then tiddlers tagged [[task]] are stored in a subdirectory `tiddlers/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|tiddlywiki.files_Files]] with an "isEditableFile" flag set to true, causing the server to remember their original file path.
+<<.note "All paths are relative to the wiki's `default-tiddler-location`.">>
 
-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 `some/thing/entirely/new` (with no tags) will be saved to `<wikiFolder>/tiddlers/wiki/some/thing/entirely/new.tid` (ie, the file `new.tid` in a directory called `entirely/`). 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 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 existance of bad fields (multi-line fields other than the text field, fields that can be trimmed of spaces from the fron or back, etc), in which case the single-file ".json" tiddler-file format is used. If the tiddler does not have bad fields, then the `type` field is referenced to find a matching file-type. Tiddlywiki's 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.
+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. 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 the file extension to be used for the tiddler file. Extensions should always start with a leading dot (see example). Tiddlers are also tested against the $:/config/FileSystemExtensions on every save to disk, and if the extension has changed a new file is created and the old file deleted. If no filter matches, the default extension is used.
+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.
 
-Two special cases should be noted: 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 recognized file-types will be saved using their defined extention along with an acompanying *.meta file of the same name which describes all fields but the "text" field.
+<<.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
 
@@ -47,6 +51,6 @@ Two special cases should be noted: Result of ".tid" will force the tiddler to be
 [tag[.tid]then[.tid]]
 ```
 
-This will cause all tidders that have the tag ".txt" in their tags field 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.
+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.
 
-Next, all tiddlers that have the ".json" tag are saved as *.json single-file tiddlers. Finally, all tiddlers that have tag ".tid" are saved as single-file text tiddlers. If a tiddler matches none of the filters, the default extension determined by the tiddler's `type` field would be used.
+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.

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 on Node.js.tid

@@ -4,14 +4,21 @@ created: 20131219100608529
 delivery: DIY
 description: Flexible hosting on your own machine or in the cloud
 method: sync
-modified: 20200507110222866
+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:

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

@@ -1,6 +1,6 @@
 created: 20161015114118243
-modified: 20201201000000000
-tags: TiddlyWikiFolders
+modified: 20211114101256212
+tags: TiddlyWikiFolders [[TiddlyWiki on Node.js]]
 title: tiddlywiki.files Files
 type: text/vnd.tiddlywiki
 
@@ -48,13 +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'' - (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. <<.from-version "5.1.23">>
+** ''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
 

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,12 +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 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
+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/Highlight Plugin.tid

@@ -1,6 +1,6 @@
 created: 20160107223417655
 list: 
-modified: 20170228102525208
+modified: 20220222094354907
 tags: OfficialPlugins [[Plugin Editions]]
 title: Highlight Plugin
 type: text/vnd.tiddlywiki
@@ -8,3 +8,5 @@ type: text/vnd.tiddlywiki
 The Highlight plugin provides the ability to apply syntax colouring to text.
 
 See [ext[https://tiddlywiki.com/plugins/tiddlywiki/highlight|plugins/tiddlywiki/highlight]]
+
+<<.warning """The latest version of the [[Highlight Plugin]] requires a modern browser that fully supports JavaScript ES6 (released in 2015). The older version is still available as the ''highlight-legacy'' plugin for users who need to use an older browser.""">>