Archiving and Interchange Tag Set


Introduction

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

This Tag Set was created from the Journal Archiving and Interchange Tag Suite, which provides a set of schema 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 Tag 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 schema modules, each of which is a separate physical file. No module is an entire schema by itself, but these modules can be combined into a number of different schemas.

The Archiving and Interchange Tag Suite may be used as is, or the Suite can be used to construct Tag Sets for authoring and archiving journal articles as well as schemas for transferring journal articles from publishers to archives and between archives. Details on creating Tag Sets 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.

[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 Tag Sets and the Suite are in the public domain. An organization that wants to create its own schema from the Suite may do so without permission from NLM.

The Suite has been set up to be extended using a new schema file and a new schema-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 schema from the Archiving and Interchange Tag Suite and intend it to stay compatible with the Suite, then please include the following statement as a comment in all of your schema modules:

    Created from, and fully compatible with, the Archiving and Interchange Tag 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 schema modules:

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

Documentation

The complete documentation for the Document Type Definition (DTD) version of the this Tag Set is available in the tag library http://dtd.nlm.nih.gov/archiving/2.3/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, W3C XML Schema, and RELAX NG versions are available by anonymous FTP: ftp://ftp.ncbi.nih.gov/pub/archive_dtd/archiving

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

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

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

The RELAX NG Schema is available on the web: http://dtd.nlm.nih.gov/archiving/2.3/rng/archivearticle.rng.

Updates

Version

The current version of the Archiving and Interchange DTD is v2.3.

Version 2.3 was released on March 28, 2007. A detailed explaination of the changes from version 2.2 is available in the v2.3 Change Report.

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

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

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

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

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

W3C XML Schema Version

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

RELAX NG Schema Version

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

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 Tag Set 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 initial XML tagging of journal material for PubMed Central, was created from the Suite also.

The Article Authoring DTD, a prescriptive DTD optimized for authoring articles directly in XML 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.

NCBI has also created two DTDs for textbooks from the modules. Details are here: Book DTD.

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.

XML Information

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


PubMed Central
NCBI | NLM | NIH
Department of Health & Human Services
Freedom of Information Act | Disclaimer
Last updated: March 27, 2007