Revision of docs for v2

Helpful script writing tricks and HowTo's
User avatar
derz00
Posts: 134
Joined: 02 Feb 2016, 17:54

Revision of docs for v2

06 Jul 2017, 05:41

Hi, I have seen multiple threads about "where/what is the main window?" And I have not found much of anything in the documentation about it. But when searching today, i found this solitary page:
https://autohotkey.com/docs/program.html

I cannot find this page or anything similar in the docs. Is there a reason? This page contains information that everyone (noobs) should know, like:

Known issue: Keyboard shortcuts for menu items do not work while the script is displaying a MsgBox or other dialog.


I asked about this in the Ask for Help forum the other day, I didn't know that MsgBox was an issue.

Can anyone tell me why this would not be a good idea: Add this page https://autohotkey.com/docs/program.html to the official docs, and link any instance of "main window" in the docs to that page.
Last edited by derz00 on 09 Jul 2017, 22:04, edited 1 time in total.
Sarcastic comment:
Loading.....
lexikos
Posts: 5407
Joined: 30 Sep 2013, 04:07
GitHub: Lexikos

Re: Missing from docs?

06 Jul 2017, 18:17

It is part of an incomplete revision of the docs (see here).
User avatar
derz00
Posts: 134
Joined: 02 Feb 2016, 17:54

Re: Missing from docs?

07 Jul 2017, 07:19

OK, I didn't realize that. I guess revising the docs will be/is a lot of work. Can you tell me where the latest updates about AHK_v2 are? Github?
Sarcastic comment:
Loading.....
lexikos
Posts: 5407
Joined: 30 Sep 2013, 04:07
GitHub: Lexikos

Re: Missing from docs?

07 Jul 2017, 16:50

What kind of updates?
User avatar
derz00
Posts: 134
Joined: 02 Feb 2016, 17:54

Re: Missing from docs?

09 Jul 2017, 07:45

I guess I just had in mind general updates of the v2 project. But maybe you don't like to be pestered about that. Anyway I suppose that if v2 becomes a stable release we will all find out. I think I might sometime start using v2 with new scripts. Thanks anyways for all your hard work!
Sarcastic comment:
Loading.....
User avatar
jeeswg
Posts: 1541
Joined: 19 Dec 2016, 01:58
Location: UK

Re: Missing from docs?

09 Jul 2017, 10:21

AutoHotkey v2
https://autohotkey.com/v2/

[AHK v2 latest release, contains latest AutoHotkey.chm file]
ahk-v2.zip
https://autohotkey.com/download/ahk-v2.zip

[AHK v2 source code]
GitHub - Lexikos/AutoHotkey_L at alpha
https://github.com/Lexikos/AutoHotkey_L/tree/alpha

[AHK v2 docs]
GitHub - Lexikos/AutoHotkey_L-Docs at v2
https://github.com/Lexikos/AutoHotkey_L-Docs/tree/v2
User avatar
derz00
Posts: 134
Joined: 02 Feb 2016, 17:54

Re: Missing from docs?

09 Jul 2017, 22:04

Hi, I downloaded that zip, but the AutoHotkey.chm file seems blank. The categories, and index links are there, but clicking on them brings nothing. Likely can blame the fact that progress is still underway.

And looking through the docs here I see that for Msgbox, it has function syntax and command syntax. I thought the choice was to remove commands. Is this just 2 different syntaxes, both technically "functions"? I suppose the command syntax is easier for beginners, and sufficient for most simple applications, although the function syntax is more powerful? I also cannot see any other command pages with this updated code examples at the bottom, so it seems this was just the first one worked on.
Sarcastic comment:
Loading.....
User avatar
Xtra
Posts: 731
Joined: 02 Oct 2015, 12:15

Re: Missing from docs?

09 Jul 2017, 23:09

derz00 wrote:The categories, and index links are there, but clicking on them brings nothing.


Right click the file, click properties and then click unblock.

HTH
User avatar
jeeswg
Posts: 1541
Joined: 19 Dec 2016, 01:58
Location: UK

Re: Revision of docs for v2

09 Jul 2017, 23:26

AFAIK commands will essentially be functions without brackets (parentheses):

Code: [Select all] [Download] GeSHi © Codebox Plus

Func(var, "string")
Cmd var, "string"
Cmd, var, "string" ;may or may not be acceptable in AHK v2

I'm not sure how the issue of the return values of functions will/won't be dealt with by commands.

Links to the AHK v1/v2 index pages:
Alphabetical Command and Function Index
https://autohotkey.com/docs/commands/
Alphabetical Command and Function Index
https://lexikos.github.io/v2/docs/commands/index.htm
lexikos
Posts: 5407
Joined: 30 Sep 2013, 04:07
GitHub: Lexikos

Re: Revision of docs for v2

10 Jul 2017, 03:10

The v2 documentation generally lags behind, though I try to keep v2-changes up to date. Currently only this document provides comparison to v1. There is a section at the top about command syntax.

Most of the examples in the v2 documentation are updated by Ragnar, but lexikos.github.io only updates when I tell it to, or when I upload a new alpha version. (I have just put up Ragnar's latest changes.)

Btw, program.html and v2 are two different topics, and both are off-topic for this sub-forum.
User avatar
derz00
Posts: 134
Joined: 02 Feb 2016, 17:54

Re: Revision of docs for v2

10 Jul 2017, 08:02

Yes, I realize this is offtopic. It may be moved as seen fit. Also, I got onto the v2 subject because I thought it was kind of related to the revision of the docs.

Now I can see that there is only the function syntax for the MsgBox examples. (EDIT: sure enough he did update the examples for all the commands I bothered to look up) Also good to know that you update the v2-changes page.

Thanks for all the helpful answers, this has clarified some confusion on my part. Keep up the good work Lexikos, Ragnar, others!
Sarcastic comment:
Loading.....

Return to “Tutorials”

Who is online

Users browsing this forum: No registered users and 2 guests