From 73f256a41198670d9c56385bf5111329c6e35c2e Mon Sep 17 00:00:00 2001 From: Marxsal Date: Mon, 31 Jul 2023 04:01:44 -0700 Subject: [PATCH] Change hashmap references to indicate additional variables (#7635) --- .../tiddlers/messages/WidgetMessage_ tm-close-window.tid | 4 ++-- .../tiddlers/messages/WidgetMessage_ tm-download-file.tid | 6 +++--- .../messages/WidgetMessage_ tm-edit-bitmap-operation.tid | 6 +++--- .../messages/WidgetMessage_ tm-edit-text-operation.tid | 4 ++-- .../tiddlers/messages/WidgetMessage_ tm-focus-selector.tid | 4 ++-- .../tiddlers/messages/WidgetMessage_ tm-http-request.tid | 4 ++-- .../tw5.com/tiddlers/messages/WidgetMessage_ tm-modal.tid | 4 ++-- .../tiddlers/messages/WidgetMessage_ tm-new-tiddler.tid | 6 +++--- .../tw5.com/tiddlers/messages/WidgetMessage_ tm-notify.tid | 6 +++--- .../messages/WidgetMessage_ tm-open-external-window.tid | 7 ++++--- .../tiddlers/messages/WidgetMessage_ tm-save-wiki.tid | 6 +++--- 11 files changed, 29 insertions(+), 28 deletions(-) diff --git a/editions/tw5.com/tiddlers/messages/WidgetMessage_ tm-close-window.tid b/editions/tw5.com/tiddlers/messages/WidgetMessage_ tm-close-window.tid index 739efb192..07b69e5b9 100644 --- a/editions/tw5.com/tiddlers/messages/WidgetMessage_ tm-close-window.tid +++ b/editions/tw5.com/tiddlers/messages/WidgetMessage_ tm-close-window.tid @@ -1,6 +1,6 @@ caption: tm-open-window created: 20220228140417116 -modified: 20220409092811188 +modified: 20230723220539648 tags: Messages title: WidgetMessage: tm-close-window type: text/vnd.tiddlywiki @@ -29,7 +29,7 @@ src=""" width="400" height="500" windowID="window1" - something="I just in over in a variable, and boy is my Hashmap tired." /> + something="I just flew in on a variable, and boy is my Hashmap tired." /> <$button>Close Window <$action-sendmessage diff --git a/editions/tw5.com/tiddlers/messages/WidgetMessage_ tm-download-file.tid b/editions/tw5.com/tiddlers/messages/WidgetMessage_ tm-download-file.tid index 128966501..e80c1aba8 100644 --- a/editions/tw5.com/tiddlers/messages/WidgetMessage_ tm-download-file.tid +++ b/editions/tw5.com/tiddlers/messages/WidgetMessage_ tm-download-file.tid @@ -1,15 +1,15 @@ +caption: tm-download-file created: 20140811112201235 -modified: 20220123141646321 +modified: 20230723214745520 tags: Messages title: WidgetMessage: tm-download-file type: text/vnd.tiddlywiki -caption: tm-download-file The download file message causes the current saver module to prompt the user to download the result of parsing a specified template tiddler as a file. It requires the following properties on the `event` object: |!Name |!Description | |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 | +|//{any other params}// |Any other parameters are made available as variables within the context of the widget message. | The following variable names have special behaviour: diff --git a/editions/tw5.com/tiddlers/messages/WidgetMessage_ tm-edit-bitmap-operation.tid b/editions/tw5.com/tiddlers/messages/WidgetMessage_ tm-edit-bitmap-operation.tid index e8df75efd..edbc5ce5d 100644 --- a/editions/tw5.com/tiddlers/messages/WidgetMessage_ tm-edit-bitmap-operation.tid +++ b/editions/tw5.com/tiddlers/messages/WidgetMessage_ tm-edit-bitmap-operation.tid @@ -1,6 +1,6 @@ caption: tm-edit-bitmap-operation created: 20160424204236050 -modified: 20160424215219517 +modified: 20230723214716576 tags: Messages title: WidgetMessage: tm-edit-bitmap-operation type: text/vnd.tiddlywiki @@ -30,12 +30,12 @@ Clears the contents of the image and fills it with a solid colour. Parameters in \end - A `tm-edit-bitmap-operation` invokes one of the available operations on a __surrounding__ bitmap 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: |!Name |!Description | |param |Name of the operation to be executed, see ''below'' for a list of possible operations | -|paramObject| Hashmap of additional parameters required by the operation top be executed | +|//{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. diff --git a/editions/tw5.com/tiddlers/messages/WidgetMessage_ tm-edit-text-operation.tid b/editions/tw5.com/tiddlers/messages/WidgetMessage_ tm-edit-text-operation.tid index 9737c3b24..a34fe3fc0 100644 --- a/editions/tw5.com/tiddlers/messages/WidgetMessage_ tm-edit-text-operation.tid +++ b/editions/tw5.com/tiddlers/messages/WidgetMessage_ tm-edit-text-operation.tid @@ -1,6 +1,6 @@ caption: tm-edit-text-operation created: 20160424211339792 -modified: 20210520053923011 +modified: 20230723214636245 tags: Messages title: WidgetMessage: tm-edit-text-operation type: text/vnd.tiddlywiki @@ -121,7 +121,7 @@ A `tm-edit-text-operation` invokes one of the available operations on a __surrou |!Name |!Description | |param |Name of the operation to be executed, see ''below'' for a list of possible operations | -|paramObject|Hashmap of additional parameters required by the operation top be executed | +|//{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. diff --git a/editions/tw5.com/tiddlers/messages/WidgetMessage_ tm-focus-selector.tid b/editions/tw5.com/tiddlers/messages/WidgetMessage_ tm-focus-selector.tid index 1b33502ed..c041e15dc 100644 --- a/editions/tw5.com/tiddlers/messages/WidgetMessage_ tm-focus-selector.tid +++ b/editions/tw5.com/tiddlers/messages/WidgetMessage_ tm-focus-selector.tid @@ -1,6 +1,6 @@ caption: tm-focus-selector created: 20190628162542132 -modified: 20190628162542132 +modified: 20230723215122038 tags: Messages title: WidgetMessage: tm-focus-selector type: text/vnd.tiddlywiki @@ -9,6 +9,6 @@ The `tm-focus-selector` message sets the focus to the DOM element identified by |!Name |!Description | |param |Selector identifying the DOM element to be focussed | -|paramObject |Optional hashmap of additional parameters to be passed to the [[focus()|https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/focus]] method | +|//{any other params}// |Any other parameters to be passed to the [[focus()|https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/focus]] method as variables.| <<.tip """Use preventScroll="true" to prevent the browser from scrolling to the focused element""">> diff --git a/editions/tw5.com/tiddlers/messages/WidgetMessage_ tm-http-request.tid b/editions/tw5.com/tiddlers/messages/WidgetMessage_ tm-http-request.tid index f6c82e760..6ff44ee38 100644 --- a/editions/tw5.com/tiddlers/messages/WidgetMessage_ tm-http-request.tid +++ b/editions/tw5.com/tiddlers/messages/WidgetMessage_ tm-http-request.tid @@ -1,6 +1,6 @@ caption: tm-http-request created: 20230429161453032 -modified: 20230429161453032 +modified: 20230723215344887 tags: Messages title: WidgetMessage: tm-http-request type: text/vnd.tiddlywiki @@ -11,7 +11,7 @@ It uses the following properties on the `event` object: |!Name |!Description | |param |Not used | -|paramObject |Hashmap of parameters (see below) | +|//{any other params}// |Any other parameters are made available as variables within the context of the widget message. See below. | The following parameters are used: diff --git a/editions/tw5.com/tiddlers/messages/WidgetMessage_ tm-modal.tid b/editions/tw5.com/tiddlers/messages/WidgetMessage_ tm-modal.tid index 9b459fb7b..158bb7878 100644 --- a/editions/tw5.com/tiddlers/messages/WidgetMessage_ tm-modal.tid +++ b/editions/tw5.com/tiddlers/messages/WidgetMessage_ tm-modal.tid @@ -1,13 +1,13 @@ caption: tm-modal created: 20140811112133701 -modified: 20201117081247738 +modified: 20230723215434712 tags: Messages title: WidgetMessage: tm-modal type: text/vnd.tiddlywiki |!Name |!Description | |param |Title of the tiddler to be displayed | -|paramObject |Hashmap of variables to be provided to the modal, contains all extra parameters passed to the widget sending the message. | +|//{any other params}// |Any other parameters are made available as variables within the context of the widget message. | |rootwindow |<<.from-version 5.1.18>> ''yes'' or ''true'' will always display a modal in the wiki-root-window | The modal message is usually generated with the ButtonWidget. The modal message is handled by the TiddlyWiki core. diff --git a/editions/tw5.com/tiddlers/messages/WidgetMessage_ tm-new-tiddler.tid b/editions/tw5.com/tiddlers/messages/WidgetMessage_ tm-new-tiddler.tid index d435d5f4f..c487f015f 100644 --- a/editions/tw5.com/tiddlers/messages/WidgetMessage_ tm-new-tiddler.tid +++ b/editions/tw5.com/tiddlers/messages/WidgetMessage_ tm-new-tiddler.tid @@ -1,6 +1,6 @@ caption: tm-new-tiddler created: 20140226194405353 -modified: 20220521143507491 +modified: 20230723215831560 tags: Messages navigator-message title: WidgetMessage: tm-new-tiddler type: text/vnd.tiddlywiki @@ -9,12 +9,12 @@ The new tiddler message creates a new draft tiddler and adds it to the current s |!Name |!Description | |param |The optional title of a tiddler to use as a template for the new tiddler | -|paramObject |Optional hashmap of additional tiddler fields | +|//{any other params}// |The names and values of additional tiddler fields. | |navigateFromTitle |Title of the tiddler from which the navigation to the new tiddler was initiated | The title for the draft tiddler is chosen according to these rules: -* If a hashmap was used and a title field was specified, use that title +* If additional parameters were used and a title field was specified, use that title * If a template tiddler was used, use the title of the template tiddler, making it unique with a numeric suffix * Otherwise, generate a new title based on the default new tiddler title with a numeric suffix to make it unique diff --git a/editions/tw5.com/tiddlers/messages/WidgetMessage_ tm-notify.tid b/editions/tw5.com/tiddlers/messages/WidgetMessage_ tm-notify.tid index f44839f45..b64f4a573 100644 --- a/editions/tw5.com/tiddlers/messages/WidgetMessage_ tm-notify.tid +++ b/editions/tw5.com/tiddlers/messages/WidgetMessage_ tm-notify.tid @@ -1,14 +1,14 @@ +caption: tm-notify created: 20140811112304772 -modified: 20160701140248738 +modified: 20230723220728382 tags: Messages title: WidgetMessage: tm-notify type: text/vnd.tiddlywiki -caption: tm-notify The notify message briefly displays a specified tiddler as a small alert in the upper right corner of the page. It requires the following properties on the `event` object: |!Name |!Description | |param |Title of the tiddler to be displayed | -|paramObject |Hashmap of variables to be provided to the notification | +|//{any other params}// |Any other parameters are made available as variables to the notify message. | The notify message is handled by the TiddlyWiki core. diff --git a/editions/tw5.com/tiddlers/messages/WidgetMessage_ tm-open-external-window.tid b/editions/tw5.com/tiddlers/messages/WidgetMessage_ tm-open-external-window.tid index 960f94f2f..4e868312c 100644 --- a/editions/tw5.com/tiddlers/messages/WidgetMessage_ tm-open-external-window.tid +++ b/editions/tw5.com/tiddlers/messages/WidgetMessage_ tm-open-external-window.tid @@ -1,6 +1,6 @@ caption: tm-open-external-window -created: 201701211823 -modified: 201701211825 +created: 20170121182300000 +modified: 20230723220850135 tags: Messages title: WidgetMessage: tm-open-external-window type: text/vnd.tiddlywiki @@ -11,7 +11,8 @@ The `tm-open-external-window` message opens an external link eg: "https://tiddly |!Name |!Description | |param |URL of the tiddler to be opened in a new browser window, defaults to the [[TiddlyWiki help|https://tiddlywiki.com/#WidgetMessage%3A%20tm-open-external-window if empty]] | -|paramObject |Optional: Hashmap of variables that will be provided to the window. see below | +|//{any other params}// |Any other parameters are made available as variables to the window. See below. | + ''parmObject'' diff --git a/editions/tw5.com/tiddlers/messages/WidgetMessage_ tm-save-wiki.tid b/editions/tw5.com/tiddlers/messages/WidgetMessage_ tm-save-wiki.tid index 605ee37e8..701caa4f2 100644 --- a/editions/tw5.com/tiddlers/messages/WidgetMessage_ tm-save-wiki.tid +++ b/editions/tw5.com/tiddlers/messages/WidgetMessage_ tm-save-wiki.tid @@ -1,15 +1,15 @@ +caption: tm-save-wiki created: 20140811112325641 -modified: 20141110133723696 +modified: 20230723220944427 tags: Messages title: WidgetMessage: tm-save-wiki type: text/vnd.tiddlywiki -caption: tm-save-wiki The save wiki message causes the current saver module to perform a full save operation. The save operation can involve user interaction. It requires the following properties on the `event` object: |!Name |!Description | |param |Title of a tiddler to use as a template for rendering the wiki (defaults to `$:/core/save/all`) | -|paramObject |Optional hashmap of variable values to use for the rendering | +|//{any other params}// |Any other parameters are made available as variables to use for the rendering. | The save wiki message is usually generated by the ButtonWidget.