-
Notifications
You must be signed in to change notification settings - Fork 62
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
Several enhancements on documentation #42
Conversation
[+] Changed <br> to <br/> [*] Removed <pre> from Table of contents to homogenize with other pages [*] Renamed Search-Paste-Mode to Search-Mode (homogenization) [+] Added missing code tags [+] Added missing links
[+] Changed <br> to <br/> [*] Renamed Search-Paste-Mode to Search-Mode (homogenization) [+] Added missing code tags [+] Added missing links
Conflicts: chm_files/docs/devList.html
Commit 8 not needed. All the custom shortcuts are already given in the context menu. The common ones (Ctrl+F for find...) are already known to the users. If you provide gui accessibility keys of Channel organizer, it will become necessary to provide keys for History GUI and then Plugin Gui and more.. This is not necessary as Clipjump menus are plain, not nested and not large. You don't have to dig to find the needed feature and its shortcut. |
I found a problem with your shortcuts.html
Maybe in the wrong place. Also it should "press Ctrl + paste mode key to execute a paste mode feature when search is active." Also there is a typo in that page |
Concerning Commit 8 (e191860): The above (missing shortcuts on context menus) is even more confusing as some of the menu entries don't have a shortcut at all (for example right clicking on the channel list in channel organizer - "New" does not have any shortcut) On the other hand: as most keyboards offer a special key to open the context menu, each command on the context menu has an implicit shortcut via the "context menu" button and the up/down arrows - so why special shortcuts at all? Shortcut should be - as the name says - SHORTCUTS and offer almost direct access to the features - without pressing a complex key-sequence. The documentation of those shortcuts should be easy accessible as well (and not via digging deep in the documentation or opening the context menu ...) So I thought it might be a good idea to have a comprehensive list of all supported shortcuts. This would include for sure documentation of shortcuts of History GUI, Plugin Gui and more Concerning: Method to document shortcuts within language files? There are two methods within language files to document shortcuts. For example in language file:
Within channelOrganizer.ahk:
What's the expected way to document shortcuts?
I think the second one is more error prune (needs more editing ...) Which way would you recommend? Concerning: [Search Mode] or [Search-Paste Mode]? What name to use for [Search-Paste Mode]? [Search-Paste Mode] might be a good choice, since the corresponding functions in the API are prefixed
Will fix it
will add it
will fix it |
Sorry for such a late response. I completely forgot about this active issue.
The main reason of not mentioning them is because they are common. But I feel your perspective is right here. Will you create a new group on the introduction as "Window Interfaces" and then add things like Organizer, History and more in it.
This one. I would like to do this way in the future and have no plans to correct the past keys because of the reason you already gave. !! NO RISK !!
[Search-paste mode] or when writing it in language - "search in paste mode". |
Sorry for the late respnse - I've been quite busy the last days (and the next days as well ...)
I'll try to do this - but it's not completely clear to me what you mean here:
I'm not quite sure as most of the window interfaces already have their own separate pages (
I see the risk - but in terms of maintainability it might make more sense to have only one method documenting hotkeys. Therefore it might be a goal in longer terms to homogenize this ... (for example: on the context menus certain hotkeys are missing (there is a menu entry for "Refresh" - but "F5" is missing) If I want to correct this, it's difficult for anybody else than you to distinguish in language-file whether What I would suggest is a third method, a combination of both: Allow "variables" within language files and before using the language file preprocess it:
During preprocess step all entities Doing so, I see several advantages:
I think my suggestion makes maintaining languages files easier and your sourcecode more fail-safe (missing or using wrong shortcuts ...) |
…- until its clear how to handle shortcuts for other window interfaces (see #42)
That's true. I am also confused as to what should be done. I think we should drop this idea for the time being and only add something like "Important bindings" section at the end of history.html, organizer.html which will only have (important & un-documented) or global combinations.
That's a good idea. One problem in this method is values of all hotkey variables (like _!x) will be needed to be defined before other keys who ask for them so that the variable is active when needed. Both of the above things, I am not sure with. It would be better to wait till better ideas (or time) come. Other suggestions
|
I would prefer to have a own page for each major window interface with detailed information. On the basic_help.html I would only give an short overview on each window interface and link to the detailled information ... (BTW: that's something I already tried to discuss on #25)
I would suggest on shortcuts.html:
I agree to postpone this until you/we have a clearer vision ...
This might be solved by n-iterations on the replacement step (running it several times to resolve all templates ([% VAR %] is what I would call a template). This should solve the problem you see.
could be solved via iterations ...
OK. I'm more a X...-Person - prefering XHTML style. I personally find it much clearer to see where any tag ends if there is a closing tag available and automated parsing and validation is much easier as well if the text is encapsulated by opening and closing tags instead of relying on implicit rules. Beneath this it's more consistent and easier to remember having all tags properly closed (as some tags explicitly need a closing tag (i.e. |
Yes. It would be better to add shortcuts for window interfaces in their respective pages. That being said a page OR section in
No. have them in their pages.
|
Please solve the |
Thanks @hoppfrosch. I will merge it soon. |
Merged ! |
No description provided.