A couple things:
One of the reasons that I chose to do Fusedocs in XML was to learn XML and
some parsing of it. I have tried to follow the general description of Hal's
Fusedocs when I created the schema. I don't consider myself a Fusedoc guru
so I am posting the general form of what I did below. Please pick it apart
and show me how I could really make it functional. That would be awesome!
Second, I love the IDEA of doing it in XML because of the ease of parsing it
with other languages. I know this might sound funny but I didn't do it with
the intention of parsing it with ColdFusion. If I had that intention I
probably wouldn't have chosen XML.
Anyway, I personally would love to see a VTOM script for this purpose. I
think the future benefit of doing Fusedocs in XML far outweighs any other
method I can currently think of. I think the benefits could start with this
list: predefined method for parsing, standardized DTD could be created (not
that something similar couldn't be done some other way, so maybe this is
only a benefit if used with XML, not a benefit to change to XML), almost any
language now has XML parsing routines that could be used to go through and
turn XML fusedocs into HTML or text files or README files for general
documentation or application schemas, etc.
Anyway, here is what I had done (don't laugh please!):
<?xml version="1.0" standalone="yes" ?>
- <DOCUMENT>
<FILENAME>...</FILENAME>
<RESPONSIBILITIES>...</RESPONSIBILITIES>
- <HISTORY>
- <REVISION>
<AUTHOR>...</AUTHOR>
<VERSION>...</VERSION>
</REVISION>
</HISTORY>
- <ATTRIBUTES>
- <INPUT>
<TYPE>...</TYPE>
<NAME>...</NAME>
</INPUT>
- <OUTPUT>
<TYPE>...</TYPE>
<NAME>...</NAME>
</OUTPUT>
</ATTRIBUTES>
</DOCUMENT>
----- Original Message -----
From: "Erki Esken" <[EMAIL PROTECTED]>
To: "Fusebox" <[EMAIL PROTECTED]>
Sent: Thursday, May 31, 2001 6:44 AM
Subject: XML FuseDocs
>
> Don't forget that you can SCRIPT Studio's VTOM. So it should be possible
> to create a wizard for editing XML FuseDocs right within CFStudio - much
> like my FuseDoc attributes appending wizard. Currently my wizard parses
> the FuseDoc after Hal's FuseDoc EBNF definition, but parsing XML FuseDocs
> is also possible using VBScript and MSXML Parser (which comes with IE and
> is already installed on almost every system anyway). It should be also
> possible to create a conversion wizard that converts from current FuseDoc
> format to XML format and vice-versa.
>
> So what do you people think? What are the big benefits of using XML based
> FuseDocs and are they worth it to start building such a wizard?
>
> > I can send you the schema I created if you'd like.
>
> Please send it to [EMAIL PROTECTED] or even better, post it to FuseWiki.
>
> -erki
>
>
>
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Structure your ColdFusion code with Fusebox. Get the official book at
http://www.fusionauthority.com/bkinfo.cfm
Archives: http://www.mail-archive.com/[email protected]/
Unsubscribe: http://www.houseoffusion.com/index.cfm?sidebar=lists
