Subject:XSD Documentation generator Author:Guido Deinhammer Date:14 Oct 2003 02:00 PM
Hi,
I noticed that in SS version 5.0.0 for the XSD documentation you can specify that included and imported schemas should also be considered for the documentation. But when I choose either of these options, I don't get any documentation at all.
However this would be a very useful feature, since currently it when I generate documentation it does not include elements and types that are included in some included schema.
Also a good idea might be to generate an individual html page for each element and provide hyperlinks.
Also what would be really cool is to automatically display the documentation for an element or an attribute when editing an XML file with a schema associated with it.
The current XSD documentation has a very basic support for
include/import.
There are 3 parameters involved that you have to setup in the XSD
documentation properties
searchIncludedSchemas = true
searchImportedSchemas = true
linksFile that has to point to an xml document with particular
structure.
Attached to this message you will find a zip file that contains a small
example, unzip the content in C:\temp.
Here is what I did
1) create links.xml that maps schema url to document url
2) open test_include_master.xsd and
switch to the Documentation tab and set the XSD doc properties
described above
then click "Save Documentation" using the default name
Repeat the last step for test_included.xsd and test_imported.xsd
You will see that under the "Schema Document Properties" there is
"Schema Composition" with the hyperlink to the included/imported schema
We will try to make this process more automatic in future versions.
Hope this helps
Ivan
> -----Original Message-----
> From: stylus-studio-tech Listmanager
> [mailto:listmanager@edn.exln.com]
> Sent: Tuesday, October 14, 2003 2:24 PM
> To: Recipients of 'stylus-studio-tech' suppressed
> Subject: XSD Documentation generator
>
>
> From: "Guido Deinhammer"
>
> Hi,
>
> I noticed that in SS version 5.0.0 for the XSD documentation
> you can specify that included and imported schemas should
> also be considered for the documentation. But when I choose
> either of these options, I don't get any documentation at all.
>
> However this would be a very useful feature, since currently
> it when I generate documentation it does not include elements
> and types that are included in some included schema.
>
> Also a good idea might be to generate an individual html page
> for each element and provide hyperlinks.
>
> Also what would be really cool is to automatically display
> the documentation for an element or an attribute when editing
> an XML file with a schema associated with it.
>
> best regards,
>
> Guido
>
>
>
> To reply: mailto:stylus-studio-tech.7081@edn.exln.com
> To start a new topic: mailto:stylus-studio-tech@edn.exln.com
> To login: http://edn.exln.com/~SSDN
>