218 replies to this topic

[Valik]

If it's not documented then you are using an undocumented feature and that comes with associated risks including but not limited to the functionality ceasing to work.

[jaberwocky6669]

I believe that I have found some typos and general grammatical errors in the beginning sections of the helpfile.

Spoiler

"Installation Directory" section of the helpfile contains a table of registry entries at the bottom with this statement: "The

keys in italic are not created by the installer itself but by the first execution of the corresponding utility" but I do not

see any italic keys. I see one italic value. Is that what was meant?



"Running Scripts"

Note : only 63 parameters can be return by $CmdLine[...], but $CmdLineRaw will always returns the entire command line.
==>
Note : only 63 parameters can be returned by $CmdLine[...], but $CmdLineRaw will always return the entire command line.


/ErrorStdOut Allows to redirect fatal error to StdOut which can be captured by an application as Scite editor.
==>
/ErrorStdOut Allows to redirect fatal error to StdOut which can be captured by an application such as Scite editor.


NOTE: Correct usage of single- and double- quotation marks is important, even double single.
==>
NOTE: Correct usage of single and double quotation marks is important even for double single quotation marks.


Form3 and Form4 can be disabled for compiled script when using #NoAutoIt3Execute.
==>
Form3 and Form4 can be disabled for compiled scripts when using #NoAutoIt3Execute.



"AutoIt on Windows Vista"

When the script runs AutoIt will check if it already has full admin rights and if not it will cause the operating system to
prompt the user for permission as shown in "UAC Prompts". If permission is not given by the user the script will terminate.
==> one space between sentences...
When the script runs AutoIt will check if it already has full admin rights and if not it will cause the operating system to
prompt the user for permission as shown in "UAC Prompts". If permission is not given by the user the script will terminate.



"Script Editors"

The full AutoIt version of SciTE that comes with all to tools can be downloaded seperately at
==>
The full AutoIt version of SciTE that comes with all tools can be downloaded seperately at



"Compiling Scripts"

This format allow to distribute smaller files as they don't include the AutoIt3.exe in each compile script.
==>
This format allows you to distribute smaller files as they don't include the AutoIt3.exe in each compiled script.

This doesn't make sense to me: "You still need to have it accessible on the target machine but just AutoIt3.exe."

Specifies the path and file name of the bin file to be use to compile the file.
==>
Specifies the path and file name of the bin file to be used to compile the file.



"AutoIt WIndow Information Tool"

AutoIt v3 comes with a standalone tool called the AutoIt Window Info Tool (Program FilesAutoIt3AU3Info.exe). AU3Info allows
you to get information from a specified window that can be used to effectively automate it.
==> one space between sentences
AutoIt v3 comes with a standalone tool called the AutoIt Window Info Tool (Program FilesAutoIt3AU3Info.exe). AU3Info
allows you to get information from a specified window that can be used to effectively automate it. Information that can be obtained includes:



"AutoIt Syntax Checker (AU3 Check)"

Au3Check issues warning if variables are used before they are seen.
==>
Au3Check issues warning if variables are used before they are declared.


However, this is bad programming style, and Au3Check will issue a warning that $hello is possible used before it is declared.
==>
However, this is bad programming style, and Au3Check will issue a warning that $hello is possibly used before it is declared.


For $i=1 To 2
If $i=2 Then msgbox(0, "ok", $hello);
Local $hello = "Goodbye"
Next
==>
For $i = 1 To 2
If $i = 2 Then MsgBox(0, "OK", $hello)
Global $hello = "Goodbye"
Next


Likewise, global variables declared in functions should best not be used in other functions.
==>
Should it be mentioned that Global variables should not be declared within functions?

Finally, Au3Check issues an error if a variable is used, but never declared, explicitly or implicitly.
==>
Finally, Au3Check issues an error if a variable is used but is never either explicitly or implicitly declared.

To manage some warnings/errors that can not be avoid some specific directive can be included in the script.
==>
Specific directives can be included in the script to manage some warnings/errors that can not be avoided.

can be used for inside functions, like the following:
==>
can be used inside functions, like the following:

Func Test_Numparams($v1 = 0, $v2 = 0, $v3 = 0, $v4 = 0, $v5 = 0, $v6 = 0, $v7 = 0, $v8 = 0, $v9 = 0)
#forceref $v1, $v2, $v3, $v4, $v5, $v6, $v7, $v8, $v9
Local $val
For $i = 1 To @NumParams
$val &= Eval("v" & $i) & " "
Next
MsgBox(0, "@NumParams example", "@NumParams =" & @NumParams & @CRLF & @CRLF & $val)
EndFunc
==>
Func Test_Numparams($v1 = 0, $v2 = 0, $v3 = 0, $v4 = 0, $v5 = 0, $v6 = 0, $v7 = 0, $v8 = 0, $v9 = 0)
#forceref $v1, $v2, $v3, $v4, $v5, $v6, $v7, $v8, $v9

Local $val

For $i = 1 To @NumParams
$val &= Eval("v" & $i) & " "
Next

MsgBox(0, "@NumParams example", "@NumParams = " & @NumParams & @CRLF & @CRLF & $val)
EndFunc

This command line utility can be invoked thru editor add-on. It located in the same directory as AutoIt3.exe. The SciTE4AutoIt3 editor provides such environment.
==>
This command line utility can be invoked though an editor add-on. It is located in the same directory as AutoIt3.exe. The SciTE4AutoIt3 editor provides such an environment.

No checking is made for array dimensions, or indices. This can only be done runtime.
==>
No checks are made for array dimensions or indices. This can only be done during runtime.

Logical errors, illegal parameters to functions, and division on zero.
==>
Logical errors, illegal parameters to functions and division by zero.

title is the only required parameter for this function, both the text and timeout are optional.
==>
The only required parameter for this function is title. However, the text and timeout parameters are optional.

In some functions the text parameter is not optional, if you do not wish to specify any text then just use "" (a blank string).
==>
In some functions, the text parameter is not optional. If you do not wish to specify any text then just use "" (a blank string).

If the same notepad window had "This is a line of text" typed into the window, the Window Info Tool would show:
==> ... to correspond with the text in the example given ...
If the same notepad window had, "This is some text!" typed into the window, the Window Info Tool would show:

This will usually be things like the contents of edit controls (as above with "This is a line of text") but will also include other text like:
==>
This will usually be things like the contents of edit controls (as above with "This is some text!") but will also include other text like:

What has been described is the default mode that AutoIt operates in, there are a number of more advanced modes to use when things are not as simple as this.
==>
What has been described is the default mode in which AutoIt operates. There are a number of more advanced modes to use when things are not as simple as this.

Note: Hidden window can be matched by "title" only if "text" is empty ("").
==>
Note: Hidden windows can be matched by "title" only if "text" is empty ("").

In this mode a window titled Untitled - Notepad would be matched by "Untitled - Notepad", "Untitled", "Notepad", "pad", etc.
==>
In this mode, a window titled Untitled - Notepad would be matched by "Untitled - Notepad", "Untitled", "Notepad", "pad", etc.



"Window Titles and Text (Advanced)"

In this mode the a window titled Untitled - Notepad would be matched by "Untitled - Notepad", "Untitled", "Un", etc.
==>
In this mode, a window titled Untitled - Notepad would be matched by "Untitled - Notepad", "Untitled", "Un", etc.

In this mode a window titled Untitled - Notepad would only be matched by "Untitled - Notepad"
==>
In this mode, a window titled Untitled - Notepad would only be matched by "Untitled - Notepad".

Mode -1 to -3
==> ... to match the WinTitleMatchMode description in the helpfile ...
Mode -1 to -4

e.g. Wait a window of classname "Notepad"
==>
e.g. Wait for a window with classname "Notepad". (?)

The variant datatype in AutoIt natively supports window handles (HWNDs). A window handle is a special value that windows assigns to a window each time it is created. When you have a handle you may use it in place of the title parameter in any of the function calls that use the title/text convention. The advantage of using window handles is that if you have multiple copies of an application open - which have the same title/text - you can uniquely identify them when using handles. When you use a window handle for the title parameter then the text parameter is completely ignored.
==>
The variant datatype in AutoIt natively supports window handles (HWNDs). A window handle is a special value that Windows assigns to windows each time they are created. When you have a handle you may use it in place of the title parameter in any of the function calls that use the title/text convention. The advantage of using window handles is that if you have multiple copies of an application open which have the same title/text then you can uniquely identify them using handles. When you use a window handle for the title parameter then the text parameter is completely ignored.



"Controls"
One of the best new features with AutoIt v3 is the ability to work directly with certain types of Window Controls. Almost everything you see on a window is a control of some kind: buttons, listboxes, edit fields, static text are all controls. In fact Notepad is just one big "Edit" control! Because AutoIt works directly with a control they provide a more reliable way to automate than just sending keystrokes.
==>
One of the best new features with AutoIt v3 is the ability to work directly with certain types of Window Controls. Almost everything you see on a window is a control of some kind. Buttons, listboxes, edit fields and static text are all examples of controls. In fact, Notepad is just one big "Edit" control! Because AutoIt works directly with a control, they provide a more reliable way to automate than just sending keystrokes.

Note: AutoIt only works with standard Microsoft controls - some applications write their own custom controls which may look like a standard MS control but may resist automation. Experiment!
==>
Note: AutoIt only works with standard Microsoft controls - some applications write their own custom controls which may look like a standard MS control but may resist automation. Experiment!

A special description can be used as the controlID parameter used in most of the Control...() functions . This description can be used to identify a control by the following properties:
==>
A special description can be used as the controlID parameter used in most of the Control...() functions. This description can be used to identify a control by the following properties:



"Send"

N.B. Some programs are very choosy about capital letters and ALT keys, i.e. "!A" is different to "!a".
==>
N.B. Some programs are very choosy about capital letters and ALT keys, i.e., "!A" is different from "!a".

AutoIt can send all ASCII and Extended ASCII characters (0-255), to send UNICODE characters you must use the "ASC" option and the code of the character you wish to send (see {ASC} at the bottom of the table below).
==>
AutoIt can send all ASCII and Extended ASCII characters (0-255). To send UNICODE characters you must use the "ASC" option and the code of the character you wish to send (see {ASC} at the bottom of the table below).

This tells AutoIt to send a SHIFT keystroke, therefore Send("Hell+o") would send the text "HellO".
==>
This tells AutoIt to send a SHIFT keystroke; therefore, Send("Hell+o") would send the text "HellO".

This tells AutoIt to send a CONTROL keystroke, therefore Send("^!a") would send "CTRL+ALT+a".
==>
This tells AutoIt to send a CONTROL keystroke; therefore, Send("^!a") would send "CTRL+ALT+a".

N.B. Some programs are very choosy about capital letters and CTRL keys, i.e. "^A" is different from "^a".
==>
N.B. Some programs are very choosy about capital letters and CTRL keys, i.e., "^A" is different from "^a".

Certain keyboard as the Czech one send different characters when using the Shift Key or being in CAPS LOCK enabled and sending a char. Due to the send AutoIt implementation the CAPS LOCKed char will be sent as Shifted one so it will not work.
==> ... not entirely sure how this should be ...
Certain keyboards as the Czech keyboard sends different characters when using the Shift Key or with CAPS LOCK enabled while sending a character. Due to the send AutoIt implementation the CAPS LOCKed character will be sent as a Shifted character so it will not work.

Send even with Opt("SendAttachMode",1) is not working.
==>
Send even with Opt("SendAttachMode",1) does not work. (?)

Using the -s mode when submitting can help to have better right on the remote computer.
==>
Using the -s mode when submitting can help to have better rights on the remote computer. (?)



"Intended Use"

With this combination of GUI Automation, GUI Interfaces and COM support, AutoIt offers you a powerful scripting tool that is able to compete with fully-fledged scripting languages like WSH or KiXStart).
==>
With this combination of GUI Automation, GUI Interfaces and COM support, AutoIt offers a powerful scripting tool that is able to compete with fully-fledged scripting languages like WSH or KiXStart.



"Notes for users familiar with AutoIt 2.64"

When start to use v3 the following should help to make things a little easier.
==>
When start to use v3 the following should help to make things a little easier.

In the table which compares the equivalent functions, some functions are the same on both sides.



"Running under Windows 64-bit Edition"

During installation, if found to be running on x64 you will be given the choice to install and configure the x64 versions.
==>
During installation, if AutoIt is found to be running on an x64 system then you will be given the choice to install and configure the x64 versions.

To see if you are running under a 64-Bit Edition of Windows use @OSArch macro.
==>
To see if you are running under a 64-Bit edition of Windows use @OSArch macro.

I should mention that the code examples should have tabs in them.

Edited by LaCastiglione, 22 December 2011 - 11:00 PM.

[guinness]

Thank very much LaCastiglione.I went through your suggestions and committed accordingly.

[guinness]

Not a major issue with the help file, but the example script for GUISetAccelerators uses Local variable declarations. While those of us that have used AutoIT and understand scope, and know that even when you declare them as local in a global scope they're still global. It might cause newer users to think that using Local in a global scope is normal.

I went ahead and updated the example with the following code:

AutoIt        expandcollapse  popup

#include <GUIConstantsEx.au3>

Example()

Func Example()
    GUICreate("Custom MsgBox", 225, 80)

    GUICtrlCreateLabel("Please select a button.", 10, 10)
    Local $iYesID = GUICtrlCreateButton("Yes", 10, 50, 65, 25)
    Local $iNoID = GUICtrlCreateButton("No", 80, 50, 65, 25)
    Local $iExitID = GUICtrlCreateButton("Exit", 150, 50, 65, 25)

    ; Set GUIAccelerators for the button controlIDs, these being Ctrl + y and Ctrl + n
    Local $aAccelKeys[2][2] = [["^y", $iYesID],["^n", $iNoID]]
    GUISetAccelerators($aAccelKeys)

    GUISetState() ; Display the GUI.

    While 1
        Switch GUIGetMsg()
            Case $GUI_EVENT_CLOSE
                MsgBox(0, "You selected", "Close")
                ExitLoop

            Case $iYesID
                MsgBox(0, "You selected", "Yes") ; Displays if the button was selected or the hotkey combination Ctrl + y was pressed.

            Case $iNoID
                MsgBox(0, "You selected", "No") ; Displays if the button was selected or the hotkey combination Ctrl + n was pressed.

            Case $iExitID
                MsgBox(0, "You selected", "Exit")
                ExitLoop

        EndSwitch
    WEnd
    GUIDelete() ; Delete the GUI.
EndFunc   ;==>Example

Edited by guinness, 23 December 2011 - 11:08 PM.

[jaberwocky6669]

Sorry, how do you mean committed? Should I have posted that to the bug tracker?

[Melba23]

LaCastiglione,

"committed changes to the repository" means that guinness has amended the stored code/text that will be used the next time AutoIt is compiled.

Your suggestions will appear in the next release. Our thanks for being an integral part of the AutoIt community and helping us produce an even better version next time round.

M23

[guinness]

Thanks Melba23 for explaining to LaCastiglione.

LaCastiglione,

Reporting issues here ('Report Help File Issues Here') is just fine for now, unless Valik or another Dev has other ideas.

Edited by guinness, 23 December 2011 - 09:28 PM.

[jaberwocky6669]

Sweet, don't encourage me. I love proofreading.

[Melba23]

LaCastiglione,

Careful, you might get recruited - or pressganged.

M23

[Valik]

guinness, you seem to be the person doing the largest portion of documentation work so figure out what works best for you and we'll do that.

[guinness]

Thanks. I'm happy with those who can't commit posting here still.

[131738]

autoit-docs-v3.3.8.0-src ?

[guinness]

Check the beta download page, V3.3.7.23 is the closest to the stable version. I don't know why you felt the need to create a trac ticket which I presume was you.

[131738]

Localization of the document

[Melba23]

131738,

Go to the AutoIt <Home> page (ribbon menu at the top of this page). Then select <AutoIt - Downloads> from the ribbon menu at the top of that page. Scroll down and you find the "AutoIt Beta" link which takes you to the download page.

M23

P.S. Did you mother never tell you that "Please" is a magic word?

[guinness]

P.S. Did you mother never tell you that "Please" is a magic word?

And Thank you.

131738,

I presumed since you knew about the document source 7z file that you would know where to download the beta versions!

[AZJIO]

In AutoIt3.chm can be upgraded examples - Helpfile.7z (9.4 kb)

GUICtrlSendToDummy

GUICtrlSetOnEvent($GUI_EVENT_CLOSE, "OnClick")

must have an GUISetOnEvent, instead of the GUICtrlSetOnEvent

[guinness]

AZJIO,

I've just download the 7z file and will go through the examples in the next couple of days. In the meantime could you confirm if the comments were meant to be in English as something seems to have happened when you've saved the files.

Edited by guinness, 24 December 2011 - 11:21 AM.

[AZJIO]

guinness

Examples I've posted in Russian. I can not accurately translate into English. Examples are easy to understand them without comment. I think they better demonstrate the capabilities of AutoIt3.

--------------------------------------------
StringReplace > Remarks > By default or if count ....
must have an "occurrence", instead of the "count"

--------------------------------------------
WinKill
WinKill("[CLASS:Notepad] ", "")
unnecessary space character, which is not immediately be noticed

--------------------------------------------
StringRegExp
typo in the example - "cRegExp"

--------------------------------------------
MouseClick, MouseClickDrag, MouseDown, MouseUp, Shutdown
add output

Exit
MouseDown("left")
Sleep(100)
MouseUp("left")

--------------------------------------------
installdir.htm (Install Directory Structure)
remove the line

<tr><td colspan=4><td></tr>

_GUICtrlEdit_Create
$WS_TABSTOP unless $ES_READONLY >>> $WS_TABSTOP only if not $ES_READONLY

Edited by AZJIO, 24 December 2011 - 12:49 PM.

[131738]

131738,

Go to the AutoIt <Home> page (ribbon menu at the top of this page). Then select <AutoIt - Downloads> from the ribbon menu at the top of that page. Scroll down and you find the "AutoIt Beta" link which takes you to the download page.

M23

P.S. Did you mother never tell you that "Please" is a magic word?

Thank you! Have been downloaded, and completed the localization

“P.S. Did you mother never tell you that "Please" is a magic word?” What does it mean?
I'm not English, relying on machine translation!