mirrors/TiddlyWiki5
1
0
Fork 0
mirror of https://github.com/Jermolene/TiddlyWiki5 synced 2024-11-14 22:04:51 +00:00
Code Issues Releases Wiki Activity

[DOCS] Make LinkCatcher variables more visible (#8713)

Browse Source 
* Make LinkCatcher variables more visible

* move tip to bottom
This commit is contained in:
Mario Pietsch 2024-10-31 17:05:03 +01:00 committed by GitHub
parent 201b695d96
commit ebb9c4f082
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 6 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
editions/tw5.com/tiddlers/widgets/LinkCatcherWidget.tid
View File

@ -1,6 +1,6 @@
caption: linkcatcher caption: linkcatcher
created: 20131024141900000 created: 20131024141900000
modified: 20220226121122574 modified: 20241031151342973
tags: Widgets MessageHandlerWidgets TriggeringWidgets tags: Widgets MessageHandlerWidgets TriggeringWidgets
title: LinkCatcherWidget title: LinkCatcherWidget
type: text/vnd.tiddlywiki type: text/vnd.tiddlywiki
@ -23,6 +23,10 @@ The content of the `<$linkcatcher>` widget is displayed normally.
|message |Optional identifier for a [[widget message|Messages]] to be sent when a navigation is caught | |message |Optional identifier for a [[widget message|Messages]] to be sent when a navigation is caught |
|set |Optional title of the tiddler to be set to a specified value when navigation occurs | |set |Optional title of the tiddler to be set to a specified value when navigation occurs |
|setTo |Value to be assigned by the `set` attribute | |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'' | |actions |Actions to be performed when a link is caught. Within the action string, the variable <<.var navigateTo>> contains the title of the tiddler being navigated.<br><<.from-version "5.1.23">> the <<.var modifier>> variable lists the modifier keys that are pressed when the action is invoked.<br>The possible modifiers are ''ctrl'', ''ctrl-alt'', ''ctrl-shift'', ''alt'', ''alt-shift'', ''shift'' and ''ctrl-alt-shift'' |
|!Action Variables |!Description |
|`navigateTo` |Contains the tiddler title being navigated to |
|`modifier` |Contains the value of a modifier key, active while actions are activated |
<<.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""">> <<.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""">>