<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>

<!--
    FILE INFORMATION

    OMA Permanent Document
       File: OMA-INF-HTM_SupportFile_DTD-20100414-I
       Type: Text

    Private Reachable Information
       Path: http://www.openmobilealliance.org/ftp/REL/P-n-G
       Name: SupportFile_DTD.html

    NORMATIVE INFORMATION

    This File provides guidance on DTD SUP files.  There is no 
    associated normative material.
	
    LEGAL DISCLAIMER

    Use of this document is subject to all of the terms and conditions
    of the Use Agreement located at
	http://www.openmobilealliance.org/UseAgreement.html

    You may use this document or any part of the document for internal
    or educational purposes only, provided you do not modify, edit or
    take out of context the information in this document in any manner.
    Information contained in this document may be used, at your sole
    risk, for any purposes.

    You may not use this document in any other manner without the prior
    written permission of the Open Mobile Alliance.  The Open Mobile
    Alliance authorizes you to copy this document, provided that you
    retain all copyright and other proprietary notices contained in the
    original materials on any copies of the materials and that you
    comply strictly with these terms.  This copyright permission does
    not constitute an endorsement of the products or services.  The
    Open Mobile Alliance assumes no responsibility for errors or
    omissions in this document.

    Each Open Mobile Alliance member has agreed to use reasonable
    endeavors to inform the Open Mobile Alliance in a timely manner of
    Essential IPR as it becomes aware that the Essential IPR is related
    to the prepared or published specification.  However, the members
    do not have an obligation to conduct IPR searches.  The declared
    Essential IPR is publicly available to members and non-members of
    the Open Mobile Alliance and may be found on the "OMA IPR
    Declarations" list at http://www.openmobilealliance.org/ipr.html.
    The Open Mobile Alliance has not conducted an independent IPR review
    of this document and the information contained herein, and makes no
    representations or warranties regarding third party IPR, including
    without limitation patents, copyrights or trade secret rights.  This
    document may contain inventions for which you must obtain licenses
    from third parties before making, using or selling the inventions.
    Defined terms above are set forth in the schedule to the Open Mobile
    Alliance Application Form.

    NO REPRESENTATIONS OR WARRANTIES (WHETHER EXPRESS OR IMPLIED) ARE
    MADE BY THE OPEN MOBILE ALLIANCE OR ANY OPEN MOBILE ALLIANCE MEMBER
    OR ITS AFFILIATES REGARDING ANY OF THE IPR'S REPRESENTED ON THE "OMA
    IPR DECLARATIONS" LIST, INCLUDING, BUT NOT LIMITED TO THE ACCURACY,
    COMPLETENESS, VALIDITY OR RELEVANCE OF THE INFORMATION OR WHETHER OR
    NOT SUCH RIGHTS ARE ESSENTIAL OR NON-ESSENTIAL.

    THE OPEN MOBILE ALLIANCE IS NOT LIABLE FOR AND HEREBY DISCLAIMS ANY
    DIRECT, INDIRECT, PUNITIVE, SPECIAL, INCIDENTAL, CONSEQUENTIAL, OR
    EXEMPLARY DAMAGES ARISING OUT OF OR IN CONNECTION WITH THE USE OF
    DOCUMENTS AND THE INFORMATION CONTAINED IN THE DOCUMENTS.

    Copyright 2010 Open Mobile Alliance Ltd.  All Rights Reserved.
    Used with the permission of the Open Mobile Alliance Ltd. under the
    terms set forth above.
-->

<head>
  	<title>Guidelines for Support Files - Document Type Definition (DTD)</title>
	<meta name="description" content="Guidance - Support Files">
	<meta http-equiv="Content-Type" content="text/html; charset=windows-1252">
	<link rel="stylesheet" href="../../GI_template/accessible_StaticPages.css" type="text/css">
	<link rel="stylesheet" href="ProcStyle.css" type="text/css">
</head>

<body>

<!--  Document Header  -->

<table border=0 width=100% cellspacing=0 cellpadding=0>
<tr>
<td align=left><img src="imgOMAlogo.gif"></td>
<td align=right>
<p class=dochead>Guidelines for Support Files - Document Type Definition (DTD)</p>
<p class=docfile>OMA-INF-HTM_SupportFiles_DTD-20090917-D</p>
</td>
</tr></table>

<!--  Navigation Bar  -->

<table width=100% cellspacing=0 cellpadding=0>
<tr><td colspan=2><img height=5 width=100% src="imgBitWht.gif"></tr>
<tr><td colspan=2><img height=5 width=100% src="imgBitSep.gif"></tr>
<tr>
<td class=navbar>
<a href="Procs-n-Guides.htm">Procs-n-Guides</a>&nbsp;>>
<a href="SupportFiles.htm">SupportFiles</a>&nbsp;>>
<b>DTD</b>
</td>
<td class=navbar align=right>Updated: 04 Apr 2010</td>
</tr>
<tr><td colspan=2><img height=5 width=100% src="imgBitSep.gif"></tr>
<tr><td colspan=2><img height=5 width=100% src="imgBitWht.gif"></tr>
</table>

<!--  Start of Document  -->

<h1>Document Type Definition (DTD)</h1>

<h3>Contents</h3>
<ul>
<li><a href="#desc">Description of DTD docs</a></li>
<li><a href="#naming">Naming of DTD docs</a></li>
<li><a href="#handling">Handling of DTD docs</a></li>
<li><a href="#package">DTD docs in Enabler Releases</a></li>
<li><a href="#public">Getting DTD docs into Public Directory</a></li>
<li><a href="#header">Embedded Header in OMA DTD Files</a></li>
</ul>

<hr class=1>
<a name="desc"><h2>Description of DTD docs</h2></a>
Document Type Definition (DTD) files provide a mechanism to declare a grammar for XML files.  The DTD files are normally reachable and permit validation of an XML document to the defined grammar.
<p>
For OMA, DTD files are normally loaded and available in a proscribed location.  That location is:
<pre>
<a href="http://www.openmobilealliance.org/tech/dtd/">http://www.openmobilealliance.org/tech/dtd/</a>
</pre>

<hr class=1>
<a name="naming"><h2>Naming of DTD docs</h2></a>
The public reachable DTD file names are generally shorter and simpler than the names of the OMA permanent documents.  There is generally no need to have superfluous text in the public file names and it is quite expected to avoid constructs like date strings and status values as well.  As a consequence, the following file name construction scheme is used for the 'SUP' files in the permanent document area and public file names.
<pre>
Perm Doc - <b>OMA-SUP-DTD_</b><i>{publicNamePart}</i><b>-V</b><i>{versionNumbers}</i><b>-{DateStr}-{State}.txt</b>
Public   - <i>{publicNamePart}</i><b>-v</b><i>{versionNumbers}</i><b>.dtd</b>
</pre>
Examples:
<pre>
<b>OMA-SUP-DTD_<font color=red>foo_barcode</font>-V<font color=red>1_0</font>-20060123-C.txt ==> <font color=red>foo_barcode</font>-v<font color=red>1_0</font>.dtd</b><br>
<b>OMA-SUP-DTD_<font color=red>xyz_msgs</font>-V<font color=red>1_2</font>-20060321-C.txt    ==> <font color=red>xyz_msgs</font>-v<font color=red>1_2</font>.dtd</b>
</pre>

<hr class=1>
<a name="handling"><h2>Handling of DTD docs</h2></a>
The DTD SUP file is maintained in the OMA Portal Permanent Document area as with the specifications in the enabler.  It is subject to revision using the normal CR process.  Application of CRs to a DTD SUP file will result in an updated file with the appropriate date associated.
<p>
The DTD SUP file should be treated as if it has the ".txt" file extension.
<p>
References to OMA defined DTDs in specifications should be done <i><font color=blue>(This needs to be aligned with the Referencing Policy)</font></i> to the developed SUP file.  This will permit easy reference and retrieval of current or past versions using the normal PD file mechanisms.  An example reference would look like:
<center>
<table border=1>
<tr><td><font size=1 style=bold>[FOO_DTD]&nbsp;&nbsp;&nbsp;</font></td><td><font size=1>DTD for FOO Messages, Version 1.0, Open Mobile Alliance,<br>OMA-SUP-DTD_foo_barcode-V1_0, URL:http://www.openmobilealliance.org/&nbsp;&nbsp;&nbsp;&nbsp;</font></td></tr>
</table>
</center>
<p>
Examples in specifications which show DTD file usage should utilize the public reachable file.  For example, the example usage would show the DTD as 
<center><table border=1>
<tr><td bgcolor=#FFFFDD>
<font style=bold size=2 color=#0000FF><pre>

&lt;!DOCTYPE DevInf PUBLIC "-//OMA//DTD FOO-BARCODE 1.0//EN"
          "http://www.openmobilealliance.org/tech/dtd/foo_barcode-v1_0.dtd"&nbsp;&nbsp;&nbsp;&nbsp;
          [&lt;?oma-foo-barcode-ver supported-versions="1.0"?>]>
</pre></font></td></tr></table></center>
<p>

<hr class=1>
<a name="package"><h2>DTD docs in Enabler Releases</h2></a>
As with Specifications, DTDs are normally components of an Enabler Release.
So, similar to how Specifications are released, DTDs are packaged in the Enabler Release Package to be made available.
This packaging also includes appropriate linkages in the ERELD.
<p>
The following is an example DTD entry in the ERELD:
<center>
<table border=1>
<tr bgcolor=cyan>
  <td colspan=3><font size=1 style=bold>Supporting Files</font></td>
</tr>
<tr>
  <td><font size=1 style=bold>[FOO_DTD]&nbsp;&nbsp;&nbsp;&nbsp;</font></td>
  <td><font size=1>OMA-SUP-DTD_foo_barcode-V1_0-20060123-C&nbsp;&nbsp;&nbsp;&nbsp;</font></td>
  <td><font size=1>
This DTD describes the barcode messages for the<br>
FOO Enabler.<br>
Working file in DTD directory:<br>
&nbsp;&nbsp;&nbsp;file: foo_barcode-v1_0.dtd<br>
&nbsp;&nbsp;&nbsp;path: http://www.openmobilealliance.org/tech/dtd/&nbsp;&nbsp;&nbsp;&nbsp;</font>
  </td>
</tr>
</table>
</center>
<p>

<hr class=1>
<a name="public"><h2>Getting DTD docs into Public Directory</h2></a>
As the public reachable DTD files permit parsers to evaluate grammar for an XML document, it is sometimes required to get a copy of the DTD file into the public reachable directory.
<p>
The primary means of publishing the DTD is the advancement of the enabler release to Candidate.
At that time, the DSO will review the ERELD and for each DTD listed, copy the material in the listed SUP file to the named version of the public DTD file.  This will also result in the DTD file get listed in the DTD index page.
<p>
The DSO would perform the needed copy action like:
<pre>
Copy from <b>OMA-SUP-DTD_foo_barcode-V1_0-20060123-C.txt</b><br>
       to <b>http://www.openmobilealliance.org/tech/dtd/foo_barcode-v1_0.dtd</b>
</pre>
<p>
In cases where a draft version of the DTD is needed in the public directory, the DSO can perform the copy dependent on the following conditions:
<ul>
<li>The DTD has the proper header which provides name information for both the PD SUP file and the public file name</li>
<li>The draft DTD in the public area would not overlay an existing Candidate or Approved DTD already in the public DTD directory</li>
<li>The DTD directory will not be updated to show the DTD (done for Candidate) so users will need to know the URL by other means</li>
</ul>
<p>

<hr class=1>
<a name="header"><h2>Embedded Header in OMA DTD Files</h2></a>
The public DTD files are the products of OMA and should properly represent the associated terms and conditions.
This is done by providing information in the file itself that can be viewed by users.
For DTDs, this is done using commented material.
<p>
The following is an example header.

<center>
<table border=1 bgcolor=#DDEEFF><tr><td><pre><font size=-1>&lt;!--
    FILE INFORMATION

    OMA Permanent Document
       File: OMA-SUP-DTD_<font color=red>foo_barcode-V1_0-20060123-C</font>
       Type: Text

    Public Reachable Information
       Path: http://www.openmobilealliance.org/tech/dtd
       Name: <font color=red>foo_barcode-v1_0</font>.dtd

    NORMATIVE INFORMATION

    Information about this file can be found in the specification
    <font color=red>OMA-TS-FOO_BAR-V1_0-20060111-C</font> available at
       http://www.openmobilealliance.org/

    Send comments to technical-comments@mail.openmobilealliance.org
	
    LEGAL DISCLAIMER

    Use of this document is subject to all of the terms and conditions
    of the Use Agreement located at
        http://www.openmobilealliance.org/UseAgreement.html

    You may use this document or any part of the document for internal
    or educational purposes only, provided you do not modify, edit or
    take out of context the information in this document in any manner.
    Information contained in this document may be used, at your sole
    risk, for any purposes.

    You may not use this document in any other manner without the prior
    written permission of the Open Mobile Alliance.  The Open Mobile
    Alliance authorizes you to copy this document, provided that you
    retain all copyright and other proprietary notices contained in the
    original materials on any copies of the materials and that you
    comply strictly with these terms.  This copyright permission does
    not constitute an endorsement of the products or services.  The
    Open Mobile Alliance assumes no responsibility for errors or
    omissions in this document.

    Each Open Mobile Alliance member has agreed to use reasonable
    endeavors to inform the Open Mobile Alliance in a timely manner of
    Essential IPR as it becomes aware that the Essential IPR is related
    to the prepared or published specification.  However, the members
    do not have an obligation to conduct IPR searches.  The declared
    Essential IPR is publicly available to members and non-members of
    the Open Mobile Alliance and may be found on the "OMA IPR
    Declarations" list at http://www.openmobilealliance.org/ipr.html.
    The Open Mobile Alliance has not conducted an independent IPR review
    of this document and the information contained herein, and makes no
    representations or warranties regarding third party IPR, including
    without limitation patents, copyrights or trade secret rights.  This
    document may contain inventions for which you must obtain licenses
    from third parties before making, using or selling the inventions.
    Defined terms above are set forth in the schedule to the Open Mobile
    Alliance Application Form.

    NO REPRESENTATIONS OR WARRANTIES (WHETHER EXPRESS OR IMPLIED) ARE
    MADE BY THE OPEN MOBILE ALLIANCE OR ANY OPEN MOBILE ALLIANCE MEMBER
    OR ITS AFFILIATES REGARDING ANY OF THE IPR'S REPRESENTED ON THE "OMA
    IPR DECLARATIONS" LIST, INCLUDING, BUT NOT LIMITED TO THE ACCURACY,
    COMPLETENESS, VALIDITY OR RELEVANCE OF THE INFORMATION OR WHETHER OR&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
    NOT SUCH RIGHTS ARE ESSENTIAL OR NON-ESSENTIAL.

    THE OPEN MOBILE ALLIANCE IS NOT LIABLE FOR AND HEREBY DISCLAIMS ANY
    DIRECT, INDIRECT, PUNITIVE, SPECIAL, INCIDENTAL, CONSEQUENTIAL, OR
    EXEMPLARY DAMAGES ARISING OUT OF OR IN CONNECTION WITH THE USE OF
    DOCUMENTS AND THE INFORMATION CONTAINED IN THE DOCUMENTS.

    Copyright 20<font color=red>10</font> Open Mobile Alliance Ltd.  All Rights Reserved.
    Used with the permission of the Open Mobile Alliance Ltd. under the
    terms set forth above.
--&gt;</font></pre></td></tr></table>
</center>
<p>
This commented header would normally be inserted in the DTD near the beginning.



<!--  Document Footer  -->

<p>
<table width=100% cellspacing=0 cellpadding=0>
<tr><td colspan=2><img height=5 width=100% src="imgBitWht.gif"></tr>
<tr><td colspan=3><img height=5 width=100% src="imgBitSep.gif"></tr>
<tr>
<td class=footer align=left>&copy; 2010 Open Mobile Alliance, Ltd.<br>All Rights Reserved</td>
<td class=footer align=right>
<a href="http://www.openmobilealliance.org/AboutOMA/useterms.aspx">Website Terms of Use</a>
</td>
</tr>
</table>

</body>
</html>