Comments (4)
Reopening issue.
Did some investigating, and seems it's not advised:
Quoting from https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/accesskey
In addition to poor browser support, there are numerous concerns with the accesskey attribute:
An accesskey value can conflict with a system or browser keyboard shortcut, or assistive technology functionality.
What may work for one combination of operating system, assistive technology, and browser may not work with other combinations.
Certain accesskey values may not be present on certain keyboards, especially when internationalization is a concern. So adapting to specific languages could cause further problems.
accesskey values that rely on numbers may be confusing to individuals experiencing cognitive concerns, where the number doesn't have a logical association with the functionality it triggers.
Informing the user that accesskeys are present, so that they are aware of the functionality. If the system lacks a method of notifying the user about this feature, the user might accidentally activate accesskeys.
Because of these issues, it is generally advised not to use accesskeys for most general-purpose websites and web apps.
However, in the next update, maintainers will be able to add custom javascript snippets to their project docs, and without testing it, it's supposed to be a 1 line code:
$("#search-in-project").attr("accesskey", "s");
Leavnig issue open for now.
from docsforge.
Closing. Since version 3.4.16 custom javascript can be added to any project.
Added a accesskey
example snippet to the documentation, I checked that it indeed works, so if it helps you go right ahead.
Since it's not recommended by both Mozilla and Wikipedia, I don't currently intend on adding it across site.
from docsforge.
Sure,
I personally never use it, but implementation seems pretty straightforward.
I'll go with your suggestion "s", and if other users want to change it in the future, it's also simple to make it customizable.
Thanks :)
from docsforge.
Thanks for researching the issue. The current Wikipedia entry also hints at possible problems (but Wikipedia itself uses an access key for its search box). It's not a big deal, either way.
from docsforge.
Related Issues (20)
- Variables added from the README documentation HOT 2
- Macros in code are causing parser errors. HOT 6
- Public Api sidebar is not displayed correctly HOT 2
- Download configuration file isn't working HOT 2
- Allow displaying doxygen's html output. HOT 2
- Add Algolia as search provider HOT 6
- Broken link in Home / Versions HOT 3
- Inconsistent punctuation in member function descriptions, and expressions like "i.e." or "e.g." HOT 3
- Missing documentation for two stream inserters
- Request: showing parameter list and return type in function descriptions HOT 5
- Thoughts about using docsforge with existing readthedocs / sphinx documentation HOT 1
- Request: adding EXTRACT_PRIV_VIRTUAL
- Related global functions shown as methods HOT 1
- Public class members other than member functions not shown
- Two enum-related problems
- "Global" language pill switching
- Suppress link generation for commonly used words
- Error generating automatic API documentation when input folder has same name as project
- ERROR!! Your sidebar section Public API has 0 pages HOT 2
- 错误,网站打不开了? HOT 1
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
D3
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
-
Recommend Topics
-
javascript
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
-
web
Some thing interesting about web. New door for the world.
-
server
A server is a program made to process requests and deliver data to clients.
-
Machine learning
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from docsforge.