1
0
mirror of https://github.com/Jermolene/TiddlyWiki5 synced 2024-11-23 18:17:20 +00:00

Docs updates

This commit is contained in:
Jermolene 2015-06-19 16:39:47 +01:00
parent 4a30d8772c
commit 61a722c7fd
4 changed files with 4 additions and 35 deletions

View File

@ -1,33 +0,0 @@
caption: action-sendmessage
created: 20141008134309742
modified: 20150518210909583
tags: Widgets ActionWidgets
title: ActionSendMessageWidget
type: text/vnd.tiddlywiki
! Introduction
The ''action-sendmessage'' widget is an [[action widget|ActionWidgets]] that sends a [[message|WidgetMessages]] back up the widget tree. ActionWidgets are used within triggering widgets such as the ButtonWidget.
! Content and Attributes
The ''action-sendmessage'' widget is invisible. Any content within it is ignored.
|!Attribute |!Description |
|$message |The message to send (eg, [[WidgetMessage: tm-new-tiddler]]) |
|$param |Optional parameter string whose meaning is dependent on the message being sent |
|$name |Optional name of additional parameter |
|$value |Value for optional parameter whose name is specified in `$name` |
|//{any attributes not starting with $}// |Multiple additional, optional named parameters that are attached to the message |
! Examples
Here is an example of button that displays both a notification and a wizard, and creates a new tiddler with tags and text:
<$macrocall $name='wikitext-example-without-html'
src='<$button>
<$action-sendmessage $message="tm-modal" $param="SampleWizard"/>
<$action-sendmessage $message="tm-notify" $param="SampleNotification"/>
<$action-sendmessage $message="tm-new-tiddler" title="This is newly created tiddler" tags="OneTag [[Another Tag]]" text=<<now "Today is DDth, MMM YYYY">>/>
Click me!
</$button>'/>

View File

@ -1,6 +1,6 @@
caption: action-sendmessage
created: 20141008134309742
modified: 20141107132122081
modified: 20150518210909583
tags: Widgets ActionWidgets
title: ActionSendMessageWidget
type: text/vnd.tiddlywiki
@ -16,7 +16,9 @@ The ''action-sendmessage'' widget is invisible. Any content within it is ignored
|!Attribute |!Description |
|$message |The message to send (eg, [[WidgetMessage: tm-new-tiddler]]) |
|$param |Optional parameter string whose meaning is dependent on the message being sent |
|//{any attributes not starting with $}// |Multiple additional named parameters that are attached to the message |
|$name |Optional name of additional parameter |
|$value |Value for optional parameter whose name is specified in `$name` |
|//{any attributes not starting with $}// |Multiple additional, optional named parameters that are attached to the message |
! Examples