OpenEuphoria

RE: Win32Lib help format (was: Re: win32lib scrollbar (For library devel

• Posted by Al Getz <Xaxo at aol.com> Feb 06, 2003
• 432 views

Hi there Dan!

Thanks for the info.  Derek sent a copy of the file you are talking 
about.

>>>
--/topic some general topic for a group of routines
--/constant some GLOBAL constant the library user might need to have 
access
<<<

I was wondering...

Any chance you can convert it to a format like this:
-------------------------------------
Major_catagory1
/sub_catagory1
 text
//sub_sub_catagory1
 text
//sub_sub_catagory2
 text
//sub_sub_catagory3
 text

/sub_catagory2
 text

Major_catagory2
/sub_catagory1
 text
//sub_sub_catagory1
 text
//sub_sub_catagory2
 text

-------------------------------------
for example:
getHandle() --maj catagory
/use: --sub_cat1
 atom handle
 handle=getHandle(Window_id)
/description: --sub_cat2
 getHandle is used to get the windows handle of the window who's id is 
Window_id.
-------------------------------------

Purpose:  Im getting ready to build a huge help program that includes 
most
 of the stuff Euphoria users might like to have help on.
 I've already got all of Euphoria 2.3 in there, broken down into the 
above format.
 All the user has to do is click on a tree view branch and get help on 
that item.


For example:(here each "/" represents another tree level)

Euphoria Help --Maj catagory
/Euphoria 2.3 Keyword Help
//? --Eu's shorthand print keyword
///Syntax
?x
///Description
This is just a shorthand way of saying: print(1, x) - i.e.
printing the value of an expression to the standard output.
///Example
? {1, 2} + {3, 4}  -- will display {4, 6}
///Comments
? differs slightly from print() since it will add new-lines to
make the output more readable on your screen or wherever you have
directed standard output.
///See Also
print

If i could get a help file on Winlib in a format similar to the above
or parse it into something like that i could include it with this help
system.  That way, all of the stuff a user needs to know would be in one
place, in one program.

Any ideas?

Al