XML Catalog Policy Draft 3

[Mark Johnson <mrj@debian.org>]

This post proposes a model for the Local Catalogs,
i.e. /usr/share/xml/DTD-DIR/catalog.xml.

For reference, I provide the catalog jargon again...

Terminology:    Root Catalog:      /etc/xml/xcatalog
============    -------------
                Package Catalogs:  /etc/xml/$package.xcat
                ----------------- 
                Local Catalogs:    /usr/share/xml/DTD-DIR/catalog.xml
                ---------------

Local Catalog Implementation Issues
===================================

  Local Catalogs (/usr/share/xml/DTD-DIR/catalog.xml)
  --------------
   Purpose:

   The primary role of the Local Catalogs is 

     a. to map PUBLIC and SYSTEM identifiers to local filenames


   As such, Local Catalogs should only contain the following elements: 
     -public, 
     -system, or 
     -uri.

     [*Again, I'm not clear when to use "system" as opposed to "uri" elements;
      will have to as Norm about this...]

++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++

   -- BEGIN xml-core Local Catalog example: /usr/share/xml/oasis/catalog.xml --

<?xml version="1.0"?>
<!DOCTYPE catalog PUBLIC "-//OASIS//DTD XML Catalogs V1.0//EN" 
  "http://www.oasis-open.org/committees/entity/release/1.0/catalog.dtd";>    

<!-- xml catalog for xml-core: points to OASIS XML Catalog DTD  -->
<catalog xmlns="urn:oasis:names:tc:entity:xmlns:xml:catalog"> 

  <public publicId="-//OASIS//DTD XML Catalogs V1.0//EN"
    uri="catalog.dtd"/>

<!-- For backward compatibility with old FPI -->

  <public publicId="-//OASIS//DTD Entity Resolution XML Catalog V1.0//EN"
     uri="catalog.dtd"/>

  <system
     systemId="http://www.oasis-open.org/committees/entity/release/1.0/catalog.dtd";
      uri="catalog.dtd"/>

  <!-- Customization that adds tr9401 support        --> 
  <!-- (currently being revised, and hence offline)  -->

  <public publicId="-//GlobalTransCorp//DTD XML Catalog V1.0-Based Extension V1.0" 
      uri="9401xcat.dtd"/>

  <system systemId="http://globaltranscorp.org/oasis/catalog/xml/9401xcat.dtd";
      uri="9401xcat.dtd"/>

</catalog>
   -- END xml-core Local Catalog example: /usr/share/xml/oasis/catalog.xml  --

++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++

   -- BEGIN Local Catalog example: docbook-xml, V4.2 DTD --

    ++ Note: this catalog ships with the dtd ++

<?xml version='1.0'?>
<!DOCTYPE catalog PUBLIC "-//OASIS//DTD Entity Resolution XML Catalog V1.0//EN" 
    "http://www.oasis-open.org/committees/entity/release/1.0/catalog.dtd";>

<catalog xmlns="urn:oasis:names:tc:entity:xmlns:xml:catalog">

<!-- ...................................................................... -->
<!-- XML Catalog data for DocBook XML V4.2 ................................ -->
<!-- File catalog.xml ..................................................... -->

<!-- Please direct all questions, bug reports, or suggestions for
     changes to the docbook@lists.oasis-open.org mailing list. For more
     information, see http://www.oasis-open.org/.
  -->

<!-- This is the catalog data file for DocBook V4.2. It is provided as
     a convenience in building your own catalog files. You need not use
     the filenames listed here, and need not use the filename method of
     identifying storage objects at all.  See the documentation for
     detailed information on the files associated with the DocBook DTD.
     See XML Catalogs at http://www.oasis-open.org/committees/entity/ for
     detailed information on supplying and using catalog data.
  -->

<!-- ...................................................................... -->
<!-- DocBook driver file .................................................. -->

<public publicId="-//OASIS//DTD DocBook XML V4.2//EN"
        uri="docbookx.dtd"/>

<!-- ...................................................................... -->
<!-- DocBook modules ...................................................... -->

<public publicId="-//OASIS//DTD DocBook CALS Table Model V4.2//EN"
        uri="calstblx.dtd"/>

<public publicId="-//OASIS//DTD XML Exchange Table Model 19990315//EN"
        uri="soextblx.dtd"/>

<public publicId="-//OASIS//ELEMENTS DocBook Information Pool V4.2//EN"
        uri="dbpoolx.mod"/>

<public publicId="-//OASIS//ELEMENTS DocBook Document Hierarchy V4.2//EN"
        uri="dbhierx.mod"/>

<public publicId="-//OASIS//ENTITIES DocBook Additional General Entities V4.2//EN"
        uri="dbgenent.mod"/>

<public publicId="-//OASIS//ENTITIES DocBook Notations V4.2//EN"
        uri="dbnotnx.mod"/>

<public publicId="-//OASIS//ENTITIES DocBook Character Entities V4.2//EN"
        uri="dbcentx.mod"/>


<!-- End of catalog data for DocBook XML V4.2 ............................. -->
<!-- ...................................................................... -->

</catalog>

   -- END Local Catalog example: docbook-xml, V4.2 DTD --

I need a break. Tomorrow I'll weigh in with some ideas I have regarding the
content and package maintainer scripts for the xml-core package.

Cheers,
Mark

-- 
_____________________________________
Mark Johnson        <mark@duke.edu>
Debian XML/SGML     <mrj@debian.org>
Home Page:          <http://dulug.duke.edu/~mark/>
GPG fp: 50DF A22D 5119 3485 E9E4  89B2 BCBC B2C8 2BE2 FE81