[screenweaver] working on documentation

[Thomas Wester]

When we wrote the api docs we put in all in a mysql database and
generated out the html files using an archaic coldfusion script. The
whole app was kind of home grown and hacked together quikcly it is not
really suitable for OS environment. The mysql database could be usefull,
I can dig it up if necessary.

I'm not sure how other projects tackle this problem. Is there an open
source way of collaborativly writing and generating help files. One that
can output the help files as xml, we can create scripts that transform
the xml files to different output formats.
It would be good to stay away from comments-in-the-source-files based
solutions so help file contributors don't need to access the .as files.

-Thomas


-----Original Message-----
From: screenweaver-bounces at osflash.org
[mailto:screenweaver-bounces at osflash.org] On Behalf Of Muzak
Sent: Friday, September 02, 2005 4:52 PM
To: chadart at gmail.com; screenweaver at osflash.org
Subject: [screenweaver] working on documentation

Just so you guys know:

I'm currently working on the documentation that goes in the Flash Help
panel.
Using Dreamweaver for now.

I'm basically making it a bit more suitable for the Help panel (slightly
smaller fonts) and adjusting/cleaning up the .css and html code.

The files I'm working on are located here:
https://secure.sourcesecure.co.uk/trac/osflash/screenweaver/browser/thre
e/trunk/res/mxp%20installer/source/HelpPanel

I guess those are derived from the original RoboHelp docs (the ones that
are still online at http://www.vanrijkom.org/sw3os/help/swhelp.html).

Are there any ideas yet of which direction we're going with this?
Will there be 2 versions (1 online, 1 for Flash IDE) and what about
those using Eclipse (and maybe later on Zorn)?

regards,
Muzak 



_______________________________________________
screenweaver mailing list
screenweaver at osflash.org
http://osflash.org/mailman/listinfo/screenweaver_osflash.org