Re: Suggestions on documentation improvements
Posted: 29 Sep 2019, 13:17
CONTROLSETCHECKED (CONTROL CHECK/UNCHECK) FOCUSES CONTROLS
- Re.:
check/uncheck Button controls (BM_SETCHECK v. BM_CLICK) - AutoHotkey Community
https://autohotkey.com/boards/viewtopic.php?f=5&t=68413
- The AHK v1/v2 documentation should mention that ControlSetChecked has the side effect of *focusing* the control.
- That BM_SETCHECK does not have this side effect, could be mentioned.
CONTROLFINDITEM (CONTROLGET FINDSTRING) AND CONTROLCHOOSESTRING
- ControlFindItem (matches whole).
- ControlChooseString (matches the start).
- The AHK v2 ControlFindItem page mentions ControlChooseString.
- The AHK v2 ControlChooseString page could/should mention ControlFindItem.
- The AHK v1 ControlGet FindString section could/should mention Control ChooseString.
- The AHK v1 Control ChooseString section could/should mention ControlGet FindString.
ENVSUB
- This is unclear:
CODE EXAMPLES
- %0% versus A_Args: Some parts of the documentation still use %0% rather than A_Args.
- The MessageBox example on the DllCall page uses "0" rather than 0.
FUNCTION LISTS: LONG PATHS
- I've updated these lists (do notify of any issues):
list of every command/function/variable from across all versions - AutoHotkey Community
https://autohotkey.com/boards/viewtopic.php?f=74&t=27321&p=131642#p131642
list of every object type/property/method - AutoHotkey Community
https://autohotkey.com/boards/viewtopic.php?f=37&t=44081
- Functions that *do* support long paths (and Loop Files) could be mentioned explicitly, here:
Long Paths | AutoHotkey
https://www.autohotkey.com/docs/misc/LongPaths.htm
FUNCTION LISTS: CASE/DEFAULT
- For my 'list of every...' list, and the control flow link below, please inform whether Case and Default are considered as control flow statements (or if not, what category of thing they are).
- Switch is listed here:
Scripting Language | AutoHotkey
https://www.autohotkey.com/docs/Language.htm#control-flow
- (Other terminology queries that the documentation could/should cover:)
terminology: objects/classes: keywords - AutoHotkey Community
https://autohotkey.com/boards/viewtopic.php?f=5&t=66547
terminology: statement separator, statement terminator - AutoHotkey Community
https://autohotkey.com/boards/viewtopic.php?f=5&t=66327
- Thanks.
- Re.:
check/uncheck Button controls (BM_SETCHECK v. BM_CLICK) - AutoHotkey Community
https://autohotkey.com/boards/viewtopic.php?f=5&t=68413
- The AHK v1/v2 documentation should mention that ControlSetChecked has the side effect of *focusing* the control.
- That BM_SETCHECK does not have this side effect, could be mentioned.
CONTROLFINDITEM (CONTROLGET FINDSTRING) AND CONTROLCHOOSESTRING
- ControlFindItem (matches whole).
- ControlChooseString (matches the start).
- The AHK v2 ControlFindItem page mentions ControlChooseString.
- The AHK v2 ControlChooseString page could/should mention ControlFindItem.
- The AHK v1 ControlGet FindString section could/should mention Control ChooseString.
- The AHK v1 Control ChooseString section could/should mention ControlGet FindString.
ENVSUB
- This is unclear:
- EnvSub can be used to: get the difference between 2 datestamps in seconds/minutes/hours/days.Sets a variable to itself minus the given value (can also compare date-time values).
CODE EXAMPLES
- %0% versus A_Args: Some parts of the documentation still use %0% rather than A_Args.
- The MessageBox example on the DllCall page uses "0" rather than 0.
FUNCTION LISTS: LONG PATHS
- I've updated these lists (do notify of any issues):
list of every command/function/variable from across all versions - AutoHotkey Community
https://autohotkey.com/boards/viewtopic.php?f=74&t=27321&p=131642#p131642
list of every object type/property/method - AutoHotkey Community
https://autohotkey.com/boards/viewtopic.php?f=37&t=44081
- Functions that *do* support long paths (and Loop Files) could be mentioned explicitly, here:
Long Paths | AutoHotkey
https://www.autohotkey.com/docs/misc/LongPaths.htm
Code: Select all
- Functions etc that use paths in some way:
- Candidates (attempt at a full list):
DirXXX
DllCall
Download(/UrlDownloadToFile)
DriveXXX
EnvXXX
FileXXX
GuiCreate(/Gui-Add-Picture/GuiControl/SB_SetIcon)
IL_Add
ImageSearch
IniXXX
LoadPicture
ProcessXXX
RunXXX
SetWorkingDir
SoundPlay
SplashImage
SplitPath
TraySetIcon(/Menu-Tray-Icon/Menu-XXX-Icon)
WinGetProcessName
WinGetProcessPath
(Did I miss one?)
- Also:
#Include/#IncludeAgain
A_ variables
AHK main window title
Clipboard variable
ListLines main window text
Loop Files
- For my 'list of every...' list, and the control flow link below, please inform whether Case and Default are considered as control flow statements (or if not, what category of thing they are).
- Switch is listed here:
Scripting Language | AutoHotkey
https://www.autohotkey.com/docs/Language.htm#control-flow
- (Other terminology queries that the documentation could/should cover:)
terminology: objects/classes: keywords - AutoHotkey Community
https://autohotkey.com/boards/viewtopic.php?f=5&t=66547
terminology: statement separator, statement terminator - AutoHotkey Community
https://autohotkey.com/boards/viewtopic.php?f=5&t=66327
- Thanks.