[screenweaver] working on documentation

Muzak p.ginneberge at telenet.be
Fri Sep 2 18:15:40 PDT 2005


If you could dig up the MySQL stuff, that would be great.
I have one running here at home and one on my online webserver.
And both are running ColdFusion as well, so I'm sure there's something we can come up with.

Don't know of any collaborative tools really.
Have used RoboHelp a few times in the past, but that's about it.

Agreed, generating docs from source code files doesn't really suit our needs.

So far I've been working on the formatting (.css and html) and this is what it looks like now (just one page as example):
http://muzakdeezign.com/swos/Help/Screenweaver/Actionscript_API/swApplication/call.html

Looks almost the same as the original except that the source code has been simplified and it looks better in the IDE.

regards,
Muzak

----- Original Message ----- 
From: "Thomas Wester" <thomas at secondstory.com>
To: <screenweaver at osflash.org>
Sent: Saturday, September 03, 2005 2:17 AM
Subject: RE: [screenweaver] working on documentation


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





More information about the screenweaver mailing list