KeeBoord - global keyboard shortcuts

[BurningTreeC]

Hi folks,

for those who already want to use global keyboard shortcuts within their wikies, I've made a plugin and a little plugin-info-page:

http://keeboord.tiddlyspot.com/

have fun with it,

BTC

[Mohammad]

Thank you BTC.

To David, please add this plugin info into Tiddlywiki toolmap

Cheers

Mohammad

[@TiddlyTweeter]

Ciao BTC

In your approach, which looks really interesting, is it possible to associate keystrokes combos with opening a single tiddler? Case: I often need to work with one or two configuration Tiddlers and its a lot of strokes to find them (they have "$:/" system names). What would the code needed be?

Best wishes
Josiah

[Mohammad]

Hi again BTC

If I use Zoomin storyview is this the correct code for defining shortcuts to navigate forward and backward through Tiddlers in story river

• Goto next tiddler in story view with ctrl-N     

<$navigator story="$:/StoryList" history="$:/HistoryList">

<$list filter="[all[current]next[$:/StoryList]]">

<$action-navigate $to=<<currentTiddler>> />

</$list>

</$navigator>

 tagged with:   $:/tags/KeyboardShortcut

• Goto previous tiddler in story view with ctrl-P

<$navigator story="$:/StoryList" history="$:/HistoryList">

<$list filter="[all[current]previous[$:/StoryList]]">

<$action-navigate $to=<<currentTiddler>> />

</$list>

</$navigator>

tagged with:   $:/tags/KeyboardShortcut

I have required tiddlers for description

• $:/config/ShortcutInfo/next-tiddler           text: Next tiddler in story river
  
• $:/config/ShortcutInfo/previous-tiddler    text: Previous tiddler in story river
  

Best

Mohammad

On Tuesday, June 5, 2018 at 3:59:20 PM UTC+4:30, BurningTreeC wrote:

[Mohammad]

Hello Josiah,

 I think its possible. I made one for you and I tested on Chrome 66 + Win 10

• Import the KeeBoord plugin to your wiki

Assume you want to have a shortcut to open a tiddler like: $:/.tiddlytwitter/myTiddler

• Create a tiddler with the name: Josiah
  

<$navigator story="$:/StoryList" history="$:/HistoryList">

       <$action-navigate $to="$:/.tiddlytwitter/myTiddler" />

</$navigator>

Tagged with: $:/tags/KeyboardShortcut

• Add a filed as below to above tiddler and then save it
• key: ((Josiah))

• Create another tiddler with the name: $:/config/ShortcutInfo/Josiah

Open Josiah favorite tiddler

This is the content of tiddler.

• Now open the control panned and goto to keyboard shortcut tab and find Josiah
• Set the shortcut key, I used here alt-J
• Now press Alt+J and see you have your favorite tiddler in focus

Thanks to BTC for providing this handy and useful plugin. 

Cheers

Mohammad

[BurningTreeC]

Ciao BTC

In your approach, which looks really interesting, is it possible to associate keystrokes combos with opening a single tiddler? Case: I often need to work with one or two configuration Tiddlers and its a lot of strokes to find them (they have "$:/" system names). What would the code needed be?

Hi Josiah, Mohammads  suggestion is exactly right!

What you can do with a button is also possible with a keyboard shortcut

BTC

[BurningTreeC]

Hi again BTC

If I use Zoomin storyview is this the correct code for defining shortcuts to navigate forward and backward through Tiddlers in story river

• Goto next tiddler in story view with ctrl-N     

<$navigator story="$:/StoryList" history="$:/HistoryList">

<$list filter="[all[current]next[$:/StoryList]]">

<$action-navigate $to=<<currentTiddler>> />

</$list>

</$navigator>

 tagged with:   $:/tags/KeyboardShortcut

• Goto previous tiddler in story view with ctrl-P

<$navigator story="$:/StoryList" history="$:/HistoryList">

<$list filter="[all[current]previous[$:/StoryList]]">

<$action-navigate $to=<<currentTiddler>> />

</$list>

</$navigator>

tagged with:   $:/tags/KeyboardShortcut

I have required tiddlers for description

• $:/config/ShortcutInfo/next-tiddler           text: Next tiddler in story river
  
• $:/config/ShortcutInfo/previous-tiddler    text: Previous tiddler in story river

Hi Mohammad, there's a problem you need to work around: the currentTiddler is not the same outside of the story river as within the story river (the keyboard shortcuts are outside the story river)

That's why [is[current]] in a keyboard shortcut will not match a tiddler in the story river.

The currentTiddler in the story river is defined through the list widget in the $:/core/ui/PageTemplate/story Tiddler. You need a way to know outside of the story river which one is the currently viewed tiddler to make your idea work.

The list widget in the story pagetemplate lists all tiddlers that are listed in the $:/StoryList tiddler's list field:

<$list filter="[list[$:/StoryList]]" .../>

If you start a presentation, you could set the text of a state tiddler , say $:/state/presentation-tiddler, to the title of the first tiddler in the presentation

When you go to the next Tiddler with your next button, you would set that state tiddler to the next title (previous title for the previous button). You would do the same in the keyboard shortcuts.

Like that you should always have a reference which tiddler is shown.

If you know the currently viewed tiddler you get the next from the $:/StoryList with this filter:

<$list filter="[{$:/state/presentation-tiddler}next[$:/StoryList]]" variable="nextTiddler">

the previous:

<$list filter="[{$:/state/presentation-tiddler}previous[$:/StoryList]]" variable="previousTiddler">

I would add a check if we're at the beginning or the end of the story list:

<$list filter="[list[$:/StoryList]count[]]" variable="storyCount">
<$list filter="[list[$:/StoryList]nth<storyCount>!title{$:/state/presentation-tiddler}]">
<$list filter="[{$:/state/presentation-tiddler}next[$:/StoryList]]" variable="nextTiddler">

<$action-setfield $tiddler="$:/state/presentation-tiddler" text=<<nextTiddler>>/>
<$action-navigate $to=<<nextTiddler>>/>
</$list>
</$list>
</$list>

Don't hesitate to ask if the how or why is unclear

BTC

[BurningTreeC]

@Mohammad

I've edited the last code example

[Mohammad]

Thank you BTC,

 Actually, I am trying to adopt these shortcuts in Tiddlyshow app! So, let me try the revised code and I will return to you to share the result.

Cheers

Mohammad

[Diego Mesa]

As usual BTC, this is fantastic!!! I really really hope this makes it into the core!! 

Side note: I tried to get the focus on search one working but was unable to. 

[BurningTreeC]

Hi Diego,

 

As usual BTC, this is fantastic!!! I really really hope this makes it into the core!! 

It's looking good that it does :) 

Side note: I tried to get the focus on search one working but was unable to. 

did you tag the tiddler that holds the code for the action with $:/tags/KeyboardShortcut?

did you create a $:/config/ShortcutInfo/quick-search tiddler and set the quick-search shortcut in the control panel?

did you add the field "key" to the tiddler tagged with $:/tags/KeyboardShortcut and put ((quick-search)) in its value field?

if you follow these 3 steps it should work I think - it does so for me

[Mohammad]

@BTC

 Your solution works great!

I have assigned Enter, Space, PageDown and Right-arror for next tiddler (slide) and Left-arrow, PageUp for previous.

There is some adjustment remained. For example, if I click on the next-slide button or previous-button, the state tiddler is not notified.

Also after slideshow, the next time state tiddler still has the last slide title and it should rewind.

Cheers

Mohammad

[BurningTreeC]

@BTC

 Your solution works great!

I have assigned Enter, Space, PageDown and Right-arror for next tiddler (slide) and Left-arrow, PageUp for previous.

Awesome 

There is some adjustment remained. For example, if I click on the next-slide button or previous-button, the state tiddler is not notified.

Also after slideshow, the next time state tiddler still has the last slide title and it should rewind.

Yes, you'll need the same solution within your next and previous buttons

you could add this to the button that starts and ends a presentation:

<$action-deletetiddler $tiddler="$:/state/presentation-tiddler"/>

and modify my code from above:

<$list filter="[[$:/state/presentation-tiddler]is[missing]]">
<$action-setfield $tiddler="$:/state/presentation-tiddler" text={{{ [list[$:/StoryList]nth[1]] }}}/>
</$list>

<$list filter="[list[$:/StoryList]

count[]]" variable="storyCount">
<$list filter="[list[$:/StoryList]nth<storyCount>!title{$:/state/presentation-tiddler}]">
<$list filter="[{$:/state/presentation-tiddler}next[$:/StoryList]]" variable="nextTiddler">

<$action-setfield $tiddler="$:/state/presentation-tiddler" text=<<nextTiddler>>/>
<$action-navigate $to=<<nextTiddler>>/>
</$list>
</$list>
</$list>

With this it sets the state tiddler to the first tiddler if it's missing - and it should be missing when you add the above line to the presentation launcher

[David Gifford]

already put it there this morning. Nice stuff coming out this week

[Mohammad]

Hi @BTC

Many thanks. I will return to you with results

Best

Mohammad

[@TiddlyTweeter]

Thanks Mohammad! & BTC

Excellent!

BTC wrote: What you can do with a button is also possible with a keyboard shortcut

So, for instance, say I had a "Help Tiddler" that I want the user to be able to display in a modal? Could that be activated though, say, "Ctrl+H"?

Josiah

[BurningTreeC]

Yes, but I think some browsers already use "Ctrl+H" as a built-in shortcut. You'll find a shortcut that fits. It's easy to set up and change. 

[Mohammad]

Hello again BTC,

 You solution works like a charm!

Thank you. I will soon update the Tiddlyshow with keyboard shortcuts feature. 

This is a step in bulding Tiddlyshow.

Thank you again for providing the great KeeBoord plugin and I hope I see it in the TW core in the next release.

Cheers

Mohammad

On Wednesday, June 6, 2018 at 1:37:23 AM UTC+4:30, BurningTreeC wrote:

[Mohammad]

A small problem.

Hi BTC

I have set the Right and Left arrow keys as shortcuts for navigating to forward/backward tiddler (slide). When I am in edit mode i.e I opened a tiddler to edit, then for moving currsor

I cannot use the arrow keys they navigate to next/previous tiddler instead of moving the cursor back and forth!

I think the KeeBoord should detect this situation. For short remedy, I used alt-N and alt-P, but this is a bug.

Cheers

Mohammad

On Wednesday, June 6, 2018 at 1:37:23 AM UTC+4:30, BurningTreeC wrote:

[BurningTreeC]

A small problem.

Hi BTC

I have set the Right and Left arrow keys as shortcuts for navigating to forward/backward tiddler (slide). When I am in edit mode i.e I opened a tiddler to edit, then for moving currsor

I cannot use the arrow keys they navigate to next/previous tiddler instead of moving the cursor back and forth!

I think the KeeBoord should detect this situation. For short remedy, I used alt-N and alt-P, but this is a bug.

 

Hmm... for now I recommend avoiding shortcuts that already have important functions. I'll have to see if we can handle such cases, too

[Mohammad]

Okay!

 I use a combination of keys! and avoid using Space, Backspace, PageUp, PageDown, Arrow keys, Enter, ...

I am thinking I can activate them in presentation mode, this should be not difficult. For example the

presentation button can set the key fields and when I finished and press end of show, the fields can be unset!

What do you think?

Cheers

Mohammad

[BurningTreeC]

Okay!

 I use a combination of keys! and avoid using Space, Backspace, PageUp, PageDown, Arrow keys, Enter, ...

I am thinking I can activate them in presentation mode, this should be not difficult. For example the

presentation button can set the key fields and when I finished and press end of show, the fields can be unset!

What do you think?

That's a good idea, it's possible! 

[Mohammad]

So, I go with this solution and will update the Tiddlyshow app.

I will inform you the result.

Cheers

Mohammad

[BurningTreeC]

When you choose the shortcuts in the ControlPanel it generates tiddlers named $:/config/shortcuts/my-action - they hold the key combination in their text fields

Your button would then set those tiddlers to your desired shortcuts when entering in presentation mode and unset them when leaving 

[Mohammad]

Thats right!

I have noticed if I delete the  $:/config/ShortcutInfo/my-action they wont appear in the control panel but they work.

In this way I can prevent users from setting shortcuts for these actions!

Is this correct? 

[Mohammad]

One more question:

If I use a DataTiddler as my state tiddler and put all these setting in that tiddler and then using transclusion I can set the values for these actions and

other settings! This way I will have less read/write.

Do you recommend this way?

[BurningTreeC]

One more question:

If I use a DataTiddler as my state tiddler and put all these setting in that tiddler and then using transclusion I can set the values for these actions and

other settings! This way I will have less read/write.

Do you recommend this way?

I don't recommend this for the keyboard shortcuts. It's a convenient way for settings, but if one wants to be able to change the keyboard shortcuts without having to reload, the corresponding shortcut tiddler itself has to change. Putting a transclusion there wouldn't trigger refreshing the shortcut because its content wouldn't change. And we rely upon the shortcut config tiddlers to change in order to be able to change shortcuts within a running wiki 

[Mohammad]

Oky! Thank you for clarification!

I go as per your solution.

Cheers

Mohammad

[Mohammad]

Hi BTC,

 I have still one problem I could not figure out!

To synchronize the navigation by shortcut keys and buttons (here links with mouse clicks), I tried to use the state tiddler in the tiddler handles the navigation. Here are the next previous button (links)

<div class="eqi-container">

  <div>

    <$list filter="[all[current]previous[$:/StoryList]]">

      <$link to={{!!title}}  tooltip="previous: {{!!title}}">
        <$action-setfield $tiddler="$:/state/presentation-tiddler" text={{!!title}}/>

        <span>{{$:/.mr/tiddlyshow/circle-left}}</span>

      </$link>

    </$list>

  </div>

  <div>

       <span class="pagenumber">{{!!page}}</span>

  </div>   

  <div>

    <$list filter="[all[current]next[$:/StoryList]]">

      <$link to={{!!title}} tooltip="next: {{!!title}}">
        <$action-setfield $tiddler="$:/state/presentation-tiddler" text={{!!title}}/>

        <span>{{$:/.mr/tiddlyshow/circle-right}}</span>

      </$link>

    </$list>

  </div>

</div>

But it seems the state tiddler ($:/state/presentation-tiddler) is not update. So, the shortcutkeys (alt+Right and alt+Left) actions are not the same as link clicks.

I mean both of them works but when navigate from same tiddler, the result is different!

One more question: If I start navigation from middle of story river, the button works fine because they navigate from the current tiddler, but I dont know how to tell this to Shortcutkeys tiddler (i.e. next-slide, previous-slide).

Thank you

Mohammad

[BurningTreeC]

Yes, the link widget will not trigger the action string. You'll need to replace it with a button:

<$button class="tc-btn-invisible" to={{!!title}} set="$:/state/presentation-tiddler" setTo={{!!title}} tooltip="yourtip">
{{$:/.mr/tiddlyshow/circle-right}}
</$button>

 

One more question: If I start navigation from middle of story river, the button works fine because they navigate from the current tiddler, but I dont know how to tell this to Shortcutkeys tiddler (i.e. next-slide, previous-slide).

That's why we use the $:/state/presentation-tiddler to save the currently viewed tiddler. So in the shortcuts you get it by:

{{$:/state/presentation-tiddler}}

... like:

<$navigator story="$:/StoryList" history="$:/HistoryList">

<$list filter="[{$:/state/presentation-tiddler}next[$:/StoryList]]">

<$action-sendmessage $message="tm-navigate"/>
</$list>
</$navigator>

If you start your presentation from a different tiddler than the first one, you'll need to set the text of $:/state/presentation-tiddler to that tiddler 

[Mohammad]

Great BTC!

 This seems to work! 

If you start your presentation from a different tiddler than the first one, you'll need to set the text of $:/state/presentation-tiddler to that tiddler

How can I do this? Is it from presentation button? Can I use the currentTiddler then?

/Mohammad

[BurningTreeC]

Great BTC!

 This seems to work! 

If you start your presentation from a different tiddler than the first one, you'll need to set the text of $:/state/presentation-tiddler to that tiddler

How can I do this? Is it from presentation button? Can I use the currentTiddler then?

How do you set the presentation to start from the middle?

[Mohammad]

I tested your previous solution, it works like a charm!

Thank you. Now keyboard shortcut and the button work fine no matter how navigation is done.

To start presentation: (demo: http://tiddlyshow.tiddlyspot.com/)

1. I load a saved presentation from Slides tab from sidebar
   
2. I go to browser fullscreen (in Chrome and Edge on windows F11)
3. I click the small toggle button upper-left corner of screen to set the presentation mode
4. I navigate using buttons at the bottom or Shortcutkeys (Alt-Right for next, and Alt-Left for previous)

If you toggle back to the author mode (exit presentation mode), you can click on other tiddlers from open Tab or interwiki links to go to other slide tiddlesr, then you may again click the toggle button to return back to presentation mode!

Here you will have the current tiddler in focus. The state tiddler still has the previous value not the title of tiddler under focus!

This is where

I will upload the Tiddlyshow+KeeBoord in few minutes.

/Mohammad

[Mohammad]

@BTC

 The above post edited.

I have uploaded the Tiddlyshow+KeeBoord with your last solution.

http://tiddlyshow.tiddlyspot.com/

/Mohammad

[BurningTreeC]

I tested your previous solution, it works like a charm!

Thank you. Now keyboard shortcut and the button work fine no matter how navigation is done.

To start presentation: (demo: http://tiddlyshow.tiddlyspot.com/)

[Note: The above version still has not the shortcutjeys]

1.  I load a saved presentation from slides tab from sidebar
   

1. I go to browser fullscreen

1. I click the small toggle button up-left to set the presentation mode

1. I navigate using buttons at the bottom

If you toggle back to author mode, you can click on other tiddlers in open Tab or interwiki links to go to other slide tiddlesr, then you can again click the toggle button to return back to presentation mode!

Here you will have the current tiddler in focus. The state tiddler still has the previous value not the title of tiddler under focus!

There's no easy fix for this. The links in the "Open" tab are all link widgets, no buttons, so modifying that tab would be a lot of work for the value...

Figuring out how one can get the currently viewed tiddler from outside the story is one of the mysteries of tiddlywiki 

[Mohammad]

One question:

When in Zoomin storyview a tiddler is opened, where its name is stored? I mean is there any state tiddler from that

we could recognize the name of current tiddler. If so, we can update the content of presentation-tiddler no matter how

and from where the current tiddler has been opened!

What do you think?

/Mohammad

[BurningTreeC]

@BTC

 The above post edited.

I have uploaded the Tiddlyshow+KeeBoord with your last solution.

I've tried it, really cool to see it in action. Good work! 

http://tiddlyshow.tiddlyspot.com/

/Mohammad

[BurningTreeC]

One question:

When in Zoomin storyview a tiddler is opened, where its name is stored? I mean is there any state tiddler from that

we could recognize the name of current tiddler. If so, we can update the content of presentation-tiddler no matter how

and from where the current tiddler has been opened!

What do you think?

As far as I know there's no such thing. There's only the $:/StoryList tiddler with the list of all open tiddlers but no reference which tiddler is shown.

I agree with you, that in Zoomin storyview it should be possible to have access to the currently viewed tiddler. That's something for a github pull request

/Mohammad

[Mohammad]

Without your help it was not there!

Thank you! I have appreciated KeeBoord and your time in slide 10.

I just have to change shortcuts, seems alt+arrow keys are used in Chrome for backward/forward page (https://www.computerhope.com/shortcut/chrome.htm)

Now, I use alt-Up and alt-Down now and I will set better shortcuts later.

Cheers

Mohammad

[Jan]

Hi Simon,
again you made a great thing... and again I got a special wish:
Is there a way to turn this into a "somtimes global shortcuts"-plugin which only works if for example a special word is revealed.
It would be usefull for me to have single-key-shortcuts for particular situations... like games and slideshows.

Ahoi,
Jan



Am 05.06.2018 um 13:29 schrieb BurningTreeC:

Hi folks,

for those who already want to use global keyboard shortcuts within their wikies, I've made a plugin and a little plugin-info-page:

http://keeboord.tiddlyspot.com/

have fun with it,

BTC

--
You received this message because you are subscribed to the Google Groups "TiddlyWiki" group.
To unsubscribe from this group and stop receiving emails from it, send an email to tiddlywiki+...@googlegroups.com.
To post to this group, send email to tiddl...@googlegroups.com.
Visit this group at https://groups.google.com/group/tiddlywiki.
To view this discussion on the web visit https://groups.google.com/d/msgid/tiddlywiki/0bea668b-e148-4e33-9d65-c6a9f344a876%40googlegroups.com.
For more options, visit https://groups.google.com/d/optout.

[BurningTreeC]

Hi Simon,
again you made a great thing... and again I got a special wish:
Is there a way to turn this into a "somtimes global shortcuts"-plugin which only works if for example a special word is revealed.
It would be usefull for me to have single-key-shortcuts for particular situations... like games and slideshows.

Ahoi,
Jan 

Thanks Jan,

the shortcuts can be set and unset without reloading the wiki - so the basic functionality should be there to accomplish what you want.

You could set the corresponding shortcut tiddler ($:/config/shortcuts/your-shortcut) to a key-combination with a button or whatever (when you reveal something) and in the corresponding tiddler that holds the action you append an action that deletes the text of that $:/config/shortcuts/your-shortcut tiddler - then it will work only once ...

Or you put some conditionals into your action tiddler like list filter=[when tiddler so-and-so is shown] or list filter=[all tiddlers in story get text regexp my-word] ... then do

[Jan]

Thanks Simon,
I had those ideas in mind, but asked myself whether this would be a
little strange. The first one seems to be safer because it won't block
anything.

Very fine work!

Am 08.06.2018 um 10:31 schrieb BurningTreeC:
> out reloading the wiki - so the basic functionality should be there to
> accomplish what you want.
>

> You could to set the corresponding shortcut tiddler

[BurningTreeC]

@Jan, how is it working for you?

@all, I'd be interested if you're using KeeBoord in one of your wikies and - if that's the case - how is it working, have you encountered issues?

BTC

[Jan]

Hello Simon,
the Tests were promising...wonderfull. I am lookiong forward to doing
some experiments in the wikiworld after the Schuljahresendstress ;-).
I'll let youn know...
Yours Jan

[Abraham Samma]

Hi BurningTreeC,

This is the plugin of my dreams!! Fantastic. Encountered no issues so far but I am inclined to believe that this should be the plugin of the month.

Infact, I dare say TW5 should come bundled with this plugin because it augments it so very well.

[Mohammad]

This is very true! I hope Jeremy bundle it with TW 5.1.18

[BurningTreeC]

Hi BurningTreeC,

This is the plugin of my dreams!! Fantastic. Encountered no issues so far but I am inclined to believe that this should be the plugin of the month.

Infact, I dare say TW5 should come bundled with this plugin because it augments it so very well.

Hi Abraham,

Thank you for the great feedback!

I've made a PR on github to integrate this functionality in the core, it's still open. Fingers crossed it gets merged :)

BTC

[JD]

Hi BTC, this plugin is so amazing! Nothing to report, I'm just thanking you for your work! It's been super reliable for me. 

[BurningTreeC]

Hi BTC, this plugin is so amazing! Nothing to report, I'm just thanking you for your work! It's been super reliable for me. 

Hi JD, thank you very much,

I've seen how you've integrated it in your material theme and the spartan theme, which I like a lot, BIG compliments for your work!

I'm glad that the plugin is so reliable and useful for you all!

have a good weekend,

BTC

[BurningTreeC]

edit @JD - in my previous post I was talking about your spartan theme, not "shadow" ... where did shadow come from? I don't know... 

BTC