From 45f5ba7d3867d90059738d79a346682659e72aca Mon Sep 17 00:00:00 2001 From: Maurycy Zarzycki Date: Sat, 11 Jun 2022 10:53:06 +0200 Subject: [PATCH] update Keyboard Shortcut documentation with information on how it interacts with navigate actions (#6703) --- .../tw5.com/tiddlers/concepts/KeyboardShortcutTiddler.tid | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/editions/tw5.com/tiddlers/concepts/KeyboardShortcutTiddler.tid b/editions/tw5.com/tiddlers/concepts/KeyboardShortcutTiddler.tid index aca6b30a0..7fa93e21a 100644 --- a/editions/tw5.com/tiddlers/concepts/KeyboardShortcutTiddler.tid +++ b/editions/tw5.com/tiddlers/concepts/KeyboardShortcutTiddler.tid @@ -10,3 +10,10 @@ A ''Keyboard Shortcut Tiddler'' is made of three parts: If the [[Keyboard Shortcut Descriptor]] has the form `((my-shortcut))` it's a ''reference'' to a ''configuration Tiddler'' that stores the corresponding [[Keyboard Shortcut|KeyboardShortcuts]] In order to make a ''shortcut'' editable through the <<.controlpanel-tab KeyboardShortcuts>> Tab in the $:/ControlPanel it's sufficient to create a tiddler `$:/config/ShortcutInfo/my-shortcut`, where the ''suffix'' is the ''reference'' used for the [[Keyboard Shortcut|KeyboardShortcuts]] + +!! Notes on wiki navigation + +If you want to create keyboard shortcuts for navigation, there are two things to keep in mind: + + * If your shortcut uses ''Ctrl'', you need to include `$scroll="yes"` in the [[ActionNavigateWidget's|ActionNavigateWidget]] attributes otherwise the action will be ignored. + * The actions need to be wrapped in [[NavigatorWidget]] like in this [[New Tiddler keyboard shortcut|$:/core/ui/KeyboardShortcuts/new-tiddler]].