Skip to content

Documenting the Keyboard Modifiers #610

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

Closed
animeshsrivastava24 opened this issue Jun 2, 2019 · 7 comments
Closed

Documenting the Keyboard Modifiers #610

animeshsrivastava24 opened this issue Jun 2, 2019 · 7 comments
Labels
Waiting for feedback More information must be provided before we can proceed

Comments

@animeshsrivastava24
Copy link
Contributor

The Keyboard Modifier only shows the Leonardo’s definitions for modifier keys, variations for other boards can also be added.

@per1234 per1234 added the Waiting for feedback More information must be provided before we can proceed label Jun 2, 2019
@per1234
Copy link
Collaborator

per1234 commented Jun 2, 2019

Please provide an example of a keyboard modifier for another board which is different from those listed on that page.

@animeshsrivastava24
Copy link
Contributor Author

While viewing the Keyboard Modifiers, I landed on https://forum.arduino.cc/index.php?topic=297878.0 and https://github.com/SFE-Chris/UNO-HIDKeyboard-Library , there were discussions on the Keyboard Key Codes. Please guide, are the discussions on these forum, relevant to this issue.

@per1234
Copy link
Collaborator

per1234 commented Jun 2, 2019

I landed on https://forum.arduino.cc/index.php?topic=297878.0

That is outdated. Years ago, the Keyboard and Mouse functionality was in the core library but luckily that code was split out into libraries which are bundled with the Arduino IDE and shared by all the boards with these capabilities. So, as far as I know, the same keyboard modifiers apply to all boards:
https://github.com/arduino-libraries/Keyboard/blob/master/src/Keyboard.h#L37-L84

and https://github.com/SFE-Chris/UNO-HIDKeyboard-Library

That's a 3rd party library, so not relevant.


I do notice a couple of serious problems after a quick glance at the Keyboard Modifiers page:

  • "The Leonardo’s definitions for modifier keys are listed below"
    • The "Leonardo" part of that sentence is misleading. That sentence should be changed to "The definitions for modifier keys are listed below:"
  • The table is missing the definitions for F13-F24

@animeshsrivastava24 if you would like to submit pull requests to fix the issues listed above, I would be happy to review and merge them.

@animeshsrivastava24
Copy link
Contributor Author

@per1234 Yes, definitely I will work on it and fix the issue.
Also, I request you to please help me out with the review of the mail. I have been waiting eagerly for your reply, it will be a great help and help me to summarize more topics for GSoD'19.

@per1234
Copy link
Collaborator

per1234 commented Jun 2, 2019

I request you to please help me out with the review of the mail. I have been waiting eagerly for your reply, it will be a great help and help me to summarize more topics for GSoD'19.

I'm sorry for the delay responding to your emails. There is some internal discussion regarding whether I am permitted to respond to these emails now that GSoD's "Technical writer exploration" phase has ended. I am waiting to hear a definitive decision on this (which was delayed due to the weekend).

@animeshsrivastava24
Copy link
Contributor Author

@per1234 Thank you so much for the response. So, will it be possible to take guidance from the mentors regarding the content proposal or not. Sure, I'll wait further and in meanwhile, keep contributing and improving the Documentation.

animeshsrivastava24 added a commit to animeshsrivastava24/reference-en that referenced this issue Jun 2, 2019
Fixed the issue arduino#610 
Updated the documentation for F13-F24
Fixed misleading definition in line 25
per1234 pushed a commit that referenced this issue Jun 3, 2019
Fixed the issue #610 
Updated the documentation for F13-F24
Fixed misleading definition in line 25
@per1234
Copy link
Collaborator

per1234 commented Jun 3, 2019

Fixed by #611

@per1234 per1234 closed this as completed Jun 3, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Waiting for feedback More information must be provided before we can proceed
Projects
None yet
Development

No branches or pull requests

2 participants