Documentation

[Jon]

I've added a couple of pages to the "Using AutoIt" section. What do you think?

http://www.hiddensoft.com/autoit3/files/unstable/AutoIt.chm

[Jos]

Help on the help file is much appreciated as Larry and I _really_ hate documenting...

Think this is very usefull info for starters....

few remarks:

maybe you want to say something about the "WinTitleMatchMode" ? ( or will that be covered in the "Advanced modes" page which you are writing?)

is this the correct default path?? (Program Files\AU3_Spy.exe) .

found 2 typo's: specifed - specifiy

p.s. like the Library Function Reference

[Jon]

maybe you want to say something about the "WinTitleMatchMode" ? ( or will that be covered in the "Advanced modes" page which you are writing?)

Yeah, doing that page now.

[CyberSlug]

Wow, that looks really good!

Do you plan on a page like that for Aut2Exe?

[Jon]

Yeah.

[jpm]

It will be good to have a description of the WinWaitActive/WinWait/WinActivate philosophy.

I mean by that some good practice to have a script keeping control on the windows activities.

PS I need an English lesson for the Steak-house/bistro comparison perhaps not a special using AutoIt page not needed

[jlandes]

Not that I care, but it might also be good to include a page on where to get the installer for AutoIt and how to install the application. I know how to do this, but others might have some difficulties. Thx.

[CyberSlug]

Not that I care, but it might also be good to include a page on where to get the installer for AutoIt and how to install the application.  I know how to do this, but others might have some difficulties.  Thx.

I assume you mean on the AutoIt website instead of in the help file, right?

[Jos]

Just mailed a proposal to add an "Advanced Editor: section to the "Using AutoIt" section where we describe how to use the commonly used editors and AutoIt with Syntax Highlighting, Context sensitive help, Run and compile scripts from within the editor. I include the Crimson description and the TextPad description that Trids posted. Others probably can describe this for the editors they use.

Think this could be usefull for others to know how these needs to be setup.

[CyberSlug]

Just a reminder: Use pngcrush when you compile the final docs.

I shaved off 3 kb [from AutoIt.chm, that is] when I tried on docs-v3.0.92-src

Edited January 31, 2004 by CyberSlug

[Jos]

Jon, could you make a few change to Table Of Contents entry Titles in the Helpfile?

This would add these Keywords also to the index when you generate it with the script... tnx

Func...EndFunc -> Func...Return...EndFunc

If -> If...Then

If...Else...EndIf -> If...Then...ElseIf...Else...EndIf

[CyberSlug]

Documentation (help file) style questions/nitpicks:

1) License: Wordwrap or fixed line length of ~77 characters?

2) Compiling Scripts: Screenshot of Aut2Exe shows "Source File (.aut file)" instead of .au3

3) Index has #-directives and @-macros all at the beginning, but the _-UDFs appear anywhere in the list. Should the the # and @ also appear mixed in, or should the _funcs appear grouped together?

4) Library Function Reference: Table does not wrap, so user must scroll horizontally to read it. Also, perhaps a different color scheme could be used.

5) Appendix: Do you want to highlight links to external websites in a different color? Also I'm not sure about copyright issues regarding the content; I might need to make a few changes to the info....

5) Function syntax specs: How do you want spaces and brackets around optional parameters?

WinWaitNotActive ( "title" [, "text" [, timeout]] )
WinWaitNotActive("title", ["text"], [timeout])
other...

[Jos]

4)  Library Function Reference:  Table does not wrap, so user must scroll horizontally to read it.  Also, perhaps a different color scheme could be used.

I added the nowrap to both columns because the first column became somewhat unreadable when we added the parameters to it... Would just wrapping the description work or do you think we should go back to wrapping both ?

Assume the color you refer to is the color of the include file cell?... what value would you think is better ? (currently its bgcolor="#C4ECFF")

I think we should also change "Include filename: <Date.au3>" to "#Include <Date.au3>" since that is what need to be coded in the script... agree ?

[jlandes]

What about removing the parameters from the function list? That might help. The user could click on the function name to get a list of parameters for the function.

[Jos]

I put them in there on Jon's request..

Just played a bit with the table and it think it looks better when I make the font smaller and remove the nowrap on the description....

see example : http://home.planet.nl/~zande499/autoit/libfunctions.htm

(also put in another color just to try it out)

what do you think ?

[GEOSoft]

I put them in there on Jon's request..

Just played a bit with the table and it think it looks better when I make the font smaller and remove the nowrap on the description....

see example : http://home.planet.nl/~zande499/autoit/libfunctions.htm

(also put in another color just to try it out)

what do you think ?

It looks fine but I made a small change in the Table structure. I removed the cell size tags since you have the 1st column set for now wrap and the table width is at 100% then the second column will set itself to 100% - The width needed for the non-wrapping column 1 which should make it easier to resize the Help file window without having scroll bars show up.

Get it here.

[Jon]

I think the parameters should be left out of the overall reference page too so you only see them when you click on the link. I would ask Jeremy how he wanted these things documented though as these are his "baby"

[CyberSlug]

About number 4: I like the changes--but I really don't mind what you do about wrapping and color scheme. I'm just trying to get things consistent

So what about the other stuff?

[Jon]

I put them in there on Jon's request..

Hehe, I just meant in the actual definition, not the reference page.

[Jos]

Hehe, I just meant in the actual definition, not the reference page.

.. misunderstood...

Will take the parameters out... what about the color for the Include file cell ?

I guess we can leave the font size to the standard ...

Edit: removed url

Edited February 7, 2004 by JdeB