View topic - Suggestions on documentation improvements • AutoHotkey Community

View unanswered posts | View active topics

Board index » AutoHotkey » Issues

All times are UTC [ DST ]

Suggestions on documentation improvements

Page 3 of 13

[ 192 posts ]

Go to page Previous 1, 2, 3, 4, 5, 6 ... 13 Next

Print view | E-mail friend

Previous topic | Next topic

Author

Message

Chris

Post subject:

Posted: June 2nd, 2007, 8:31 pm

Joined: March 2nd, 2004, 3:36 pm
Posts: 10720

engunneer wrote:

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

Surprisingly, both spellings are considered valid.

Top

svi

Post subject:

Posted: June 5th, 2007, 8:16 pm

Joined: October 9th, 2006, 8:19 pm
Posts: 236
Location: Finland

Earlier in this thread mentioned: (regarding placement)

Quote:

The first comma of any command may be omitted.

is a bit false.

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

Code:

WinGetPos X, Y, , , Untitled

works, but

Code:

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

Top

Chris

Post subject:

Posted: June 6th, 2007, 1:18 am

Joined: March 2nd, 2004, 3:36 pm
Posts: 10720

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.

Top

PhiLho

Post subject:

Posted: June 6th, 2007, 9:47 am

Joined: December 27th, 2005, 1:46 pm
Posts: 6837
Location: France (near Paris)

Chris wrote:

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.

_________________

vPhiLho := RegExReplace("Philippe Lhoste", "^(\w{3})\w*\s+\b(\w{3})\w*$", "$1$2")

Last edited by PhiLho on June 6th, 2007, 1:09 pm, edited 1 time in total.

Top

Chris

Post subject:

Posted: June 6th, 2007, 1:08 pm

Joined: March 2nd, 2004, 3:36 pm
Posts: 10720

Thanks. I've amended the wording.

Top

Stefan

Post subject:

Posted: June 9th, 2007, 10:15 pm

Joined: July 30th, 2004, 11:30 pm
Posts: 74
Location: Deutschland (sorry for my english)

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.

_________________

Stefan

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

Top

Chris

Post subject:

Posted: June 10th, 2007, 10:40 pm

Joined: March 2nd, 2004, 3:36 pm
Posts: 10720

Thanks; I've added "Escape sequences (e.g. `%)" to the "related" section.

Top

corrupt

Post subject:

Posted: June 11th, 2007, 1:59 am

Joined: December 29th, 2004, 1:28 pm
Posts: 2541

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.

Top

Chris

Post subject:

Posted: June 11th, 2007, 4:00 am

Joined: March 2nd, 2004, 3:36 pm
Posts: 10720

Thanks.

Top

Fuco

Post subject:

Posted: June 26th, 2007, 11:44 pm

Joined: March 21st, 2006, 8:31 pm
Posts: 49
Location: Slovakia, Europe :)

I had a realy hard problem with this.

Suspend command wrote:

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

Code:

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")

Top

Chris

Post subject:

Posted: June 27th, 2007, 10:57 am

Joined: March 2nd, 2004, 3:36 pm
Posts: 10720

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.

Top

engunneer

Post subject:

Posted: July 10th, 2007, 11:08 pm

Joined: August 30th, 2005, 8:43 pm
Posts: 8647
Location: Salem, MA

Built-in Functions wrote:

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

should be

Built-in Functions wrote:

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

_________________

(Common Answers) - New Tutorials Forum - Humongous FAQ

Top

Superfraggle

Post subject:

Posted: July 10th, 2007, 11:27 pm

Joined: November 2nd, 2004, 2:43 pm
Posts: 1019
Location: London, UK

Just a minor typo I noticed

Progress wrote:

; 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

Top

Chris

Post subject:

Posted: July 11th, 2007, 2:34 am

Joined: March 2nd, 2004, 3:36 pm
Posts: 10720

Thanks; the items in the two posts above have been corrected.

Top

engunneer

Post subject:

Posted: July 11th, 2007, 3:43 am

Joined: August 30th, 2005, 8:43 pm
Posts: 8647
Location: Salem, MA

thanks for having a good place to suggest these changes.

_________________

(Common Answers) - New Tutorials Forum - Humongous FAQ

Top

Page 3 of 13

[ 192 posts ]

Go to page Previous 1, 2, 3, 4, 5, 6 ... 13 Next

Board index » AutoHotkey » Issues

All times are UTC [ DST ]

Who is online

Users browsing this forum: No registered users and 6 guests

You can post new topics in this forum
You can reply to topics in this forum
You cannot edit your posts in this forum
You cannot delete your posts in this forum
You cannot post attachments in this forum