Transcript RELAX NG

RELAX NG
26-Jul-16
What is RELAX NG?

RELAX NG is a schema language for XML




OASIS is the Organization for the Advancement of
Structured Information Standards



It is an alternative to DTDs and XML Schemas
It is based on earlier schema languages, RELAX and TREX
It is not a W3C standard, but is an OASIS standard
ebXML (Enterprise Business XML) is a joint effort of OASIS and
UN/CEFACT (United Nations Centre for Trade Facilitation and
Electronic Business)
OASIS developed the highly popular DocBook DTD for
describing books, articles, and technical documents
RELAX NG has recently been adopted as an ISO/IEC
standard
2
Design goals


Simple and easy to learn
Uses XML syntax


Does not change the information set of an XML document







But there is also a “concise” (non-XML) syntax
(I’m not sure what this means)
Supports XML namespaces
Treats attributes uniformly with elements so far as possible
Has unrestricted support for unordered content
Has unrestricted support for mixed content
Has a solid theoretical basis
Can make use of a separate datatyping language (such W3C
XML Schema Datatypes)
3
RELAX NG tools


Assorted validators and translators are now available for
RELAX NG
See http://relaxng.org
4
Basic structure

A RELAX NG specification is written in XML, so it
obeys all XML rules





The RELAX NG specification has one root element
The document it describes also has one root element
The root element of the specification is element
If the root element of your document is book, then the
RELAX NG specifications begins:
<element name="book"
xmlns="http://relaxng.org/ns/structure/1.0">
and ends:
</element>
5
Data elements

RELAX NG makes a clear separation between:



For starters, we will use the two (XML-defined) elements:



the structure of a document (which it describes)
the datatypes used in the document (which it gets from somewhere else,
such as from XML Schemas)
<text> ... </text> (usually written <text/>)
 Plain character data, not containing other elements
<empty></empty> (usually written <empty/>)
 Does not contain anything
Other datatypes, such as <double>...</double>
are not defined in RELAX NG

To inherit datatypes from XML Schemas, use:
datatypeLibrary="http://www.w3.org/2001/XMLSchema-datatypes"
as an attribute of the root element
6
Data types from XML Schemas

Here are some of the predefined numeric types:
xs:decimal
xs:byte
xs:short
xs:int
xs:long
xs:positiveInteger
xs:negativeInteger
xs:nonPositiveInteger
xs:nonNegativeInteger
7
Predefined date and time types



xs:date -- A date in the format CCYY-MM-DD, for
example, 2002-11-05
xs:time -- A date in the format hh:mm:ss (hours,
minutes, seconds)
xs:dateTime -- Format is CCYY-MM-DDThh:mm:ss


The T is part of the syntax
Allowable restrictions on dates and times:

enumeration, minInclusive, minExclusive, maxInclusive,
maxExclusive, pattern, whiteSpace
8
Defining tags




To define a tag (and specify its content), use
<element name="myElement">
<!-- Content goes here -->
</element>
Example: The DTD
<!ELEMENT name (firstName, lastName)>
<!ELEMENT firstName (#PCDATA)>
<!ELEMENT lastName (#PCDATA)>
Translates to:
<element name="name">
<element name="firstName"> <text/> </element>
<element name="lastName"> <text/> </element>
</element>
Note: As in the DTD, the components must occur in order
9
RELAX NG describes patterns


Your RELAX NG document specifies a pattern that
matches your valid XML documents
For example, the pattern:
<element name="name">
<element name="firstName"> <text/> </element>
<element name="lastName"> <text/> </element>
</element>

Will match the XML:
<name>
<firstName>David</firstName>
<lastName>Matuszek</lastName>
</name>
10
Easy tags
<zeroOrMore> ... </zeroOrMore>
The enclosed content occurs zero or more times
<oneOrMore> ... </oneOrMore>
The enclosed content occurs one or more times
<optional> ... </optional>
The enclosed content occurs once or not at all
<choice> ... </choice>
Any one of the enclosed elements may occur
<!-- This is an XML comment; it is not a container,
and it may not contain two consecutive hyphens -->
11
Example
<element name="addressList">
<zeroOrMore>
<element name="name">
<element name="firstName"> <text/> </element>
<element name="lastName"> <text/> </element>
</element>
<element name="address">
<choice>
<element name="email> <text/> </element>
<element name="USPost"> <text/> </element>
</choice>
</element>
</zeroOrMore>
</element>
12
Enumerations

The <value>...</value> pattern matches a specified
value


Example:
<element name="gender">
<choice>
<value>male</value>
<value>female</value>
</choice>
</element>
The contents of <value> are subject to whitespace
normalization:


Leading and trailing whitespace is removed
Internal sequences of whitespace characters are collapsed to a
single blank
13
More about data

To inherit datatypes from XML Schemas, add this attribute
to the root element:
datatypeLibrary =
"http://www.w3.org/2001/XMLSchema-datatypes"

You can access the inherited types with the <data> tag, for
instance, <data type="double>



The <data> pattern must match the entire content of the enclosing
tag, not just part of it
<element name="illegalUse"> <!-- Don't do this! -->
<data type="double"/>
<element name="moreStuff"> <text/> </element>
</element>
If you don't specify a datatype library, RELAX NG defines
the following for you (along with <text/> and <empty/>):


<string/> : No whitespace normalization is done
<token/> : A sequence of characters containing no whitespace
14
<group>


<group>...</group> is used as “fat parentheses”
Example:
<choice>
<element name="name"> <text/> <element>
choice #1
<group>
<element name="firstName">
<text/>
</element>
choice #2
<element name="lastName">
<text/>
</element>
</group>
</choice>

15
Attributes

Attributes are defined practically the same way as elements:


Example:


<attribute name="attributeName">...</attribute>
<element name="name">
<attribute name="title"> <text/> </attribute>
<element name="firstName"> <text/> </element>
<element name="lastName"> <text/> </element>
</element>
Matches:

<name title="Dr.">
<firstName>David</firstName>
<lastName>Matuszek</lastName>
</name>
16
More about attributes



With attributes, as with elements, you can use
<optional>, <choice>, and <group>
It doesn’t make sense to use <oneOrMore> or
<zeroOrMore> with attributes
In keeping with the usual XML rules,


The order in which you list elements is significant
The order in which you list attributes is not significant
17
Still more about attributes


<attribute name="attributeName"> <text/> </attribute>
can be (and usually is) abbreviated as
<attribute name="attributeName"/>
However,
<element name="elementName"> <text/> </element>
can not be abbreviated as
<element name="elementName"/>
 If an element has no attributes and no content, you must
use <empty/> explicitly
18
<list>

<list> pattern </list> matches a whitespaceseparated list of tokens, and applies the pattern to
those tokens

Example:
<!-- A floating-point number and some integers -->
<element name="vector">
<list>
<data type="float"/>
<oneOrMore>
<data type="int"/>
</oneOrMore>
</list>
</element>
19
<interleave>


<interleave> ... </interleave> allows the contained
elements to occur in any order
<interleave> is more sophisticated than you might
expect

If a contained element can occur more than once, the various
instances do not need to occur together
20
Interleave example
<element name="contactInformation">
<interleave>
<zeroOrMore>
<element name="phone"> <text/> </element>
</zeroOrMore>
<oneOrMore>
<element name="email"> <text/> </element>
</oneOrMore>
</interleave>
</element>
<contactInformation>
<email>[email protected]</email>
<phone>215-898-8122</phone>
<email>[email protected]</email>
</contactInformation>
21
<mixed>


<mixed> allows mixed content, that is, both text and
patterns
If pattern is a RELAX NG pattern, then
<mixed> pattern </mixed>
is shorthand for
<interleave> <text/> pattern </interleave>
22
Example of <mixed>
•
Pattern:
Without this we get one
bold or one italic
<element name="words">
<mixed>
<zeroOrMore>
<choice>
<element name="bold"> <text/> </element>
<element name="italic"> <text/> </element>
</choice>
</zeroOrMore>
</mixed>
</element>

Matches:
<words>This is <italic>not</italic> a <bold>great</bold>
example, <italic>but</italic> it should suffice.</words>
23
The need for named patterns

So far, we have defined elements exactly at the
point that they can be used

There is no equivalent of:


With the RELAX NG we have discussed so far, each
time we want to include a person, we would need to
explicitly define both person and name at that point:


<!ELEMENT person (name)>
<!ELEMENT name (firstName, lastName)>
...use person several places in the DTD...
<element name="person">
<element name="firstName"> <text/> </element>
<element name="lastName"> <text/> </element>
</element>
The <grammar> element solves this problem
24
Syntax of <grammar>
<grammar xmlns="http://relaxng.org/ns/structure/1.0">
<start>
...usual RELAX NG elements, which may include:
<ref name="DefinedName"/>
</start>
<!-- One or more of the following: -->
<define name="DefinedName">
...usual RELAX NG elements, attributes, groups, etc.
</define>
</grammar>
25
Use of <grammar>

To write a <grammar>,

Make <grammar> the root element of your specification





Hence it should say xmlns="http://relaxng.org/ns/structure/1.0"
Use, as the <start> element, a pattern that matches the entire
(valid) XML document
In each <define> element, write a pattern that you want to use
other places in the specification
Wherever you want to use a defined element, put
<ref name="NameOfDefinedElement">
Note that defined elements may be used in definitions, not just in
the <start> element
 Definitions may even be recursive, but
 Recursive references must be in an element, not an attribute
26
Long example of <grammar>


<!ELEMENT name (firstName, lastName)>
<grammar xmlns="http://relaxng.org/ns/structure/1.0">
<start>
<ref name="Name"/>
</start>
<define name="Name">
<element name="name">
<element name="firstName"> <text/> </element>
<element name="lastName">
<ref name="LastName">
XML is case sensitive-</element>
</element>
Note that defined terms are
</define>
capitalized differently
<define name="LastName">
<element name="lastName"> <text/> </element>
</define>
</grammar>
27
Common usage I


A typical way to use RELAX NG is to use a <grammar> with just the root
element in <start> and every element described by a <define>
<grammar xmlns="http://relaxng.org/ns/structure/1.0">
<start>
<ref name="NOVEL">
</start>
<define name="NOVEL">
<element name="novel">
<ref name="TITLE"/>
<ref name="AUTHOR"/>
<oneOrMore>
<ref name="CHAPTER"/>
</oneOrMore>
</element>
</define>
...more...
28
Common usage II
<define name="TITLE">
<element name="title">
<text/>
</element>
</define>
<define name="AUTHOR">
<element name="author">
<text/>
</element>
</define>
<define name="CHAPTER">
<element name="chapter">
<oneOrMore>
<ref name="PARAGRAPH"/>
</oneOrMore>
</element>
</define>
<define name="PARAGRAPH">
<element name="paragraph">
<text/>
</element>
</define>
</grammar>
29
Replacing DTDs

With <grammar> and multiple <define>s, we can do essentially
the same things as a DTD

Advantages:




RELAX NG is more expressive than a DTD; we can interleave elements,
specify data types, allow specific data values, use namespaces, and control the
mixing of data and patterns
RELAX NG is written in XML
RELAX NG is relatively easy to understand
Disadvantages


RELAX NG is extremely verbose
 But there is a “compact syntax” that is much shorter
RELAX NG is not (yet) nearly as well known
 Hence there are fewer tools to work with it
 This situation seems to be changing
30
The End
So by this maxim be impressed,
USE THE TOOLS THAT WORK THE BEST.
Do not yield your sovereign judgment,
To any sort of political fudgement.
The criterion of sound design
Should be, must be, your guideline.
And if you're designing documents,
Try RNG. We charge no rents.
-- John Cowan
31