Help File/Documentation Issues. (Discussion Only)

[mLipok]

I come back to the question of how to describe the file names which should be expected variable names, such as "Constants are defined in ...."

I had selected all cases (I hope).
Examples posted below.
In addition, detailed descriptions appear in different locations / sections.

In my opinion, should usually be in one place at the beginning of the "Remarks" EDIT: and to facilitate further analysis should be written in the same way as "Constants are defined in ....".

This problem does not allow me to make a deeper analysis.

Please, any concepts.

 

EDIT: my other (current) proposal for standardization:  "Above constants require #include <.....>"

---

Above constants require #include <Constants.au3>

Constants are defined in FileConstants.au3

Include Constants.au3 in your script to use the symbolic name in parentheses to specify the origin.

To use the values specified above you must #include <WindowsConstants.au3> in your script.

The above constants are defined in #include <GUIConstantsEx.au3>

These types are defined in the "Constants.au3" include file.

 

Providing the Standard I/O parameter with the proper values permits interaction with the child process through the <a href="StderrRead.htm">StderrRead()</a>, <a href="StdinWrite.htm">StdinWrite()</a> and <a href="StdoutRead.htm">StdoutRead()</a> functions. Combine the flag values (or use $STDERR_CHILD, $STDIN_CHILD & $STDOUT_CHILD, defined in Constants.au3) to manage more than one stream.

 

$LVxxx_ constants require #include <ListViewConstants.au3>, $CDxx_ constants require #include <WindowsConstants.au3>

$CDxx_ constants require #include <WindowsConstants.au3>

Please see the XlFileFormat enumeration in ExcelConstants.au3 for possible values.

The pattern constants are declared in GDIPlusConstants.au3, those that start with $GDIP_HATCHSTYLE_*.

$SB_xxxxx require #include <ScrollBarsConstants.au3>

Edited June 7, 2014 by mLipok

[mLipok]

For deeper analysis I have in mind such cases as are here: #2736

[AZJIO]

guinness

Tutorials -> Loop

Ru - http://azjio.ucoz.ru/publ/cikl/6-1-0-46

En - translate

Edited June 7, 2014 by AZJIO

[mLipok]

"Intended Use"

It seems that it is a little outdated ?

[guinness]

AutoIt -> Using AutoIt -> Intended Use

This should be the first item in the section

Fixed. You're lucky I saw this.

[guinness]

guinness

Tutorials -> Loop

Ru - http://azjio.ucoz.ru/publ/cikl/6-1-0-46

En - translate

Thanks.

[guinness]

I come back to the question of how to describe the file names which should be expected variable names, such as "Constants are defined in ...."

 

I had selected all cases (I hope).

Examples posted below.

In addition, detailed descriptions appear in different locations / sections.

In my opinion, should usually be in one place at the beginning of the "Remarks" EDIT: and to facilitate further analysis should be written in the same way as "Constants are defined in ....".

This problem does not allow me to make a deeper analysis.

Please, any concepts.

 

 

EDIT: my other (current) proposal for standardization:  "Above constants require #include <.....>"

 

---

 

Above constants require #include <Constants.au3>

Constants are defined in FileConstants.au3

Include Constants.au3 in your script to use the symbolic name in parentheses to specify the origin.

To use the values specified above you must #include <WindowsConstants.au3> in your script.

The above constants are defined in #include <GUIConstantsEx.au3>

These types are defined in the "Constants.au3" include file.

 

 

Providing the Standard I/O parameter with the proper values permits interaction with the child process through the <a href="StderrRead.htm">StderrRead()</a>, <a href="StdinWrite.htm">StdinWrite()</a> and <a href="StdoutRead.htm">StdoutRead()</a> functions. Combine the flag values (or use $STDERR_CHILD, $STDIN_CHILD & $STDOUT_CHILD, defined in Constants.au3) to manage more than one stream.

 

 

$LVxxx_ constants require #include <ListViewConstants.au3>, $CDxx_ constants require #include <WindowsConstants.au3>

 

$CDxx_ constants require #include <WindowsConstants.au3>

 

Please see the XlFileFormat enumeration in ExcelConstants.au3 for possible values.

 

The pattern constants are declared in GDIPlusConstants.au3, those that start with $GDIP_HATCHSTYLE_*.

 

$SB_xxxxx require #include <ScrollBarsConstants.au3>

I am not sure what you're asking. So please create appropriate tickets. Thanks.

[mLipok]

I am not sure what you're asking. So please create appropriate tickets. Thanks.

Ok.

At the moment I complete the missing information about files defined constants EDIT like here.

Then on the TRACK, I issue appropriate proposals to modify the existing documentation, which now contain references to files with the definitions of constants.

BTW:

one question here.

Edited June 9, 2014 by mLipok

[guinness]

I have answered your question.

[jaberwacky]

I am not sure what you're asking.

IT HAPPENED!

[iCode]

bitten by the boolean for the last time

from the help file...

If Boolean values are used together with numbers, the following rules apply:

A value 0 will be equal to Boolean False
Any other number value will be equal to Boolean True

 

this lead not only myself, but i'm sure many others, to ass-u-me that the "0" in "$bOff = 0 " will always be interpreted as False when it's compared to a boolean, which is of course false - pun intended

>this post was most helpful to me, particularly example #3

Edited June 12, 2014 by iCode

[mLipok]

For a long time several times, I wanted to describe the proposal.
Well, if you are working in both Relase and Beta is often used HelpFile in both versions.
Sometimes it is hard to figure out which version of the help file just uses it.
Then you every time, open the help file on the main page.

And here comes the proposal:
for almost every description eg ClipGet()
above the name of the function is this kind of description:
Function Reference

I propose that for each function on the top wrote something like this:
Function Reference (AutoIt 3.3.XX.YY)

[Melba23]

mLipok,

Rather than changing the text of virtually every page of the Help file, it would be much easier to change the title of the Help window itself to include the version number: e.g. AutoIt Help v3.3.12.0.

M23

[mLipok]

Indeed.
The simplest ideas are the best

You can add this feature to the next BETA ?

mLipok

[Melba23]

mLipok,

I cannot - but if you make a "Feature Request" I am sure someone else will make it happen.

M23

[mLipok]

Done #2761

edit:

now is even completed

Edited June 23, 2014 by mLipok

[orbs]

from the FileGetVersion help:

FileGetVersion ( "filename" [, "stringname"] )

 

please consider to mention the default value for the 2nd parameter "stringname".

 

note that the default value is not "FileVersion". see this script:

ConsoleWrite('blank: '&FileGetVersion(@AutoItExe,'')&@CR)

ConsoleWrite('not specified: '&FileGetVersion(@AutoItExe)&@CR)

ConsoleWrite('FileVersion: '&FileGetVersion(@AutoItExe,'FileVersion')&@CR)

ConsoleWrite('ProductVersion: '&FileGetVersion(@AutoItExe,'ProductVersion')&@CR)

the results are:

 

blank: 

not specified: 3.3.10.2

FileVersion: 3, 3, 10, 2

ProductVersion: 3, 3, 10, 2

 

so you see, when the parameter is not specified, the result is different than when "FileVersion" is specified.

however, the "not specified" result is identical to the "File Version" as seen by the Properties dialog, which in turn is not identical to the result when "FileVersion" string is specified:

 

 

 

[guinness]

Please read the first post very carefully.

[mLipok]

I am not sure what you're asking. So please create appropriate tickets. Thanks.

 

Look here #2782.

Compare with orginal.

This was my proposal which I have in my mind,  in post #361 .

I want to do a unification for this kind of description.

Ultimately, this will facilitate the analysis of such cases #2779 "Typo on RichEdit_StreamToVar parameters"

[funkey]

I don't know if it's reported or not, but sometimes when I add an UDF function to my code I press F1 in SciTE on the function name to get to the documentation of the function. Then I copy the include line from documentation and paste it to the code. I'm used to work with 3.3.8.1 and there this works great. It work OK in 3.3.12.0 too but there is a space character before the include statement like ' #include <File.au3>'. I know this is no great thing, but I'm not that fast to mark the line . Would be nice if this can be changed.