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
Chris
  • Administrators
  • 10727 posts
  • Last active:
  • Joined: 02 Mar 2004

minor typo - key list - special keys section
detectible -> detectable

Surprisingly, both spellings are considered valid.

svi
  • Members
  • 237 posts
  • Last active: Mar 09 2015 06:34 PM
  • Joined: 09 Oct 2006
Earlier in this thread mentioned: (regarding placement)

The first comma of any command may be omitted.

is a bit false.

If the first parameter is omitted, a comma is naturally required:

WinGetPos X, Y, , , Untitled
works, but
WinGetPos , Y, , , Untitled
doesn't.

I once fell into this trap, but I'm not sure if it should be mentioned in the documentation ; a delight to learn should be preserved ...
Pekka Vartto

Chris
  • Administrators
  • 10727 posts
  • Last active:
  • Joined: 02 Mar 2004
I see your point; but maybe the current wording is better because it avoids the complexity of describing the exception. Also, the exception seems somewhat self-evident. I'm not sure.

PhiLho
  • Moderators
  • 6850 posts
  • Last active: Jan 02 2012 10:09 PM
  • Joined: 27 Dec 2005

Also, the exception seems somewhat self-evident.

Uh, no... But indeed, a good concise formulation isn't obvious. I came up with:
The comma between the command name and the first parameter, if non empty, can be omitted.
Or, to preserve original sentence:
The first comma of any command may be omitted. Except if the first parameter is empty.
Posted Image vPhiLho := RegExReplace("Philippe Lhoste", "^(\w{3})\w*\s+\b(\w{3})\w*$", "$1$2")

Chris
  • Administrators
  • 10727 posts
  • Last active:
  • Joined: 02 Mar 2004
Thanks. I've amended the wording.

Stefan
  • Members
  • 74 posts
  • Last active: Apr 15 2009 09:33 PM
  • Joined: 30 Jul 2004
Help about "Send"

I have missed the info that the %-char must be quoted/escaped and how.

Maybe there should be an quick info
about such special chars in the SEND-help
and that the `-char is Alt+96
and maybe an link to "EscapeChars" in the "Related" section?

------------------------------------------------------------------------
Related
SendMode, SetKeyDelay, SetStoreCapslockMode, EscapeChars, ControlSend, BlockInput, Hotstrings, WinActivate
------------------------------------------------------------------------

--

Thanks to engunneer for pointing me to this thread.
Posted Image Stefan

This post was created with the kindly help of http://dict.leo.org/ and remember: “Allways look on the bright side of Life”

Chris
  • Administrators
  • 10727 posts
  • Last active:
  • Joined: 02 Mar 2004
Thanks; I've added "Escape sequences (e.g. `%)" to the "related" section.

corrupt
  • Members
  • 2558 posts
  • Last active: Nov 01 2014 03:23 PM
  • Joined: 29 Dec 2004

An integer between 0 and 4294967296 that FunctionName will see in A_EventInfo whenever it is called via this Address. This is useful when FunctionName is called by more than one Address. If omitted, it defaults to Address. Note: Unlike global other settings, the current thread's A_EventInfo is not disturbed by the fast mode.



Chris
  • Administrators
  • 10727 posts
  • Last active:
  • Joined: 02 Mar 2004
Thanks.

Fuco
  • Members
  • 49 posts
  • Last active: Oct 24 2008 06:21 PM
  • Joined: 21 Mar 2006
I had a realy hard problem with this.

Any hotkey subroutine whose first line is Suspend (except "Suspend On") will be exempt from suspension. In other words, the hotkey will remain enabled even while suspension is ON. This allows suspension to be turned off via such a hotkey.


It says that first line should be suspend, my code was something like this

labelofhotkey:
{            ; because of some reason, this is first line :O
suspend  ; this should be the first line of subroutine...but it isnt :(
...
...
}

There should be said, that { and } are taken as "lines" ( which thay aint imo ), because I and also lot of ppl like using of { } to make code nicer :) and so can experience this problem.

Or there is second and harder option, and thats modifying "syntax" or whatever so it accept also this situation.
RegExReplace("C:\Program Files\AutoHotkey", "(^C)(?=\W).{4}((?i)[GOD])\w{1,4}\s(\D)(?:\w+)*\\(?3)(u|o).*?(k).*" , "$3$4$l1$5$2")

Chris
  • Administrators
  • 10727 posts
  • Last active:
  • Joined: 02 Mar 2004
Braces were never intended to be used at the beginning and end of subroutines. However, I"ve clarified it slightly via "Any hotkey subroutine whose very first line is Suspend..."

Although more explicit wording could be added, I think it would be more distracting than it's worth because the wording is already a bit complicated.

Thanks.

engunneer
  • Moderators
  • 9162 posts
  • Last active: Sep 12 2014 10:36 PM
  • Joined: 30 Aug 2005

<snip>
WinActive(WinTitle [, WinText, ExcludeTitle, ExcludeText])
<snip>
WinExist(WinTitle [, WinText, ExcludeTitle, ExcludeText])
<snip>


should be

<snip>
WinActive([WinTitle , WinText, ExcludeTitle, ExcludeText])
<snip>
WinExist([WinTitle , WinText, ExcludeTitle, ExcludeText])
<snip>



Superfraggle
  • Members
  • 1019 posts
  • Last active: Sep 25 2011 01:06 AM
  • Joined: 02 Nov 2004
Just a minor typo I noticed

; Here is a working example that demonstrates how a Progress window can be
; overlayed on a SplashImage to make a professional looking Installer screen:
IfExist, C:\WINDOWS\system32\ntimage.gif, SplashImage, %A_WinDir%\system32\ntimage.gif, A,,, Installation
Loop, %A_WinDir%\system32\*.*
{
Progress, %a_index%, %a_loopfilename%, Installing..., Draft Installtion
Sleep, 50
if a_index = 100
break
}
; There is similar example at the bottom of the GUI page. Its advantage is that it uses only a single
; window and it gives you more control over window layout.


Steve F AKA Superfraggle

http://r.yuwie.com/superfraggle

Chris
  • Administrators
  • 10727 posts
  • Last active:
  • Joined: 02 Mar 2004
Thanks; the items in the two posts above have been corrected.

engunneer
  • Moderators
  • 9162 posts
  • Last active: Sep 12 2014 10:36 PM
  • Joined: 30 Aug 2005
thanks for having a good place to suggest these changes.