[Omnihelp-devs] First enhancements...

[Glenn M. <gle...@vo...>]

Hi Jeremy,

With your permission, I would like to help enhance and extend OmniHelp. =
The first task that I would like to tackle is the "doxyenation" of the =
javascript code. I'll add doxygen comment blocks to the functions. Then =
I'll use open-source doxygen to extract the prototypes and comments into =
a mini-HTML system.

When I'm finished (by the end of next weekend), how should I progress in =
making this source (and even the generated mini-HTML system) available =
as the basis? I'm a bit ignorant has to the checkout, check-in hand-off =
procedure so that this open-source effort can grow.

I feel that this effort is worthwhile to me to help me understand the =
code. Once I'm done, the mini-HTML system will be provide useful =
overviews and information on what the javascript does, so that when =
others want to modify the code, they can know where to localize their =
efforts.

I'm not going to be able to complete this doxygenation effort. I can put =
in the templates and describe things that I know. You know the code =
better. The mechanism will be in place for you and others to document =
what the code does and have it be exposed.

Yes, this will initially make two separate mini-HTML systems: the one =
generated from Mif2Go and your FM document, and the one generated from =
Doxygen.

However, it will provide me with a working target to tailor and enhance =
my other open-source tools which will eventually allow OmniHelp to grow =
and support modular components. After all, OmniHelp needs to be in a =
position where people can use it in real-world documentation projects, =
whereby the documentation suite is composed of multiple manuals and/or =
mini-HTML systems.

In preparation, last weekend I downloaded a perl environment and doxygen =
executable for my Windows XP box at home.

Is this proposed involvement acceptable?

Glenn Maxey
Technical Writer
Voyant Technologies, Inc.
1765 West 121st Avenue
Westminster, CO 80234-2301
Tel. +1 303.223.5164
Fax. +1 303.223.5275
gle...@vo...