Change hashmap references to indicate additional variables (#7635)

This commit is contained in:
Marxsal 2023-07-31 04:01:44 -07:00 committed by GitHub
parent 1b5b8905d8
commit 73f256a411
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
11 changed files with 29 additions and 28 deletions

View File

@ -1,6 +1,6 @@
caption: tm-open-window caption: tm-open-window
created: 20220228140417116 created: 20220228140417116
modified: 20220409092811188 modified: 20230723220539648
tags: Messages tags: Messages
title: WidgetMessage: tm-close-window title: WidgetMessage: tm-close-window
type: text/vnd.tiddlywiki type: text/vnd.tiddlywiki
@ -29,7 +29,7 @@ src="""
width="400" width="400"
height="500" height="500"
windowID="window1" 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> </$button>
<$button>Close Window <$button>Close Window
<$action-sendmessage <$action-sendmessage

View File

@ -1,15 +1,15 @@
caption: tm-download-file
created: 20140811112201235 created: 20140811112201235
modified: 20220123141646321 modified: 20230723214745520
tags: Messages tags: Messages
title: WidgetMessage: tm-download-file title: WidgetMessage: tm-download-file
type: text/vnd.tiddlywiki 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: 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 | |!Name |!Description |
|param |Title of a tiddler to use as a template for the new tiddler | |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: The following variable names have special behaviour:

View File

@ -1,6 +1,6 @@
caption: tm-edit-bitmap-operation caption: tm-edit-bitmap-operation
created: 20160424204236050 created: 20160424204236050
modified: 20160424215219517 modified: 20230723214716576
tags: Messages tags: Messages
title: WidgetMessage: tm-edit-bitmap-operation title: WidgetMessage: tm-edit-bitmap-operation
type: text/vnd.tiddlywiki type: text/vnd.tiddlywiki
@ -30,12 +30,12 @@ Clears the contents of the image and fills it with a solid colour. Parameters in
\end \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: 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 | |!Name |!Description |
|param |Name of the operation to be executed, see ''below'' for a list of possible operations | |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. The `tm-edit-bitmap-operation` message is usually generated by a ButtonWidget or an ActionWidget and is handled by the surrounding bitmap editor.

View File

@ -1,6 +1,6 @@
caption: tm-edit-text-operation caption: tm-edit-text-operation
created: 20160424211339792 created: 20160424211339792
modified: 20210520053923011 modified: 20230723214636245
tags: Messages tags: Messages
title: WidgetMessage: tm-edit-text-operation title: WidgetMessage: tm-edit-text-operation
type: text/vnd.tiddlywiki type: text/vnd.tiddlywiki
@ -121,7 +121,7 @@ A `tm-edit-text-operation` invokes one of the available operations on a __surrou
|!Name |!Description | |!Name |!Description |
|param |Name of the operation to be executed, see ''below'' for a list of possible operations | |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. The `tm-edit-text-operation` message is usually generated by a ButtonWidget or an ActionWidget and is handled by the surrounding text editor.

View File

@ -1,6 +1,6 @@
caption: tm-focus-selector caption: tm-focus-selector
created: 20190628162542132 created: 20190628162542132
modified: 20190628162542132 modified: 20230723215122038
tags: Messages tags: Messages
title: WidgetMessage: tm-focus-selector title: WidgetMessage: tm-focus-selector
type: text/vnd.tiddlywiki type: text/vnd.tiddlywiki
@ -9,6 +9,6 @@ The `tm-focus-selector` message sets the focus to the DOM element identified by
|!Name |!Description | |!Name |!Description |
|param |Selector identifying the DOM element to be focussed | |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""">> <<.tip """Use preventScroll="true" to prevent the browser from scrolling to the focused element""">>

View File

@ -1,6 +1,6 @@
caption: tm-http-request caption: tm-http-request
created: 20230429161453032 created: 20230429161453032
modified: 20230429161453032 modified: 20230723215344887
tags: Messages tags: Messages
title: WidgetMessage: tm-http-request title: WidgetMessage: tm-http-request
type: text/vnd.tiddlywiki type: text/vnd.tiddlywiki
@ -11,7 +11,7 @@ It uses the following properties on the `event` object:
|!Name |!Description | |!Name |!Description |
|param |Not used | |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: The following parameters are used:

View File

@ -1,13 +1,13 @@
caption: tm-modal caption: tm-modal
created: 20140811112133701 created: 20140811112133701
modified: 20201117081247738 modified: 20230723215434712
tags: Messages tags: Messages
title: WidgetMessage: tm-modal title: WidgetMessage: tm-modal
type: text/vnd.tiddlywiki type: text/vnd.tiddlywiki
|!Name |!Description | |!Name |!Description |
|param |Title of the tiddler to be displayed | |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 | |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. The modal message is usually generated with the ButtonWidget. The modal message is handled by the TiddlyWiki core.

View File

@ -1,6 +1,6 @@
caption: tm-new-tiddler caption: tm-new-tiddler
created: 20140226194405353 created: 20140226194405353
modified: 20220521143507491 modified: 20230723215831560
tags: Messages navigator-message tags: Messages navigator-message
title: WidgetMessage: tm-new-tiddler title: WidgetMessage: tm-new-tiddler
type: text/vnd.tiddlywiki 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 | |!Name |!Description |
|param |The optional title of a tiddler to use as a template for the new tiddler | |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 | |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: 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 * 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 * Otherwise, generate a new title based on the default new tiddler title with a numeric suffix to make it unique

View File

@ -1,14 +1,14 @@
caption: tm-notify
created: 20140811112304772 created: 20140811112304772
modified: 20160701140248738 modified: 20230723220728382
tags: Messages tags: Messages
title: WidgetMessage: tm-notify title: WidgetMessage: tm-notify
type: text/vnd.tiddlywiki 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: 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 | |!Name |!Description |
|param |Title of the tiddler to be displayed | |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. The notify message is handled by the TiddlyWiki core.

View File

@ -1,6 +1,6 @@
caption: tm-open-external-window caption: tm-open-external-window
created: 201701211823 created: 20170121182300000
modified: 201701211825 modified: 20230723220850135
tags: Messages tags: Messages
title: WidgetMessage: tm-open-external-window title: WidgetMessage: tm-open-external-window
type: text/vnd.tiddlywiki type: text/vnd.tiddlywiki
@ -11,7 +11,8 @@ The `tm-open-external-window` message opens an external link eg: "https://tiddly
|!Name |!Description | |!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]] | |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'' ''parmObject''

View File

@ -1,15 +1,15 @@
caption: tm-save-wiki
created: 20140811112325641 created: 20140811112325641
modified: 20141110133723696 modified: 20230723220944427
tags: Messages tags: Messages
title: WidgetMessage: tm-save-wiki title: WidgetMessage: tm-save-wiki
type: text/vnd.tiddlywiki 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: 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 | |!Name |!Description |
|param |Title of a tiddler to use as a template for rendering the wiki (defaults to `$:/core/save/all`) | |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. The save wiki message is usually generated by the ButtonWidget.