XML Editor
Sign up for a WebBoard account Sign Up Keyword Search Search More Options... Options
Chat Rooms Chat Help Help News News Log in to WebBoard Log in Not Logged in
Show tree view Topic
Topic Page 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 Go to previous topicPrev TopicGo to next topicNext Topic
Postnext
Michele CrossSubject: Documentation (annotations) in generated Documentation?
Author: Michele Cross
Date: 07 Mar 2007 10:10 PM
This is probably a very basic newbie question.

I have all these lovely annotations in my xml schema but they don't come out when I generate the documentation using the documentation tab. I would have thought that since it is 'documentation' these would be one of the more obvious things to include by default... I can't find any settings to include them. I see that there is the option to edit the xs3p.xsl file but I'm hoping not to have to go there.

Thank you for your advice and suggestions!

michele

Postnext
Ivan PedruzziSubject: Documentation (annotations) in generated Documentation?
Author: Ivan Pedruzzi
Date: 08 Mar 2007 09:17 AM

Hi Michele,

Which Stylus Studio build are you running (Help -> About)?

Could you please post an example of schema?

Attached you can see how the xsd:documentation is rendered

Ivan Pedruzzi
Stylus Studio Team

Postnext
Michele CrossSubject: Documentation (annotations) in generated Documentation?
Author: Michele Cross
Date: 08 Mar 2007 05:47 PM
Thanks Ivan,

I am running Stylus Studio 2007 XML Enterprise Suite, build 735f.

Here is a sample extract from our (enormous) schema

<?xml version="1.0"?>
<xsd:schema xmlns:xsd="http://www.w3.org/2001/XMLSchema"><xsd:complexType name="Currency">
<xsd:sequence>
</xsd:sequence>
</xsd:complexType><xsd:group name="com.sandstone_tech.fldinterface.festival.model.framework.PeriodicAmount.fields">
<xsd:sequence>
<xsd:element name="amount" type="Currency"/>
<xsd:element name="defaultFrequencyAmount" type="Currency"/>
<xsd:element name="monthlyAmount" type="Currency">
<xsd:annotation>
<xsd:documentation>The payment amount converted to a monthly rate</xsd:documentation>
</xsd:annotation>
</xsd:element>
<xsd:element name="period" type="xsd:string"/>
<xsd:element name="weeklyAmount" type="Currency"/>
</xsd:sequence>
</xsd:group>
</xsd:schema>

Posttop
Ivan PedruzziSubject: Documentation (annotations) in generated Documentation?
Author: Ivan Pedruzzi
Date: 08 Mar 2007 10:55 PM

Hi Michele,

Only xsd:documentation for global definitions are rendered in the HTML documentation.

The only workaround I can suggest is to re-factor the documentation into the global parent, see attached schema.


Ivan Pedruzzi
Stylus Studio Team


Documentsandstone.xsd

 
Topic Page 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 Go to previous topicPrev TopicGo to next topicNext Topic
Download A Free Trial of Stylus Studio 6 XML Professional Edition Today! Powered by Stylus Studio, the world's leading XML IDE for XML, XSLT, XQuery, XML Schema, DTD, XPath, WSDL, XHTML, SQL/XML, and XML Mapping!  
go

Log In Options

Site Map | Privacy Policy | Terms of Use | Trademarks
Stylus Scoop XML Newsletter:
W3C Member
Stylus Studio® and DataDirect XQuery ™are from DataDirect Technologies, is a registered trademark of Progress Software Corporation, in the U.S. and other countries. © 2004-2016 All Rights Reserved.