I like the structure, and will adopt it. It should be in HTML, but can be in pdf as well.. search for and download Win2PDF.. this is a virtual printer which 'prints' to a PDF file. This printer can be used from ANY windows application that can print..
so.. we build the docs in HTML, then we offer a link to DL the PDF version.. Of course, someone should be resposable for updating the PDF when the HTML is updated.. (pssst.. I would like to be an admin.. it sucks to not be able to DO anything..) ----- Original Message ----- From: "Laszlo Teglas" <[EMAIL PROTECTED]> To: <[EMAIL PROTECTED]> Sent: Wednesday, November 14, 2001 1:23 PM Subject: [Dynapi-Dev] Documentation Project > Yes we are desperately in need of documentation. I believe we should create > a document structure instead of just adding files and tutorials independent > of each other. I have started to lay out the documentation structure as I > perceive it to be logical. I am looking for feedback and expanding the > structure: > > | > +-Introduction Module > | +-What is DynAPI > | +-History and Evolution of DynAPI > | | +-Origin of DynAPI 1.0 (Dans) > | | +-Major diffs between 1.0 and 2.0 > | | +-Major diffs between 2.0 and 2.5 > | | +-Major diffs between 2.5 and proposed future 2.6/3.0? > | | +-Detailed Revision File > | | > | +-Who Should use DynAPI > | +-Requirements / Supported Browsers and OS's > | +-FAQ > | +-License > | +-Contributors > | > +-Reference Module (To the point breakdown of the DynAPI Class Structure > | | no examples) > | +-dynapi.js > | | +-Purpose/Function > | | +-Requirements/Inheritance Structure > | | +-Constructor/Initializer > | | +-Fields/Constants/Properties > | | +-Fields/Constants/Properties Inherited from other classes > | | +-Methods/Functions > | | +-Methods/Functions Inherited form other classes > | | > | +-api > | | +-browser.js > | | | +-Purpose/Function > | | | +-Requirements/Inheritance Structure > | | | +-Constructor/Initializer > | | | +-Fields/Constants/Properties > | | | +-Fields/Constants/Properties Inherited from other classes > | | | +-Methods/Functions > | | | +-Methods/Functions Inherited form other classes > | | | > | | +-dyndocument.js > | | | +-Function/Function > | | | +-Requirements/Inheritance Structure > | | | +-Constructor/Initializer > | | | +-Fields/Constants/Properties > | | | +-Fields/Constants/Properties Inherited from other classes > | | | +-Methods/Functions > | | | +-Methods/Functions Inherited form other classes > | | | > | | +-dynlayer.js > | | +-Function/Function > | | +-Requirements/Inheritance Structure > | | +-Constructor/Initializer > | | +-Fields/Constants/Properties > | | +-Fields/Constants/Properties Inherited from other classes > | | +-Methods/Functions > | | +-Methods/Functions Inherited form other classes > | | > | +-event > | | +-dragevent.js (same breakdown as above) > | | +-keyboard.js > | | +-listeners.js > | | +-mouse.js > | | +-simple.js > | | > | +-ext (same breakdown as above) > | +-gui > | +-images > | +-util > | > +-Example Module > | +-Examples for each of the classes (Each example would be independent of > | any other example) (This is like a quick reference how to get started) > | > +-Tutorial Module (Detailed in-depth tutorial each step building on the > previous) > +-The basics of how DynAPI works > | +-dynapi.js (explain how it works) > | +-browser.js (explain how it works) > | +-dyndocument.js (explain how it works) > | +-dynlayer.js (explain how it works and create "Hello dynLayer") > | > +-Gui Tutorial > | +-What are widgets? > | +-Detailed walk through in creating each of the standard guis > | > +-Events Tutorial > | +-What are Listeners and Events > | +-Detailed walk through in utilizing each event file > | > +-Util Tutorial > | +-Detailed walk through in utilizing each Utility file > | > +-Extension Tutorial > | +-Detailed walk through in utilizing each Extension file > | > +-Advanced Topic Tutorials > | +-Create your own widgets > | +-Any other Advanced tutorials we can think of > | > +-Summary Tutorial > +-This tutorial would be like a step through project that would > build an extensive program based on All/most of the DynAPI > components and previous tutorials (perhaps a game or chat room) > maybe someone already has such a thing that they would be willing to > donate for the cause. > > As you can see there are 4 modules: > Introduction Module; Reference Module; Example Module; Tutorial Module > They can be incorporated into one manual or be used independently. > A lot of this stuff we already have, we just need to organize it and expand > on it. > > Should this be a plain text document, html, pdf, all of the above? > > Your thoughts and comments appreciated > > NanoFace =;^) > > > _______________________________________________ > Dynapi-Dev mailing list > [EMAIL PROTECTED] > http://www.mail-archive.com/dynapi-dev@lists.sourceforge.net/ _______________________________________________ Dynapi-Dev mailing list [EMAIL PROTECTED] http://www.mail-archive.com/dynapi-dev@lists.sourceforge.net/
