Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

In some examples, use of keysym and keycombo seem wrong #44

Open
lo48576 opened this issue Aug 30, 2018 · 0 comments
Open

In some examples, use of keysym and keycombo seem wrong #44

lo48576 opened this issue Aug 30, 2018 · 0 comments

Comments

@lo48576
Copy link

lo48576 commented Aug 30, 2018

  1. About use of keysym for key combinations
  2. About use of keycombo without action attributes

Use of keysym for key combinations

keysym's description is below:

The keysym identifies the symbolic name of a key on a computer keyboard. This is distinct from any scan code that it may generate (keycode), or any text (keycap) that might be printed on the key.

However, some pages in the tdg.docbook.org reference, keysym is used to represent key combinations:
https://github.com/docbook/defguide/search?utf8=%E2%9C%93&q=keysym&type=

Here is one of such examples:

<keycombo><keysym>C-c</keysym><keysym>C-x</keysym></keycombo>

Is this usage (<keysym>C-x</keysym>) valid?
I think this is invalid use (because keysym "identifies the symbolic name of a key on a computer keyboard"), and it should be written as <keycombo action="simul"><keysym>C</keysym><keycap>x</keycap></keycombo> (for example) or something like that.

If <keysym>C-x</keysym> is ok, the description of keysym element should be changed.

Use of keycombo without action attributes

In the same parts of examples:

<keycombo><keysym>C-c</keysym><keysym>C-x</keysym></keycombo>

<keycombo><keysym>C-c</keysym><keysym>C-x</keysym></keycombo> is used and this seems to represent "sequential" combination.
But in the reference, action attribute is decribed as below:

If keycombo contains more than one element, simul is the default, otherwise there is no default.

The keycombo contains two keysyms, so this keycombo should have action="seq".
I think this should be fixed, whether the keysym use here is correct or nested keycombo should be used.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant