ePubTk refdb export schema

Table of Contents

top

Schema Document Properties

Target Namespace http://dev.livingreviews.org/epubtk/refdb/export
Version 1.0
Element and Attribute Namespaces
  • Global element and attribute declarations belong to this schema's target namespace.
  • By default, local element declarations belong to this schema's target namespace.
  • By default, local attribute declarations belong to this schema's target namespace.
Documentation export schema for the reference database (refdb) component of ZIM's ePublishingToolkit. this schema will be publicly available from the schema location http://dev.livingreviews.org/epubtk/refdb/export.xsd $HeadURL$ $LastChangedBy$ $LastChangedRevision$

Declared Namespaces

Prefix Namespace
Default namespace http://dev.livingreviews.org/epubtk/refdb/export
xml http://www.w3.org/XML/1998/namespace
xsd http://www.w3.org/2001/XMLSchema
Schema Component Representation
<xsd:schema targetNamespace="http://dev.livingreviews.org/epubtk/refdb/export" attributeFormDefault="qualified" elementFormDefault="qualified" version="1.0">
...
</xsd:schema>
top

Global Declarations

Element: bibData

Name bibData
Type bibDataType
Nillable no
Abstract no
Documentation element to hold one atom of bibliographical data such as an author name
XML Instance Representation
<bibData
field=" xsd:string [1]"
type=" xsd:string [0..1]"
tex=" xsd:string [0..1]">
<!-- Mixed content -->
Start Choice [0..*]
<sub> xsd:string </sub> [1]
<sup> xsd:string </sup> [1]
<url> xsd:string </url> [1]
End Choice
</bibData>
Schema Component Representation
<xsd:element name="bibData" type=" bibDataType "/>
top

Element: export

Name export
Type Locally-defined complex type
Nillable no
Abstract no
Documentation search results are exported as list of bibliographical records plus meta data about the search which produced the list.
XML Instance Representation
<export
source=" xsd:string [1]"
journal=" xsd:string [0..1]"
created=" xsd:dateTime [1]"
schemaVersion=" schemaVersionType [1]">
<query> ... </query> [0..1]
<record> ... </record> [0..*]
</export>
Schema Component Representation
<xsd:element name="export">
<xsd:complexType>
<xsd:sequence>
<xsd:element ref=" query " maxOccurs="1" minOccurs="0"/>
<xsd:element ref=" record " maxOccurs="unbounded" minOccurs="0"/>
</xsd:sequence>
<xsd:attribute name="source" type=" xsd:string " use="required"/>
<xsd:attribute name="journal" type=" xsd:string " use="optional"/>
<xsd:attribute name="created" type=" xsd:dateTime " use="required"/>
<xsd:attribute name="schemaVersion" type=" schemaVersionType " use="required"/>
</xsd:complexType>
</xsd:element>
top

Element: input

Name input
Type Locally-defined complex type
Nillable no
Abstract no
Documentation element containing one piece of input data, making up the query resulting in the list of records. values of the name attributes have the following meaning: 'sortOrder': the criterion to sort the list of matching records. 'limit': the number of records to actually retrieve from the db. 'offset': the offset within the list of all matching records at which the 'limit'-sized is to be cut out. 'author': search string entered in the 'author' input field 'title': search string entered in the 'title' input field 'keyword': search string entered in the 'keyword' input field 'journal': search string entered in the 'journal' input field 'year': search string entered in the 'year' input field
XML Instance Representation
<input
name=" xsd:string [1]"
value=" xsd:string [1]"
mode=" xsd:string [0..1]"/>
Schema Component Representation
<xsd:element name="input">
<xsd:complexType>
<xsd:attribute name="name" type=" xsd:string " use="required"/>
<xsd:attribute name="value" type=" xsd:string " use="required"/>
<xsd:attribute name="mode" type=" xsd:string " use="optional"/>
</xsd:complexType>
</xsd:element>
top

Element: query

Name query
Type Locally-defined complex type
Nillable no
Abstract no
Documentation container for input data which made up the query resulting in the list of records. the attributes are to be interpreted as follows: 'totalResults': the total number of records matching the search criteria.
XML Instance Representation
<query
totalResults=" xsd:nonNegativeInteger [1]"
uri=" xsd:string [0..1]">
<input> ... </input> [0..*]
</query>
Schema Component Representation
<xsd:element name="query">
<xsd:complexType>
<xsd:sequence>
<xsd:element ref=" input " maxOccurs="unbounded" minOccurs="0"/>
</xsd:sequence>
<xsd:attribute name="totalResults" type=" xsd:nonNegativeInteger " use="required"/>
<xsd:attribute name="uri" type=" xsd:string " use="optional"/>
</xsd:complexType>
</xsd:element>
top

Element: record

Name record
Type Locally-defined complex type
Nillable no
Abstract no
Documentation the container for the various bibliographical data items of a reference the attribute 'ord' is the ordinal of the record within the result set
XML Instance Representation
<record
genre=" xsd:string [1]"
id=" xsd:string [1]"
ord=" xsd:positiveInteger [1]"
coins=" xsd:string [0..1]">
<bibData> ... </bibData> [0..*]
<referencedIn> ... </referencedIn> [1..*]
</record>
Schema Component Representation
<xsd:element name="record">
<xsd:complexType>
<xsd:sequence>
<xsd:element ref=" bibData " maxOccurs="unbounded" minOccurs="0"/>
<xsd:element ref=" referencedIn " maxOccurs="unbounded" minOccurs="1"/>
</xsd:sequence>
<xsd:attribute name="genre" type=" xsd:string " use="required"/>
<xsd:attribute name="id" type=" xsd:string " use="required"/>
<xsd:attribute name="ord" type=" xsd:positiveInteger " use="required"/>
<xsd:attribute name="coins" type=" xsd:string " use="optional"/>
</xsd:complexType>
</xsd:element>
top

Element: referencedIn

Name referencedIn
Type Locally-defined complex type
Nillable no
Abstract no
Documentation a container for citation context specific bibliographical data. the 'pubNo' attribute contains the publication number of the publication which cites this record. the 'ord' attribute specifies the position of this record within the citing article's list of references. the 'key' attribute holds the citation key used to refer to the reference in the citing article.
XML Instance Representation
<referencedIn
pubNo=" xsd:string [1]"
ord=" xsd:integer [1]"
key=" xsd:string [1]">
<bibData> ... </bibData> [0..*]
</referencedIn>
Schema Component Representation
<xsd:element name="referencedIn">
<xsd:complexType>
<xsd:sequence>
<xsd:element ref=" bibData " maxOccurs="unbounded" minOccurs="0"/>
</xsd:sequence>
<xsd:attribute name="pubNo" type=" xsd:string " use="required"/>
<xsd:attribute name="ord" type=" xsd:integer " use="required"/>
<xsd:attribute name="key" type=" xsd:string " use="required"/>
</xsd:complexType>
</xsd:element>
top

Global Definitions

Complex Type: bibDataType

Super-types: complexTextType < bibDataType (by extension)
Sub-types: None
Name bibDataType
Abstract no
Documentation the element's content provides the value of the bibliographical data item. the 'field' attribute specifies the bibliographical data type of the element. the 'type' attribute provides additional information how to interpret the content of the element. the 'text' attribute provides a LaTeX-string from which the element's content was derived.
XML Instance Representation
<...
field=" xsd:string [1]"
type=" xsd:string [0..1]"
tex=" xsd:string [0..1]">
<!-- Mixed content -->
Start Choice [0..*]
<sub> xsd:string </sub> [1]
<sup> xsd:string </sup> [1]
<url> xsd:string </url> [1]
End Choice
</...>
Schema Component Representation
<xsd:complexType name="bibDataType" mixed="true">
<xsd:complexContent>
<xsd:extension base=" complexTextType ">
<xsd:attribute name="field" type=" xsd:string " use="required"/>
<xsd:attribute name="type" type=" xsd:string " use="optional"/>
<xsd:attribute name="tex" type=" xsd:string " use="optional"/>
</xsd:extension>
</xsd:complexContent>
</xsd:complexType>
top

Complex Type: complexTextType

Super-types: None
Sub-types:
Name complexTextType
Abstract no
Documentation type for bibData element content. this type of mixed content corresponds to refdb's extended unicode strings
XML Instance Representation
<...>
<!-- Mixed content -->
Start Choice [0..*]
<sub> xsd:string </sub> [1]
<sup> xsd:string </sup> [1]
<url> xsd:string </url> [1]
End Choice
</...>
Schema Component Representation
<xsd:complexType name="complexTextType" mixed="true">
<xsd:choice maxOccurs="unbounded" minOccurs="0">
<xsd:element name="sub" type=" xsd:string "/>
<xsd:element name="sup" type=" xsd:string "/>
<xsd:element name="url" type=" xsd:string "/>
</xsd:choice>
</xsd:complexType>
top

Simple Type: schemaVersionType

Super-types: xsd:decimal < schemaVersionType (by restriction)
Sub-types: None
Name schemaVersionType
Content
  • Base XSD Type: decimal
  • value comes from list: {'1.0'}
Documentation enumeration of version number of this schema which are compatible with the current version.
Schema Component Representation
<xsd:simpleType name="schemaVersionType">
<xsd:restriction base=" xsd:decimal ">
<xsd:enumeration value="1.0"/>
</xsd:restriction>
</xsd:simpleType>
top

Legend

Complex Type:

Schema Component Type

AusAddress

Schema Component Name
Super-types: Address < AusAddress (by extension)
Sub-types:
  • QLDAddress (by restriction)
If this schema component is a type definition, its type hierarchy is shown in a gray-bordered box.
Name AusAddress
Abstract no
The table above displays the properties of this schema component.
XML Instance Representation
<... country="Australia" >
<unitNo> string </unitNo> [0..1]
<houseNo> string </houseNo> [1]
<street> string </street> [1]
Start Choice [1]
<city> string </city> [1]
<town> string </town> [1]
End Choice
<state> AusStates </state> [1]
<postcode> string <<pattern = [1-9][0-9]{3}>> </postcode> [1] ?
</...>

The XML Instance Representation table above shows the schema component's content as an XML instance.

Schema Component Representation
<complexType name="AusAddress">
<complexContent>
<extension base=" Address ">
<sequence>
<element name="state" type=" AusStates "/>
<element name="postcode">
<simpleType>
<restriction base=" string ">
<pattern value="[1-9][0-9]{3}"/>
</restriction>
</simpleType>
</element>
</sequence>
<attribute name="country" type=" string " fixed="Australia"/>
</extension>
</complexContent>
</complexType>
The Schema Component Representation table above displays the underlying XML representation of the schema component. (Annotations are not shown.)
top

Glossary

Abstract (Applies to complex type definitions and element declarations). An abstract element or complex type cannot used to validate an element instance. If there is a reference to an abstract element, only element declarations that can substitute the abstract element can be used to validate the instance. For references to abstract type definitions, only derived types can be used.

All Model Group Child elements can be provided in any order in instances. See: http://www.w3.org/TR/xmlschema-1/#element-all.

Choice Model Group Only one from the list of child elements and model groups can be provided in instances. See: http://www.w3.org/TR/xmlschema-1/#element-choice.

Collapse Whitespace Policy Replace tab, line feed, and carriage return characters with space character (Unicode character 32). Then, collapse contiguous sequences of space characters into single space character, and remove leading and trailing space characters.

Disallowed Substitutions (Applies to element declarations). If substitution is specified, then substitution group members cannot be used in place of the given element declaration to validate element instances. If derivation methods, e.g. extension, restriction, are specified, then the given element declaration will not validate element instances that have types derived from the element declaration's type using the specified derivation methods. Normally, element instances can override their declaration's type by specifying an xsi:type attribute.

Key Constraint Like Uniqueness Constraint, but additionally requires that the specified value(s) must be provided. See: http://www.w3.org/TR/xmlschema-1/#cIdentity-constraint_Definitions.

Key Reference Constraint Ensures that the specified value(s) must match value(s) from a Key Constraint or Uniqueness Constraint. See: http://www.w3.org/TR/xmlschema-1/#cIdentity-constraint_Definitions.

Model Group Groups together element content, specifying the order in which the element content can occur and the number of times the group of element content may be repeated. See: http://www.w3.org/TR/xmlschema-1/#Model_Groups.

Nillable (Applies to element declarations). If an element declaration is nillable, instances can use the xsi:nil attribute. The xsi:nil attribute is the boolean attribute, nil, from the http://www.w3.org/2001/XMLSchema-instance namespace. If an element instance has an xsi:nil attribute set to true, it can be left empty, even though its element declaration may have required content.

Notation A notation is used to identify the format of a piece of data. Values of elements and attributes that are of type, NOTATION, must come from the names of declared notations. See: http://www.w3.org/TR/xmlschema-1/#cNotation_Declarations.

Preserve Whitespace Policy Preserve whitespaces exactly as they appear in instances.

Prohibited Derivations (Applies to type definitions). Derivation methods that cannot be used to create sub-types from a given type definition.

Prohibited Substitutions (Applies to complex type definitions). Prevents sub-types that have been derived using the specified derivation methods from validating element instances in place of the given type definition.

Replace Whitespace Policy Replace tab, line feed, and carriage return characters with space character (Unicode character 32).

Sequence Model Group Child elements and model groups must be provided in the specified order in instances. See: http://www.w3.org/TR/xmlschema-1/#element-sequence.

Substitution Group Elements that are members of a substitution group can be used wherever the head element of the substitution group is referenced.

Substitution Group Exclusions (Applies to element declarations). Prohibits element declarations from nominating themselves as being able to substitute a given element declaration, if they have types that are derived from the original element's type using the specified derivation methods.

Target Namespace The target namespace identifies the namespace that components in this schema belongs to. If no target namespace is provided, then the schema components do not belong to any namespace.

Uniqueness Constraint Ensures uniqueness of an element/attribute value, or a combination of values, within a specified scope. See: http://www.w3.org/TR/xmlschema-1/#cIdentity-constraint_Definitions.

top