Post Documentation Bugs Here

[CyberSlug]

I'm trying to keep track of issues/bugs people have with the documentation, but there are a lot of posts, so I'm starting this thread Also, what do you think of a ref page like this?

Current To-Do List, (link)

EDIT: I'll update the list whenever I do stuff.

Edited February 8, 2004 by CyberSlug

[trids]

Good idea, CS .. and thanks for the opportunity

Drawing together recent requests for tutorials, and recalling my initial exposure to Autoit (and indeed any new language) I'd like to suggest expanding a little bit more on some of the Example sections.

To illustrate, the topic for FileOpenDialog() might be enhanced with the following example:

expandcollapse popup

;FileOpen dialog options
;------------------------------------------------

    $sFiles=FileOpenDialog( "Choose Image(s)", @DesktopDir, "Images (*.jpg;*.bmp)", 1 + 4 )
    $ynCancel = @Error  ;preserving @error for later scrutiny
    
    MsgBox(4096 + 64, @scriptname, "@error=" & $ynCancel & @LF & $sFiles)

    if $ynCancel then
      ;User Pressed Cancel
    else

        $aFiles = StringSplit($sFiles, "|")
        If $aFiles[0] = 1 then  
          ;Single selection
            $sX = $aFiles[1]
        else
          ;$aFiles[0] = count of entries incl path
          ;$aFiles[1] = path
          ;$aFiles[2] = file-1
          ;$aFiles[3] = file-2
            $sPath = $aFiles[1] & "\"
            $sX = ""
            for $nFile = 2 to $aFiles[0]
                $sX = $sX & $sPath & $aFiles[$nFile] & @LF
            next
            $sX = StringTrimRight($sX,1)
        endif
        
        MsgBox (4096 + 64, "File(s) selected", $sX)
    endif

    $aFiles = StringSplit($sX,@LF)
    
    $sMsg = "$aFiles[0]=" & $aFiles[0] & @LF
    $sMsg = $sMsg & "$aFiles[1]=" & $aFiles[1] 
    MsgBox(4096 + 64, @scriptname, $sMsg)


Exit

Perhaps a bit overkill, but I hope this helps. Edited February 5, 2004 by trids

[GEOSoft]

Drawing together recent requests for tutorials, and recalling my initial exposure to Autoit (and indeed any new language) I'd like to suggest expanding a little bit more on some of the Example sections.

I mentioned to CS that, once I get a few of these projects I have hanging out of the way, I would try and put together a new CHM file that is examples only. All arranged by category and function. That could either be distributed with AutoIt or it can be made available for download elsewhere. If it has to be made available on another site then I would probably put it on mine since I have no bandwidth limits to worry about. I just saved that code of yours to include. I might modify it slightly though.

Edit: I would also like to get a chance to take Larry's ***** HELP ***** files for the GUI and make some actual working examples out of them. That will probably require some input from Larry and, like is help files show, he's not heavily into documentation.

Edited February 5, 2004 by GEOSoft

[jpm]

ProcessWaitClose

--------------------------------------------------------------------------------

Pauses script execution until a given process does not exist.

ProcessWaitClose ( "process" [, timeout])

just update it

[GEOSoft]

I think that the documentation of AUT2EXE needs some updating, perhaps with valid examples. I still can't get that build script working this way.

; Script Function:
;   Build Backup
;
RunWait ('C:\Program Files\AutoIt3\Aut2Exe\Aut2Exe.exe /in Back.au3 /icon Back.ico')
RunWait ('C:\Program Files\AutoIt3\Aut2Exe\Aut2Exe.exe /in RBack.au3 /icon RBack.ico')
Exit

Im wondering if it's not supposed to be

; Script Function:
;   Build Backup
;
RunWait ('C:\Program Files\AutoIt3\Aut2Exe\Aut2Exe.exe /Back.au3 /Back.ico')
RunWait ('C:\Program Files\AutoIt3\Aut2Exe\Aut2Exe.exe /RBack.au3 /RBack.ico')
Exit

[trids]

Adding some colour to the documentation on Asc() and Chr() ..

expandcollapse popup

;--------------------------------------------
;  Just Asc() to have fun with Chr()   :o)))
;--------------------------------------------
 
    _DisplayBase(2, 19)   ;What is the binary equivalent of decimal 19

    _DisplayBase(16, 19)  ;What is the hex equivalent of decimal 19

    _DisplayBase(8, 19)   ;etc

    _DisplayBase(13, 19)   
    
    _DisplayBase(20, 219)  
    
    Exit


Func _DisplayBase($pBase, $pNumber)
;Helper function for _ToBase()
    Msgbox (0,@scriptname, $pNumber & " to base " & $pBase & " = " & _ToBase($pBase, $pNumber))     
EndFunc


Func _ToBase($pBase, $pNumber)
;Converts the decimal $pNumber to base $pBase    
    
    $sX = ""
    Do
        $nNext = Int($pNumber / $pBase)
        $nRem = Mod($pNumber, $pBase)
        If $nRem > 9 then
            $sX = Chr(Asc("A") - 10 + $nRem) & $sX
        Else
            $sX = String($nRem) & $sX
        Endif
        $pNumber = $nNext
    Until $pNumber = 0
    
    Return $sX
    
EndFunc

[Nutster]

UBound function documentation

I originally put in See Also: Dim, but the keyword docs had not yet been written. Could a link now be made?

Log function:

Add comment that if number is less than or equal to 0, @error is set to What? 1?

Sin/Cos/Tan functions:

Remarks:

1 radian = pi / 180 degrees.

BlockInput function

What happens on ME?

Break function

Describe how to break AutoIt V3

ProcessClose function

What happens when more than one instance of a program is running?

If two instances of NotePad are running, what happens when

ProcessClose("notepad.exe")

Thank you.

Edited February 5, 2004 by Nutster

[Jon]

I think that the documentation of AUT2EXE needs some updating, perhaps with valid examples.  I still can't get that build script working this way.

; Script Function:
;   Build Backup
;
RunWait ('C:\Program Files\AutoIt3\Aut2Exe\Aut2Exe.exe /in Back.au3 /icon Back.ico')
RunWait ('C:\Program Files\AutoIt3\Aut2Exe\Aut2Exe.exe /in RBack.au3 /icon RBack.ico')
Exit

Im wondering if it's not supposed to be

; Script Function:
;   Build Backup
;
RunWait ('C:\Program Files\AutoIt3\Aut2Exe\Aut2Exe.exe /Back.au3 /Back.ico')
RunWait ('C:\Program Files\AutoIt3\Aut2Exe\Aut2Exe.exe /RBack.au3 /RBack.ico')
Exit

Try

RunWait ('"C:\Program Files\AutoIt3\Aut2Exe\Aut2Exe.exe" /in Back.au3 /icon Back.ico')

As the exe is a long filename.

[GEOSoft]

Thanks Jon;

That wasn't the problem. It turned out that even though the build script and the the /in <script names> were all in the same folder along with the icon files, it needed the path set, so I just added a line at the top of the script.

$a = @ScriptDir

Then used $a & '\' for the file path. It works great now and I have compiled the sript so now it's just a single click to compile the project. instead of having to go though the Aut2exe UI twice.

[CyberSlug]

Nutster's remarks are eactly the types of things I was looking for. Please let me know of similar bugs and omissions in the help file

See my first post for an updated to-do list.

Edited February 6, 2004 by CyberSlug

[CyberSlug]

I'd like to add a nitpick about H1 in default.css:

How about changing background-repeat: no-repeat; to background-repeat: repeat; ?

Sample screenshots showing effects:

[Jon]

I'd like to add a nitpick about H1 in default.css:

How about changing background-repeat: no-repeat; to background-repeat: repeat; ?

Changed to repeat-y. Ta.

[Nutster]

More doc problems:

TimerStop function:

What units is the answer given in? Milliseconds?

IsFloat, StringIsFloat functions:

Remarks: More information on what triggers a true.

IsInt, StringIsInt functions:

Remarks: More information on what triggers a true.

Some more docs on using variables and arrays in AutoItV3 should also be put in the Using AutoIt section.

StringIsDigit function

Remarks: Keep in mind that any whitespace or punctuation (including . will cause StringIsDigit to return 0.

StringIsXDigit function

Add to Remarks:

Hexidecimal digits are 0-9, A-F, a-f.

Not all string functions should be considered related to all others.

e.g. StringUpper and StringLower do not need to be in the related lists of StringInStr, StringIsAlNum, StringIsAlpha, StringIsAscii, StringIsDigit, StringIsSpace, StringIsXDigit, StringLeft, StringLen, StringMid, StringSplit, StringTrimLeft, StringTrimRight

StringLen does not need to be considered related to all of those, maybe StringLeft, StringMid, StringRight, StringTrimLeft, StringTrimRight, StringStripCR, StringStripWS

[CyberSlug]

Keep 'em coming!

I'll start making updates to

docs-v3.0.92-beta-sr..> 06-Feb-2004 07:07 495k

if that's okay....

[Jon]

s'fine.

I looked though the docs again tonight and realised that unless you already knew "about stuff" that all the expression stuff (>< < <> == =, variables, etc) would be very difficult - so I might branch the "language syntax" into it's own topic and explain each in more detail.

[CyberSlug]

Jon, I won't mess with any of the intro stuff--I'll leave that to you--but I have a lot of small changes to the keywords and functions

Posted Feb7 DocFixes for keywords

Edit: Ack, I had a bug in the IfElseEndIf example. I'll fix it in my next upload.

Fun discovery of the day:

;infinite loop
For $i = 1 to 3 step 0
Next
;executes zero times
For $i = 3 to 1 step 0
Next

Edited February 7, 2004 by CyberSlug

[Jon]

Ta.

[GEOSoft]

On StringFormat, The top two items in the "Type" table are the same. This does not seem right, or there is something else not explained on the page.

d Integer Signed decimal integer.

i Integer Signed decimal integer.

[CyberSlug]

Posted Feb8 doc fixes

Mostly functions; still have more to do.

Covered IsFloat and StringIsFloat in excruciating detail.... can't AutoIt have regular expressions instead?!?

Edited February 8, 2004 by CyberSlug

[jpm]

On StringFormat, The top two items in the "Type" table are the same.  This does not seem right, or there is something else not explained on the page.

That coming from the windows doc. I don't know if the AutoIt3 format number need this level of differentiation.

Did you test both and see differences?