Journal Publishing DTD


Introduction

The National Center for Biotechnology Information (NCBI), a center of the National Library of Medicine (NLM), created the Journal Publishing Document Type Definition (DTD) with the intent of providing a common format for the creation of journal content in XML.

For journals that have not selected an SGML/XML model, NCBI will encourage the use of this DTD to define the incoming data for PubMed Central, the U.S. National Library of Medicine's digital archive of life sciences journal literature.

Ancestry

The DTD was constructed using the modules of the Archiving and Interchange DTD Suite and has been modeled along the same philosophical lines as the Archiving and Interchange DTD, which is a DTD for interchange and storage of journal material. However, because this is a publishing DTD optimized for the creation of new material, the DTD is far smaller (fewer elements and fewer choices in many contexts) than the full Journal Archiving and Interchange DTD. The philosophy for the interchange DTD was to accept as many varied forms of as many structures as possible. The philosophy of this DTD is to prefer a single structural form, or at least a single style of tagging to simplify the creation of content in XML.

Not a Strict Subset

The only element in the Publishing DTD that is not in the Archiving and Interchange DTD is the NLM Citation Model (<nlm-citation>). This citation model is more prescriptive than <citation>. This model and the extensive examples of tagged citations provided are intended to encourage the creation of citations according to NLM's guidelines.

PubMed/MEDLINE

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.

Documentation

The complete documentation for the Journal Publishing DTD is available in the tag library http://dtd.nlm.nih.gov/publishing/tag-library.

The Tag Library contains the following sections:

Introduction

An introduction to the contents of this Tag Library, to the design philosophy and intended usage of the Journal Publishing DTD.

Elements Section

Descriptions of the elements used in the Journal Publishing DTD.

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.

Full Article Samples

Two full articles are provided in both PDF form and in XML according to this DTD. These are provided to help users understand the relationship between the article as displayed and the XML version of the 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/publishing_dtd.

A direct link to the files is available: ftp.ncbi.nih.gov/pub/publishing_dtd/journal-publishing-dtd-1.1.zip and ftp.ncbi.nih.gov/pub/publishing_dtd/journal-publishing-dtd-1.1.zip.

The DTD is available on the Web: http://dtd.nlm.nih.gov/1.1/journalpublishing.dtd

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

Updates

Version

The current version of the Journal Publishing DTD is v1.1.

Version 1.1 was released on November 5, 2003. A detailed explanation 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/publishing/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

Because this DTD has been created to define incoming data for PubMed Central, NCBI will manage all updates. These updates will be based on suggestions from the XML Interchange Structure Working Group. This group advises NLM on recommended changes in and/or additions to the tag set. The first meeting of the Working Group was held on August 18, 2003. The meeting notes are available as a Word document (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

If you are creating content for PMC and have any questions or comments, please email them to publishing-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/publishing-dtd.

If you are interested in making a new version of the DTD, please see the Archiving and Interchange DTD Suite site for information about creating a new DTD from the Suite of DTD modules.

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.

Coding Examples

Examples of tables and citations using the Journal Publishing DTD are provided in this section. The citation examples illustrate fully tagged National Library of Medicine citations. The table examples demonstrate a wide array of style-compliant tables.

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.

Related DTDs

This DTD was constructed using the modules in the Archiving and Interchange DTD Suite.

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.

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: November 5, 2003