[screenweaver] Help docs generator - current status.

Muzak p.ginneberge at telenet.be
Sun Sep 18 07:25:04 PDT 2005


Here's a screen capture demo of what I'm currently working on regarding the SWOS documentation.

Thomas provided me with the MySQL data that they used for previous versions and I started creating a UI for it (in flash).
http://www.muzakdeezign.com/swos/docs_demo/demo01.html

I wrote some remoting services (currently in Coldfusion) and hooked that up with Flash.
The api can be viewed here (is a snapshot of my network server, so not live)
http://www.muzakdeezign.com/swos/docs_demo/docs_select_api.html

For those not familiar with the database structure it probably won't say much though :-)

Anyway, the most important remote method for now is 'getTreeData' which returns all the data from the database in an xml format that 
can be used in a Flash Tree component. Just call the method and throw the result in a Tree, as simple as that.

At this point, no editing possibilities have been implemented, but that's the goal.. eventually.

And here are some thoughts on what we could do with this:

- online viewing of help documentation (no need to generate/upload seperate .html files to a server as it hooks straight into the 
database)
- online editing of documentation data (restricted with username/password)

- generate help for Flash IDE (.xml, .html, etc..). This will most likely not be the online app, but a desktop version, which 
connects to the online services (remoting) and stores the generated files locally.


As mentioned above, the remoting services are currently written in Coldfusion, but - if needed - can be rewritten in PHP later in 
case we need to relocate the application to another server.
I don't mind hosting this on my server (which has Coldfusion support) though.

Let me know what you think ;-)

regards,
Muzak





More information about the screenweaver mailing list