tiddlywiki 5.3.3 → 5.3.5

package/editions/tw5.com/tiddlers/howtos/How to embed PDF and other documents.tid

@@ -1,5 +1,5 @@
 created: 20141117000000000
-modified: 20161229175752081
+modified: 20230803051806817
 tags: Learning
 title: How to embed PDF and other documents
 type: text/vnd.tiddlywiki
@@ -24,7 +24,7 @@ This method be OK as long as your PDF is not too big. There can be concerns if y
 
 !!! 2. Embedding with '_canonical_uri'
 
-The other way is to create a tiddler link to the external file. In this method the file is not actually incorporated into your TW5 file, but can be accessed with the `{{My Image File.jpg}}` transclusion syntax just like an embedded file. The location address of the file can also be changed under [[node.js]]. See [[ExternalImages]] for details of using external images with node.js.
+The other way is to create a tiddler link to the external file. In this method the file is not actually incorporated into your TW5 file, but can be accessed with the `{{My Image File.jpg}}` transclusion syntax just like an embedded file. The location address of the file can also be changed under [[Node.js]]. See [[ExternalImages]] for details of using external images with node.js.
 
 Create a tiddler with a field `_canonical_uri`. Put in the local address to the external file. Set the `type` field to `application/pdf`.
 

package/editions/tw5.com/tiddlers/howtos/Setting a page background image.tid

@@ -1,5 +1,5 @@
 created: 20150417155912612
-modified: 20160610082700598
+modified: 20230803044412567
 tags: [[Customise TiddlyWiki]]
 title: Setting a page background image
 type: text/vnd.tiddlywiki
@@ -14,5 +14,5 @@ type: text/vnd.tiddlywiki
 #* ''Cover'' causes the background image to be sized so that it completely covers the page. Some of the image may be clipped
 #* ''Contain'' causes the background image to be sized so that it fits within the page
 
-Note that the palette ''DarkPhotos'' is provided to make the sidebar more readable on dark background images.
+Note that the palette [[DarkPhotos|ColourPalettes]] is provided to make the sidebar more readable on dark background images.
 

package/editions/tw5.com/tiddlers/howtos/Tagging.tid

@@ -1,5 +1,5 @@
 created: 20140904075400000
-modified: 20160612132049797
+modified: 20230803050201458
 tags: [[Working with TiddlyWiki]] Concepts
 title: Tagging
 type: text/vnd.tiddlywiki
@@ -20,7 +20,7 @@ By tagging your tiddlers, you can view, navigate and organise your information i
 
 * You can use [[filters|Filters]] to create lists of tiddlers based on their tags. You can then display any combination of the [[fields|TiddlerFields]] of those tiddlers. For example, you could build a glossary by listing the title and text of all tiddlers tagged ''Glossary''. Such lists can be formatted in any way you wish: e.g. bulleted, numbered or comma-separated.
 
-* There are a number of special ''system tags'' that control the layout of tiddlers and the entire ~TiddlyWiki page. See [[Page and tiddler layout customisation]] for instructions.
+* There are a number of special ''system tags'' that control the layout of tiddlers and the entire ~TiddlyWiki page. See [[Page and tiddler layout customisation|Customising TiddlyWiki's user interface]] for instructions.
 
 There are two more things you can do with tags:
 
@@ -28,7 +28,7 @@ There are two more things you can do with tags:
 
 You can use the <<.icon $:/core/images/tag-button>> [[tag manager|$:/TagManager]], found on the ''Tags'' tab under ''More'' in the sidebar, to change the colour of a tag's pill or add an icon to the pill.
 
-* To change the colour, click the button in the ''Colour'' column to select from a colour picker. Alternatively, click the icon in the ''Info'' column, then type a [[CSS]] colour value in the ''Colour'' field
+* To change the colour, click the button in the ''Colour'' column to select from a colour picker. Alternatively, click the icon in the ''Info'' column, then type a [[CSS|Cascading Style Sheets]] colour value in the ''Colour'' field
 * To change the icon, click the <<.icon $:/core/images/down-arrow>> button in the ''Icon'' column and choose from the list of available icons
 
 ! Change the order in which tags are listed

package/editions/tw5.com/tiddlers/howtos/Using Excise.tid

@@ -1,11 +1,11 @@
 created: 20160810122928198
-modified: 20230505104214168
+modified: 20230803044526608
 tags: [[Editor toolbar]]
 title: Using Excise
 type: text/vnd.tiddlywiki
 
 ! Excise text
-From the EditorToolbar you can export selected text to a new tiddler and insert a [[link|Linking in WikiText]], [[Transclusion]] or [[macro|Macros]] in its place. Click ''Excise text'' (<<.icon $:/core/images/excise>>), input name of the new tiddler, and choose excise method.
+From the [[Editor toolbar]] you can export selected text to a new tiddler and insert a [[link|Linking in WikiText]], [[Transclusion]] or [[macro|Macros]] in its place. Click ''Excise text'' (<<.icon $:/core/images/excise>>), input name of the new tiddler, and choose excise method.
 
 !! How to excise text
 # Highlight the relevant piece of text 

package/editions/tw5.com/tiddlers/images/Open Collective Logo.tid

@@ -1,4 +1,6 @@
-title: Open Collective Logo
+created: 20240621075644739
+modified: 20240621075647009
 tags: picture
+title: Open Collective Logo
 
-<svg xmlns="http://www.w3.org/2000/svg" xml:space="preserve" style="fill-rule:evenodd;clip-rule:evenodd;stroke-linejoin:round;stroke-miterlimit:2" viewBox="0 0 28 28"><path d="M25.509 6.026A13.934 13.934 0 0 1 28 14c0 2.963-.92 5.71-2.491 7.974l-3.626-3.627A8.96 8.96 0 0 0 23 14a8.964 8.964 0 0 0-1.117-4.347l3.626-3.627Z"/><path d="m21.974 2.49-3.627 3.628a9 9 0 1 0 0 15.765l3.627 3.626A13.934 13.934 0 0 1 14 27.999C6.268 28 0 21.733 0 14 0 6.269 6.268 0 14 0c2.963 0 5.711.922 7.974 2.492Z"/></svg>
+<svg style="fill-rule:evenodd;clip-rule:evenodd;stroke-linejoin:round;stroke-miterlimit:2" viewBox="0 0 28 28"><path d="M25.509 6.026A13.934 13.934 0 0 1 28 14c0 2.963-.92 5.71-2.491 7.974l-3.626-3.627A8.96 8.96 0 0 0 23 14a8.964 8.964 0 0 0-1.117-4.347l3.626-3.627Z"/><path d="m21.974 2.49-3.627 3.628a9 9 0 1 0 0 15.765l3.627 3.626A13.934 13.934 0 0 1 14 27.999C6.268 28 0 21.733 0 14 0 6.269 6.268 0 14 0c2.963 0 5.711.922 7.974 2.492Z"/></svg>

package/editions/tw5.com/tiddlers/macros/StylesheetMacros.tid

@@ -1,5 +1,5 @@
 created: 20150221181835000
-modified: 20150221223956000
+modified: 20230803034031256
 tags: Macros [[Core Macros]]
 title: Stylesheet Macros
 type: text/vnd.tiddlywiki
@@ -16,6 +16,8 @@ The following core [[macros|Macros]] make it easy to specify alternative browser
 : for the `x-transition-origin` properties
 ;`<<background-linear-gradient gradient>>`
 : for the `x-linear-gradient` values of the `background-image` property
+;`<<column-count columns>>`
+: for the `x-column-count` property
 
 The following macros are documented separately:
 

package/editions/tw5.com/tiddlers/macros/TabsMacro.tid

@@ -1,6 +1,6 @@
 caption: tabs
 created: 20131228162203521
-modified: 20210721122823354
+modified: 20240627201724476
 tags: Macros [[Core Macros]]
 title: tabs Macro
 type: text/vnd.tiddlywiki
@@ -34,7 +34,7 @@ By default the tabs are arranged horizontally above the content. To get vertical
 
 Within the template, the title of the selected tab is available in the <<.var currentTab>> variable.
 
-The <<.vlink currentTiddler>> variable is not affected by the <<.var tabs>> macro. This can put you in trouble if the list of tabs includes tiddlers that depend on the value of the <<.vlink currentTiddler>>, for example tiddlers listing children based on its own name. To overcome this problem you can use a [[TemplateTiddler|TemplateTiddlers]] like the following:
+The <<.vlink currentTiddler>> variable is not affected by the <<.var tabs>> macro. This can put you in trouble if the list of tabs includes tiddlers that depend on the value of the <<.vlink currentTiddler>>, for example tiddlers listing children based on its own name. To overcome this problem you can make use of the <<.vlink currentTab>> variable, which can be used in a [[TemplateTiddler|TemplateTiddlers]] such as the following:
 
 ```
 <$tiddler tiddler=<<currentTab>>>

package/editions/tw5.com/tiddlers/macros/TagMacro.tid

@@ -1,6 +1,6 @@
 caption: tag
 created: 20141206130540337
-modified: 20230725201240201
+modified: 20240228131301798
 tags: Macros [[Core Macros]]
 title: tag Macro
 type: text/vnd.tiddlywiki
@@ -11,7 +11,35 @@ The <<.def tag>> [[macro|Macros]] generates a tag pill for a specified tag. Clic
 
 !! Parameters
 
-;tag
+; tag
 : The title of the tag, defaulting to the [[current tiddler|Current Tiddler]]
 
+!! CSS classes
+
+<<.from-version "v5.3.4">>
+
+; `tc-tag-missing`
+: This class is defined if a tag does ''not exist'' as a tiddler.
+
+; `tc-tag-exists`
+: This class is defined if a tag does exist as a tiddler
+
+!!! Defining the class
+
+To define the `tc-tag-missing` class a stylesheet tiddler needs to be created. The default font-style for missing tiddler links is //italic//, so it's used for the example code below. Eg:
+
+''title:'' `myTagsStylesheet`<br>
+''tag:'' `$:/tags/Stylesheet`
+
+<<copy-to-clipboard-above-right src:"""
+.tc-tag-missing {
+	font-style: italic;
+}
+""">>
+```
+.tc-tag-missing {
+	font-style: italic;
+}
+```
+
 <<.macro-examples "tag">>

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

@@ -1,5 +1,5 @@
 created: 20150221211317000
-modified: 20230725203751870
+modified: 20240228131331605
 tags: [[tag Macro]] [[Macro Examples]]
 title: tag Macro (Examples)
 type: text/vnd.tiddlywiki
@@ -7,22 +7,26 @@ type: text/vnd.tiddlywiki
 <$macrocall $name=".example" n="1" eg="""<<tag>>"""/>
 <$macrocall $name=".example" n="2" eg="""<<tag Concepts>>"""/>
 
+The Following tag can be shown with a font-style: //italic// if the corresponding stylesheet exists. See: [[tag Macro]]
+
+<$macrocall $name=".example" n="3" eg="""<<tag "Does not exist">>"""/>
+
 If a [[list widget|ListWidget]] generates multiple tag macros for the same tag, clicking any of them opens dropdowns on all of them, as in the example below. This is usually unwanted.
-<$macrocall $name=".example" n="3" eg="""<$list filter="[tag[HelloThere]]">
+<$macrocall $name=".example" n="4" eg="""<$list filter="[tag[HelloThere]]">
 
 * <$link/> is tagged with: <$list filter="[<currentTiddler>tags[]]"> <<tag>> </$list>
 
 </$list>"""/>
 
 Adding the `counter="transclusion"` attribute to the list widget that generates multiple identical tag macros causes each of them to be identified as a unique one. Clicking on any of them opens only a single dropdown.
-<$macrocall $name=".example" n="4" eg="""<$list filter="[tag[HelloThere]]" counter="transclusion">
+<$macrocall $name=".example" n="5" eg="""<$list filter="[tag[HelloThere]]" counter="transclusion">
 
 * <$link/> is tagged with: <$list filter="[<currentTiddler>tags[]]"> <<tag>> </$list>
 
 </$list>"""/>
 
 A slightly more performant option is to use the `variable="transclusion"` attribute in the list widget. In this case, the variable `<<transclusion>>` has to be used inside the list widget instead of the `<<currentTiddler>>` .
-<$macrocall $name=".example" n="5" eg="""<$list filter="[tag[HelloThere]]" variable="transclusion">
+<$macrocall $name=".example" n="6" eg="""<$list filter="[tag[HelloThere]]" variable="transclusion">
 
 * <$link to=<<transclusion>>/> is tagged with: <$list filter="[<transclusion>tags[]]"> <<tag>> </$list>
 

package/editions/tw5.com/tiddlers/macros/import/tags-of-current-tiddler.tid

@@ -1,6 +1,7 @@
 code-body: yes
 created: 20150221145803000
+modified: 20240310124126491
 title: $:/editions/tw5.com/macro-examples/tags-of-current-tiddler
 type: text/vnd.tiddlywiki
 
-\define tags-of-current-tiddler() {{!!tags}}
+\procedure tags-of-current-tiddler() {{!!tags}}

package/editions/tw5.com/tiddlers/macros/import/tv-get-export-image-link.tid

@@ -1,6 +1,7 @@
+code-body: yes
 created: 20150228123855000
-modified: 20150228123921000
+modified: 20240310133309881
 title: $:/editions/tw5.com/macro-examples/tv-get-export-image-link
 type: text/vnd.tiddlywiki
 
-\define tv-get-export-image-link(src) https://www.tiddlywiki.com/$src$
+\function tv-get-export-image-link(src) [[https://www.tiddlywiki.com/$(src)$]substitute[]]

package/editions/tw5.com/tiddlers/macros/import/tv-wikilink-tooltip.tid

@@ -1,8 +1,9 @@
 code-body: yes
 created: 20150228120252000
+modified: 20240310124217005
 title: $:/editions/tw5.com/macro-examples/tv-wikilink-tooltip
 type: text/vnd.tiddlywiki
 
-\define tv-wikilink-tooltip()
+\procedure tv-wikilink-tooltip()
 <$transclude field="tooltip">(<$transclude field="caption"/>)</$transclude>
 \end

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

@@ -1,19 +1,19 @@
 caption: list-thumbnails
 created: 20200612170158838
-modified: 20200612171804473
+modified: 20230803033631967
 tags: Macros [[Core Macros]]
 title: list-thumbnails Macro
 type: text/vnd.tiddlywiki
 
-The <<.def list-thumbnails>> [[macros|Macros]] are used to create lists of linkable thumbnail panels.
+The <<.def list-thumbnails>> [[macros|Macros]] are used to create lists of linkable thumbnail panels. It assumes that the input has <<.field icon>>, <<.field color>>, <<.field background-color>>, <<.field image>>, and <<.field caption>> fields, filled as desired.
 
 !! Parameters
 
 ;filter
-: filter for selecting thumbnails
+: A [[filter|Filters]] for selecting thumbnails
 ;width
-:Width of thumbnail (default 280 pixels)
+: A width in px for the thumbnail, defaulting to `280`
 ;height
-:Height of thumbnail (default 157 pixels)
+: A height in px for the thumbnail, defaulting to `157`
 
 <<.macro-examples "list-thumbnails">>

package/editions/tw5.com/tiddlers/macros/syntax/Macro Call Syntax.tid

@@ -1,9 +1,13 @@
 created: 20150221105732000
 modified: 20150221222352000
-tags: [[Macro Syntax]]
+tags: [[Macro Syntax]] $:/deprecated
 title: Macro Call Syntax
 type: text/vnd.tiddlywiki
 
+<<.deprecated-since "5.3.0" "Procedure Call Syntax">>
+
+----------
+
 <<.preamble """What follows is a formal presentation of the syntax of the WikiText syntax for macro calls, using [[railroad diagrams|Railroad Diagrams]]. A [[simpler overview|Macro Calls in WikiText]] is also available.""">>
 
 <$railroad text="""

package/editions/tw5.com/tiddlers/macros/syntax/Macro Definition Syntax.tid

@@ -1,9 +1,13 @@
 created: 20150220200255000
 modified: 20150221222349000
-tags: [[Macro Syntax]]
+tags: [[Macro Syntax]] $:/deprecated
 title: Macro Definition Syntax
 type: text/vnd.tiddlywiki
 
+<<.deprecated-since "5.3.0" "Procedure Definition Syntax">>
+
+----------
+
 <<.preamble """What follows is a formal presentation of the syntax of the `\define` pragma, using [[railroad diagrams|Railroad Diagrams]]. A [[simpler overview|Macro Definitions in WikiText]] is also available.""">>
 
 <$railroad text="""

package/editions/tw5.com/tiddlers/macros/syntax/Procedure Call Syntax.tid

@@ -0,0 +1,33 @@
+created: 20240310165023000
+modified: 20240310172648116
+tags: [[Procedure Syntax]]
+title: Procedure Call Syntax
+type: text/vnd.tiddlywiki
+
+<<.preamble """What follows is a formal presentation of the syntax of the WikiText syntax for procedure calls, using [[railroad diagrams|Railroad Diagrams]].""">>
+
+!! procedure-name
+
+<$railroad text="""
+"<<" [[ procedure-name |Procedures]] [: [[whitespace|"Filter Whitespace"]] [:{param-value}] ]">>"
+"""/>
+
+* The [[procedure's|Procedures]] <<.place procedure-name>> is a sequence of non-whitespace characters other than `(` or `>`.
+
+* <<.place whitespace>> denotes a sequence of [[whitespace characters|Filter Whitespace]].
+
+!!! param-value
+
+Each ''individual'' <<.place param-value>> has the following syntax:
+
+<$railroad text="""
+\start none
+\end none
+[: param-name [:[[whitespace|"Filter Whitespace"]]] ":" [:[[whitespace|"Filter Whitespace"]]] ] value [: [[whitespace|"Filter Whitespace"]] ]
+"""/>
+
+* The <<.place param-name>> is a sequence of letters (`A`--`Z`, `a`--`z`), digits (`0`--`9`), hyphens (`-`) and underscores (`_`).
+
+* The <<.place value>> is specified as follows:
+
+<$railroad text={{$:/editions/tw5.com/railroad/macro-parameter-value}}/>

package/editions/tw5.com/tiddlers/macros/syntax/Procedure Definition Syntax.tid

@@ -0,0 +1,93 @@
+created: 20240310165023000
+modified: 20240310175033730
+tags: [[Procedure Syntax]]
+title: Procedure Definition Syntax
+type: text/vnd.tiddlywiki
+
+<<.preamble """What follows is a formal presentation of the syntax of the [[Pragma: \procedure]], using [[railroad diagrams|Railroad Diagrams]]. """>>
+
+! \procedure
+
+There are 2 types of procedure definitions
+
+* Single line definitions
+* Multi line definitions
+
+!! Single Line
+
+Single line definitions should only be used for very short bodies, where the procedure name, params and the body fit into 1 line terminated with a line-feed.
+
+<$railroad text="""
+"\procedure"
+[[<"space">|"Filter Whitespace"]]
+"procedure-name"
+<"(params)">
+[:[[<"space">|"Filter Whitespace"]]]
+"body"
+"lf"
+"""/>
+
+!! Multi Line
+
+The majority of procedure definitions will have a body, that spans over several lines of wikitext. Those procedure definitions are terminated using the "\end" pragma
+
+<$railroad text="""
+"\procedure"
+[[<"space">|"Filter Whitespace"]]
+"procedure-name"
+<"(params)">
+[:[[<"space">|"Filter Whitespace"]]]
+body
+"\end"
+"""/>
+
+The [[procedure-name|Procedures]] is a sequence of non-whitespace characters other than `(` or `>`.
+
+
+* <<.place procedure-name>> is a sequence of letters (`A`--`Z`, `a`--`z`), digits (`0`--`9`), hyphens (`-`) and underscores (`_`)
+* <<.place body>> is wikitext including [[nested procedures|Pragma: \procedure]]
+* <<.place space>> denotes a sequence of [[whitespace characters|Filter Whitespace]]
+
+!! params
+
+The parameter declaration list <<.place (params)>> has the following syntax:
+
+<$railroad text="""
+\start none
+\end none
+"(" [:"sep"] [:{ parameter "sep" }] ")"
+"""/>
+
+* <<.place sep>> is any sequence of characters that does not match a <<.place param-name>>. <br>Among other things, this includes commas, spaces and linefeeds.
+
+
+Each ''individual'' <<.place parameter>> has the following syntax:
+
+<$railroad text="""
+\start none
+\end none
+"param-name" [: [:[[<"space">|"Filter Whitespace"]]] ":" [:[[<"space">|"Filter Whitespace"]]] default ]
+"""/>
+
+* <<.place param-name>> is a sequence of letters (`A`--`Z`, `a`--`z`), digits (`0`--`9`), hyphens (`-`) and underscores (`_`).
+
+* <<.place default>> is an optional value of a parameter is specified as follows:
+
+<$railroad text={{$:/editions/tw5.com/railroad/macro-parameter-value}}/>
+
+!! body
+
+The <<.place body>> of the definition has the following syntax:
+
+<$railroad text="""
+\start none
+\end none
+{[[<"wikitext">|WikiText]] "lf"}  
+"""/>
+
+* <<.place wikitext>> is any sequence of characters that doesn't terminate the macro definition.
+** If [[nested procedures|Pragma: \procedure]] are used they need to be at the start of the wikitext. There are the same rules as if the wikitext would be in a tiddler. 
+** Pragmas need to be before standard wikitext.
+
+* <<.place lf>> denotes a linefeed.
+

package/editions/tw5.com/tiddlers/macros/syntax/Procedure Syntax.tid

@@ -0,0 +1,11 @@
+created: 20240310165023000
+modified: 20240310173318213
+tags: Procedures
+title: Procedure Syntax
+type: text/vnd.tiddlywiki
+
+Plain text description can be found at [[Procedures]]
+
+<<list-links filter:"[tag[Procedure Syntax]]">>
+
+<<.tip "The railroad boxes in the linked tiddlers can be used to navigate.">>

package/editions/tw5.com/tiddlers/macros/tag-picker_Macro.tid

@@ -1,6 +1,6 @@
 caption: tag-picker
 created: 20161128191316701
-modified: 20161128191435641
+modified: 20240708175550512
 tags: Macros [[Core Macros]]
 title: tag-picker Macro
 type: text/vnd.tiddlywiki
@@ -9,9 +9,18 @@ The <<.def tag-picker>> [[macro|Macros]] generates a combination of a text box a
 
 !! Parameters
 
-;actions
-: Action widgets to be triggered when the pill is clicked. Within the text, the variable ''tag'' contains the title of the selected tag.
-;tagField
-: <<.from-version 5.1.23>> The ''field'' that gets updated with the selected tag. Defaults to ''tags''.
+; actions
+: Action widgets to be triggered when the pill is clicked. Within the text, the variable <<.var tag>> contains the title of the selected tag.
+
+; tagField
+: <<.from-version 5.1.23>> The specified ''field'' that gets updated with the selected tag. Defaults to `tags`.
+
+; tiddler
+: <<.from-version 5.3.4>> Defines the target tiddler, which should be manipulated. Defaults to: <<.var currentTiddler>>.
+
+; tagListFilter
+: <<.from-version 5.3.4>> This parameter defaults to: `[tags[]]` which creates a list of all existing tags. If the tag list should come from a different source the filter should look similar to eg: `[<listSource>get[field-name]enlist-input[]]`. See examples.
+: <<.from-version 5.3.5>> This parameter defaults to: `[tags[]sort[]]`. This change allows a custom sort order, since `sort[]` is not hardcoded into the tag-picker macro anymore. 
+
 
 <<.macro-examples "tag-picker">>

package/editions/tw5.com/tiddlers/macros/thumbnail Macro.tid

@@ -1,14 +1,29 @@
 caption: thumbnail
 created: 20150325172203603
-modified: 20150325172336079
+modified: 20230803033450805
 tags: Macros [[Core Macros]]
 title: thumbnail Macro
 type: text/vnd.tiddlywiki
 
-The <<.def thumbnail>> [[macros|Macros]] are used to create linkable thumbnail panels.
+The <<.def thumbnail>> [[macro|Macros]] is used to create linkable thumbnail panels. An alternative <<.def thumbnail-right>> macro uses the same parameters, but floats to the right of its container.
 
 !! Parameters
 
-(none)
+;link
+: The tiddler to link to
+;icon
+: An icon to place in the center of the thumbnail. Must be enclosed in curly brackets
+;color
+: A color for the icon
+;background-color
+: A background color if there is no image. Does not show if the image has transparency
+;image
+: A background image for the thumbnail
+;caption
+: A caption for the element
+;width
+: A width in px for the thumbnail, defaulting to `280`
+;height
+: A height in px for the thumbnail, defaulting to `157`
 
-<<.macro-examples "thumbnail">>
+<<.macro-examples "thumbnail">>

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

@@ -1,5 +1,5 @@
 created: 20130826122000000
-modified: 20220613124446953
+modified: 20240520162828577
 tags: Mechanisms
 title: PluginMechanism
 type: text/vnd.tiddlywiki
@@ -16,6 +16,10 @@ By convention, plugin titles have the form `$:/plugins/<publisher>/<name>`. Plug
 
 When [[running TiddlyWiki under Node.js|TiddlyWiki on Node.js]], plugins can also be stored as individual tiddler files in [[PluginFolders]].
 
+! Plugin Stability
+
+{{Plugin Stability}}
+
 ! Plugin Types
 
 {{Plugin Types}}

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

@@ -12,6 +12,6 @@ The rules governing refresh throttling are:
 ** 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)
+* 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 previously 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/WikificationMechanism.tid

@@ -1,5 +1,5 @@
 created: 20191012080221911
-modified: 20191013094002890
+modified: 20230803052515281
 tags: Mechanisms
 title: WikificationMechanism
 type: text/vnd.tiddlywiki
@@ -8,8 +8,8 @@ type: text/vnd.tiddlywiki
 
 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
+* [[ParserMechanism|WikiText parser mode transitions]]: 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|Widgets]]: 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:

package/editions/tw5.com/tiddlers/messages/WidgetMessage_ tm-copy-to-clipboard.tid

@@ -1,6 +1,6 @@
 caption: tm-copy-to-clipboard
 created: 20171215150056004
-modified: 20171215150600888
+modified: 20240523174013095
 tags: Messages
 title: WidgetMessage: tm-copy-to-clipboard
 type: text/vnd.tiddlywiki
@@ -11,6 +11,8 @@ It requires the following properties on the `event` object:
 
 |!Name |!Description |
 |param |Text to be copied to the clipboard |
+|successNotification |<<.from-version "5.3.4">> Optional title of tiddler containing notification to be used if the operation succeeds |
+|failureNotification |<<.from-version "5.3.4">> Optional title of tiddler containing notification to be used if the operation fails |
 
 This message is usually generated with the ButtonWidget. It is handled by the TiddlyWiki core.
 

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

@@ -1,6 +1,6 @@
 caption: tm-edit-bitmap-operation
 created: 20160424204236050
-modified: 20230723214716576
+modified: 20230803045807664
 tags: Messages
 title: WidgetMessage: tm-edit-bitmap-operation
 type: text/vnd.tiddlywiki
@@ -37,7 +37,7 @@ A `tm-edit-bitmap-operation` invokes one of the available operations on a __surr
 |//{any other params}// |Any other parameters are made available as variables within the context of the widget message. |
 
 
-The `tm-edit-bitmap-operation` message is usually generated by a ButtonWidget or an ActionWidget and is handled by the surrounding bitmap editor.
+The `tm-edit-bitmap-operation` message is usually generated by a ButtonWidget or an [[ActionWidget|ActionWidgets]] and is handled by the surrounding bitmap editor.
 
 ! Bitmap Operations
 

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

@@ -1,6 +1,6 @@
 caption: tm-edit-text-operation
 created: 20160424211339792
-modified: 20230723214636245
+modified: 20230803045746596
 tags: Messages
 title: WidgetMessage: tm-edit-text-operation
 type: text/vnd.tiddlywiki
@@ -123,7 +123,7 @@ A `tm-edit-text-operation` invokes one of the available operations on a __surrou
 |param |Name of the operation to be executed, see ''below'' for a list of possible operations |
 |//{any other params}// |Any other parameters are made available as variables within the context of the widget message. |
 
-The `tm-edit-text-operation` message is usually generated by a ButtonWidget or an ActionWidget and is handled by the surrounding text editor.
+The `tm-edit-text-operation` message is usually generated by a ButtonWidget or an [[ActionWidget|ActionWidgets]] and is handled by the surrounding text editor.
 
 ! Text Operations
 

package/editions/tw5.com/tiddlers/messages/WidgetMessage_ tm-http-request Example Basic Authentication.tid

@@ -0,0 +1,34 @@
+title: WidgetMessage: tm-http-request Example - Basic Authentication
+tags: $:/tags/Global
+
+
+!! HTTP Basic Authentication
+
+[[HTTP Basic Authentication|https://en.wikipedia.org/wiki/Basic_access_authentication]] is a simple scheme for HTTP clients pass a username and password to an HTTP server.
+
+The credentials are passed via the "Authorization" header as the string "Basic " (note the space) followed by the base64-encoded username and password joined with a colon.
+
+Here is a simple, illustrative example:
+
+```
+\procedure get-tiddler-list-from-tiddlywiki-server(url,username,password)
+	\procedure completion-get-json()
+	\import [subfilter{$:/core/config/GlobalImportFilter}]
+		<$action-log msg="In completion-get-json"/>
+		<$action-log/>
+	\end completion-get-json
+	<$action-sendmessage
+		$message="tm-http-request"
+		url=<<url>>
+		method="GET"
+		header-Authorization={{{ [<username>addsuffix[:]addsuffix<password>encodebase64[]addprefix[Basic ]] }}}
+		oncompletion=<<completion-get-json>>
+	/>
+\end get-tiddler-list-from-tiddlywiki-server
+
+<$button>
+<<get-tiddler-list-from-tiddlywiki-server url:"http://127.0.0.1:8080" username:"Joe" password:"Bloggs">>
+Download
+</$button>
+```
+

package/editions/tw5.com/tiddlers/messages/WidgetMessage_ tm-http-request Example Random Dog.tid

@@ -1,5 +1,5 @@
 title: WidgetMessage: tm-http-request Example - Random Dog
-tags: $:/tags/Global
+tags: $:/tags/Macro $:/tags/Global
 
 \procedure download-dog(url)