XML Source of "referenceMod.xsd"
See Also: |
|
Schema Location: |
http://docs.oasis-open.org/dita/v1.1/OS/schema/referenceMod.xsd |
XML Source
<?xml version="1.0" encoding="UTF-8"?>
<!-- ============================================================= -->
<!-- HEADER -->
<!-- ============================================================= -->
<!-- MODULE: DITA Reference XSD Module -->
<!-- VERSION: 1.1 -->
<!-- DATE: November 2006 -->
<!-- -->
<!-- ============================================================= -->
<!-- ============================================================= -->
<!-- SYSTEM: Darwin Information Typing Architecture (DITA) -->
<!-- -->
<!-- PURPOSE: DTD to describe DITA References -->
<!-- -->
<!-- ORIGINAL CREATION DATE: -->
<!-- March 2001 -->
<!-- -->
<!-- (C) Copyright OASIS-Open.org 2005, 2006 -->
<!-- (C) Copyright IBM Corporation 2001, 2004. -->
<!-- All Rights Reserved. -->
<!-- ============================================================= -->
<xs:schema attributeFormDefault="unqualified" elementFormDefault="qualified" xmlns:ditaarch="http://dita.oasis-open.org/architecture/2005/" xmlns:xs="http://www.w3.org/2001/XMLSchema">
<!-- ==================== Import Section ======================= -->
<xs:annotation>
<xs:documentation>
The <
<keyword>reference</keyword>
> element defines a top-level container
for a reference topic. Reference topics document programming constructs or
facts about a product. Examples of reference topics include language elements,
class descriptions, commands, functions, statements, protocols, types, declarators,
operands, and API information, which provide quick access to facts, but no
explanation of concepts or procedures. Reference topics have the same high-level
structure as any other topic type, with a title, short description, and body.
Within the body, reference topics are typically organized into one or more
sections, property lists, and tables. The reference topic type provides general
rules that apply to all kinds of reference information, using elements like <
<keyword>refsyn</keyword>
> for
syntax or signatures, and <
<keyword>properties</keyword>
> for lists of properties
and values.
</xs:documentation>
</xs:annotation>
<xs:complexContent>
<xs:extension base="reference.class">
<xs:attribute default="- topic/topic reference/reference " ref="class"/>
</xs:extension>
</xs:complexContent>
</xs:complexType>
</xs:element>
<xs:annotation>
<xs:documentation>
The <
<keyword>refbody</keyword>
> element is a container for the
main content of the reference topic. Reference topics limit the body structure
to tables (both simple and standard), property lists, syntax sections, and
generic sections and examples, in any sequence or number.
</xs:documentation>
</xs:annotation>
<xs:complexContent>
<xs:extension base="refbody.class">
<xs:attribute default="- topic/body reference/refbody " ref="class"/>
</xs:extension>
</xs:complexContent>
</xs:complexType>
</xs:element>
<xs:annotation>
<xs:documentation>
The <
<keyword>refsyn</keyword>
> element is a special section inside
a reference topic. The section often contains syntax or signature content
(for example, a command-line utility's calling syntax, or an API's signature).
The <
<keyword>refsyn</keyword>
> contains a brief, possibly diagrammatic
description of the subject's interface or high-level structure.
</xs:documentation>
</xs:annotation>
<xs:complexType mixed="true">
<xs:complexContent>
<xs:extension base="refsyn.class">
<xs:attribute default="- topic/section reference/refsyn " ref="class"/>
</xs:extension>
</xs:complexContent>
</xs:complexType>
</xs:element>
<xs:annotation>
<xs:documentation>
The <
<keyword>properties</keyword>
> element gives a list of properties for
the subject of the current topic, for example whether a class is public or protected.
Each property can include the type, value, and a description. The typical rendering is
usually in a table-like format. To represent multiple values for a type, just create
additional property elements and use only the <
<keyword>propvalue</keyword>
>
element (and <
<keyword>propdesc</keyword>
> when needed) for each successive
value.
</xs:documentation>
</xs:annotation>
<xs:complexContent>
<xs:extension base="properties.class">
<xs:attribute default="- topic/simpletable reference/properties " ref="class"/>
</xs:extension>
</xs:complexContent>
</xs:complexType>
</xs:element>
<xs:annotation>
<xs:documentation>
The <
<keyword>property</keyword>
> element represents a property
of the current topic's subject. For example, if the current topic is a class,
the property might show that the class is protected rather than public.
It contains three optional elements: type, value, and description.
</xs:documentation>
</xs:annotation>
<xs:complexContent>
<xs:extension base="property.class">
<xs:attribute default="- topic/strow reference/property " ref="class"/>
</xs:extension>
</xs:complexContent>
</xs:complexType>
</xs:element>
<xs:annotation>
<xs:documentation>
The <
<keyword>propvalue</keyword>
> element indicates the value or values
for the current property type. You can put values in separate rows if they
need separate descriptions, and just leave the <
<keyword>proptype</keyword>
> element
blank.
</xs:documentation>
</xs:annotation>
<xs:complexType mixed="true">
<xs:complexContent>
<xs:extension base="propvalue.class">
<xs:attribute default="- topic/stentry reference/propvalue " ref="class"/>
</xs:extension>
</xs:complexContent>
</xs:complexType>
</xs:element>
<xs:annotation>
<xs:documentation>
The <
<keyword>propdesc</keyword>
> element is used to provide a short description
of the property type and its listed values (or just the value).
</xs:documentation>
</xs:annotation>
<xs:complexType mixed="true">
<xs:complexContent>
<xs:extension base="propdesc.class">
<xs:attribute default="- topic/stentry reference/propdesc " ref="class"/>
</xs:extension>
</xs:complexContent>
</xs:complexType>
</xs:element>
<xs:annotation>
<xs:documentation>
The proptype element describes the type of property.
</xs:documentation>
</xs:annotation>
<xs:complexType mixed="true">
<xs:complexContent>
<xs:extension base="proptype.class">
<xs:attribute default="- topic/stentry reference/proptype " ref="class"/>
</xs:extension>
</xs:complexContent>
</xs:complexType>
</xs:element>
<xs:annotation>
<xs:documentation>
The prophead element supports regular headings for the properties element.
</xs:documentation>
</xs:annotation>
<xs:complexContent>
<xs:extension base="prophead.class">
<xs:attribute default="- topic/sthead reference/prophead " ref="class"/>
</xs:extension>
</xs:complexContent>
</xs:complexType>
</xs:element>
<xs:complexType mixed="true">
<xs:complexContent>
<xs:extension base="propvaluehd.class">
<xs:attribute default="- topic/stentry reference/propvaluehd " ref="class"/>
</xs:extension>
</xs:complexContent>
</xs:complexType>
</xs:element>
<xs:complexType mixed="true">
<xs:complexContent>
<xs:extension base="propdeschd.class">
<xs:attribute default="- topic/stentry reference/propdeschd " ref="class"/>
</xs:extension>
</xs:complexContent>
</xs:complexType>
</xs:element>
<xs:complexType mixed="true">
<xs:complexContent>
<xs:extension base="proptypehd.class">
<xs:attribute default="- topic/stentry reference/proptypehd " ref="class"/>
</xs:extension>
</xs:complexContent>
</xs:complexType>
</xs:element>
</xs:group>
<!-- Base type: topic.class -->
<xs:sequence>
<xs:group ref="title"/>
<xs:choice minOccurs="0">
</xs:choice>
<xs:group minOccurs="0" ref="prolog"/>
<xs:group minOccurs="0" ref="refbody"/>
</xs:sequence>
<xs:attribute name="id" type="xs:ID" use="required"/>
<xs:attribute name="conref" type="xs:string"/>
</xs:complexType>
<!-- Base type: body.class -->
<xs:choice maxOccurs="unbounded" minOccurs="0">
</xs:choice>
<xs:attribute name="base" type="xs:string"/>
</xs:complexType>
<!-- Base type: section.class -->
<xs:choice maxOccurs="unbounded" minOccurs="0">
</xs:choice>
<xs:attribute name="spectitle" type="xs:string"/>
</xs:complexType>
<!-- Base type: simpletable.class -->
<xs:sequence>
<xs:group minOccurs="0" ref="prophead"/>
<xs:group maxOccurs="unbounded" ref="property"/>
</xs:sequence>
<xs:attribute name="keycol" type="xs:NMTOKEN"/>
<xs:attribute name="refcols" type="xs:NMTOKENS"/>
<xs:attribute name="spectitle" type="xs:string"/>
</xs:complexType>
<!-- Base type: sthead.class -->
<xs:sequence>
</xs:sequence>
</xs:complexType>
<!-- Base type: stentry.class -->
<xs:choice maxOccurs="unbounded" minOccurs="0">
</xs:choice>
<xs:attribute name="specentry" type="xs:string"/>
</xs:complexType>
<!-- Base type: stentry.class -->
<xs:choice maxOccurs="unbounded" minOccurs="0">
</xs:choice>
<xs:attribute name="specentry" type="xs:string"/>
</xs:complexType>
<!-- Base type: stentry.class -->
<xs:choice maxOccurs="unbounded" minOccurs="0">
</xs:choice>
<xs:attribute name="specentry" type="xs:string"/>
</xs:complexType>
<!-- Base type: strow.class -->
<xs:sequence>
<xs:group minOccurs="0" ref="proptype"/>
<xs:group minOccurs="0" ref="propdesc"/>
</xs:sequence>
</xs:complexType>
<!-- Base type: stentry.class -->
<xs:choice maxOccurs="unbounded" minOccurs="0">
</xs:choice>
<xs:attribute name="specentry" type="xs:string"/>
</xs:complexType>
<!-- Base type: stentry.class -->
<xs:choice maxOccurs="unbounded" minOccurs="0">
</xs:choice>
<xs:attribute name="specentry" type="xs:string"/>
</xs:complexType>
<!-- Base type: stentry.class -->
<xs:choice maxOccurs="unbounded" minOccurs="0">
</xs:choice>
<xs:attribute name="specentry" type="xs:string"/>
</xs:complexType>
</xs:schema>