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

Update all shortcuts in the manual #110

Open
YYBartT opened this issue Apr 18, 2024 · 0 comments
Open

Update all shortcuts in the manual #110

YYBartT opened this issue Apr 18, 2024 · 0 comments
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@YYBartT
Copy link
Collaborator

YYBartT commented Apr 18, 2024

With the automatic export of keyboard shortcuts, all unique shortcuts that can be used are now available in the manual as variables. Currently the list is still updated from the JSON file by manually running a Python script, but in a next step this could also be automated.

The shortcuts that are currently in the manual are all written as text, for example on The Script Editor page. Now that we have the shortcuts available, there is no use in typing them manually anymore since a given key combination either corresponds to an existing hotkey or it doesn't and there is a chance a shortcut might change, in which case we need to update it manually on all the pages that mention it.

Replacing all existing, manually written shortcuts with a link/reference to one of the variables should make things more robust and should result in less out-of-date shortcuts being listed in the manual.

One thing to look into is how to do this in RoboHelp, either through variables or cross-references. The shortcuts need to be listed on the Keyboard Shortcuts page, but can also be inserted on any other manual page. Additionally, the shortcuts inserted on other manual pages should refer to the keyboard shortcuts page. Look for the best way to do this.

@gurpreetsinghmatharoo gurpreetsinghmatharoo moved this from Triage to Backlog in Team Workload Apr 18, 2024
@gurpreetsinghmatharoo gurpreetsinghmatharoo added the documentation Improvements or additions to documentation label Apr 18, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
Status: Backlog
Development

No branches or pull requests

2 participants