Rules and Standards

CAA V5 XML Code Presentation

Presentation conventions to improve the readability of XML code
Technical Article

Abstract

This article gives information on how to edit XML Schema as regards to the document layout. CAA Use Cases are expected to meet these conventions.


Global layout

The XML Schema documents presentation must obey the following order:

[Top]

Type and element declaration layout

[Top]

Naming Conventions

[Top]

Comments

All exposed entities in XML Schema, i.e., global and local types and elements, must be documented using the annotation and documentation elements. For example:

<xsd:element name="product" type="productType">
  <xsd:annotation>
    <xsd:documentation>Use this element to exchange product data.</xsd:documentation>
  </xsd:annotation>
</xsd:element>

Note that since English language is assumed for XML documentation, CAA rules does not require the use of the xml:lang attribute with documentation elements.

If documentation in multiple languages were needed, using the xml:lang attributes with documentation element would be required.

[Top]


History

Version: 1.0 [Sep 2001] Document created
[Top]

Copyright © 2001, Dassault Systèmes. All rights reserved.