Taylor & Francis Journal Article DTD User Guide

DTD User Guide (1.10.1) for DTD "Taylor & Francis Journal Article DTD" version 1.10

Main Menu Change History Introduction Topics Attributes Attributes (shared) Elements Elements (grouped) DTD

Description

This required element holds almost all of the metadata (data about data) concerning the article (most of the attributes of the <article> or <unarticle> parent elements are also metadata). This includes the journal metadata (title, issue, ISS and code numbers) and the article metadata (author, keywords and production dates).

Parent Elements

The elements listed below may directly contain this element. They are "parent" elements. Elements in referenced groups are included, up to two levels of group nesting.

Parent elements: <article> <unarticle>

Model Diagram

The DTD model for this element:

--+(sequence)
  |  
 journalcode  -- TEXT
  |  
 issn (repeatable) -- TEXT
  |  
 coden  -- TEXT
  |  
 sici (optional) -- TEXT
  |  
 pubitemid (optional) -- TEXT
  |  
 pubmedabbrev (optional) -- TEXT
  |  
 author (optional and repeatable) -- (elements)
  |  
 affiliations (optional) -- (elements)
  |  
 fundingdetails (optional) -- (elements)
  |  
 licensestatement (optional) -- (TEXT and elements)
  |  
 relatedarticle (optional and repeatable) -- (TEXT and elements)
  |  
 supplementmaterial (optional and repeatable) -- (elements)
  |  
 search (optional) -- (elements)
  |  
 production-dates  
  |  
 comment (optional and repeatable) -- TEXT
  |  
 countriesoforigin (optional) -- (elements)

DTD Definition

The DTD contains the following element and attribute definitions (note that embedded links are to definitions within the DTD page of this guide):

<!ELEMENT meta                           (journalcode, issn+, coden, sici?, pubitemid?, pubmedabbrev?, author*, 
                                              affiliations?, fundingdetails?, licensestatement?, relatedarticle*, supplementmaterial*, 
                                              search?, production-dates, comment*, countriesoforigin?)>
<!ATTLIST meta
                articleurl               CDATA  #IMPLIED 
                articlestatus            CDATA  #IMPLIED 
                colorgraphics            (yes | no)  "no" 
                contenttype              CDATA  #IMPLIED 
                firstpage                CDATA  #IMPLIED 
                inpress                  (yes | no)  #IMPLIED 
                issuenum                 CDATA  #IMPLIED 
                volumeisissue            (yes | no)  "no" 
                lastpage                 CDATA  #IMPLIED 
                elocation                CDATA  #IMPLIED 
                medlinejrnltitle         CDATA  #IMPLIED 
                pagecount                CDATA  #IMPLIED 
                partofspecissue          (yes | no)  "no" 
                pdffilename              CDATA  #IMPLIED 
                pdffilesize              CDATA  #IMPLIED 
                pdfpagecount             CDATA  #IMPLIED 
                pdfunavailable           (retracted | rights | nosource | notproduced | 
                                          notyetproduced)  #IMPLIED 
                primaryaudience          (Researcher | Professional | Librarian | Educator | 
                                          Non-specialist | Undergraduate | Consumer)  #IMPLIED 
                productid                CDATA  #REQUIRED 
                refstyle                 (Math | Chem | Med)  #IMPLIED 
                secondaryaudience        (Researcher | Professional | Librarian | Educator | 
                                          Non-specialist | Undergraduate | Consumer)  #IMPLIED 
                seq                      CDATA  #REQUIRED 
                specissuetitle           CDATA  #IMPLIED 
                volumenum                CDATA  #IMPLIED 
                seriesnum                CDATA  #IMPLIED 
                taggingstage             (final | preview | inproduction)  "final" 
               %a-group-CommonIDAttrs;>

Defined in DTD section Metadata

General Attributes (shared with other elements)

Common Optional ID Attributes (a-group-CommonIDAttrs)

Local Attributes (defined for this element alone)

Attribute: articleurl (Article Uniform Resource Locator)

Description

This attribute holds a URL (Uniform Resource Locator) that identifies the location of the article. It is not used at tagging, but may be populated by an archiving system of online publishing system.

Specification

This attribute is not required. It has text content.

DTD Definition

                articleurl               CDATA  #IMPLIED

Attribute: articlestatus

Documentation updated in version 1.6.

Description

This attribute holds information on the current status of the article within initial production. Keywords would typically include "Copyedit", "Proofread", "Staged" and "Published". This free-text attribute may be used to hold detail not indicated by taggingstage

Specification

This attribute is not required. It has text content.

DTD Definition

                articlestatus            CDATA  #IMPLIED

Attribute: colorgraphics

Description

This attribute indicates whether or not there are color graphics associated with the article. The attribute need not be used when there are none.

Specification

This attribute is required but has a default value of "no". The allowed values are "yes" and "no".

DTD Definition

                colorgraphics            (yes | no)  "no"

Attribute: contenttype

Description

This attribute holds classification details assigned during classification and used in searching.

contenttype="Research | Review-static/background"

contenttype="Review-static/background | Clinical Therapy | Research"

Specification

This attribute is not required. It has text content.

DTD Definition

                contenttype              CDATA  #IMPLIED

Attribute: firstpage

Description

This attribute contains a number that represents the page number in the issue it was originally published in that the article started on. When it is used, the lastpage attribute must also be used to record the final page in the range of pages over which the article spanned.

Specification

This attribute is not required. It has text content.

DTD Definition

                firstpage                CDATA  #IMPLIED

Attribute: inpress

Description

This attribute, when used and given the value "yes", indicates that although the article has been publishe electronically, it may not yet have been published in print.

Specification

This attribute is not required. The allowed values are "yes" and "no".

DTD Definition

                inpress                  (yes | no)  #IMPLIED

Attribute: issuenum (Issue Number)

Documentation updated in version 1.9.

Description

This attribute contains a number that represents the issue number of the journal that contains the article. The issuenum attribute must be consistent across all articles in an issue.

If the issue number is a range, the range should be expressed with a hyphen (-, U+002D), for example:

issuenum="1-2"

Supplementary issues should be numbered with the letter "S" followed by a number.

For articles yet to be assigned to a specific volume and issue, the volumenum and issuenum attributes should be populated with "preprint".

Specification

This attribute is not required. It has text content.

DTD Definition

                issuenum                 CDATA  #IMPLIED

Attribute: volumeisissue (Volume Is Issue)

Introduced in version 1.9.

Description

Some journals are numbered with only volume numbers, where each "volume" is an issue with a table of contents. These volumes do not have an issue number. However, the issuenum attribute cannot be left empty and is required for the file to pass validation and load to our online platform. For issues that have a volume number and no issue number, volumeisissue must be set to "yes" and the issuenum attribute must be set to "1". For example:

volumenum="300" issuenum="1" volumeisissue="yes"

This should render as:

Volume 300

Specification

This attribute is required but has a default value of "no". The allowed values are "yes" and "no".

DTD Definition

                volumeisissue            (yes | no)  "no"

Attribute: lastpage

Description

This attribute contains a number that represents the page number in the issue it was originally published in that the article eneded on. When it is used, the firstpage attribute must also be used to record the first page in the range of pages over which the article spanned.

Specification

This attribute is not required. It has text content.

DTD Definition

                lastpage                 CDATA  #IMPLIED

Attribute: elocation (Electronic Location)

Introduced in version 1.9.

Description

This attribute holds a page location for an article that does not have traditional page numbering. This is used, for example, in some online-only journals. When it is used, the firstpage attribute and lastpage attribute should not be used.

Specification

This attribute is not required. It has text content.

DTD Definition

                elocation                CDATA  #IMPLIED

Attribute: medlinejrnltitle (Medline Journal Title)

Description

This attribute provides the title of the journal as it appears on Medline. The implied value is "no".

Specification

This attribute is not required. It has text content.

DTD Definition

                medlinejrnltitle         CDATA  #IMPLIED

Attribute: pagecount

Description

This attribute contains a number that represents a count of the number of pages in the original published journal issue occupied by the article (in whole, or in part at both the start and end of the article).

Specification

This attribute is not required. It has text content.

DTD Definition

                pagecount                CDATA  #IMPLIED

Attribute: partofspecissue (Part Of Special Issue)

Description

If present, this attribute contains information on the special issue that the article is part of.

If this attribute is used, the specissuetitle attribute should also be used to record the title of the special issue.

Specification

This attribute is required but has a default value of "no". The allowed values are "yes" and "no".

DTD Definition

                partofspecissue          (yes | no)  "no"

Attribute: pdffilename (Portable Document Format File Name)

Documentation updated in version 1.9.

Description

This attribute contains the name of a PDF file that contains a rendition of the article. When this attribute is used, the pdffilesize attribute should also be used. The complete name of the PDF file should be given, including a lower-case file extension, for example:

pdffilename="UCST_A_456788_O.pdf"

Specification

This attribute is not required. It has text content.

DTD Definition

                pdffilename              CDATA  #IMPLIED

Attribute: pdffilesize (Portable Document Format File Size)

Documentation updated in version 1.9.

Description

This attribute contains the size of a PDF file that contains a rendition of the article. The size is a simple number that represents the size in bytes. When this attribute is used, the pdffilename attribute should also be used.

pdffilename="UCST_A_456788_O.pdf" pdffilesize="1187825"

Specification

This attribute is not required. It has text content.

DTD Definition

                pdffilesize              CDATA  #IMPLIED

Attribute: pdfpagecount (Portable Document Format Page Count)

Description

This attribute contains a number that represents a count of the pages in the PDF file that contains a rendition of the article.

Specification

This attribute is not required. It has text content.

DTD Definition

                pdfpagecount             CDATA  #IMPLIED

Attribute: pdfunavailable (Portable Document Format unavailable)

Introduced in version 1.9.

Description

This attribute indicates a reason for the absence of a PDF file for the article. This attribute should be populated if the pdffilename attribute is empty or if the PDF is not present in the article files. Possible values are:


-	retracted - The PDF has been taken down due to a retraction.


-	rights - Rights or permissions issues prevent us from making the PDF available online.


-	nosource - The PDF is known to be missing and we do not have a source to obtain the article.


-	notproduced - The article published without a PDF file.


-	notyetproduced - A PDF file is not currently available, and is expected to be added later.

Specification

This attribute is not required. The allowed values are "retracted", "rights", "nosource", "notproduced" and "notyetproduced".

DTD Definition

                pdfunavailable           (retracted | rights | nosource | notproduced | 
                                          notyetproduced)  #IMPLIED

Attribute: primaryaudience

Description

This attribute provides information on who is most likely to be interested in the article, such as a "Librarian" or "researcher". If there is no appropriate category in the list, or it is not possible to identify a primary audience, this attribute should be omitted. Note that the secondaryaudience attribute should not be used unless this attribute has already been used (and must contain a different value if it is used).

Specification

This attribute is not required. The allowed values are "Researcher", "Professional", "Librarian", "Educator", "Non-specialist", "Undergraduate" and "Consumer".

DTD Definition

                primaryaudience          (Researcher | Professional | Librarian | Educator | 
                                          Non-specialist | Undergraduate | Consumer)  #IMPLIED

Attribute: productid (Product Identifier)

Documentation updated in version 1.8.

Description

This required attribute holds the unique identifier code assigned to the "product" (the journal), which is usually a three or four letter abbreviation of its title, assigned and used by Taylor & Francis. Therefore this is currently the same as the content of the <journalcode> element. In the future the product identifier may differ from the journal code.

This attribute and its defined value is replicated in various other elements within the article.

Specification

This attribute is required. It has text content.

DTD Definition

                productid                CDATA  #REQUIRED

Attribute: refstyle (Reference Style)

Description

This attribute indicates that the references in the article should be formatted according to the conventions of "Mathematical", "Chemical" or "Medical" journal formatting.

Specification

This attribute is not required. The allowed values are "Math", "Chem" and "Med".

DTD Definition

                refstyle                 (Math | Chem | Med)  #IMPLIED

Attribute: secondaryaudience

Description

This attribute provides information on who is most likely to be interested in the article, after recognition of the primary audience (given in the primaryaudience attribute) such as a "Librarian" or "researcher". If there is no appropriate category in the list, or it is not possible to identify a Secondary audience, this attribute should be omitted. But if this attribute is used, the primaryaudience attribute must also be present, and must hold a different value.

Specification

This attribute is not required. The allowed values are "Researcher", "Professional", "Librarian", "Educator", "Non-specialist", "Undergraduate" and "Consumer".

DTD Definition

                secondaryaudience        (Researcher | Professional | Librarian | Educator | 
                                          Non-specialist | Undergraduate | Consumer)  #IMPLIED

Attribute: seq (Sequence)

Description

This required attribute holds a number that represents the sequential position of the article within the journal issue that it was originally published in. The format of this entry must be Arabic numbering only.

Specification

This attribute is required. It has text content.

DTD Definition

                seq                      CDATA  #REQUIRED

Attribute: specissuetitle (Special Issue Title)

Documentation updated in version 1.9.

Description

This attribute contains the title of the issue, if the issue is a special issue. All articles within an issue bearing an issue title must be coded consistently. When creating article XML files for an issue that has a title, ensure that all article files contain the special issue title and that the title is coded the same in each article (including spacing and the use of upper- and lower-case letters).

If this attribute is used, the partofspecissue attribute must also be given a value of "Y".

If formatting elements are required to properly capture an issue title, the <issuetitle> element should be used.

Specification

This attribute is not required. It has text content.

DTD Definition

                specissuetitle           CDATA  #IMPLIED

Attribute: volumenum (Volume Number)

Documentation updated in version 1.9.

Description

This attribute holds a number that represents the volume number of the journal that contains the issue that contains the article. The volumenum attribute must be consistent across all articles in an issue.

For articles yet to be assigned to a specific volume and issue, the volumenum and issuenum attributes should be populated with "preprint".

Specification

This attribute is not required. It has text content.

DTD Definition

                volumenum                CDATA  #IMPLIED

Attribute: seriesnum (Series Number)

Introduced in version 1.5.

Description

This attribute holds a number that represents the series number of the journal that contains the volume and issue that contains the article. This allows series number to be captured in journals that publish with series numbers.

Specification

This attribute is not required. It has text content.

DTD Definition

                seriesnum                CDATA  #IMPLIED

Attribute: taggingstage (Tagging Stage)

Introduced in version 1.6.

Description

This attribute indicates the tagging (production) stage of the article XML. The value should be used as a processing instruction to control how the article is displayed online: either as a 'final' article with PDF (normal form), as an unpaginated 'preview' article with PDF (iFirst PrEview), or as 'inproduction' (an early form of article before copyediting, typically HTML only). During early production stages should be set to inproduction, then set to final or preview when final or preview files are requested.

An option is included for preview and may be used, however when supplying XML for a PrEview request the current conventions for PrEview should still be used (volumenum="preprint" issuenum="preprint").

Specification

This attribute is required but has a default value of "final". The allowed values are "final", "preview" and "inproduction".

DTD Definition

                taggingstage             (final | preview | inproduction)  "final"