Archiving and Interchange DTD


Introduction

The National Center for Biotechnology Information (NCBI) of the National Library of Medicine (NLM) created the Journal Archiving and Interchange Document Type Definition (DTD) with the intent of providing a common format in which publishers and archives can exchange journal content.

This DTD was created from the Journal Archiving and Interchange DTD Suite, which provides a set of XML modules that define elements and attributes for describing the textual and graphical content of journal articles as well as some non-article material such as letters, editorials, and book and product reviews).

The Suite of Modules

The intent of this DTD Suite is to preserve the intellectual content of journals independent of the form in which that content was originally delivered. The Suite has been written as a set of XML DTD modules, each of which is a separate physical file. No module is an entire DTD by itself, but these modules can be combined into a number of different DTDs.

The Archiving and Interchange DTD may be used as is, or the Suite can be used to construct DTDs for authoring and archiving journal articles as well as DTDs for transferring journal articles from publishers to archives and between archives. Details on creating DTDs from the Suite are available in the Tag Library. Although the full Suite was developed to support electronic production, the structures should be adequate to support some print production as well.

NCBI/NLM also created the Journal Publishing DTD from the Suite. The Publishing DTD is a prescriptive subset of the Archiving and Interchange DTD optimized for the authoring and initial XML tagging of journal material. PubMed Central is encouraging the use of the Journal Publishing DTD to define submitted content.

[Note: NCBI/NLM also created a DTD for the submission of citations and abstracts for MEDLINE/PubMed that predated this Suite full-text effort. If you want to submit citations and abstracts to NLM for inclusion in PubMed/MEDLINE, use the PubMed Journal Article DTD. Detailed information is available from the PubMed web site: Information for Publishers re: XML Tagged Data.]

Using the Suite

These DTDs and the Suite are in the public domain. An organization that wants to create its own DTD from the Suite may do so without permission from NLM.

The Suite has been set up to be extended using a new DTD file and a new DTD-specific customization module to redefine the many Parameter Entities. Do not modify the Suite directly or redistribute modified versions of the Suite.

In the interest of maintaining consistency and clarity for potential users, NLM requests:

  1. If you create a DTD from the Archiving and Interchange DTD Suite and intend it to stay compatible with the Suite, then please include the following statement as a comment in all of your DTD modules:

    Created from, and fully compatible with, the Archiving and Interchange DTD Suite.

  2. If you alter one or more modules of the suite, then please rename your version and all its modules to avoid any confusion with the original Suite. Also, please include the following statement as a comment in all your DTD modules:

    Based in part on, but not fully compatible with, the Archiving and Interchange DTD Suite.

Documentation

The complete documentation for the Archiving and Interchange DTD v1.1 is available in the tag library http://dtd.nlm.nih.gov/1.1/tag-library.

The Tag Library contains the following sections:

Introduction

An introduction to the content of the Tag Library, to the design philosophy and intended usage of the Archiving and Interchange DTD Suite, and to the Journal Archiving and Interchange DTD.

Elements Section

Descriptions of the elements used in the Journal Archiving and Interchange DTD and DTD Suite modules.

Attributes Section

Descriptions of the attributes in the DTD modules.

Parameter Entity Section

Names (with occasional descriptions) and contents of the Parameter Entities in the DTD modules.

Context Table

Listings of where each element may be used. All elements are given in a simple alphabetical list. There is a single table for the elements from all the Suite modules that are called from the DTD.

Document Hierarchy Diagrams

Tree-like graphical representations of the content of many elements. This can be a fast visual way to determine the structure of an article or of any element within an article.

Index by Tag Name

Index of element descriptions, alphabetically by tag name (element-type name).

Index by Element Name

Index of element descriptions, alphabetically by element name (the longer, more descriptive name).

DTD Section

Copies of the Journal Archiving and Interchange DTD, its customization module, and the full Archiving and Interchange DTD Suite of XML DTD modules described in the Tag Library.

Also, the DTD modules themselves are well commented.

Frequently Asked Questions

A Frequently Asked Questions page is available.

Getting the Files

The DTD files and W3C Schema version are available by anonymous FTP: ftp://ftp.ncbi.nih.gov/pub/archive_dtd

A direct link to the files is available: ftp.ncbi.nih.gov/pub/archive_dtd/archive-interchange-dtd-1.1.zip and ftp.ncbi.nih.gov/pub/archive_dtd/archive-interchange-dtd-1.1.xsd

The DTD is available on the web: http://dtd.nlm.nih.gov/1.1/archivearticle.dtd

The W3C Schema is available on the web: http://dtd.nlm.nih.gov/1.1/xsd/archivearticle.xsd

Updates

Version

The current version of the Archiving and Interchange DTD is v1.1.

Version 1.1 was released on November 5, 2003. A detailed explaination of the changes from version 1.0 is available in the General Introduction to the v1.1 Tag Library.

Version 1.0 is available here: http://dtd.nlm.nih.gov/1.0/.

W3C Schema Version

A W3C Schema has been generated from the DTD. The Schema version describes the same content model as the DTD. Information is available on the W3C Schema page.

Working Group and Secretariat

To keep the DTD relevant to the publishing and archiving communities, NLM has created the XML Interchange Structure Working Group. This group advises NLM on recommended changes in and/or additions to the tagset. The first meeting of the Working Group was held on August 18, 2003. The meeting notes are available as a Word document (working-group/AITWG-08-18-2003.doc).

NLM has contracted with Mulberry Technologies, Inc. of Rockville, MD to act as Archiving and Interchange Tagset Secretariat. The Secretariat will collect the feedback to be discussed by the Working Group and will maintain the files and documentation.

Feedback

Please submit all questions or comments to archive-dtd@ncbi.nlm.nih.gov.

This is a public mailing list. More information on the list is available: http://www.ncbi.nlm.nih.gov/mailman/listinfo/archive-dtd.

Any suggestions for changes to the Tagset or documentation should be made through the Journal Article Tag Set Comment Form at the Mulberry Technolgies site.

Related DTDs

The Journal Publishing DTD, a prescriptive DTD optimized for the authoring and initial XML tagging of journal material for PubMed Central, was created from the Suite also.

If you want to submit citations and abstracts to NLM for inclusion in PubMed/MEDLINE, use the PubMed Journal Article DTD. Detailed information is available from the PubMed web site: Information for Publishers re: XML Tagged Data.

Tools

NLM has created an XSL transform to HTML for previewing content in the Archiving and Interchange DTD and a Cascading Style Sheet to support it.

Commercial Tools that have been written for the DTDs are also available on the Tools page.

XML Information

Links to general information on XML, XSLT, Unicode™, and XLink are available on the XML Resources page.

Acknowledgments

NLM thanks Mulberry Technologies, Inc. and Inera, Inc. for their expert advice and the intense document analysis that was required to create this library of DTD modules for archiving and content interchange.

NLM also thanks the Harvard University Libraries, both for proposing that a draft archiving NLM DTD for life sciences journals be extended to accommodate journals in all disciplines and for sponsoring Inera's collaboration with other DTD authors in completing Version 1.0. The Andrew W. Mellon Foundation provided support for these important contributions.


U.S. National Library of Medicine, 8600 Rockville Pike, Bethesda, MD 20894
National Institutes of Health, Department of Health & Human Services
Copyright, Privacy, Accessibility
Last updated: March 23, 2004