1 / 9

SDD Schema Documentation

SDD Schema Documentation. Preliminary Thoughts Howard Abrams – CA, Inc. In v1.0. Schema is just the raw XML Documentation for schema elements in spec. Example in v1.0. Example in v1.0. < xsd:element name=" DeploymentDescriptor " type=" sdd-dd:DeploymentDescriptorType “/>

havard
Download Presentation

SDD Schema Documentation

An Image/Link below is provided (as is) to download presentation Download Policy: Content on the Website is provided to you AS IS for your information and personal use and may not be sold / licensed / shared on other websites without getting consent from its author. Content is provided to you AS IS for your information and personal use only. Download presentation by click this link. While downloading, if for some reason you are not able to download a presentation, the publisher may have deleted the file from their server. During download, if you can't get a presentation, the file might be deleted by the publisher.

E N D

Presentation Transcript

  1. SDD Schema Documentation Preliminary Thoughts Howard Abrams – CA, Inc.

  2. In v1.0 • Schema is just the raw XML • Documentation for schema elements in spec

  3. Example in v1.0

  4. Example in v1.0 <xsd:element name="DeploymentDescriptor" type="sdd-dd:DeploymentDescriptorType“/> <xsd:complexType name="DeploymentDescriptorType"> <xsd:sequence> <xsd:element name="Topology" type="sdd-dd:TopologyType"/> <xsd:choice> <xsd:choice> <xsd:element name="InstallableUnit" type="sdd-dd:InstallableUnitType"/> <xsd:element name="ConfigurationUnit" type="sdd-dd:ConfigurationUnitType"/> <xsd:element name="LocalizationUnit" type="sdd-dd:LocalizationUnitType"/> </xsd:choice> <xsd:sequencemaxOccurs="unbounded"> <xsd:elementname="CompositeInstallable" type="sdd-dd:CompositeInstallableType"/> </xsd:sequence> </xsd:choice> <xsd:element name="Requisites" type="sdd-dd:RequisitesType" minOccurs="0"/> <xsd:any namespace="##other" processContents="lax" minOccurs="0" maxOccurs="unbounded"/> </xsd:sequence> <xsd:attributeGroup ref="sdd-common:DescriptorInfoGroup"/> </xsd:complexType>

  5. Example in v1.0

  6. Proposed for v1.1 • Schema would contain <annotation> and <documentation> tags that give the same information that is found in the spec. • Benefits: • Allows schema to more easily be understood. • Allows tools to use the documentation for code completion or tooltip help.

  7. Example in v1.1 <xsd:element name="DeploymentDescriptor" type="sdd-dd:DeploymentDescriptorType“> <xsd:annotation> <xsd:documentation> DeploymentDescriptor is the top level element of a deployment descriptor. The DeploymentDescriptor defines the information required to support deployment of the package contents. This includes the Topology, which declares all of the resources that may participate in deployment. It also includes one atomic content element or one or more CompositeInstallable content elements. Atomic content elements are InstallableUnit, ConfigurationUnit, or LocalizationUnit. Atomic content elements define artifacts that can be processed to deploy software resources. They are atomic because they cannot aggregate other content elements. A CompositeInstallable element is the root of a content element hierarchy that defines content that performs the one deployment operation supported by the CompositeInstallable. A CompositeInstallable can define base, selectable and localization content as well as the aggregation of other content elements. </xsd:documentation> </xsd:annotation> </xsd:element> <xsd:complexType name="DeploymentDescriptorType"> <xsd:sequence> <xsd:element name="Topology" type="sdd-dd:TopologyType"/> <xsd:choice> <xsd:choice> <xsd:element name="InstallableUnit" type="sdd-dd:InstallableUnitType"/> <xsd:element name="ConfigurationUnit" type="sdd-dd:ConfigurationUnitType"/> <xsd:element name="LocalizationUnit" type="sdd-dd:LocalizationUnitType"/> </xsd:choice> <xsd:sequencemaxOccurs="unbounded"> <xsd:elementname="CompositeInstallable" type="sdd-dd:CompositeInstallableType"/> </xsd:sequence> </xsd:choice> <xsd:element name="Requisites" type="sdd-dd:RequisitesType" minOccurs="0"/> <xsd:any namespace="##other" processContents="lax" minOccurs="0" maxOccurs="unbounded"/> </xsd:sequence> <xsd:attributeGroup ref="sdd-common:DescriptorInfoGroup"/> </xsd:complexType>

  8. Example in v1.1

  9. Open Issues • At least in Eclipse, documentation is only shown on the element not the type. • Our schema doesn’t define top-level elements and reference them, instead we declare elements in-line and specify types. This could me more duplication of documentation. • More investigation is needed • How do we make sure the schema and spec are in sync. • Some type of automation to go from xsd to word? • Make xsd the only place documentation on elements is stored?

More Related