Jump to content

Sky Slate Blueberry Blackcurrant Watermelon Strawberry Orange Banana Apple Emerald Chocolate
Photo

Suggestions on documentation improvements


  • Please log in to reply
244 replies to this topic
Lexikos
  • Administrators
  • 9844 posts
  • AutoHotkey Foundation
  • Last active:
  • Joined: 17 Oct 2006

a mention on the WinGetText command page that it obeys SetTitleMatchMode and will return extra text if 'Slow' is used

 

That is incorrect, as explained here.



faqbot
  • Members
  • 997 posts
  • Last active:
  • Joined: 10 Apr 2012
Not sure where to post but if someone has 'better' examples for SendLevel and #InputLevel that would be useful. Basic usage works but as soon as you use Unicode characters it seems to fail - see these two non-working examples here: http://www.autohotke...-key-remapping/ http://www.autohotke...art-of-another/ regular a-z 1-0 hotstrings/hotkeys work, unicode hotstrings/hotkeys don't - it might something simple which could/should be clarified in the doc.

faqbot
  • Members
  • 997 posts
  • Last active:
  • Joined: 10 Apr 2012
Perhaps an example to illustrate the "Common source of confusion" as described here http://l.autohotkey....ions.htm#Locals would be useful to add to the documentation
; This example illustrates the "Common source of confusion" as described above

FunctionWithoutGlobal("a|b|c") ; will fail
FunctionWithGlobal("a|b|c")    ; will work

FunctionWithoutGlobal(String)
	{
	 Loop, % SplitFunction(String)
		MsgBox % A_Index ":" Str%A_Index%     ; second MsgBox will be empty
	 MsgBox Function *without* global: %Str2% ; will be empty
	}

FunctionWithGlobal(String)
	{
	 global
	 Loop, % SplitFunction(String)
		MsgBox % A_Index ":" Str%A_Index%  ; second MsgBox will be b
	 MsgBox Function *with* global: %Str2% ; will show b
	}

SplitFunction(var)	
	{
	 global
	 StringSplit, Str, var, |
	 Return Str0
	}


guest3456
  • Members
  • 1704 posts
  • Last active: Nov 19 2015 11:58 AM
  • Joined: 10 Mar 2011
http://l.autohotkey..../FormatTime.htm

if my tests are correct, the comments for last example are wrong for this line, in both AHK_B and AHK_L docs


return NumberOfSeconds//3600 ":" mmss

; This method is used to support more than 24 hours worth of sections.


should read
 

; This is used to support more than 60 minutes worth of seconds.



trismarck
  • Members
  • 390 posts
  • Last active: Nov 25 2015 12:35 PM
  • Joined: 02 Dec 2010

Please add the information for ControlGet that ControlGet doesn't support the name of the Autohotkey variable associated with a control as a parameter (to use the name of AHK variable, use GuiControlGet). I remember I've stumbled on this at least two times and saw at least two topics like this one.


New Autohotkey forum: http://ahkscript.org.


faqbot
  • Members
  • 997 posts
  • Last active:
  • Joined: 10 Apr 2012
Suggest to add a comment below Remarks on http://l.autohotkey....IfWinActive.htm
hotkey::
IfWinActive, window
  ; do this
else
 ; send hotkey
return
to create a context sensitive hotkey as they don't understand/know about #IfWinActive suggested text

Common source of confusion: If you want to create context sensitive hotkeys using #IfWinActive is usually easier to implement.


LazyMan
  • Members
  • 587 posts
  • Last active: Oct 21 2014 05:13 PM
  • Joined: 17 Feb 2011

The SendPlay documentation delivered with the download includes the following which is not available online:

 

However, SendPlay may have no effect at all on Windows Vista or later if User Account Control is enabled, even if the script is running as an administrator. The following script provides a workaround for this problem: http://www.autohotke...topic75595.html.


Jackie Sztuk _Blackholyman
  • Spam Officer
  • 3757 posts
  • Last active: Apr 03 2016 08:47 PM
  • Joined: 28 Feb 2012
seems to be in both the l.net and in the .org

http://l.autohotkey....#SendPlayDetail
http://ahkscript.org...#SendPlayDetail

the .com has been out off date for a long time...
Helping%20you%20learn%20autohotkey.jpg?d

[AHK] Version. 1.1+ [CLOUD] DropBox ; Copy [WEBSITE] Blog ; About

LazyMan
  • Members
  • 587 posts
  • Last active: Oct 21 2014 05:13 PM
  • Joined: 17 Feb 2011

Thanks for those links, Blackholyman. :)

 

It's sad that the documentation at this site is not being kept current. :(

 



hoppfrosch
  • Members
  • 399 posts
  • Last active: Feb 26 2016 05:31 AM
  • Joined: 25 Jan 2006

Thanks for those links, Blackholyman. :)

 

It's sad that the documentation at this site is not being kept current. :(

 

Have a look here instead ;-)



Lexikos
  • Administrators
  • 9844 posts
  • AutoHotkey Foundation
  • Last active:
  • Joined: 17 Oct 2006

The SendPlay documentation delivered with the download includes the following which is not available online:

 

The link works just fine for me.



LazyMan
  • Members
  • 587 posts
  • Last active: Oct 21 2014 05:13 PM
  • Joined: 17 Feb 2011

The link works just fine for me.

 Whatchoo talkin' 'bout Willis?

 

The following quoted documentation is included in 2 of the 3 links below it (bet you can guess which one does not have it):

However, SendPlay may have no effect at all on Windows Vista or later if User Account Control is enabled, even if the script is running as an administrator. The following script provides a workaround for this problem: http://www.autohotke...topic75595.html.

That's what I'm talking about!?  :)



Lexikos
  • Administrators
  • 9844 posts
  • AutoHotkey Foundation
  • Last active:
  • Joined: 17 Oct 2006

Ah, now I understand Blackholyman's reply.  You said it wasn't available online, but the quoted text clearly is, so I assumed you were talking about something else.

 

You may notice the link in the quote is to a topic from the old old forum, but it actually still works.  This is the link I was talking about.

 

Also, there is no documentation at l.autohotkey.net anymore. ;)



Joefiesta
  • Members
  • 84 posts
  • Last active: Sep 09 2016 02:27 PM
  • Joined: 01 Nov 2010

FILEAPPEND   documentation

 

The documentation for FILEAPPEND states: "Writes text to the end of a file (first creating the file, if necessary)."  Nothing elso is mentioned in the documentation under FILEAPPEND in regards to creating a file.

 

This is not correct.  If the target directory does not exist, the file is not created.  The system issues A_lasterror  3



Joefiesta
  • Members
  • 84 posts
  • Last active: Sep 09 2016 02:27 PM
  • Joined: 01 Nov 2010

A_lasterror.

 

Documentation (e.g.this quote from RUN/WAIT) states: "However, A_LastError is also set by DllCall."

 

This is not exact. It implies that ONLY Run/wait and DLLCALL set A_lasterror.  A_lasterror is set by many AHK commands.