AutoHotkey Homepage AutoHotkey Community
Let's help each other out
 
 FAQFAQ   SearchSearch   MemberlistMemberlist   RegisterRegister 
 ProfileProfile   Log in to check your private messagesLog in to check your private messages   Log inLog in 

AutoHotkey Help file

 
Post new topic   Reply to topic    AutoHotkey Community Forum Index -> Wish List
View previous topic :: View next topic  
Author Message
Serenity



Joined: 07 Nov 2004
Posts: 1276

PostPosted: Wed Mar 09, 2005 8:43 am    Post subject: AutoHotkey Help file Reply with quote

Personally, I *really* prefer the way the help file was before, that it used the default colors set within IE like other help files. This seems to be the standard. Why has this changed?

A suggestion- I think it would be useful to have a subtree under Gui for each Gui item, and have examples of each gui item as it would work within a script. Its a very long page in the help file and its not so clear at first what the correct syntax is. Theres been so many newbie questions lately about Gui items and syntax, perhaps others would benefit from this. I'm thinking of spending some time to write up some frequently used examples like the following, though this probably goes beyond the scope of the help file:

Code:
; gui - edit styles
;-------------------
;-------------------

; show horizontal scroll bar when line exceeds window size
;-------------------------------------------------------------------------

Gui, Add, Edit, -Wrap +Multi, EditBox


; removing the 3D effect
;----------------------------

Gui, Add, Edit -0x200


; making it read-only
;-----------------------

Gui, Add, Edit +ReadOnly


; getting the text entered into an editfield
------------------------------------------------

Gui, Add, Edit, vEditfield +ReadOnly x0 y0 w120 h20, default text
GuiControlGet, display, , Editfield

_________________
"Anything worth doing is worth doing slowly." - Mae West
Back to top
View user's profile Send private message Visit poster's website
jonny



Joined: 13 Nov 2004
Posts: 3004
Location: Minnesota

PostPosted: Wed Mar 09, 2005 2:37 pm    Post subject: Reply with quote

That's the kind of thing we need a wiki for. Cool
Back to top
View user's profile Send private message
Chris
Site Admin


Joined: 02 Mar 2004
Posts: 10480

PostPosted: Wed Mar 09, 2005 4:30 pm    Post subject: Re: AutoHotkey Help file Reply with quote

Serenity wrote:
I *really* prefer the way the help file was before, that it used the default colors set within IE like other help files. This seems to be the standard. Why has this changed?
I didn't realize other help files tend to obey the user's custom background color. Anyway, it was changed because some felt that the custom background color is inappropriate for the help file. That discussion is here: http://www.autohotkey.com/forum/viewtopic.php?t=2571&postdays=0&postorder=asc&start=15

I'm open to changing it back again if anyone else feels as you do.

Quote:
I think it would be useful to have a subtree under Gui for each Gui item, and have examples of each gui item as it would work within a script.
Recent versions of the help file have a single example directly beneath each control type. The reason there aren't more examples in that section is mostly due to clutter: many of the control options (such as read-only) are fairly rarely used and seem too distracting to feature prominently. I tried to make up for this by including many working examples at the bottom of the page.

I know the help file could use improvement. In particular, the Gui page is lacking an introduction/mini-tutorial, which should hopefully get added in the future.

More suggestions are welcome.
Back to top
View user's profile Send private message Send e-mail
Serenity



Joined: 07 Nov 2004
Posts: 1276

PostPosted: Wed Mar 09, 2005 11:28 pm    Post subject: Reply with quote

Hmm, to be fair its not quite the standard, I've also come across alot that of docs for use no html code for coloring at all, which I prefer. On the other hand, the linux html docs I've come across all follow this scrict format of black on white. I prefer the contrast to be lower.

Can the help file be modified at all, after downloading it? I couldn't find any html values/strings with a hex editor so I am assuming the .chm is compressed in some way.

jonny wrote:
That's the kind of thing we need a wiki for. Cool

If someone could host a wiki for AutoHotkey I'd be happy to contribute to it. Smile
_________________
"Anything worth doing is worth doing slowly." - Mae West
Back to top
View user's profile Send private message Visit poster's website
jonny



Joined: 13 Nov 2004
Posts: 3004
Location: Minnesota

PostPosted: Thu Mar 10, 2005 12:16 am    Post subject: Reply with quote

Seren wrote:
Can the help file be modified at all, after downloading it? I couldn't find any html values/strings with a hex editor so I am assuming the .chm is compressed in some way.


Chm is short for Compiled Help Markup. Compiled help files are... well... compiled, so ya, they can't be modified by ordinary means after they're made.
Back to top
View user's profile Send private message
Chris
Site Admin


Joined: 02 Mar 2004
Posts: 10480

PostPosted: Thu Mar 10, 2005 12:51 am    Post subject: Reply with quote

Serenity wrote:
Can the help file be modified at all, after downloading it? I couldn't find any html values/strings with a hex editor so I am assuming the .chm is compressed in some way.
If you get a help file tool such as Microsoft's free HTML Help Workshop, you can decompress the help file and edit the .css file inside. If you remove the line "background-color:#FFFFFF;" from the top section, the background color won't be forced-white anymore.
Back to top
View user's profile Send private message Send e-mail
Serenity



Joined: 07 Nov 2004
Posts: 1276

PostPosted: Thu Mar 10, 2005 7:31 am    Post subject: Reply with quote

Thanks Chris, thats just what I needed. Smile
_________________
"Anything worth doing is worth doing slowly." - Mae West
Back to top
View user's profile Send private message Visit poster's website
Display posts from previous:   
Post new topic   Reply to topic    AutoHotkey Community Forum Index -> Wish List All times are GMT
Page 1 of 1

 
Jump to:  
You can post new topics in this forum
You can reply to topics in this forum


Powered by phpBB © 2001, 2005 phpBB Group