Home > Articles > Web Services > XML

This chapter is from the book

Supporting External DTDs

So far, we've stored DTDs internally in XML documents, using <!DOCTYPE> elements. But we can also store DTDs externally, in entirely separate files (which usually use the extension .dtd). It's often a good idea to use an external DTD with an XML application that is shared by many people. That way, if you want to make changes in the XML application, you only need to change the DTD once, not in dozens of separate files. (In fact, that's the way many XML applications, such as XHTML, are implemented.)

Private and Public DTDs

There are two ways to support external DTDs—as private DTDs for personal or limited use and as public DTDs for public use. We'll start with private DTDs.

Creating Private DTDs

You specify that we're using an external private DTD by using the SYSTEM keyword in the <!DOCTYPE> element, like this:

<!DOCTYPE document SYSTEM "ch04_07.dtd"> 

This example specifies the name of the document element (which is just <document> in this example), the SYSTEM keyword to indicate that the example is using a private external DTD, and the name of the external DTD file. Note that because the XML document now depends on an external file, the external DTD file, we must also change the standalone attribute from "yes" to "no", as shown in ch04_06.xml in Listing 4.6. The external DTD here is in ch04_07.dtd, which is shown in Listing 4.7. Note that the external DTD simply holds the part of the document that was originally between the [ and ] in the earlier versions of the <!DOCTYPE> element.

Listing 4.6 A Sample XML Document That Uses a Private External DTD (ch04_06.xml)

<?xml version = "1.0" encoding="UTF-8" standalone="no"?>
<!DOCTYPE document SYSTEM "ch04_07.dtd"> 
<document>
  <employee>
    <name>
      <lastname>Kelly</lastname>
      <firstname>Grace</firstname>
    </name>
    <hiredate>October 15, 2005</hiredate>
    <projects>
      <project>
        <product>Printer</product>
        <id>111</id>
        <price>$111.00</price>
      </project>
      <project>
        <product>Laptop</product>
        <id>222</id>
        <price>$989.00</price>
      </project>
    </projects>
  </employee>
    .
    .
    .
</document>

Listing 4.7 An External DTD (ch04_07.dtd)

<!ELEMENT document (employee)*> 
<!ELEMENT employee (name, hiredate, projects)> 
<!ELEMENT name (lastname, firstname)> 
<!ELEMENT lastname (#PCDATA)> 
<!ELEMENT firstname (#PCDATA)> 
<!ELEMENT hiredate (#PCDATA)> 
<!ELEMENT projects (project)*> 
<!ELEMENT project (product,id,price)> 
<!ELEMENT product (#PCDATA)> 
<!ELEMENT id (#PCDATA)> 
<!ELEMENT price (#PCDATA) > 

The example shown in Listing 4.7 assumes that the external DTD is in the same directory as the XML document itself, so you just need to give the name of the external DTD file in the <!DOCTYPE> element:

<?xml version = "1.0" standalone="no"?>
<!DOCTYPE document SYSTEM "ch04_07.dtd"> 

On the other hand, you can place the external DTD anywhere, as long as you give its full URI (in this case, that's just the full URL, as far as most XML processors are concerned) in the <!DOCTYPE> element, as in this example:

<?xml version = "1.0" standalone="no"?>
<!DOCTYPE document SYSTEM "http://www.xmlpowercorp.com/dtds/ch04_07.dtd"> 

You need to supply a URL like this for an external DTD if you want to use an online XML validator.

Creating Public DTDs

As discussed so far today, it's easy to create and use a private external DTD. Creating and using a public external DTD can take a little more work. In this case, you use the PUBLIC keyword instead of SYSTEM in the <!DOCTYPE> DTD. To use the PUBLIC keyword, you must also create a formal public identifier (FPI), which is a quoted string of text, made up of four fields separated by //. For example, the official FPI for transitional XHTML 1.0 is -//W3C//DTD XHTML 1.0 Transitional//EN. Here are the rules for creating the fields in FPIs:

  • The first field indicates whether the DTD is for a formal standard. For DTDs you create on your own, this field should be -. If a non-official standards body has created the DTD, you use +. For formal standards bodies, this field is a reference to the standard itself (such as ISO/IEC 19775:2003).

  • The second field holds the name of the group or person responsible for the DTD. You should use a name that is unique (for example, W3C just uses W3C).

  • The third field specifies the type of the document the DTD is for and should be followed by a unique version number of some kind (such as Version 1.0).

  • The fourth field specifies the language in which the DTD is written (for example, EN for English) .

When you use a public external DTD, we can use the <!DOCTYPE> element like this: <!DOCTYPE rootname PUBLIC FPI URI>. Listing 4.8 shows an example, ch04_08.xml, which uses the made-up FPI -//DTDS4ALL//Custom DTD Version 1.0//EN. This document uses ch04_07.dtd as the external DTD, as in the previous example, but as we can see, it treats that DTD as a public external DTD, complete with its own FPI.

Listing 4.8 A Sample XML Document That Uses a Public External DTD (ch04_08.xml)

<?xml version = "1.0" standalone="no"?>
<!DOCTYPE document PUBLIC "-//DTDS4ALL//Custom DTD Version 1.0//EN"
"http://www.xmlpowercorp.com/dtds/ch04_07.dtd">
<document>
  <employee>
    <name>
      <lastname>Kelly</lastname>
      <firstname>Grace</firstname>
    </name>
    <hiredate>October 15, 2005</hiredate>
    <projects>
      <project>
        <product>Printer</product>
        <id>111</id>
        <price>$111.00</price>
      </project>
      <project>
        <product>Laptop</product>
        <id>222</id>
        <price>$989.00</price>
      </project>
    </projects>
  </employee>
    .
    .
    .
</document>

Using Internal and External DTDs at the Same Time

So far, you've seen these versions of the <!DOCTYPE> element:

  • <!DOCTYPE rootname [DTD]>

  • <!DOCTYPE rootname SYSTEM URI>

  • <!DOCTYPE rootname PUBLIC identifier URI>

However, you can also use both internal and external DTDs if you use these forms of the <!DOCTYPE> element:

  • <!DOCTYPE rootname SYSTEM URI [DTD]>

  • <!DOCTYPE rootname PUBLIC identifier URI [DTD]>

In this case, the external DTD is specified by URL and the internal one by DTD. Listing 4.9 shows an example in ch04_09.xml, where the external DTD—ch04_10.xml in List- ing 4.10—specifies the syntax of all elements in ch04_09.xml except the <price> element, which is specified in the <!DOCTYPE> element in the XML document ch04_09.xml.

Listing 4.9 A Sample XML Document That Uses an Internal DTD and an External DTD (ch04_09.xml)

<?xml version = "1.0" encoding="UTF-8" standalone="no"?>
<!DOCTYPE document SYSTEM "http://www.lightlink.com/steve/ch04_10.dtd" [ 
<!ELEMENT price (#PCDATA)>           
]>                       
<document>
  <employee>
    <name>
      <lastname>Kelly</lastname>
      <firstname>Grace</firstname>
    </name>
    <hiredate>October 15, 2005</hiredate>
    <projects>
      <project>
        <product>Printer</product>
        <id>111</id>
        <price>$111.00</price>
      </project>
      <project>
        <product>Laptop</product>
        <id>222</id>
        <price>$989.00</price>
      </project>
    </projects>
  </employee>
    .
    .
    .
</document>

Listing 4.10 The External DTD for ch04_09.xml (ch04_10.xml)

<!ELEMENT document (employee)*> 
<!ELEMENT employee (name, hiredate, projects)> 
<!ELEMENT name (lastname, firstname)> 
<!ELEMENT lastname (#PCDATA)> 
<!ELEMENT firstname (#PCDATA)> 
<!ELEMENT hiredate (#PCDATA)> 
<!ELEMENT projects (project)*> 
<!ELEMENT project (product,id,price)> 
<!ELEMENT product (#PCDATA)> 
<!ELEMENT id (#PCDATA) > 

Combining internal and external DTDs like this is a good idea if you have a standard DTD that we share with other XML documents but also want to do some customization in certain XML documents. Theoretically, if you specify the syntax for an element or attribute in both an internal and external DTD, the internal DTD is supposed to take precedence. Unfortunately, however, most XML processors these days just treat conflicts in an internal and external DTD as errors.

InformIT Promotional Mailings & Special Offers

I would like to receive exclusive offers and hear about products from InformIT and its family of brands. I can unsubscribe at any time.

Overview


Pearson Education, Inc., 221 River Street, Hoboken, New Jersey 07030, (Pearson) presents this site to provide information about products and services that can be purchased through this site.

This privacy notice provides an overview of our commitment to privacy and describes how we collect, protect, use and share personal information collected through this site. Please note that other Pearson websites and online products and services have their own separate privacy policies.

Collection and Use of Information


To conduct business and deliver products and services, Pearson collects and uses personal information in several ways in connection with this site, including:

Questions and Inquiries

For inquiries and questions, we collect the inquiry or question, together with name, contact details (email address, phone number and mailing address) and any other additional information voluntarily submitted to us through a Contact Us form or an email. We use this information to address the inquiry and respond to the question.

Online Store

For orders and purchases placed through our online store on this site, we collect order details, name, institution name and address (if applicable), email address, phone number, shipping and billing addresses, credit/debit card information, shipping options and any instructions. We use this information to complete transactions, fulfill orders, communicate with individuals placing orders or visiting the online store, and for related purposes.

Surveys

Pearson may offer opportunities to provide feedback or participate in surveys, including surveys evaluating Pearson products, services or sites. Participation is voluntary. Pearson collects information requested in the survey questions and uses the information to evaluate, support, maintain and improve products, services or sites, develop new products and services, conduct educational research and for other purposes specified in the survey.

Contests and Drawings

Occasionally, we may sponsor a contest or drawing. Participation is optional. Pearson collects name, contact information and other information specified on the entry form for the contest or drawing to conduct the contest or drawing. Pearson may collect additional personal information from the winners of a contest or drawing in order to award the prize and for tax reporting purposes, as required by law.

Newsletters

If you have elected to receive email newsletters or promotional mailings and special offers but want to unsubscribe, simply email information@informit.com.

Service Announcements

On rare occasions it is necessary to send out a strictly service related announcement. For instance, if our service is temporarily suspended for maintenance we might send users an email. Generally, users may not opt-out of these communications, though they can deactivate their account information. However, these communications are not promotional in nature.

Customer Service

We communicate with users on a regular basis to provide requested services and in regard to issues relating to their account we reply via email or phone in accordance with the users' wishes when a user submits their information through our Contact Us form.

Other Collection and Use of Information


Application and System Logs

Pearson automatically collects log data to help ensure the delivery, availability and security of this site. Log data may include technical information about how a user or visitor connected to this site, such as browser type, type of computer/device, operating system, internet service provider and IP address. We use this information for support purposes and to monitor the health of the site, identify problems, improve service, detect unauthorized access and fraudulent activity, prevent and respond to security incidents and appropriately scale computing resources.

Web Analytics

Pearson may use third party web trend analytical services, including Google Analytics, to collect visitor information, such as IP addresses, browser types, referring pages, pages visited and time spent on a particular site. While these analytical services collect and report information on an anonymous basis, they may use cookies to gather web trend information. The information gathered may enable Pearson (but not the third party web trend services) to link information with application and system log data. Pearson uses this information for system administration and to identify problems, improve service, detect unauthorized access and fraudulent activity, prevent and respond to security incidents, appropriately scale computing resources and otherwise support and deliver this site and its services.

Cookies and Related Technologies

This site uses cookies and similar technologies to personalize content, measure traffic patterns, control security, track use and access of information on this site, and provide interest-based messages and advertising. Users can manage and block the use of cookies through their browser. Disabling or blocking certain cookies may limit the functionality of this site.

Do Not Track

This site currently does not respond to Do Not Track signals.

Security


Pearson uses appropriate physical, administrative and technical security measures to protect personal information from unauthorized access, use and disclosure.

Children


This site is not directed to children under the age of 13.

Marketing


Pearson may send or direct marketing communications to users, provided that

  • Pearson will not use personal information collected or processed as a K-12 school service provider for the purpose of directed or targeted advertising.
  • Such marketing is consistent with applicable law and Pearson's legal obligations.
  • Pearson will not knowingly direct or send marketing communications to an individual who has expressed a preference not to receive marketing.
  • Where required by applicable law, express or implied consent to marketing exists and has not been withdrawn.

Pearson may provide personal information to a third party service provider on a restricted basis to provide marketing solely on behalf of Pearson or an affiliate or customer for whom Pearson is a service provider. Marketing preferences may be changed at any time.

Correcting/Updating Personal Information


If a user's personally identifiable information changes (such as your postal address or email address), we provide a way to correct or update that user's personal data provided to us. This can be done on the Account page. If a user no longer desires our service and desires to delete his or her account, please contact us at customer-service@informit.com and we will process the deletion of a user's account.

Choice/Opt-out


Users can always make an informed choice as to whether they should proceed with certain services offered by InformIT. If you choose to remove yourself from our mailing list(s) simply visit the following page and uncheck any communication you no longer want to receive: www.informit.com/u.aspx.

Sale of Personal Information


Pearson does not rent or sell personal information in exchange for any payment of money.

While Pearson does not sell personal information, as defined in Nevada law, Nevada residents may email a request for no sale of their personal information to NevadaDesignatedRequest@pearson.com.

Supplemental Privacy Statement for California Residents


California residents should read our Supplemental privacy statement for California residents in conjunction with this Privacy Notice. The Supplemental privacy statement for California residents explains Pearson's commitment to comply with California law and applies to personal information of California residents collected in connection with this site and the Services.

Sharing and Disclosure


Pearson may disclose personal information, as follows:

  • As required by law.
  • With the consent of the individual (or their parent, if the individual is a minor)
  • In response to a subpoena, court order or legal process, to the extent permitted or required by law
  • To protect the security and safety of individuals, data, assets and systems, consistent with applicable law
  • In connection the sale, joint venture or other transfer of some or all of its company or assets, subject to the provisions of this Privacy Notice
  • To investigate or address actual or suspected fraud or other illegal activities
  • To exercise its legal rights, including enforcement of the Terms of Use for this site or another contract
  • To affiliated Pearson companies and other companies and organizations who perform work for Pearson and are obligated to protect the privacy of personal information consistent with this Privacy Notice
  • To a school, organization, company or government agency, where Pearson collects or processes the personal information in a school setting or on behalf of such organization, company or government agency.

Links


This web site contains links to other sites. Please be aware that we are not responsible for the privacy practices of such other sites. We encourage our users to be aware when they leave our site and to read the privacy statements of each and every web site that collects Personal Information. This privacy statement applies solely to information collected by this web site.

Requests and Contact


Please contact us about this Privacy Notice or if you have any requests or questions relating to the privacy of your personal information.

Changes to this Privacy Notice


We may revise this Privacy Notice through an updated posting. We will identify the effective date of the revision in the posting. Often, updates are made to provide greater clarity or to comply with changes in regulatory requirements. If the updates involve material changes to the collection, protection, use or disclosure of Personal Information, Pearson will provide notice of the change through a conspicuous notice on this site or other appropriate way. Continued use of the site after the effective date of a posted revision evidences acceptance. Please contact us if you have questions or concerns about the Privacy Notice or any objection to any revisions.

Last Update: November 17, 2020