Jump to content
Sign in to follow this  
CyberSlug

Improved Help File (UNofficial)

Recommended Posts

There should be a multidimensional example for UBound. I wasn't exactly sure what the "first" dimension was until I wrote some test code.

-FunkyDo

Share this post


Link to post
Share on other sites

I'm thinking of basing the next unofficial release on Jon's docs-v3.0.87-src.zip 18-Jan-2004 14:00 release.

I guess the biggest effects will be:

1) no error flag sections in the function reference

2) a few sections like CDTray need my extensive comments added again :whistle:

3) Tips / Examples section might be omitted .... see this thread

I hope to make the unofficial docs more convenient for Jon, i.e., Jon could be able to pull his docs directly from these unofficial ones. Consequently. the officially released docs should be more complete and bug free.

Comments/Questions anyone?


Use Mozilla | Take a look at My Disorganized AutoIt stuff | Very very old: AutoBuilder 11 Jan 2005 prototype I need to update my sig!

Share this post


Link to post
Share on other sites

I would prefer to see left as is until there are major changes in Jon's docs but that is just my opinion.

While you are at it, in FileGetTime there is an error in Jon's

@error is set to 0 if the function was successful, otherwise is it set to 1.

should be

@error is set to 0 if the function was successful, otherwise *it is* set to 1.


George

Question about decompiling code? Read the decompiling FAQ and don't bother posting the question in the forums.

Be sure to read and follow the forum rules. -AKA the AutoIt Reading and Comprehension Skills test.***

The PCRE (Regular Expression) ToolKit for AutoIT - (Updated Oct 20, 2011 ver:3.0.1.13) - Please update your current version before filing any bug reports. The installer now includes both 32 and 64 bit versions. No change in version number.

Visit my Blog .. currently not active but it will soon be resplendent with news and views. Also please remove any links you may have to my website. it is soon to be closed and replaced with something else.

"Old age and treachery will always overcome youth and skill!"

Share this post


Link to post
Share on other sites

Okay, I'll continue as is unless Jon says otherwise. I guess I'd like Jon to basically use the unofficial docs without much modification :whistle: but I want to do whatever would be most helpful to him.

BTW, there are still bugs in the macro section--someone pointed out that @OSVersion should list WIN_NT4 instead of WIN_NT--so I'll try to get these fixed so Jon can (perhaps) merge updated versions into his docs.

Edited by CyberSlug

Use Mozilla | Take a look at My Disorganized AutoIt stuff | Very very old: AutoBuilder 11 Jan 2005 prototype I need to update my sig!

Share this post


Link to post
Share on other sites

3.0.88 unofficial docs posted

Mostly small fixes:

-Added ElseIf (with example) to If...Then...EndIf

-Fixed an @OSVersion return value (WIN_NT4)

-Added Appendix CLSID example

-Updated HotKeySet remarks and example

-Noted "smart" boolean comparsions in Syntax section

-Fixed examples using pow instead of ^ operator

To Do:

- Update Examples and Tips

- Look at source code to determine environment limits. For example, up to 64 files may be open at once, strings have a max length of ..., etc.


Use Mozilla | Take a look at My Disorganized AutoIt stuff | Very very old: AutoBuilder 11 Jan 2005 prototype I need to update my sig!

Share this post


Link to post
Share on other sites

It's easiest if you keep track of changes and send me the details of those - I'd just copy yours over the top of mine but I've been burnt before doing that when godawful Frontpage tags crept in unseen.

I tried doing windiff to see what changed but all the timestamps are different and <tbody> tags have appeared as well so basically every file had changes.

Share this post


Link to post
Share on other sites

Help file, section FileMove syntax is incorrect.

Parameters

source The source path of the file(s) to move.  Wildcards (*) are supported.

dest The destination path of the moved file(s).  Wildcards (*) are supported.

....continued.....

Example

FileMove("C:\*.au3", "D:\mydir\*.*")

At least on WinXP, almost all wildcard senarios don't actually work.


AutoIt3, the MACGYVER Pocket Knife for computers.

Share this post


Link to post
Share on other sites

Would it work when CyberSlug finishes the update to the "UNofficial" helpfile and you start using that as your new bases source for the future updates to the helpfile?

I really like the extra stuff that CyberSlug has put in and it will be a big task to be incorporated into the current "Official" version ... especially knowing how much you love doing this kind of work. B)

just my humble opinion... :whistle:

Edited by JdeB

SciTE4AutoIt3 Full installer Download page   - Beta files       Read before posting     How to post scriptsource   Forum etiquette  Forum Rules 
 
Live for the present,
Dream of the future,
Learn from the past.
  :)

Share this post


Link to post
Share on other sites

I don't use FrontPage but do use Mozilla Composer and TextPad. And I've made changes to practically every file....

If HTML-formatting is an issue, I could put the documentation for each function in plaintext file like the following and use a JdeB-like script to generate the corresponding htm doc file.

Function_Name_Goes_Here

Sentence_Description_Goes_Here

###API###
Syntax_Example_Goes_Here  

###Parameters### 
Info goes here... 

###Return Value### 
Info goes here...

###Remarks###
Info goes here...

###Related###
<a href="foo.htm">Foo</a>, <a href="bar.htm">Bar</a>

###Example###
Example goes here...

What do you think, Jon?


Use Mozilla | Take a look at My Disorganized AutoIt stuff | Very very old: AutoBuilder 11 Jan 2005 prototype I need to update my sig!

Share this post


Link to post
Share on other sites

What do you think, Jon?

I like the idea but it would be a monster amount of work to write that script. And some of the functions have extra bits...and tables...and other formatting.

I don't mind if someone else edits the files as long as the tags and formatting is consistant and the dir structure/filenames match.

Share this post


Link to post
Share on other sites

Jon: Tables aren't that much of a problem; I can use Excel to save an html table as a tab-delimited text file, plus I have a script to create tables from tab-delimited files. Other formatting can be handled on an individual basis. I'd probably handle the dozen keyword reference files individually.

JdeB: Did you send the message to yahoo or my university account? Unless you titled the email "free debt consolidation," I didn't get anything yet....


Use Mozilla | Take a look at My Disorganized AutoIt stuff | Very very old: AutoBuilder 11 Jan 2005 prototype I need to update my sig!

Share this post


Link to post
Share on other sites

CyberSlug... I used the "Email" button on the Forum... will sent it to your Yahoo account in a minute.

Am I the only one having problems with PM on this Forum at this moment ?? :whistle:


SciTE4AutoIt3 Full installer Download page   - Beta files       Read before posting     How to post scriptsource   Forum etiquette  Forum Rules 
 
Live for the present,
Dream of the future,
Learn from the past.
  :)

Share this post


Link to post
Share on other sites

Cyberslug,

can you please take my 3.0.89 help files and make your unoffical ones have the same filenames/structure (some small differences in intro and using). Then copy your changed stuff (most things) over the top and send me it back. I'll then use this for the official docs and we can sync changes from now on.

I'd like to keep the files/dirs the same as I have it now because I have it all CVS controlled and moving stuff is a pain.

The only thing I've changed in recently (i think) is the addition of ElseIf, @tempdir, @username and I also made a lot of keywords bold in the while.htm, select.htm etc.

Share this post


Link to post
Share on other sites

Jon, I can't seem to figure out pow()

Did you remove it? Or am I not guessing the usage correctly.

I was going to try to write up the HTML, but...

3.0.85

- Added: HotKeySet()

- Added: Abs(), Sin(), Cos(), Tan(), ASin(), ACos(), ATan(), Sqrt(), Log(), Exp(), Pow()


AutoIt3, the MACGYVER Pocket Knife for computers.

Share this post


Link to post
Share on other sites

I had the same confusion when working on the helpfile for that version...

Jon changed it to ^

Have a look at the http://www.hiddensoft.com/autoit3/files/ChangeLog.txt

3.0.85

- Added: HotKeySet()

- Added: Abs(), Sin(), Cos(), Tan(), ASin(), ACos(), ATan(), Sqrt(), Log(), Exp()

- Added: ^ operator


SciTE4AutoIt3 Full installer Download page   - Beta files       Read before posting     How to post scriptsource   Forum etiquette  Forum Rules 
 
Live for the present,
Dream of the future,
Learn from the past.
  :)

Share this post


Link to post
Share on other sites

Create an account or sign in to comment

You need to be a member in order to leave a comment

Create an account

Sign up for a new account in our community. It's easy!

Register a new account

Sign in

Already have an account? Sign in here.

Sign In Now
Sign in to follow this  

  • Recently Browsing   0 members

    No registered users viewing this page.

×
×
  • Create New...