XML namespace

The educational technology and digital learning wiki
Jump to navigation Jump to search

Introduction

Learning goals
  • Understand why Namespaces are needed
  • Learn how to use namespace declarations
  • Learn how to create combined XHTML/SVG/MathML/etc documents
Prerequisites
Moving on
Level and target population
  • Beginners
Remarks
  • This tutorial provides a short overview about XML namespaces. It includes minimal knowledge needed for an XML class. Most parts also can be used in introductory web technologies class. Technical web authors also must understand namespaces, since they are used in XHTML and combined profiles.

XML namespace have two purposes:

  • Clearly identify a markup language version (DocType declarations are not necessarily mandatory)
  • Allow to mix two or more languages in a single document

XML Namespaces allow to fully/uniquely qualify XML element and attribute names to prevent from confusing two elements that have the same name but mean different things. Various XML vocabularies (languages/applications) may be mixted. E.g. in a standards compliant web browser like Firefox or Opera you may include SVG and MathML code with the same XHTML page. But then we can run into naming conflicts, i.e. different vocabularies (DTDs) can use the same names for elements !

In addition, since DTDs are not mandatory for most W3C languages, the W3C requires namespace definitions within root elements, e.g. XHTML must have one: 

<html xmlns="http://www.w3.org/1999/xhtml">

Basically this statement says that within the html element all child elements are XHTML, unless they are explicitly part of another namespace.

Namespaces are a W3C standard since Jan 1999. That means that namespaces have been introduced after XML has been invented.

Standards involved

The Namespace standard:

Namespaces are identified with URIs

A URI is either a URL or a URN

Compound W3C documents

See also: The standards overview article. Most XML-based standards in education (e.g. IMS Content Packaging make heavy use of namespaces ! In addition most IMS and SCORM standards use XML Schema which are associated to XML contents via namespace declarations.

Namespaces

An example demonstrating the need for namespaces

Here is an XML fragment using title within a bibliography element: 

<book>
 <title>A true story</title>
 <description>A real cool publication</description>
</book>

A 2nd XML fragment uses title in a employees record: 

<record>
 <name>Miller</name> 
 <title>Dr. </title>
 <publications> ... </publications>
</record>

If these two XML fragments were added together, there would be a name conflict because both contain a <title>< element with different meaning. In one case we mean book title and in the other something like "none", PhD, etc.. A stylesheet would have to render these elements very differently. But we can solve this problem by adding prefixes, like this: 

<employees:record>
  <employees:name>Miller</employees:name>
  <employees:title>Dr. </employees:title>
  <employees:publications>
    <biblio:book>
      <biblio:title>A true story</biblio:title>
      <biblio:description>A real cool publication</biblio:description>
    </biblio:book>
  </employees:publications>
</employees:record>

A real world example

The The Open Packaging Format. Below is the content of an *.opf file that must be included within ePub "zip" file (a popular e-book format. It defines the structure of the book using assets and includes metadata.

OPF example copied with minor modifications from Wikipedia (nov 30 2010). 

<?xml version="1.0"?>
<package version="2.0" xmlns="http://www.idpf.org/2007/opf" unique-identifier="BookId">
 
  <metadata xmlns:dc="http://purl.org/dc/elements/1.1/" xmlns:opf="http://www.idpf.org/2007/opf">
    <dc:title>Pride and Prejudice</dc:title>
    <dc:language>en</dc:language>
    <dc:identifier id="BookId" opf:scheme="ISBN">123456789X</dc:identifier>
    <dc:creator opf:file-as="Austen, Jane" opf:role="aut">Jane Austen</dc:creator>
  </metadata>
 
  <manifest>
    <item id="chapter1" href="chapter1.xhtml" media-type="application/xhtml+xml"/>
    <item id="chapter2" href="chaptertwo.xhtml" media-type="application/xhtml+xml"/>
    <item id="stylesheet" href="style.css" media-type="text/css"/>
    <item id="ch1-pic" href="ch1-pic.png" media-type="image/png"/>
    <item id="myfont" href="css/myfont.otf" media-type="application/x-font-opentype"/>
    <item id="ncx" href="book.ncx" media-type="application/x-dtbncx+xml"/>
  </manifest>
 
  <spine toc="ncx">
    <itemref idref="chapter1" />
    <itemref idref="chapter2" />
  </spine>
 
  <guide>
    <reference type="loi" title="List Of Illustrations" href="appendix.html#figures" />
  </guide>
 
</package>

This OPF file includes two namespaces:

Declaring namespaces

Formally speaking, an XML namespace is simply a collection of names (elements and attributes) of a markup vocabulary that can be uniquely identified

Procedure
  1. Create or identify a namespace identifier you wish to use: An XML namespace is identified by a unique URI reference, usually a URL.
  2. The URL does need not point to anything on the Internet. It is just used as a unique string, i.e. a name
  3. Therefore if some namespace URLs below are broken there is absolutly nothing to worry about. However, most namespace identifiers actually point to a real web page that either provides an explanation or at least informations about the organization/author that created the namespace. This means that if you plan to create your own namespaces, you should use the name of any webpage over which you have control.
  4. Make a namespace declaration within the element that belongs to this namespace, i.e. map a prefix of your choice to a unique URI.

There are two major variants of namespaces: prefixednamespaces and default ones.

(1) declaring a namespace that will require use of prefixes 

 <prefix:element xmlns:prefix="URI">

Example: 

 <html:html xmlns:html="http://www.w3.org/1999/xhtml">

(2) declaring a default namespace for element and its children. I.e. these will not be prefixed. 

 <element xmlns="URI"><

Example: 

 <html xmlns="http://www.w3.org/1999/xhtml"> ......

Scoping

"Scoping" means "where does a declaration apply ?

The scope of an XML namespace declaration extends from the beginning of the start-tag in which it appears to the end of the corresponding end-tag, including all children. Most frequently, namespaces are declared in the document root.

XHMTL fragment example
<?xml version="1.0"?>
  <html:html xmlns:html='http://www.w3.org/1999/xhtml'>
  <html:head>
    <html:title>Frobnostication</html:title>
  </html:head>
  <html:body>
    <html:p>
      Moved to<html:a href='http://frob.example.com'>here.</html:a>
    </html:p>
  </html:body>
</html:html>
Example with 2 namespaces (both use URNs instead of URLs)
<?xml version="1.0"?>
<!-- both namespace prefixes are available throughout the XML fragment -->
<bk:book xmlns:bk='urn:loc.gov:books'
         xmlns:isbn='urn:ISBN:0-395-36341-6'>
    <bk:title>Cheaper by the Dozen</bk:title>
    <isbn:number>1568491379</isbn:number>
</bk:book>

Default namespaces

If most elements in an XML document belonged to the same namespace, it would be ugly to prefix each element name. Instead define a default namespace that applies to all non-prefixed elements and attributes. Syntax: 

 <element xmlns="URI"> < ....

The default namespace applies to the element in which it was defined and all descendants of that element. But if a descendants has another default namespace defined on it, this new namespace definition overrides the previous one and becomes the default for that element and its descendants. Note that namespaces does not apply to attribute names ! This is a likely source of trouble for XSLT ...

XHTML default namespace example
<?xml version="1.0"?>
<!-- elements are in the HTML namespace by default -->
<html xmlns='http://www.w3.org/1999/xhtml'>
   <head>
      <title>Frobnostication</title>
   </head>
   <body>
      <p>Moved to <a href='http://frob.example.com'>here</a>.</p>
   </body>
</html>

Default namespace for a book vocabulary plus a namespace for ISBN example: 

  <!-- unprefixed element types are from "books" -->
  <book xmlns='urn:loc.gov:books'
        xmlns:isbn='urn:ISBN:0-395-36341-6'>
  <title>Cheaper by the Dozen</title>
  <isbn:number>1568491379</isbn:number>
  </book>
A larger example of namespace scoping

It includes some XHTML whose namespace is declared within the "p" element. 

<?xml version="1.0"?>
<!-- initially, the default namespace is "books" -->
<book xmlns='urn:loc.gov:books'
      xmlns:isbn='urn:ISBN:0-395-36341-6'>
   <title>Cheaper by the Dozen</title>
   <isbn:number>1568491379</isbn:number>
   <notes>
   <!-- make HTML the default namespace for some commentary -->
      <p xmlns='http://www.w3.org/1999/xhtml'>
         This is a <i>funny</i> book!
     </p>
   </notes>
</book>
XSLT namespace example

XSLT is a transformation language, i.e. programming language that allows to translate an XML content into another content (XML or other). XSLT instructions are prefixed with "xsl" here. Output produced is namespace-less here. See the XSLT tutorial for an introduction. 

<?xml version="1.0"?>
<xsl:stylesheet xmlns:xsl="http://www.w3.org/1999/XSL/Transform">
<xsl:template match="page">
  .....
  <html> <head> <title> <xsl:value-of select="title"/> </title> </head>
  <body bgcolor="#ffffff"> <xsl:apply-templates/> </body>
  </html>
</xsl:template>

<xsl:template match="title">
  <h1 align="center"> <xsl:apply-templates/> </h1>
</xsl:template>

<xsl:template match="content">
  <p align="center"> <xsl:apply-templates/> </p>
</xsl:template>

<xsl:template match="comment">
  <hr /> <xsl:apply-templates/>
  </xsl:template>
</xsl:stylesheet>

Validation of composite documents

Validating documents that contain different namespaces are called composite or compound documents and validation is not always easy since combined DTDs may not exist. A validation standard for composite W3C vocabularies is currently under preparation (but may not happen ...). Usually, combined documents are produced by server-side programs for delivery and they are just well-formed (not attached to DTDs or other schemas)

You also may write DTDs that validate your own compound documents as we demonstrate in the following example.

A DTD rule with an extra namespace example

In this example, the "a" element and the "description" attribute belongs to the default namespace, but the href and type attributes belong to the xlink namespace. We declare the namespace in the root element, but also could have done it just for the "el" element. Note: Xlinks do not work in IE7/8. 

<!ELEMENT link_list (el+)>
<!ATTLIST link_list xmlns:xlink CDATA #FIXED "http://www.w3.org/1999/xlink">
<!ELEMENT el (#PCDATA)>
<!ATTLIST el description CDATA #IMPLIED
          xlink:href CDATA #REQUIRED
          xlink:type CDATA #FIXED "simple" >

See the DTD tutorial for details.

An XML example file
<?xml version="1.0" encoding="ISO-8859-1" ?>
<!DOCTYPE link_list SYSTEM "link_list.dtd">
<?xml-stylesheet href="link_list.css" type="text/css" ?>
 <link_list xmlns:xlink="http://www.w3.org/1999/xlink">
    <el description="verified"
        xlink:type="simple"
        xlink:href="http://www.webster.ch/">Webster Geneva</el>
    <el xlink:href="http://www.webster.edu/"
        xlink:type="simple">Webster</el>
</link_list>

Namespaces for documents

Client-side XML web languages and namespaces overview

The W3C defines several Internet languages and for which namespace declarations are mandatory (even if you use them "standalone", i.e. not in composite documents.

Some W3C languages
Name Namespace URL Explanation
XSLT http://www.w3.org/1999/XSL/Transform XSL - Transformations
XSL-FO http://www.w3.org/1999/XSL/Format XSL - Formatting
XML Schema http://www.w3.org/2001/XMLSchema XML grammar definition language
SVG http://www.w3.org/2000/svg Scalable Vector Graphics
RDF http://www.w3.org/1999/02/22-rdf-syntax-ns Resource Description Format
SMIL 2.0 http://www.w3.org/2001/SMIL20/ Synchronized Multimedia Integration Lang.
VoiceXML 2.0 http://www.w3.org/2001/vxml Synthesized voice
XLink http://www.w3.org/1999/xlink" XML Linking Language
XForms http://www.w3.org/2002/xforms Next generation of HTML forms.
XHTML http://www.w3.org/1999/xhtml XML-based HTML variant
MathML http://www.w3.org/1998/Math/MathML Mathematical markup language


Some of these languages (e.g. SMIL, MathML, SVG, X3D) need special clients for display. Others are transducers or helpers, i.e. are used to define, style, transform and process XML contents

RDF namespace

RDF-based languages are very prolific and add to the complexity of semantic web initiatives

See 100 most common RDF namespaces

Other Document standards

Each of the following usually packages a document as zip file. Inside the zip, you will find several files using several XML languages.

Compound documents

Combining various content delivery formats is the future (also on cell phones). For example, XHTML-formatted content can be augmented by SVG objects or mathematical formula.

Examples of possible Compound Document profiles
  • XHTML + SVG + MathML
  • XHTML + SMIL
  • XHTML + XForms
  • XHTML + VoiceML

The W3C is working on a generic Compound Document by Reference Framework (CDRF) that defines a language-independent processing model for combining arbitrary document formats ...

Web browser caveats
  • IE doesn't support natively most XML W3C "content" languages (e.g. SVG, MathML), but implements a version of SMIL, called "Timed Text". Firefox supports static SVG and MathML. Both implement RSS

Workarounds:

  • Use a browser that is more advanced (e.g. Firefox, Opera, Chrome) or specialized players (e.g. Realplayer for SMIL)
  • For HTML + SVG + MathML, use HTML5
  • Call your files *.xml (often helps if you use IE)
  • For some formats you may install plugins or extensions in your web browser and then use a more indirect method to assemble contents, i.e. <object> or <iframe>. This will work with most browsers if you have the right plugin (SVG in this case) installed.
<iframe src="hello-svg.svg" height="300" width="80%" frameborder="0">
... Sorry you need an SVG plugin ...
</iframe><

XHTML + other vocabularies

XHTML / MathML example
<?xml version="1.0" encoding="iso-8859-1"?>
<xhtml:html xmlns:xhtml="http://www.w3.org/1999/xhtml">
  <xhtml:body>
    <xhtml:h1>A Compound Document</xhtml:h1>
    <xhtml:p>A simple formula using MathML in XHTML.</xhtml:p>
    <mathml:math xmlns:mathml="http://www.w3.org/1998/Math/MathML">
      <mathml:mrow>
         <mathml:msqrt> <mathml:mn>49</mathml:mn> </mathml:msqrt>
         <mathml:mo>=</mathml:mo>
         <mathml:mn>7</mathml:mn>
       </mathml:mrow>
     </mathml:math>
  </xhtml:body>
</xhtml:html>

MathML doesn't natively work with IE 6/7/8. But there are workarounds. See the MathML article for some more information about MathML and dealing with IE.

Xlink example

XLink was supposed to replace all linking constructs in the W3C languages. It is adopted by SVG, X3D, but not by XHTML 2 which introduces its own linking constructs. XML-capable browsers are also supposed to implement this (Firefox, but not IE)

Example - Story grammar that implements XLink for an A element
<?xml version="1.0" encoding="ISO-8859-1" ?>
<STORY xmlns:xlink="http://www.w3.org/1999/xlink">
  <Title>The Webmaster</Title>
  .....
  <INFOS> <Date>30 octobre 2003 - </Date>
  <Author>DKS - </Author>
  <A xlink:href=http://jigsaw.w3.org/css-validator/check/referer
     xlink:type="simple">CSS Validator</A>
   </INFOS>
</STORY>
SVG example
  • Most browsers (i.e. all major browser except IE8) can handle SVG. However, some only implement SVG 1.0 and most only static SVG. As of, only Opera implemented the so-called SMILE tags.
  • Alternatively, use HTML and read the using SVG with HTML5 tutorial

XHTML with embedded SVG tags (tested with Firefox) 

<?xml version="1.0" encoding="ISO-8859-1" ?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
      "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd" >

<html xmlns="http://www.w3.org/1999/xhtml"  
      xmlns:svg="http://www.w3.org/2000/svg">
 <head>
  <title>SVG within XHTML Demo</title>
 </head>
 <body>
    <h1>SVG within XHTML Demo</h1>
  <p> You can embed SVG into XHTML, provided that your browser natively implements SVG. E.g. Firefox 1.5+ supports most of static SVG.
  </p>

  The SVG part starts below <hr />

  <svg xmlns="http://www.w3.org/2000/svg" version="1.1" width="400" height="300">
   <!-- a small rectangle -->
   <rect x="50" y="50" rx="5" ry="5" width="300" height="100" style="fill:#CCCCFF;stroke:#000099"/>
   
   <!-- a text in the same place -->
   <text x="55" y="90" style="stroke:#000099;fill:#000099;font-size:24;">
    HELLO dear reader
   </text>

  </svg>
  <hr />
  The SVG part ended above
</body>
</html>

SVG with a plugin (Note: This only works with old browsers (e.g. IE 6 and FF 1) since Adobe discontinued support for their SVG plus since the bought Macromedia and its opaque vendor-friendly Flash format)

Works with older IEs or Firefox (and a SVG plugin installed) 

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
  <head> <title>HELLO SVG with an iframe</title> </head>
  <body>
     <h1>HELLO SVG with an iframe</h1>
        Here is an embeded SVG scene using iframe. Alternatively you could use an
        "embed" tag (a slightly more complicated solution).
     <iframe src="hello-svg.svg" height="200" width="80%" frameborder="0">
     Sorry you need an SVG plugin ...
     </iframe>
     <hr>
 </body> 
</html>

In the following example, the SVG file is a standard stand-alone SVG file 

<?xml version="1.0" standalone="no"?>
<!DOCTYPE svg PUBLIC "-//W3C//DTD SVG 1.0//EN"
          "http://www.w3.org/TR/2001/PR-SVG-20010719/DTD/svg10.dtd">
<svg xmlns="http://www.w3.org/2000/svg">
   <rect x="50" y="50" rx="5" ry="5" width="300" height="100"
         style="fill:#CCCCFF;stroke:#000099"/>
   <text x="55" y="90" style="stroke:#000099;fill:#000099;font-size:24;">
   HELLO dear reader
   </text>
</svg>

Combining XHTML with your XML

It sometimes can be practical to combine your own XML contents with XHTML, because HTML offers easy-to-use functionality like image inclusions or links. Note however that in practice this feature is not often used since:

  • XSLT stylesheets allow transformations of XML data into XHTML. The stylesheet will contain the extra HTML and the result displayed usually will be all HTML and will be easier to manage with CSS.
  • The way browsers implement this is not really stable
XHTML with some XML included, using CSS for styling
  • Tested with Firefox 2.x (works) and IE 7 (CSS doesn't work, I don't know why ...)

Procedure:

  1. Define a namespace for the included XML content
  2. Attach a CSS stylesheet with an XML processor instruction. Else, users will not see the contents of your XML.
  3. Your file must be understood as "XML", e.g. call it something.xhtml or something.xht or something.xml. If you use IE7/8 it must be something.xml, since IE doesn't support XHTML). Do not call your file something.html or something.htm !!

XHTML with some cooking XML included (file cooking.xhtml): 

<?xml version="1.0" ?>
<?xml-stylesheet type="text/css" href="cooking.css"?>

<html xmlns="http://www.w3.org/1999/xhtml"
      xmlns:re="http://webster.unige.ch/coap21/dolores">
  <head>
    <title>A Compound XHTML-XML Document</title>
    <!-- this should work with IE but doesn't, maybe IE6 ? -->
    <link href="dolores.css" type="text/css" rel="stylesheet"/>
  </head>

  <body>

    <h1>A Compound XHTML-XML Document</h1>
    <p>Contains a cooking recipee written down by R. Dolores for a COAP 2180 CSS exercise. Everything below the line is XML styled with a CSS stylesheet</p>
    <hr/>

  <re:recipe>
     <re:recipe_head>
	<re:recipe_name>Cold Salmon in Creamy Spiced Sauce</re:recipe_name>
 	<re:recipe_author>Hilaire Walden</re:recipe_author>

	<re:meal_type>Fish and Shellfish</re:meal_type>
     </re:recipe_head>
  	
     <re:recipe_body>
	  	<re:ingredients>
	  	  <re:ingredient>1/2 teaspoon finely crushed cumin seeds</re:ingredient>
	  	  <re:ingredient>1 teaspoon chilli powder</re:ingredient>
	  	  <re:ingredient>salt and freshly ground black pepper</re:ingredient>

	  	  <re:ingredient>2 tablespoons olive oil</re:ingredient>
	  	  <re:ingredient>2 cloves garlic, crushed</re:ingredient>
	  	  <re:ingredient>1.25 cm (1/2 in) fresh ginger root, finely chopped</re:ingredient>
	  	  <re:ingredient>4 pieces salmon fillet, skinned</re:ingredient>
	  	  <re:ingredient>125 ml (4 fl oz / 1/2 cup) double (heavy) cream</re:ingredient>
	  	  <re:ingredient>250 ml (8 fl oz / 1 cup) thick plain yogurt</re:ingredient>

	  	  <re:ingredient>large pinch of saffron threads, toasted and crushed</re:ingredient>
  		  <re:ingredient>seeds from 6 cardamom pods, toasted and finely crushed</re:ingredient>
	  	  <re:ingredient>salt</re:ingredient>
  		  <re:ingredient>coriander (cilantro) to garnish</re:ingredient>
	  	</re:ingredients>
  	<re:directions>
	  <re:direction>Mix together the cumin seeds, chilli powder and pepper and rub into the fish.</re:direction>

	<re:direction>Heat the oil in a frying pan, add the garlic and ginger and heat until they sizzle.</re:direction>
	<re:direction>Add the salmon fillets and fry until they start to colour (about 15-20 seconds on each side).</re:direction>
	<re:direction>Stir in the cream, yogurt, saffron, cardamom and salt.</re:direction>
	<re:direction>Adjust the heat so that the sauce is just bubbling and cook, turning the fish once, until the flesh just flakes when tested with the point of a sharp knife (about 3-4 minutes each side).</re:direction>
	<re:direction>Transfer the fish to a shallow dish. Boil the sauce until it has reduced and thickened, pour over the fish and leave to cool.</re:direction>
        <re:direction>Cover the dish and chill until 15-20 minutes before serving.</re:direction>

	<re:direction>Garnish with coriander (cilantro).</re:direction>
	</re:directions>
     </re:recipe_body>

     <re:recipe_footer>
     <re:serving>4</re:serving>
     <re:preparation_time>15 minutes</re:preparation_time>
     </re:recipe_footer>

     <re:document_info>
  		<re:document_author>Hilaire Walden</re:document_author>
  		<re:date_updated>21/01/07</re:date_updated>
  		<re:source>Easy to Cook, Hot &amp; Spicy</re:source>
  	</re:document_info>
  </re:recipe>

  </body>
</html>

Combining your XML with XHTML

Works with Firefox 1x/2x and IE7 (probably also with IE6).

  • An HTML namespace is declared in the root element and we use it twice (for the img and a tags).
  • Btw this is a trick to get around non-implementation of the xlink standard in IE.
XML plus XHTML
<?xml version="1.0" ?>
<?xml-stylesheet href="xml_plus_xhtml.css" type="text/css"?>
<page xmlns:html="http://www.w3.org/1999/xhtml" updated="jan 2007">
 <title>Hello friend</title>
 <list>
   <!-- we use an HTML tag below to include a picture -->
   <html:img src="photo.jpg"/>
   <item price="10"> White plate </item> 
   <item price="20"> Gold plate </item> 
   <item price="15"> Silver plate </item> 
 </list>

 <comment> Written by <html:a href="http://tecfa.unige.ch/tecfa-people/schneider.html">DKS/Tecfa</html:a> , feb 2007 </comment>
</page>

XSLT transformations of compound documents

Principles:

  • Declare the same namespaces on top of the XSLT stylesheet
  • Declare even the default namespace (e.g. XHTML)
  • Each XPath expression must use a prefix !
  • Strip the output from prefixes if you produce XHTML



Further reading:

Retrieved from "https://edutechwiki.unige.ch/mediawiki/index.php?title=XML_namespace&oldid=43112"