Page 1 of 1

Broken links in HTML documentation

Posted: Tue Jul 24, 2007 10:50 pm
by JSMAUG
The HTML created from a self contained .xsd contains many broken links, especially in the "Schema Component Representation" and the "XML Instance Representation". The same links work when they appear in other sections. For example, a bad super type link in the "XML Instance Representation" is bracketed by a working super type link below the complex type heading and a diagram created from a link to the same super type.

What are we missing?

Posted: Wed Jul 25, 2007 2:52 pm
by sorin_ristache
Hello,

Can you post a sample schema for this problem?


Regards,
Sorin

Posted: Thu Jul 26, 2007 8:13 am
by JSMAUG
Sorin,

The following can be used to demonstrate the HTML documentation problem. "BranchBaseAttributesType" and "string30 are resolved for some things but not others." They are fine in the xml editor. The behavior is the same on the developer's fully licensed copy and my 8.2 trial copy. We have been using Oxygen for writing xml, but this is our first venture into documenting it.

Thanks


<?xml version="1.0" encoding="UTF-8"?>
<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema">
<xs:annotation id="OverallDescription">
<xs:documentation xml:lang="en">
This is a schema for demonstrating the link problem.
</xs:documentation>
</xs:annotation>

<!-- BRANCHES -->
<xs:complexType name="BranchBaseAttributesType">
<xs:sequence>
<xs:element name="UserFieldValue" minOccurs="0" maxOccurs="1" type="xs:string" />
</xs:sequence>
<xs:attribute name="UID_BUse" type="string30" />
<xs:attribute name="BranchID" type="string30"/>
<xs:attribute name="Name" type="string30"/>
<xs:attribute name="Sections" type="string30" />
<xs:attribute name="Comments" type="string30" />
<xs:attribute name="SYS_AreaAdjustment" type="string30" />
<xs:attribute name="SYS_Area" type="string30" />
</xs:complexType>

<xs:complexType name="BranchType">
<xs:complexContent>
<xs:extension base="BranchBaseAttributesType">
<xs:sequence>
<xs:element name="SectionsCollection" type="xs:string" minOccurs="0" maxOccurs="1" />
</xs:sequence>
<xs:attribute name="UID_BUniqueID" type="string30" />
</xs:extension>
</xs:complexContent>
</xs:complexType>

<xs:simpleType name="string30" id="string30">
<xs:restriction base=" xs:string ">
<xs:maxLength value="30"/>
</xs:restriction>
</xs:simpleType>

</xs:schema>

Posted: Thu Jul 26, 2007 12:06 pm
by sorin_ristache
Hello,

Yes, the links to the type definitions for BranchBaseAttributesType and string30 are broken in Schema Component Representation and in XML Instance Representation. We will fix the problem in a future version of oXygen.


Thank you,
Sorin

Re: Broken links in HTML documentation

Posted: Fri Nov 07, 2008 1:50 pm
by sorin_ristache
Hello,

We fixed the broken links in the generated XML Schema documentation. The improved generator of the schema documentation will be included in the next version of Oxygen (version 10.1).


Regards,
Sorin