nanogui: Thread: Microwindows Documentation

I've been meaning to learn a little about DocBook, I've also been 
playing with Microwindows a bit. I noticed a mail in the Microwindows 
archives in which the writer had suggested converting the couple 
existing documents to DocBook format so that they could be more easily 
maintained. Shazam I have a project :)

I've just started to put this stuff together.

http://home.twcny.rr.com/garyshome/

I'd like to get feedback, comments, criticisms, etc... from you all 
before I continue on with anymore of this. I'd also like any text that 
anyone might want to contribute to a Micowindows User Guide. I have time 
to put the documentation together and maintain it, but I prpbably don't 
have enough time to become a master at the internals of Microwindows.

Gary

On Wed, 20 Dec 2000, Gary James wrote:
> existing documents to DocBook format so that they could be more easily 
> maintained. Shazam I have a project :)

Great, if you're a docbook expert perhaps you could work on improving the
new API documentation which will come with pre7- it's automatically
generated with gtkdoc and has a good reference to all the function calls,
but so far it's a bit ugly and doesn't document the structures and event
types. Also it'd be nice to wrap the API reference up into a larger
"Nano-X Programmer's Reference" which includes a lot more description
about how to use the API to program for Nano-X, demo applications, etc.

-- 
------- Alex Holden -------
http://www.linuxhacker.org/
 http://www.robogeeks.org/

: Great, if you're a docbook expert perhaps you could work on improving the
: new API documentation which will come with pre7- it's automatically
: generated with gtkdoc and has a good reference to all the function calls,
: but so far it's a bit ugly and doesn't document the structures and event
: types. Also it'd be nice to wrap the API reference up into a larger
: "Nano-X Programmer's Reference" which includes a lot more description
: about how to use the API to program for Nano-X, demo applications, etc.

Gtkdoc-style automated docs has been added to 0.89pre7, which now
includes .html, .sgml, and .pdf documentation.  The documentation can
be updated automatically from comments in nanox/client.c.

Regards,

Greg

I've put up an update to my Microwindows documentation.

The function reference section has been reformatted, I learned some new 
DocBook tricks :)  The biggest change comes in the new structure and 
enumeration references. I have about half the structures and 
enumeration's from nano-X.h documented. All of the event structures are 
completed. I've started building cross reference links between my 
function reference and the structure references, but it still needs one 
BIG walk through. I've only done light proof reading so if you notice 
errors please send me a note telling me where to make changes.

This release has been written against Microwindows version 0.89pre6. Now 
that 0.89pre7 has been released I will probably go through the whole 
thing to make sure everything is consistent with the new version.

The documents and SGML sources can be found at:

http://home.twcny.rr.com/embedded/microwin/

have fun
Gary James

I've finally finished bringing the nano-X API reference document up to date
with Microwindows revision 0.89pre7. In this release the document reflects
all of the API changes made from Microwindows 0.89pre6. This release covers
all of the public API as declared in the "nano-X.h" header file. With the
exception of the selection functions, events and structures. I need to
experiment more with those pieces before I feel comfortable attempting to
describe how they work.

This release has quite a few structures added that were not in the previous
vesion of the document. I've added a few nano-X code examples where I felt
it would help the discussion. There is also a significant amount of
additional linking between related subjects.

http://home.twcny.rr.com/embedded/microwin/

Gary James

I've put together a quick page of links to a few newer Microwindows &
nano-X based projects. If anybody knows of more links let me know I'll add
them to the list.

http://home.twcny.rr.com/embedded/microwin/links.html


I've also added a few examples of using images to my getting started
document.

http://home.twcny.rr.com/embedded/microwin/install/index.html


Gary James
####@####.####
http://home.twcny.rr.com/embedded