Re: Suggestions on documentation improvements
Posted: 17 Aug 2018, 16:44
EDITING PAGES
- @Ragnar: Good points, I think we need a prominent place where information about AutoHotkey and GitHub is contained. I had no idea of any of that, despite following this thread for a fair while.
- It might seem minor, but out of respect I wanted to let you choose which hyphen Unicode character, and whether to use spacing or not, html formatting etc. Furthermore, there may be style guide precedent based on other pages.
RELATED TOPICS
- Because it's easier to search for 'Related T' than wade through 'related' multiple times, I would suggest that all 'Related' section headers become 'Related Topics'.
- (For the record, these 2 pages use 'Related Topics', every other page uses 'Related' as the section header.)
Remapping Keys (Keyboard, Mouse and Joystick) | AutoHotkey
https://autohotkey.com/docs/misc/Remap.htm
Remapping a Joystick to Keyboard or Mouse | AutoHotkey
https://autohotkey.com/docs/misc/RemapJoystick.htm
- (Despite appearing only twice, I thought that 'Related Topics' was common, partly because other pages use the phrase 'related topic(s)' occasionally. So I kept trying to search for 'Related T' with no luck.)
- Many pages lack a 'Related Topics' section, including these two, which I think should link to each other. Cheers.
Basic Object - Methods & Properties | AutoHotkey
https://autohotkey.com/docs/objects/Object.htm
Objects - Definition & Usage | AutoHotkey
https://autohotkey.com/docs/Objects.htm
VERSION NUMBER MISSING
- [ObjRawSet][v1.1.21+]
Basic Object - Methods & Properties | AutoHotkey
https://autohotkey.com/docs/objects/Object.htm
- [ComObject/ComObjEnwrap/ComObjUnwrap/ComObjMissing/ComObjParameter][v1.0.90+?]
ComObjActive() - Syntax & Usage | AutoHotkey
https://autohotkey.com/docs/commands/ComObjActive.htm
- [Array][v1.0.97+?] and [Object][v1.0.90+?]
Basic Object - Methods & Properties | AutoHotkey
https://autohotkey.com/docs/objects/Object.htm
- [A_IsUnicode][v1.0.90+?]
Variables and Expressions - Definition & Usage | AutoHotkey
https://autohotkey.com/docs/Variables.htm
- I've created a list of AHK v1.1 new features, with the version number for each item.
list of every command/function/variable from across all versions - AutoHotkey Community
https://autohotkey.com/boards/viewtopic ... 42#p131642
FUNCTION INDEX MISSING
- OnError.
- @Ragnar: Good points, I think we need a prominent place where information about AutoHotkey and GitHub is contained. I had no idea of any of that, despite following this thread for a fair while.
- It might seem minor, but out of respect I wanted to let you choose which hyphen Unicode character, and whether to use spacing or not, html formatting etc. Furthermore, there may be style guide precedent based on other pages.
RELATED TOPICS
- Because it's easier to search for 'Related T' than wade through 'related' multiple times, I would suggest that all 'Related' section headers become 'Related Topics'.
- (For the record, these 2 pages use 'Related Topics', every other page uses 'Related' as the section header.)
Remapping Keys (Keyboard, Mouse and Joystick) | AutoHotkey
https://autohotkey.com/docs/misc/Remap.htm
Remapping a Joystick to Keyboard or Mouse | AutoHotkey
https://autohotkey.com/docs/misc/RemapJoystick.htm
- (Despite appearing only twice, I thought that 'Related Topics' was common, partly because other pages use the phrase 'related topic(s)' occasionally. So I kept trying to search for 'Related T' with no luck.)
- Many pages lack a 'Related Topics' section, including these two, which I think should link to each other. Cheers.
Basic Object - Methods & Properties | AutoHotkey
https://autohotkey.com/docs/objects/Object.htm
Objects - Definition & Usage | AutoHotkey
https://autohotkey.com/docs/Objects.htm
VERSION NUMBER MISSING
- [ObjRawSet][v1.1.21+]
Basic Object - Methods & Properties | AutoHotkey
https://autohotkey.com/docs/objects/Object.htm
- [ComObject/ComObjEnwrap/ComObjUnwrap/ComObjMissing/ComObjParameter][v1.0.90+?]
ComObjActive() - Syntax & Usage | AutoHotkey
https://autohotkey.com/docs/commands/ComObjActive.htm
- [Array][v1.0.97+?] and [Object][v1.0.90+?]
Basic Object - Methods & Properties | AutoHotkey
https://autohotkey.com/docs/objects/Object.htm
- [A_IsUnicode][v1.0.90+?]
Variables and Expressions - Definition & Usage | AutoHotkey
https://autohotkey.com/docs/Variables.htm
- I've created a list of AHK v1.1 new features, with the version number for each item.
list of every command/function/variable from across all versions - AutoHotkey Community
https://autohotkey.com/boards/viewtopic ... 42#p131642
FUNCTION INDEX MISSING
- OnError.