Generate keybinding documentation #162
Conversation
ioncore/ioncore_misc.lua
Outdated
| if ref:sub(1,5) == "Mod4+" then | ||
| ref = ref:sub(6, #ref) | ||
| end | ||
| io.write("<tr class=\"shortcut\" ref=\"#" .. ref .. "\"><td>" .. binding["kcb"] .. "</td><td>" .. binding["doc"] .. "</td></tr>\n") |
There was a problem hiding this comment.
I guess you could save some backslashes by using single quotes?
ioncore/ioncore_misc.lua
Outdated
| io.write("<td width=\"400px\" valign=\"top\">\n") | ||
| io.write("<h2>META key</h2>\n") | ||
| io.write("All keybindings are activated by also pressing the META key, which by default is the 'windows' key.<br>\n") | ||
| io.write("The 'grey' bindings are activated by pressing Shift in addition to META.<br><br>\n") |
There was a problem hiding this comment.
I think this should read "The 'grey' bindings are activated by pressing ALTMETA (by default pressing Shift while holding META.<br><br>\n"
|
Great review comments! Should all be done now. |
|
I think there's some cases of missing 'local' keywords left.. I've seen |
|
I guess otherwise it's good to go. Cool new feature! |
Disregard this, of course you only need to declare the first assignment local. |
ioncore/ioncore_misc.lua
Outdated
| @@ -100,9 +100,8 @@ end | |||
|
|
|||
| function ioncore.show_live_docs(frame) | |||
| local keysfile = io.open("/tmp/notionkeys.html", "w") | |||
There was a problem hiding this comment.
This could break if more than one user on the system uses notion, or if another user created the file already. Not sure it's really a concern.
There was a problem hiding this comment.
Changed this to use os.tmpname() (as io.tmpfile() does not necessarily have a name). I guess ideally we should clean up those files when exiting, but at least on linux /tmp will be cleared on reboot anyway, so this might be fine for now.
There was a problem hiding this comment.
Good to know, I only knew about io.tmpfile(). The only problem is that the filename doesn't end with .html now... So maybe it might be required to call os.rename(filename, filename..".html") before opening, but if you say it works, I'll believe you :)
There was a problem hiding this comment.
It works with firefox, but it's a good suggestion to add the .html, will do that in a follow-up PR
So we can show docs like https://notionwm.net/notionkeys.html that actually correspond to the current configuration