mirrors/TiddlyWiki5
1
0
Fork 0
mirror of https://github.com/Jermolene/TiddlyWiki5 synced 2024-06-24 06:13:17 +00:00
Code Issues Releases Wiki Activity

More widget message documentation

Browse Source
This commit is contained in:
Jermolene 2014-08-11 13:17:11 +01:00
parent c38d682d7d
commit 1c44ea8941
10 changed files with 109 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
editions/tw5.com/tiddlers/TableOfContents.tid
View File

@ -183,18 +183,30 @@ $body$
">>
## <<toc-heading "Widget Messages" "
## WidgetMessages
## [[tw-auto-save-wiki|WidgetMessage: tw-auto-save-wiki]]
## [[tw-cancel-tiddler|WidgetMessage: tw-cancel-tiddler]]
## [[tw-clear-password|WidgetMessage: tw-clear-password]]
## [[tw-close-all-tiddlers|WidgetMessage: tw-close-all-tiddlers]]
## [[tw-close-other-tiddlers|WidgetMessage: tw-close-other-tiddlers]]
## [[tw-close-tiddler|WidgetMessage: tw-close-tiddler]]
## [[tw-delete-tiddler|WidgetMessage: tw-delete-tiddler]]
## [[tw-download-file|WidgetMessage: tw-download-file]]
## [[tw-edit-tiddler|WidgetMessage: tw-edit-tiddler]]
## [[tw-full-screen|WidgetMessage: tw-full-screen]]
## [[tw-home|WidgetMessage: tw-home]]
## [[tw-import-tiddlers|WidgetMessage: tw-import-tiddlers]]
## [[tw-login|WidgetMessage: tw-login]]
## [[tw-logout|WidgetMessage: tw-logout]]
## [[tw-modal|WidgetMessage: tw-modal]]
## [[tw-navigate|WidgetMessage: tw-navigate]]
## [[tw-new-tiddler|WidgetMessage: tw-new-tiddler]]
## [[tw-notify|WidgetMessage: tw-notify]]
## [[tw-perform-import|WidgetMessage: tw-perform-import]]
## [[tw-permalink|WidgetMessage: tw-permalink]]
## [[tw-permaview|WidgetMessage: tw-permaview]]
## [[tw-save-tiddler|WidgetMessage: tw-save-tiddler]]
## [[tw-save-wiki|WidgetMessage: tw-save-wiki]]
## [[tw-server-refresh|WidgetMessage: tw-server-refresh]]
## [[tw-set-password|WidgetMessage: tw-set-password]]
">>
## <<toc-heading "Filter Operators" "

11
editions/tw5.com/tiddlers/messages/WidgetMessage_ tw-auto-save-wiki.tid Normal file
View File

@ -0,0 +1,11 @@
created: 20140811112343634
modified: 20140811114420597
tags: message
title: WidgetMessage: tw-auto-save-wiki
type: application/x-tiddler
The autosave wiki message causes the current saver module to perform a background save if it is required.
The autosave wiki message should be generated whenever changes are made to the store. For example, the navigator widget generates the autosave wiki message as part of its handling of the [[WidgetMessage: tw-save-tiddler]], [[WidgetMessage: tw-delete-tiddler]] and [[WidgetMessage: tw-perform-import]].
The autosave wiki message is handled by the TiddlyWiki core SyncMechanism which invokes the current [[SaverModule|SaverModules]]. Not all SaverModules can handle autosaving.

14
editions/tw5.com/tiddlers/messages/WidgetMessage_ tw-download-file.tid Normal file
View File

@ -0,0 +1,14 @@
created: 20140811112201235
modified: 20140811115140378
tags: message
title: WidgetMessage: tw-download-file
type: application/x-tiddler
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 |
The download file message is usually generated with the ButtonWidget.
The download file message is handled by the TiddlyWiki core SyncMechanism which invokes the current [[SaverModule|SaverModules]].

9
editions/tw5.com/tiddlers/messages/WidgetMessage_ tw-full-screen.tid Normal file
View File

@ -0,0 +1,9 @@
created: 20140811112400855
modified: 20140811113627373
tags: message
title: WidgetMessage: tw-full-screen
type: application/x-tiddler
The fullscreen message toggles the "fullscreen" mode of the browser, if it supports it.
The fullscreen message is handled by the TiddlyWiki core.

10
editions/tw5.com/tiddlers/messages/WidgetMessage_ tw-login.tid Normal file
View File

@ -0,0 +1,10 @@
created: 20140811112445887
modified: 20140811113336694
tags: message
title: WidgetMessage: tw-login
type: application/x-tiddler
The login message prompts the user for a username and password and attempts to login to the current serverside host. The tiddler [[$:/status/IsLoggedIn]] reflects the current login status with the values "yes" or "no", and [[$:/status/UserName]] reflects the current username.
The login message is handled by the TiddlyWiki core SyncMechanism which invokes the current [[SyncAdaptorModule|SyncAdaptorModules]] (typically the ''tiddlywiki/tiddlywebadaptor'' plugin).

9
editions/tw5.com/tiddlers/messages/WidgetMessage_ tw-logout.tid Normal file
View File

@ -0,0 +1,9 @@
created: 20140811112457311
modified: 20140811113344084
tags: message
title: WidgetMessage: tw-logout
type: application/x-tiddler
The logout message attempts to log the user out of the current serverside host. The tiddler [[$:/status/IsLoggedIn]] reflects the current login status with the values "yes" or "no", and [[$:/status/UserName]] reflects the current username.
The logout message is handled by the TiddlyWiki core SyncMechanism which invokes the current [[SyncAdaptorModule|SyncAdaptorModules]] (typically the ''tiddlywiki/tiddlywebadaptor'' plugin).

12
editions/tw5.com/tiddlers/messages/WidgetMessage_ tw-modal.tid Normal file
View File

@ -0,0 +1,12 @@
created: 20140811112133701
modified: 20140811120203685
tags: message
title: WidgetMessage: tw-modal
type: application/x-tiddler
The modal message displays a specified tiddler in a modal overlay that dims the main page. It requires the following properties on the `event` object:
|!Name |!Description |
|param |Title of the tiddler to be displayed |
The modal message is usually generated with the ButtonWidget. The modal message is handled by the TiddlyWiki core.

12
editions/tw5.com/tiddlers/messages/WidgetMessage_ tw-notify.tid Normal file
View File

@ -0,0 +1,12 @@
created: 20140811112304772
modified: 20140811120248738
tags: message
title: WidgetMessage: tw-notify
type: application/x-tiddler
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 |
The notify message is handled by the TiddlyWiki core.

11
editions/tw5.com/tiddlers/messages/WidgetMessage_ tw-save-wiki.tid Normal file
View File

@ -0,0 +1,11 @@
created: 20140811112325641
modified: 20140811115149288
tags: message
title: WidgetMessage: tw-save-wiki
type: application/x-tiddler
The save wiki message causes the current saver module to perform a full save operation. The save operation can involve user interaction, unlike the [[WidgetMessage: tw-auto-save-wiki]]/
The save wiki message is usually generated by the ButtonWidget.
The save wiki message is handled by the TiddlyWiki core SyncMechanism which invokes the current [[SaverModule|SaverModules]].

9
editions/tw5.com/tiddlers/messages/WidgetMessage_ tw-server-refresh.tid Normal file
View File

@ -0,0 +1,9 @@
created: 20140811112435281
modified: 20140811113453568
tags: message
title: WidgetMessage: tw-server-refresh
type: application/x-tiddler
The server refresh message attempts to synchronise the latest changes to the current serverside host.
The server refresh message is handled by the TiddlyWiki core SyncMechanism which invokes the current [[SyncAdaptorModule|SyncAdaptorModules]] (typically the ''tiddlywiki/tiddlywebadaptor'' plugin).