tiddlywiki 5.2.1 → 5.2.2

package/editions/tw5.com/tiddlers/saving/Saving with Polly.tid

@@ -0,0 +1,29 @@
+caption: Polly
+color: #29B6F6
+community-author: TiddlyTweeter
+created: 20220223153410510
+delivery: Service
+description: Batch script for saving downloaded TiddlyWiki files.
+method: save
+modified: 20220223160414274
+tags: Chrome Firefox [[Internet Explorer]] Linux Mac Opera Safari Saving Windows Edge
+title: Saving with Polly
+type: text/vnd.tiddlywiki
+
+[[Polly|https://github.com/Marxsal/polly]] is a batch file system using Windows //~PowerShell// to restore ~TiddlyWiki files from a specified download directory to their original home directory.
+
+Effectively, this becomes a new way to save your files, but with these features:
+
+* No binary executables
+* Human-readable batch script.
+* No special plugins in your ~TiddlyWiki file
+* No special browser required
+* No browser extension required.
+* No need for node.exe running in background
+* Total size expanded package only 100k
+* Backups as regular file and/or zip to specified directories
+* The ability to "parrot" extra copies to target directories (e.g. a Dropbox folder)
+
+It should be able to run anywhere that //~PowerShell// runs, including Windows, Linux, and Mac.
+
+https://github.com/Marxsal/polly

package/editions/tw5.com/tiddlers/system/doc-macros.tid

@@ -1,5 +1,5 @@
 created: 20150117152607000
-modified: 201804111739
+modified: 20211230150413997
 tags: $:/tags/Macro
 title: $:/editions/tw5.com/doc-macros
 type: text/vnd.tiddlywiki
@@ -113,6 +113,20 @@ This is an example tiddler. See [[Table-of-Contents Macros (Examples)]].
 </$list>
 \end
 
+\define .bad-example(eg)
+<table class="doc-bad-example">
+<tbody>
+<tr class="evenRow">
+<td><span class="tc-inline-style" style="font-size:1.5em;">&#9888;</span> Warning:<br> Don't do it this way!</td>
+<td>
+
+$eg$
+</td>
+</tr>
+</tbody>
+</table>
+\end
+
 \define .link-badge(text,link,colour)
 <a href=<<__link__>> class="doc-link-badge" style="background-color:$colour$;" target="_blank" rel="noopener noreferrer"><$text text=<<__text__>>/></a>
 \end
@@ -147,4 +161,14 @@ This is an example tiddler. See [[Table-of-Contents Macros (Examples)]].
 </$tiddler>
 \end
 
+\define .banner-credits(credit,url)
+<img src=<<__url__>> width="140" style="float:left;margin-right:0.5em;"/>
+
+$credit$
+
+<div style="clear:both;">
+
+</div>
+\end
+
 <pre><$view field="text"/></pre>

package/editions/tw5.com/tiddlers/system/doc-styles.tid

@@ -1,5 +1,5 @@
 created: 20150117152612000
-modified: 20211124164948726
+modified: 20211230150725145
 tags: $:/tags/Stylesheet
 title: $:/editions/tw5.com/doc-styles
 type: text/vnd.tiddlywiki
@@ -133,6 +133,10 @@ td svg {
 	padding-left: 20px;
 }
 
+.doc-bad-example code, .doc-bad-example pre, table.doc-bad-example {
+  background-color:#ffff80;
+}
+
 .doc-table th, .doc-table tr {
 	vertical-align: top;
 }

package/editions/tw5.com/tiddlers/system/download-empty.tid

@@ -1,4 +1,5 @@
 title: $:/editions/tw5.com/download-empty
+code-body: yes
 
 \define saveTiddlerFilter()
 [[$:/core]] [[$:/isEncrypted]] [[$:/themes/tiddlywiki/snowwhite]] [[$:/themes/tiddlywiki/vanilla]] -[[$:/boot/boot.css]] -[type[application/javascript]library[yes]] -[[$:/boot/boot.js]] -[[$:/boot/bootprefix.js]] +[sort[title]]

package/editions/tw5.com/tiddlers/system/operator-macros.tid

@@ -1,7 +1,7 @@
 created: 20150117152607000
-modified: 20150228114306000
-title: $:/editions/tw5.com/operator-macros
+modified: 20220227210111054
 tags: $:/tags/Macro
+title: $:/editions/tw5.com/operator-macros
 
 \define .operator-examples(op,text:"Examples") <$link to="$op$ Operator (Examples)">$text$</$link>
 
@@ -48,3 +48,5 @@ tags: $:/tags/Macro
 <$macrocall $name=".note" _="This operator is <<.em not>> available when ~TiddlyWiki is running in a web browser."/>
 
 \end
+
+<pre><$view field="text"/></pre>

package/editions/tw5.com/tiddlers/system/operator-template.tid

@@ -1,8 +1,8 @@
 created: 20150203173506000
-modified: 20150203181725000
-title: $:/editions/tw5.com/operator-template
-tags: $:/tags/ViewTemplate
 list-before: $:/core/ui/ViewTemplate/body
+modified: 20220316121232243
+tags: $:/tags/ViewTemplate
+title: $:/editions/tw5.com/operator-template
 
 \define .op-place()
 <$macrocall $name=".if"
@@ -71,6 +71,9 @@ list-before: $:/core/ui/ViewTemplate/body
 </$set>
 <!-- -->
 </table>
+
+[[Learn more about how to use Filters|Filters]]
+
 <$list filter="[all[current]has[from-version]]" variable="listItem">
 <$macrocall $name=".from-version" version={{!!from-version}}/>
 </$list>

package/editions/tw5.com/tiddlers/system/style-guide-macros.tid

@@ -1,5 +1,7 @@
-title: $:/editions/tw5.com/style-guide-macros
+created: 20220227210120989
+modified: 20220227210123695
 tags: $:/tags/Macro
+title: $:/editions/tw5.com/style-guide-macros
 
 \define style-guide(good,bad)
 <table>
@@ -15,3 +17,5 @@ tags: $:/tags/Macro
 </tbody>
 </table>
 \end
+
+<pre><$view field="text"/></pre>

package/editions/tw5.com/tiddlers/system/variable-macros.tid

@@ -1,7 +1,7 @@
 created: 20150228114241000
-modified: 20150228141312000
-title: $:/editions/tw5.com/variable-macros
+modified: 20220227210136243
 tags: $:/tags/Macro
+title: $:/editions/tw5.com/variable-macros
 
 \define .variable-examples(v,text:"Examples") <$link to="$v$ Variable (Examples)">$text$</$link>
 \define .macro-examples(m,text:"Examples") <$link to="$m$ Macro (Examples)">$text$</$link>
@@ -17,3 +17,5 @@ It can be set to <<.value yes>> or <<.value no>> prior to transcluding such a bu
 
 The standard page template sets it to the value found in [[$configTiddler$]], with the result that this becomes the default for the whole page. The user can adjust this default by using a tickbox on the <<.controlpanel-tab Settings>> tab of the [[Control Panel|$:/ControlPanel]].
 \end
+
+<pre><$view field="text"/></pre>

package/editions/tw5.com/tiddlers/system/wikitext-macros.tid

@@ -1,7 +1,8 @@
 created: 20150117184156000
-modified: 20150117184616000
-title: $:/editions/tw5.com/wikitext-macros
+modified: 20220227210152153
 tags: $:/tags/Macro
+title: $:/editions/tw5.com/wikitext-macros
+type: text/vnd.tiddlywiki
 
 \define wikitext-example(src)
 <div class="doc-example">
@@ -43,6 +44,17 @@ $$$
 </div>
 \end
 
+\define wikitext-example-table-header() <thead><tr><th/><th>wiki text</th><th>renders as</th></tr></thead>
+
+\define wikitext-example-table-row(id, code)
+ <tr>
+<th><<__id__>></th><td><$codeblock code=<<__code__>>/></td><td>
+
+<<__code__>>
+</td>
+</tr>
+\end
+
 \define tw-code(tiddler)
 <$codeblock language={{$tiddler$!!type}} code={{$tiddler$}}/>
 \end
@@ -51,4 +63,6 @@ $$$
 [[$tiddler$]]:
 
 <<tw-code $tiddler$>>
-\end
+\end
+
+<pre><$view field="text"/></pre>

package/editions/tw5.com/tiddlers/webserver/Using HTTPS.tid

@@ -1,12 +1,14 @@
 created: 20180702160923664
-modified: 20180703100549667
+modified: 20211111023610539
 tags: [[WebServer Guides]]
 title: Using HTTPS
 type: text/vnd.tiddlywiki
 
 By default, TiddlyWiki's WebServer serves resources over the insecure HTTP protocol. The risk is minimal if it is only being used within a private, trusted network but in many situations it is desirable to use a secure HTTPS connection.
 
-HTTPS requires the server to be configured with a certificate via a "cert" file and a "key" file, configured via the [[tls-cert|WebServer Parameter: tls-cert]] and [[tls-key|WebServer Parameter: tls-key]] parameters
+HTTPS requires the server to be configured with a certificate via a "cert" file and a "key" file, configured via the [[tls-cert|WebServer Parameter: tls-cert]] and [[tls-key|WebServer Parameter: tls-key]] parameters.
+
+<<.from-version "5.2.2">> The optional [[tls-passphrase|WebServer Parameter: tls-passphrase]] parameter allows the server to use certificate files that have been generated with a passphrase/password.
 
 Certificates can be obtained from a certification authority such as https://letsencrypt.org/, or you can create a self-signed certificate for internal testing.
 
@@ -17,3 +19,16 @@ openssl req -newkey rsa:2048 -new -nodes -keyout mywikifolder/key.pem -out mywik
 openssl x509 -req -days 365 -in mywikifolder/csr.pem -signkey mywikifolder/key.pem -out mywikifolder/server.crt
 tiddlywiki mywikifolder --listen username=joe password=bloggs tls-key=key.pem tls-cert=server.crt
 ```
+
+If using a [[tls-passphrase|WebServer Parameter: tls-passphrase]] to generate the certificate files, the commands would change as below:
+
+* remove the `-nodes` flag, which specifies "no encryption"
+* replace `TLS_PASSPHRASE` in the `-passout` and `-passin` parameters in the below commands with your chosen string.
+
+This is the simplest, but __least secure method,__ of passing a passphrase to the certificate utility. See [[this Stack Exchange anwser on openssl certificates|https://security.stackexchange.com/questions/106525/generate-csr-and-private-key-with-password-with-openssl]] and the [[openssl|https://www.openssl.org/docs/man1.0.2/man1/openssl.html]] and [[openssl-passphrase-options|https://www.openssl.org/docs/manmaster/man1/openssl-passphrase-options.html]] page in the openssl utility documentation.
+
+```
+openssl req -newkey rsa:2048 -passout pass:TLS_PASSPHRASE -new -keyout mywikifolder/key.pem -out mywikifolder/csr.pem -passout pass:TLS_PASSPHRASE
+openssl x509 -req -days 365 -in mywikifolder/csr.pem -signkey mywikifolder/key.pem -out mywikifolder/server.crt -passin pass:TLS_PASSPHRASE
+tiddlywiki mywikifolder --listen username=joe password=bloggs tls-key=key.pem tls-cert=server.crt tls-passphrase=TLS_PASSPHRASE
+```

package/editions/tw5.com/tiddlers/webserver/WebServer API_ Get All Tiddlers.tid

@@ -20,7 +20,7 @@ In order to avoid denial of service attacks with malformed filters in the defaul
 To enable a particular filter, create a tiddler with the title "$:/config/Server/ExternalFilters/" concatenated with the filter text, and the text field set to "yes". For example, the TiddlyWeb plugin includes the following shadow tiddler to enable the filter that it requires:
 
 ```
-title: $:/config/Server/ExternalFilters/[all[tiddlers]] -[[$:/isEncrypted]] -[prefix[$:/temp/]] -[prefix[$:/status/]]
+title: $:/config/Server/ExternalFilters/[all[tiddlers]] -[[$:/isEncrypted]] -[prefix[$:/temp/]] -[prefix[$:/status/]] -[[$:/boot/boot.js]] -[[$:/boot/bootprefix.js]] -[[$:/library/sjcl.js]] -[[$:/core]]
 text: yes
 ```
 

package/editions/tw5.com/tiddlers/webserver/WebServer Authorization.tid

@@ -1,18 +1,24 @@
 created: 20180630194006239
-modified: 20180904174030250
+modified: 20211122004159427
 tags: WebServer
 title: WebServer Authorization
 type: text/vnd.tiddlywiki
 
-''Authorization'' is the process of determining which resources may be accessed by a particular user. It occurs after [[authentication|WebServer Authentication]] has determined the identity of the user. TiddlyWiki's WebServer implements a simple authorization scheme which permits independent control of who has read and write access to a wiki.
+''Authorization'' is the process of determining which resources may be accessed by a particular user. It occurs after [[authentication|WebServer Authentication]] has determined the identity of the user. TiddlyWiki's WebServer implements a simple authorization scheme which permits independent control of who has administrator access to the server, and read and write access to a wiki.
 
-The WebServer parameters [[readers|WebServer Parameter: readers]] and [[writers|WebServer Parameter: writers]] each contain a comma separated list of //principals// (which is to say, either usernames or certain special tokens) which should have read or write access respectively.
+The WebServer parameters [[admin|WebServer Parameter: admin]], [[readers|WebServer Parameter: readers]] and [[writers|WebServer Parameter: writers]] each contain a comma separated list of //principals// (which is to say, either usernames or certain special tokens) which should have read or write access respectively. 
 
 The available special tokens are:
 
 * ''(anon)'' - indicates all anonymous users
 * ''(authenticated)'' - indicates all authenticated users
 
+!! Admin Functions
+
+<<.tip"""The ''(anon)'' token is not valid for the [[admin|WebServer Parameter: admin]] parameter.""">>
+
+At this time, no server functions are restricted to ''admin'' authorized users in the unmodified [[Tiddlywiki server|WebServer]]. Third party plugins can leverage this to restrict routes or commands to a subset of authorized users.
+
 !! Read-only Mode
 
 Read-only mode is engaged when the current user is not authorized to write to the current wiki.
@@ -39,3 +45,9 @@ In the following example, read access is granted to all authenticated users, but
 ```
 tiddlywiki mywikifolder --listen credentials=myusers.csv "readers=(authenticated)" writers=mary
 ```
+
+In the following example, read and write access is granted to all authenticated users, but only "mary" is granted admin access:
+
+```
+tiddlywiki mywikifolder --listen credentials=myusers.csv "readers=(authenticated)" "writers=(authenticated)" admin=mary
+```

package/editions/tw5.com/tiddlers/webserver/WebServer Parameter_ admin.tid

@@ -0,0 +1,8 @@
+caption: admin
+created: 20211111015634164
+modified: 20211111023141767
+tags: [[WebServer Parameters]]
+title: WebServer Parameter: admin
+type: text/vnd.tiddlywiki
+
+<<.from-version "5.2.2">> The [[web server configuration parameter|WebServer Parameters]] ''admin'' is used to specify the security principals with administrator access to the [[WebServer]]. Does not accept the ''(anon)'' special token. See [[WebServer Authorization]] for more details.

package/editions/tw5.com/tiddlers/webserver/WebServer Parameter_ required-plugins.tid

@@ -0,0 +1,8 @@
+caption: required-plugins
+created: 20211226160733000
+modified: 20211226160754000 
+tags: [[WebServer Parameters]]
+title: WebServer Parameter: required-plugins
+type: text/vnd.tiddlywiki
+
+<<.from-version "5.2.2">> The [[web server configuration parameter|WebServer Parameters]] ''required-plugins'' is used to specify the plugins required to start the [[WebServer]]. It take a comma seperated list of plugin titles. The WebServer will issue a warnign in the console if the required plugins are not loaded. This parameter defaults to `$:/plugins/tiddlywiki/filesystem,$:/plugins/tiddlywiki/tiddlyweb`.

package/editions/tw5.com/tiddlers/webserver/WebServer Parameter_ tls-passphrase.tid

@@ -0,0 +1,10 @@
+caption: tls-passphrase
+created: 20211111004416873
+modified: 20211111022120158
+tags: [[WebServer Parameters]]
+title: WebServer Parameter: tls-passphrase
+type: text/vnd.tiddlywiki
+
+<<.from-version "5.2.2">> The optional [[web server configuration parameter|WebServer Parameters]] ''tls-passphrase'' contains the "certificate passphrase", a string used to decrypt the certificate file used when running the web server under HTTPS.
+
+See [[Using HTTPS]] for details.

package/editions/tw5.com/tiddlers/widgets/$__editions_tw5.com_widget-examples_qualify-transcluded.tid

@@ -0,0 +1,14 @@
+created: 20220125161941555
+modified: 20220125162920771
+tags: [[Widget Examples]]
+title: $:/editions/tw5.com/widget-examples/qualify-transcluded
+type: text/vnd.tiddlywiki
+
+<$macrocall $name=".example" n="1"
+eg="""<$qualify title="BaseTiddler" name="iamnotanumber">
+<ul>
+<li><code><<iamnotanumber>></code></li>
+<li><code><<transclusion>></code></li>
+</ul>
+</$qualify>
+"""/>

package/editions/tw5.com/tiddlers/widgets/DraggableWidget.tid

@@ -1,6 +1,6 @@
 caption: draggable
 created: 20170406081938627
-modified: 20211009122105437
+modified: 20220223145136863
 tags: Widgets TriggeringWidgets
 title: DraggableWidget
 type: text/vnd.tiddlywiki
@@ -16,8 +16,10 @@ See DragAndDropMechanism for an overview.
 |!Attribute |!Description |
 |tiddler |Optional title of the payload tiddler for the drag |
 |filter |Optional filter defining the payload tiddlers for the drag |
-|class |Optional CSS classes to assign to the draggable element. The class `tc-draggable` is added automatically, and the class `tc-dragging` is applied while the element is being dragged |
-|tag |Optional tag to override the default "div" element |
+|tag |Optional tag to override the default "div" element created by the widget|
+|selector|<<.from-version 5.2.2>> Optional CSS Selector to identify a DOM element within the widget that will be used as the drag handle |
+|class |Optional CSS classes to assign to the DOM element created by the widget. The class `tc-draggable` is added to the drag handle, which is the same as the DOM element created by the widget unless the <<.param selector>> attribute is used. The class `tc-dragging` is applied to the drag handle while the element is being dragged |
+
 |startactions |Optional action string that gets invoked when dragging ''starts'' |
 |endactions |Optional action string that gets invoked when dragging ''ends'' |
 |dragimagetype |<<.from-version "5.2.0">> Optional type of drag image: `dom` (the default) or `blank` to disable the drag image |
@@ -28,5 +30,7 @@ The [[actionTiddler Variable]] is accessible in both //startactions// and //enda
 
 <<.tip """Note that the [[actionTiddler Variable]] holds a [[Title List]] quoted with double square brackets. This is unlike the DroppableWidget which uses the same variable to pass a single unquoted title.""">>
 
+<<.tip """When specifying a DOM node to use as the drag handle with the <<.param selector>> attribute, give it the class `tc-draggable` in order for it to have the appropriate cursor.""">>
+
 
 The LinkWidget incorporates the functionality of the DraggableWidget via the ''draggable'' attribute.

package/editions/tw5.com/tiddlers/widgets/EditTextWidget.tid

@@ -28,7 +28,7 @@ The content of the `<$edit-text>` widget is ignored.
 |autocomplete |<<.from-version 5.1.23>> An optional string to provide a hint to the browser how to handle autocomplete for this input |
 |tag |Overrides the generated HTML editing element tag. For a multi-line editor use `tag=textarea`. For a single-line editor use `tag=input` |
 |type |Overrides the generated HTML editing element `type` attribute |
-|size |The size of the input field (in characters) |
+|size |The size of the input field (in characters). This exact result depends on browser and font. Use the `class` attribute to style width for precise control |
 |autoHeight |Either "yes" or "no" to specify whether to automatically resize `textarea` editors to fit their content (defaults to "yes") |
 |minHeight |Minimum height for automatically resized `textarea` editors, specified in CSS length units such as "px", "em" or "%" |
 |rows|Sets the rows attribute of a generated textarea |

package/editions/tw5.com/tiddlers/widgets/EventCatcherWidget.tid

@@ -1,5 +1,5 @@
 created: 20201123113532200
-modified: 20211031180336257
+modified: 20220311154749139
 tags: Widgets TriggeringWidgets
 title: EventCatcherWidget
 type: text/vnd.tiddlywiki
@@ -12,11 +12,12 @@ type: text/vnd.tiddlywiki
 
 The event catcher widget traps DOM-initiated Javascript events dispatched within its child content, and allows invoking a series of ActionWidgets in response to those events. 
 
-In order for the events to be trapped they must:
+In order for the events to be trapped:
 
-* be of one of the events specified in the event catcher widget's `events` attribute
-* arise within a DOM node specified by the widget's `selector` attribute
-* support event bubbling
+* The event must be of one of the events specified in the event catcher widget's `events` attribute
+* The event must target a DOM node with an ancestor that matches the widget's `selector` attribute
+* <<.from-version "5.2.2">> Optionally, the DOM node targetted by the event must also match the widgets `matchSelector` attribute
+* The event must support event bubbling
 
 Use of the event catcher widget is beneficial when using large numbers of other trigger widgets such as the ButtonWidget is causing performance problems. The workflow it enables is akin to what is referred to as "event delegation" in JavaScript parlance.
 
@@ -25,8 +26,8 @@ Use of the event catcher widget is beneficial when using large numbers of other
 The content of the `<$eventcatcher>` widget is displayed normally.
 
 |!Attribute |!Description |
-
 |selector |A CSS selector. Only events originating inside a DOM node with this selector will be trapped |
+|matchSelector |<<.from-version "5.2.2">> An optional CSS selector. Only events targetting DOM nodes matching this selector will be trapped |
 |//{any attributes starting with $}// |<<.from-version "5.2.0">> Each attribute name (excluding the $) specifies the name of an event, and the value specifies the action string to be invoked. For example: `$click=<<clickActions>>`  |
 |tag |Optional. The HTML element the widget creates to capture the events, defaults to:<br>» `span` when parsed in inline-mode<br>» `div` when parsed in block-mode |
 |class |Optional. A CSS class name (or names) to be assigned to the widget HTML element |

package/editions/tw5.com/tiddlers/widgets/ImageWidget.tid

@@ -1,6 +1,6 @@
 title: ImageWidget
 created: 20140416160234142
-modified: 20140820100234142
+modified: 20220101205921813
 tags: Widgets
 caption: image
 
@@ -22,6 +22,14 @@ Any content of the `<$image>` widget is ignored.
 
 The width and the height can be specified as pixel values (eg "23" or "23px") or percentages (eg "23%"). They are both optional; if not provided the browser will use CSS rules to size the image.
 
+! Image Status Classes
+
+<<from-version "5.2.2">> The following CSS classes are automatically added to the `<img>` element to indicate the status of the image. Note that only one of these classes will be added at the same time.
+
+|''tc-image-loading'' |When the image is being loaded |
+|''tc-image-loaded'' |The image has been loaded successfully |
+|''tc-image-error'' |The image could not be loaded |
+
 ! External Images and the ''_canonical_uri'' field
 
 When used to display tiddler-based images, the image widget operates in two distinct modes:

package/editions/tw5.com/tiddlers/widgets/LinkCatcherWidget.tid

@@ -1,6 +1,6 @@
 caption: linkcatcher
 created: 20131024141900000
-modified: 20211009122821108
+modified: 20220226121122574
 tags: Widgets MessageHandlerWidgets TriggeringWidgets
 title: LinkCatcherWidget
 type: text/vnd.tiddlywiki
@@ -25,3 +25,4 @@ The content of the `<$linkcatcher>` widget is displayed normally.
 |setTo |Value to be assigned by the `set` attribute |
 |actions |Actions to be performed when a link is caught. Within the action string, the variable "navigateTo" contains the title of the tiddler being navigated. <<.from-version "5.1.23">> the <<.def "modifier">> variable lists the modifier keys that are pressed when the action is invoked. The possible modifiers are ''ctrl'', ''ctrl-alt'', ''ctrl-shift'', ''alt'', ''alt-shift'', ''shift'' and ''ctrl-alt-shift'' |
 
+<<.tip """<<.from-version "5.2.0">> For more complex use cases involving trapping the <<.param tm-navigate>> message consider the MessageCatcherWidget which provides greater flexibility""">>

package/editions/tw5.com/tiddlers/widgets/MacroCallWidget.tid

@@ -1,6 +1,6 @@
 caption: macrocall
 created: 20131024141900000
-modified: 20200928102843275
+modified: 20220122193731433
 tags: Widgets
 title: MacroCallWidget
 type: text/vnd.tiddlywiki
@@ -38,6 +38,8 @@ You can see several examples of the macro call widget within the core:
 * Listing field information: [[$:/snippets/allfields]]
 * Generating `data:` URIs: [[$:/themes/tiddlywiki/starlight/styles.tid]]
 
+See also [[WikiText parser mode: macro examples]]
+
 ! Content and Attributes
 
 The content of the `<$macrocall>` widget is ignored.

package/editions/tw5.com/tiddlers/widgets/MessageCatcherWidget.tid

@@ -1,5 +1,5 @@
 created: 20210309133636211
-modified: 20211009122821123
+modified: 20211222153049771
 tags: Widgets MessageHandlerWidgets TriggeringWidgets
 title: MessageCatcherWidget
 type: text/vnd.tiddlywiki
@@ -37,7 +37,7 @@ The message catcher widget sets the following variables within each action strin
 <$action-log/>
 \end
 
-<$messagecatcher type="tm-navigate" actions=<<actions>>>
+<$messagecatcher $tm-navigate=<<actions>>>
 
 Click on [[this link]] to fire an action. See the browser JavaScript console for the output
 

package/editions/tw5.com/tiddlers/widgets/QualifyWidget.tid

@@ -0,0 +1,39 @@
+caption: vars
+created: 20220125160004463
+modified: 20220125163041347
+tags: Widgets
+title: QualifyWidget
+
+! Introduction
+
+The <<.wid qualify>> widget sets a variable
+to a unique string that encodes its position within the widget tree, as identified by the stack of transcluded tiddlers that lead to that position.
+
+Internally, it is implemented using the transclusion variable.
+
+! Content and Attributes
+
+The content of the <<.wid qualify>> widget is the scope for the value assigned to the <<.var name>> variable.
+
+|!Attribute |!Description |
+|//title// |The prefix for the string, normally a tiddler title |
+|//name// |The name of the variable to be set to the unique string |
+
+! Examples
+
+The two examples below are identical, but produce different results because the second one has been transcluded from [[another tiddler|$:/editions/tw5.com/widget-examples/qualify-transcluded]].
+
+Each example shows the result of calling <<.var qualify>> and then the value of the <<.vlink transclusion>> variable.
+<$macrocall $name=".example" n="1"
+eg="""<$qualify title="BaseTiddler" name="iamnotanumber">
+<ul>
+<li><code><<iamnotanumber>></code></li>
+<li><code><<transclusion>></code></li>
+</ul>
+</$qualify>
+"""/>
+{{$:/editions/tw5.com/widget-examples/qualify-transcluded}}
+
+! Remarks
+
+In most cases it will be simpler to use the [[qualify Macro]].

package/editions/tw5.com/tiddlers/widgets/TranscludeWidget.tid

@@ -1,9 +1,9 @@
+caption: transclude
 created: 20130824142500000
-modified: 20140717175900970
+modified: 20220122190609396
 tags: Widgets
 title: TranscludeWidget
 type: text/vnd.tiddlywiki
-caption: transclude
 
 ! Introduction
 
@@ -22,12 +22,12 @@ The TranscludeWidget treats any contained content as a fallback if the target of
 
 ! Parsing modes
 
-TiddlyWiki parses text in two modes:
+TiddlyWiki [[parses text in two modes|WikiText Parser Modes]]:
 
-* ''inline'' mode recognises character formatting such as emphasis, links
-* ''block'' mode recognises all the ''inline'' formatting, and adds block formatting such as tables, headings and lists
+* [[inline mode|Inline Mode WikiText]] recognises character formatting such as emphasis, links
+* [[block mode|Block Mode WikiText]] recognises all the ''inline'' formatting, and adds block formatting such as tables, headings and lists
 
-Usually, the mode is determined by whether the transclude widget itself has been parsed in block or inline mode. This can be overridden with the `mode` attribute.
+Usually, the mode is determined by whether the transclude widget itself has been parsed in block or inline mode. This can be overridden with the <<.attr mode>> attribute.
 
 For example, consider tiddler "A" with this content:
 
@@ -57,6 +57,7 @@ This can be fixed by amending tiddler "A":
 #<$transclude tiddler="B" mode="block"/>
 # Item two
 ```
+See also these [[other examples|WikiText parser mode: transclusion examples]].
 
 ! ~SubTiddler Access
 

package/editions/tw5.com/tiddlers/widgets/ViewWidget.tid

@@ -1,6 +1,6 @@
 caption: view
 created: 20131024141900000
-modified: 20210402093330113
+modified: 20211219213444235
 tags: Widgets
 title: ViewWidget
 type: text/vnd.tiddlywiki
@@ -27,18 +27,18 @@ The content of the `<$view>` widget is displayed if the field or property is mis
 The following formats can be specified in the `format` attribute:
 
 |!Format |!Description |
-|''text'' |Plain text (default) |
-|''htmlencoded'' |The field is displayed with HTML encoding |
+|''text'' |Plain text (default) <<.tip "See also the TextWidget. `<$view format=text tiddler=MyTiddler/>` renders the same as `<$text text={{MyTiddler}}/>`">>|
+|''htmlencoded'' |The field is displayed with HTML encoding. <<.tip "Rendered value is the same as the output from the [[encodehtml|encodehtml Operator]] filter operator">>  |
 |''htmltextencoded'' |<<.from-version "5.2.0">> The field is displayed with HTML encoding, only double quotes (") are not escaped. This creates a more compact htmlencoding appropriate for html text content, but //not// for attributes. |
-|''urlencoded'' |The field is displayed with URL encoding |
-|''doubleurlencoded'' |The field is displayed with double URL encoding |
+|''urlencoded'' |The field is displayed with URL encoding <<.tip "Rendered value is the same as the output from the [[encodeuri|encodeuri Operator]] filter operator">> |
+|''doubleurlencoded'' |The field is displayed with double URL encoding <<.tip "Rendered value is the same as the output from calling the [[encodeuri|encodeuri Operator]] filter operator twice">> |
 |''htmlwikified'' |The field is wikified according to the mode attribute and the resulting HTML returned as plain text (ie HTML elements will appear in plain text) |
 |''plainwikified'' |The field is wikified according to the mode attribute and the text content of the resulting HTML returned as plain text (ie HTML elements will be removed) |
 |''htmlencodedplainwikified'' |The field is wikified according to the mode attribute and the text content of the resulting HTML returned as HTML encoded plain text (ie HTML elements will be removed) |
-|''date'' |The field is interpreted as a UTC date and displayed according to the DateFormat specified in the `template` attribute |
-|''relativedate'' |The field is interpreted as a UTC date and displayed as the interval from the present instant |
+|''date'' |The field is interpreted as a UTC date and displayed according to the DateFormat specified in the `template` attribute <<.tip "Rendered value is the same as the output from the [[format:date|format Operator]] filter operator">> |
+|''relativedate'' |The field is interpreted as a UTC date and displayed as the interval from the present instant <<.tip "Rendered value is the same as the output from the [[format:relativedate|format Operator]] filter operator">> |
 |''stripcomments'' |The field is interpreted as JavaScript source code and any lines beginning `\\#` are stripped |
-|''jsencoded'' |The field is displayed as a JavaScript encoded string |
+|''jsencoded'' |The field is displayed as a JavaScript encoded string <<.tip "Rendered value is the same as the output from the [[stringify|stringify Operator]] filter operator">> |
 
 !! "WikiText format"
 
@@ -54,3 +54,21 @@ The following example will view the core version of the tiddler [[$:/DefaultTidd
 <$view tiddler="$:/core" subtiddler="$:/DefaultTiddlers"/>
 
 '>>
+
+! Examples
+
+Given this [[Saturday]] example tiddler:
+
+|!tiddler|!raw content|!rendered content|
+|[[Saturday]]|<$text text={{Saturday}}/>|{{Saturday}}|
+
+Here is how `<$view tiddler=Saturday format=<<format>>/>` renders for each format:
+<table>
+<tr><th>format</th><th>renders as</th></tr>
+<$list filter="text htmlencoded htmltextencoded urlencoded doubleurlencoded htmlwikified plainwikified htmlencodedplainwikified stripcomments jsencoded" variable=format>
+<tr>
+<td>''<<format>>''</td>
+<td><$view tiddler="Saturday" format=<<format>>/></td>
+</tr>
+</$list>
+</table>

package/editions/tw5.com/tiddlers/widgets/WikifyWidget.tid

@@ -1,6 +1,6 @@
 caption: wikify
 created: 20160321144949700
-modified: 20161017122117062
+modified: 20220122191540121
 tags: Widgets
 title: WikifyWidget
 type: text/vnd.tiddlywiki
@@ -17,7 +17,7 @@ The content of the `<$wikify>` widget is the scope for the value assigned to the
 |name |The name of the variable to assign |
 |text |The text to parse and render |
 |type |The ContentType of the text (defaults to `text/vnd.tiddlywiki`) |
-|mode |The parse mode: `block` (the default) or `inline` |
+|mode |The parse mode: [[block|Block Mode WikiText]] (the default) or [[inline|Inline Mode WikiText]] |
 |output |Keyword indicating the desired output type, defaulting to `text` (see below) |
 
 The available output types are: