OpenEuphoria

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

• Posted by Dan Moyer <DANIELMOYER at prodigy.net> Feb 08, 2003
• 393 views

Al,

As it happens I'm working on something *vaguely* similar to what you
describe, which responds to the "--/tag" comment convention used in
Win32Lib, and hope to write an "editor" to help library developers
painlessly add those "--/tag" style comments to their libraries if they
want.

You might consider making such an "editor" for the style of tags *you* want.
For instance, read the library file in, look for --/topic (if necessary),
also look for "--/func" & "--/proc", maybe also "--/const" , show that code
in a window, have fields for user to fill in with appropriate data, then
that data, with your tags, would be added to the code in the appropriate
places.

Dan Moyer

----- Original Message -----
From: "Al Getz" <Xaxo at aol.com>
To: "EUforum" <EUforum at topica.com>
Sent: Thursday, February 06, 2003 1:21 AM
Subject: RE: Win32Lib help format (was: Re: win32lib scrollbar (For library
devel


>
> 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
>
>
>
> TOPICA - Start your own email discussion group. FREE!
>