The XML Schema for the xld namespace
Overview
The xld Schema describes an XML based language for structured documents which may be "literate scripts" including various formal texts.
First, the attributes to the schema element.
The xldoc element is the top level element in an xl document.
The stripft element identifies formal text to be stripped out for processing.
The content of a document is provided as a series of sections.
The body of a section is provided as a series of secbodies, each of which may be divided into columns. This allows for variation in the number of columns within different parts of a single section.
Each column consists of a series of subsections, which have a title (which may be hyperlinked) and some text.
Element's for including "formal" text in a document.
Introduction
First, the attributes to the schema element.
The schema Element
The "..FormDefault" attributes indicate that occurences of the attribute and element names of the target XML dialect will not be qualified in this specification by their namespace.
xl-xsd
<xsd:schema
xmlns:xsd="http://www.w3.org/1999/XMLSchema"
target_namespace="http://www.x-logic.org/xmlns/draft/xld"
elementFormDefault="unqualified"
attributeFormDefault="unqualified">

The xldoc Element
The xldoc element is the top level element in an xl document.
attributes
id
Document source identification. Displayed at the foot of the page.
name
this is the base of the filename of the output files, usually the same as the source filename
title
the title of the document
description
a description for inclusion in the metadata
keywords
keywords for the document metadata
class
this is used in selecting the style file for the document
root
relative path to the root or home of the site, used for linking to local images
up
a relative path the to file on the "up" arrow
author
this attribute should contain a string which uniquely (within site) identifies the author or copyright holder of this document. A site specific template named "author" should be used to output a copyright or signature text which is place at the foot of each page and index frame. This template will usually select the text conditionally on the value of this field, and/or may incorporate the value of the field.
elements
title
if plain text does not suffice for the title used as a header in the document (e.g. if an image is to be included) then this title element should be used as well as the title attribute (which is still required for the title element).
ititle
this may be used to abbreviate the title for use at the head of the index frame
stripft
a stripft element provides information controlling stripping of formal text for processing. Any number may be supplied, each creating a different extract file.
description
a description for inclusion in the metadata

xl-xsd
<xsd:element name="xldoc">
<xsd:complexType>

<xsd:attribute name="id" type="xsd:string" use="optional"/>
<xsd:attribute name="name" type="xsd:string"/>
<xsd:attribute name="title" type="xsd:string"/>
<xsd:attribute name="description" type="xsd:string"/>
<xsd:attribute name="keywords" type="xsd:string"/>
<xsd:attribute name="class" type="xsd:string"/>
<xsd:attribute name="root" type="xsd:string"/>
<xsd:attribute name="up" type="xsd:string" use="optional"/>
<xsd:attribute name="author" type="xsd:string" use="optional"/>

<xsd:element name="title" type="xsd:string" minOccurs="0"/>
<xsd:element name="ititle" type="xsd:string" minOccurs="0"/>
<xsd:element ref="stripft" minOccurs="0" maxOccurs="unbounded"/>
<xsd:element ref="section" maxOccurs="unbounded"/>

</xsd:complexType>
</xsd:element>

The stripft Element
The stripft element identifies formal text to be stripped out for processing.
The purpose of the stripft element is to provide the information needed to generate one formal text file from the source of the document.
attributes
lang
The mandatory lang attribute identifies the language of the formal text to be stripped. All xld:ft elements which specify this language will have their textual content stripped into a file. If no further attributes are supplied the filename is constructed from the name attribute of the xld:xldoc element followed by "." and a language code which is the value of the lang attribute with a leading "xl-" removed if present.
suffix
If present, this optional attribute will used instead of the lang attribute in forming the filename suffix (without removal of "xl-").
filename
If a filename attribute is present, it is used without modification, and supercedes the other ways of computing a filename.
If there are multiple xld:ft elements with the same language code they are all output in document order, unless they have a key attribute, in which case they are sorted on the key attribute (as a string).

xl-xsd
<xsd:element name="stripft">
<xsd:complexType>
<xsd:attribute name="lang" type="xsd:string" use="mandatory"/>
<xsd:attribute name="suffix" type="xsd:string" use="optional"/>
<xsd:attribute name="filename" type="xsd:string" use="optional"/>
</xsd:complexType>
</xsd:element>

The section Element
The content of a document is provided as a series of sections.
attributes
title
the title of this section
ititle
an optional abbreviated title for use in the page index, if omitted the "title" is used
tag
an optional tag for an anchor on this section. If omitted the "ititle" will be used as a tag.
doc
an optional attribute providing the name of a document for which this section is to be an overview. The overview will in this case be extracted from the target document automatically. In this case the section element is likely to have no child elements, since these will be obtained from elsewhere.
dir
if the doc attribute is present but the document referred to is not in the same directory as this document then a dir attribute must be provided whose value is a relative path to the directory containing the document
elements
abstract
This optional element, if present, should contain a brief abstract for the section, which is presented alongside the section title and in overviews of the document. If a "doc" attribute is present and the abstract element is absent, the abstract from the overview of the target document is used.
title
This optional element may be used instead of the title attribute to give a title which is not suitable for the value of an attribute, usually because it is or includes an image.
secbody
The body of the section consists of a series of any number of secbody elements. The use of multiple secbodies allows more flexibility in the layout of the section, for example, permitting the number of columns to be varied within a single section.
section

xl-xsd
<xsd:element name="section">
<xsd:complexType>

<xsd:attribute name="title" type="xsd:string" use="mandatory"/>
<xsd:attribute name="ititle" type="xsd:string" use="optional"/>
<xsd:attribute name="tag" type="xsd:string" use="optional"/>
<xsd:attribute name="doc" type="xsd:string" use="optional"/>
<xsd:attribute name="dir" type="xsd:string" use="optional"/>

<xsd:element name="abstract" type="xsd:string" minOccurs="0"/>
<xsd:element name="title" type="xsd:string" minOccurs="0"/>
<xsd:element ref="secbody" minOccurs="0" maxOccurs="unbounded"/>

</xsd:complexType>
</xsd:element>

The secbody Element
The body of a section is provided as a series of secbodies, each of which may be divided into columns. This allows for variation in the number of columns within different parts of a single section.
attributes
title
A secbody may be given a title (but usually isn't).
elements
sbcol
This element, which must appear at least once, is one column of this part of a section.
secbody

xl-xsd
<xsd:element name="secbody">
<xsd:complexType>
<xsd:attribute name="title" type="xsd:string" use="optional"/>
<xsd:element ref="sbcol" minOccurs="1" maxOccurs="unbounded"/>
</xsd:complexType>
</xsd:element>

The sbcol Element
This element is one column of a secbody, and contains a sequence of subsections.
attributes
title
this optional attribute provides a heading for a column
elements
subsec
each column consists of a sequence of subsection elements
sbcol

xl-xsd
<xsd:element name="sbcol">
<xsd:complexType>
<xsd:attribute name="title" type="xsd:string" use="optional"/>
<xsd:element ref="subsec" minOccurs="0" maxOccurs="unbounded"/>
</xsd:complexType>
</xsd:element>

The subsec Element
Each column consists of a series of subsections, which have a title (which may be hyperlinked) and some text.
attributes
title
This optional attribute provide a title for the subsection
href
If an href is present then the title of the subsection is hyperlinked to this address.
elements
The content of the subsection consists of text with optional xhtml markup. Some of the xhtml tags are duplicated in the xld namespace.
subsec

xl-xsd
<xsd:element name="subsec">
<xsd:complexType>
<xsd:attribute name="title" type="xsd:string" use="optional"/>
<xsd:any namespace="##other" maxOccurs="unbounded"/>
</xsd:complexType>
</xsd:element>


xl-xsd
</xsd:schema>

Formal Text
Element's for including "formal" text in a document.
attributes
elements
The ft Element

xl-xsd

attributes
elements

xl-xsd


up quick index © RBJ

$Id: XldSchema.xml,v 1.1.1.1 2000/12/04 17:22:32 rbjones Exp $