| View previous topic :: View next topic |
| Author |
Message |
SanskritFritz
Joined: 17 Feb 2005 Posts: 283 Location: Hungary, Budapest
|
Posted: Wed Mar 16, 2005 7:15 pm Post subject: Suggestions on documentation improvements |
|
|
In the [url=http://www.autohotkey.com/docs/scripts/EasyWindowDrag_(KDE).htm]documentation[/url] the comment is a result of copy and paste :
GetKeyState,KDE_Button,RButton,P ; Break if LButton has been released. _________________ Is there another word for synonym?
Last edited by SanskritFritz on Wed Feb 15, 2006 3:14 pm; edited 1 time in total |
|
| Back to top |
|
 |
Chris Site Admin
Joined: 02 Mar 2004 Posts: 10450
|
Posted: Wed Mar 16, 2005 11:47 pm Post subject: |
|
|
| Thanks, that's been fixed. Please continue to report typos in the documentation whenever you notice them. Or you can just mail them to support@autohotkey.com. |
|
| Back to top |
|
 |
jonny
Joined: 13 Nov 2004 Posts: 3005 Location: Minnesota
|
Posted: Thu Mar 17, 2005 12:08 am Post subject: |
|
|
My bad. Thanks for reporting it. |
|
| Back to top |
|
 |
SanskritFritz
Joined: 17 Feb 2005 Posts: 283 Location: Hungary, Budapest
|
Posted: Fri Apr 08, 2005 9:52 am Post subject: |
|
|
Ok, here is another one in ControlClick:
| Quote: | | WinTitle: If this and the next 3 parameters are omitted, the Last Found Window will be used. If this is the letter A and the next 3 parameters are omitted, the active window will be used. | Well, to be exact, in this case those params aren't the next. Again we are victims of copy-paste  _________________ Is there another word for synonym? |
|
| Back to top |
|
 |
Chris Site Admin
Joined: 02 Mar 2004 Posts: 10450
|
Posted: Fri Apr 08, 2005 10:30 pm Post subject: |
|
|
| Good catch; I'll definitely fix that. In this case, it was probably caused by global search & replace across all documents. |
|
| Back to top |
|
 |
SanskritFritz
Joined: 17 Feb 2005 Posts: 283 Location: Hungary, Budapest
|
Posted: Mon May 02, 2005 10:30 am Post subject: |
|
|
Here we go again :
http://www.autohotkey.com/docs/commands/SetTimer.htm
"If you wish the timer's first first execution to be immediate..."
BTW I just love to RTFM, really, Autohotkey has one of the best documentations one can wish, I especially value the examples very high! _________________ Is there another word for synonym? |
|
| Back to top |
|
 |
Chris Site Admin
Joined: 02 Mar 2004 Posts: 10450
|
Posted: Mon May 02, 2005 11:13 am Post subject: |
|
|
Thanks; that's been fixed.  |
|
| Back to top |
|
 |
SanskritFritz
Joined: 17 Feb 2005 Posts: 283 Location: Hungary, Budapest
|
Posted: Tue Feb 07, 2006 2:54 pm Post subject: |
|
|
Another small annoyance:
On the page http://www.autohotkey.com/docs/Variables.htm
in the A_EventInfo section there is a Note. I think it should be outside of the table cell, as it does not refer to A_EventInfo only. _________________ Is there another word for synonym? |
|
| Back to top |
|
 |
Chris Site Admin
Joined: 02 Mar 2004 Posts: 10450
|
Posted: Tue Feb 07, 2006 3:56 pm Post subject: |
|
|
| Thanks; I've changed it. |
|
| Back to top |
|
 |
PhiLho
Joined: 27 Dec 2005 Posts: 6702 Location: France (near Paris)
|
Posted: Tue Feb 07, 2006 4:43 pm Post subject: |
|
|
Interesting thread for small thingies not worth a separate entry...
Two notes I took when first reading the doc. (I omit the Gosub/Exit already reported):
Script section, "Comments in Scripts": "Tip: The first comma of any command may be omitted. "
I don't feel this tip belongs to comments... I suggest you put this tip in the Tutorial section, since you first use this syntax here and I was a bit confused to see MsgBox without initial comma unlike the previous examples...
AutoScriptWriter is mentioned twice in the doc, but not much information is given on how to use it.
I understand that it is a third party software, and finally rather simple to use, but a link to a page with a few words on its usage could help. I was perplexed until I found out that the red logo is an actual button... |
|
| Back to top |
|
 |
Chris Site Admin
Joined: 02 Mar 2004 Posts: 10450
|
Posted: Tue Feb 07, 2006 7:59 pm Post subject: |
|
|
| Quote: | "Tip: The first comma of any command may be omitted."
I don't feel this tip belongs to comments | You're right, I never liked it there. I've moved it to Escape Sequences (on the same page) where it seems to fit better. I've also added it to the Quick-start Tutorial, but changed most of the tutorial to omit the first comma so that new users get used to the convenience. Thanks.
| Quote: | AutoScriptWriter ... not much information is given on how to use it.
I was perplexed until I found out that the red logo is an actual button... | Some documentation of that is planned. I've made a note to explain the button better. Thanks. |
|
| Back to top |
|
 |
PhiLho
Joined: 27 Dec 2005 Posts: 6702 Location: France (near Paris)
|
Posted: Thu Feb 09, 2006 3:18 pm Post subject: |
|
|
1) You write: Text
Unmodifiable text with no border
After testing, I saw that is not exactly true on the "Unmodifiable" side (even if I understand that the sense is to oppose it to Edit): you can use ControlSetText to change the text. Or, as toralf pointed out, the more appropriate GuiControl command.
It is nicer than using a read-only Edit control, I often use such thingies to display debug data...
Perhaps you can add a line about this in this paragraph or change slightly the wording.
Also, the GuiControl page should include the Text control in the (Blank) and Text sub-commands.
2) Why If[Not]InString isn't in the Flow of Control section? There is a link to this command in the If page, but it is near the bottom, and one can miss it in a quick glance (I did... "Mumble... I recall something like that, where can it be? Mumble..." ).
I would include in the yellow list, I see not reason why it isn't there. _________________
vPhiLho := RegExReplace("Philippe Lhoste", "^(\w{3})\w*\s+\b(\w{3})\w*$", "$1$2") |
|
| Back to top |
|
 |
Chris Site Admin
Joined: 02 Mar 2004 Posts: 10450
|
Posted: Thu Feb 09, 2006 9:50 pm Post subject: |
|
|
| Thanks; I've made a note to correct those things in the documentation. |
|
| Back to top |
|
 |
PhiLho
Joined: 27 Dec 2005 Posts: 6702 Location: France (near Paris)
|
Posted: Wed Feb 15, 2006 10:04 am Post subject: |
|
|
Still reporting some small remarks on the fine documentation.
Perhaps this thread should be renamed, or perhaps I should start one of my own
1) PostMessage / SendMessage has a convenient link to the message list.
OnMessage hasn't, at least, not on the MsgNumber description.
It would be nice to add one, since I am not able to locate this page in the Summary tab of the CHM file.
2) SysGet: "Within a function, to create an set of variables" _________________
vPhiLho := RegExReplace("Philippe Lhoste", "^(\w{3})\w*\s+\b(\w{3})\w*$", "$1$2") |
|
| Back to top |
|
 |
SanskritFritz
Joined: 17 Feb 2005 Posts: 283 Location: Hungary, Budapest
|
Posted: Wed Feb 15, 2006 11:48 am Post subject: |
|
|
| Quote: | | Perhaps this thread should be renamed | Suggestions please  _________________ Is there another word for synonym? |
|
| Back to top |
|
 |
|