Help File/Documentation Issues. (Discussion Only)

[mLipok]

I think so.

 

As I understand that ultimately it will also have representation on calltips guide in SciTE4AutoIt?

[guinness]

Since I don't use the Array I will have to do a little bit of digging to see what is the supported subscript dimension.

[BrewManNH]

Most of the array functions won't work with anything other than 1D arrays.

[guinness]

  On 12/30/2013 at 1:07 AM, BrewManNH said:

Most of the array functions won't work with anything other than 1D arrays.

That being said, I still need to check as you haven't pointed out which functions. So I don't want to make an assumption like this.

[Jury]

Just an idea but would it be possible with each new version of AutoIt that the Index listing in the Help file be colour coded showing, for example, items in red =  script breaking changes, blue = new items, green = redundant items (but still usable) and so on?  Perhaps to difficult but just in case it isn't..

Thanks for all the work the developers are doing,

jury

[guinness]

Add to Trac as a feature request please.

[mLipok]

First (at the beginning), I wanted to ask:

Is the version of OnLine documentation also contains a description of all the UDF?

 

but....

 

Then I searched a bit and I was able to find:

http://www.autoitscript.com/autoit3/docs/libfunctions/_Word_DocOpen.htm

http://www.autoitscript.com/autoit3/docs/libfunctions/$tagBITMAPINFO.htm

 

I checked the main page of the documentation:

http://www.autoitscript.com/autoit3/docs/

Unfortunately, there's no link to any UDF

And here my questions arises: 

 

1.

EDIT:

Why is the main page there is a link to all the UDF?

Why in the main page there is no a link to all the UDF?

I mean here:

http://www.autoitscript.com/autoit3/docs/

 

 

2.

Can You add:

 

something like this:

Function Reference

• Function Reference

I mean: User Defined Functions

• Array Management
• Clipboard Management
• Color Management
• ....
• ...

 

Edited December 30, 2013 by mlipok

[mLipok]

in

_WinAPI_BackupRead

in paramteres:

$iLength The size of the buffer, in bytes. The buffer size must be greater than the size of the
$tagWIN32_STREAM_ID structure. 
------------------------------------------------
 (see MSDN for more information)

above this line:

(see MSDN for more information)

is additional frame element

 

after checking in  _WinAPI_BackupRead.txt

$iLength
    The size of the buffer, in bytes. The buffer size must be greater than the size of the
    $tagWIN32_STREAM_ID structure.

    (see MSDN for more information)

I see there is additional new/blank line without TAB

Is that intentional ?

 

Edit 1:

the same I notice in

_WinAPI_BackupWrite

Edit 2:

_WinAPI_CompareString

 

Edit 3:

Such txt file may be found in this way - RegExp:

(?is)@@ParamTable@@.*?\r\n\r\n.*?@@End@@.*?###ReturnValue###

Edit 4:

as I read in "Readme.txt"

  Quote

 

@@ParamTable@@

Description

     ParamTables are special, two-column tables
     where the first column is only one line,
     but the second column can be many lines.

How To Denote

     Any information that appears in the second
     column must be indented with at least one tab.

     Each entry that is NOT indented begins a new row.

     DO NOT LEAVE ANY BLANK LINE BETWEEN HERE AND "@@End@"

@@End@@

 

 

So is that an bug/issue in "_WinAPI_BackupRead.txt" and these other files ?

Edited December 31, 2013 by mlipok

[czardas]

Static keyword:

  Quote

 

If the scope specifier Local is used, then the static variable is visible and usable only in the function in which it is declared and it's resolved in the environment of execution (logical scope).

 

logical scope? ^^

[guinness]

So you think it should be removed?

[czardas]

What is logical scope? I'm also unsure what being resolved implies here.

Edited December 31, 2013 by czardas

[BrewManNH]

Logical scope = Function or Global level of a script

[trancexx]

The environment of execution is scope in which the code is run. BrewManNH's bifurcation is correct but full definition of the term knows for another sub-context which then fully determines the environment of code execution.

You can see it explained through means of code in this small example:

Func ABC($bSomething = 0)

    Switch $bSomething
        Case 0
            Local Static $vSomething = "2014" & @CRLF
        Case 1
            Local Static $vSomething = "Happy New Year" & @CRLF
        Case 2
            Local Static $vSomething = "Happy New Year "
    EndSwitch

    ConsoleWrite($vSomething)

EndFunc


ABC(0)
ABC(1)
ABC(2)
ABC(0)

...The code is purely theoretrical.

[guinness]

mlipok,

_WinAPI_CompareString() is fine, but I changed the other two functions (+below) by removing that line as it has no place in a new row.

_WinAPI_BackupRead.txt
_WinAPI_BackupWrite.txt
_WinAPI_BrowseForFolderDlg.txt
_WinAPI_ChangeWindowMessageFilterEx.txt
_WinAPI_CopyFileEx.txt
_WinAPI_CreateFileEx.txt
_WinAPI_FindTextDlg.txt
_WinAPI_GetDeviceGammaRamp.txt
_WinAPI_GetWindowSubclass.txt
_WinAPI_MoveFileEx.txt
_WinAPI_OpenFileById.txt
_WinAPI_PageSetupDlg.txt
_WinAPI_PlaySound.txt
_WinAPI_PrintDlg.txt
_WinAPI_PrintDlgEx.txt
_WinAPI_RegisterPowerSettingNotification.txt
_WinAPI_RemoveWindowSubclass.txt
_WinAPI_ReOpenFile.txt
_WinAPI_ReplaceTextDlg.txt
_WinAPI_SetCurrentProcessExplicitAppUserModelID.txt
_WinAPI_SetDeviceGammaRamp.txt
_WinAPI_SetTimer.txt
_WinAPI_SetWindowSubclass.txt
_WinAPI_ShellChangeNotify.txt

[czardas]

  On 12/31/2013 at 3:09 PM, trancexx said:

The environment of execution is scope in which the code is run. BrewManNH's bifurcation is correct but full definition of the term knows for another sub-context which then fully determines the environment of code execution.

You can see it explained through means of code in this small example:

Func ABC($bSomething = 0)

    Switch $bSomething
        Case 0
            Local Static $vSomething = "2014" & @CRLF
        Case 1
            Local Static $vSomething = "Happy New Year" & @CRLF
        Case 2
            Local Static $vSomething = "Happy New Year "
    EndSwitch

    ConsoleWrite($vSomething)

EndFunc


ABC(0)
ABC(1)
ABC(2)
ABC(0)

...The code is purely theoretrical.

 

Thank you! Same to you and everyone else.

[AZJIO]

Style File Help

[guinness]

I am not following. Sorry.

[water]

As mlipok described in post #267a link to the online documentation for the UDFs is missing in 3.3.10.x as it was in 3.3.8.1.

Should we open a trac ticket?

[guinness]

All,

If there is a definite issue post in Trac, as I won't always be able to follow this thread. This is described already in the first post. Thanks.

Edited January 2, 2014 by guinness

[guinness]

  On 1/2/2014 at 11:51 AM, water said:

As mlipok described in post #267a link to the online documentation for the UDFs is missing in 3.3.10.x as it was in 3.3.8.1.

Should we open a trac ticket?

Could you show me where it was before please. On what page? As I see it this is a feature request because the UDFs in the chm version are in the TOC but not on the index page, which is where it's missing.