IEEE JATS References-27Oct2016
IEEE JATS References-27Oct2016
Version 1.0
PREPARED BY
A confidential report for IEEE volunteers, staff, and content-providers October 2016
This report is the property of the Institute of Electrical and Electronics Engineers, Inc.
(IEEE). The report contains proprietary information of IEEE and is solely for the use of
IEEE Volunteers, Staff and Authorized Third-Parties. This Confidentiality and
Nondisclosure Statement and Agreement is for the purpose of protecting such
confidential information from being made available to and disclosed to unauthorized
persons.
Introduction
This guide provides general information regarding tagging of references for processing by the IEEE
Reference Validation and Management System. As with any XML submission, it is important that the
XML is fully validated prior to delivery to IEEE. The reference format used conforms to “IEEE JATS DTD
version 1.51”.
In addition readers of this guide should refer to “IEEE JATS XML Reference Samples”. This document
gives the required order of the tags and how to punctuate each type of reference. This document is
provided as a PDF file with additional hints for tagging references. It is also provided as a sample XML
file. This file should be used as the basis for creating actual references for submission to IEEE. As shown
in the PDF’s TOC an individual reference, such as a periodical, can have more or less information
associated with it. Therefore it is important that the right initial reference is chosen as the starting point.
1
For both types of references the numbering starts at 1 and ends with the total number of references
of each type 1.
In order for IEEE to process the references the following tags must be present in the XML:
<article-id pub-id-type="arnumber"></article-id>
<article-id pub-id-type="doi"></article-id>
The accompanying “IEEE JATS XML Reference Samples” shows how different kinds of references are
tagged. In both versions of the sample “IEEEEJATS XML Reference Samples” <given-names> shows only
initials. Both JATS and IEEE permit spelling out the full given name and/or middle name if desired. The
tag <label> is not displayed in IEEE Xplore.
1
Currently IEEE Xplore groups references as bibliographic or normative. It does not display the reference number.
2
Section 3. IEEE Guide to XML Reference Citation Tagging
Element Element Description Attribute Attribute values Attribute Comments Example CODINGSAMPLE(in context) IEEENOTES
<ref> One item in a Id ref1, ref2, ref3,… <refid="ref1">
bibliographic list,
typically describing a B22,B23,B24 (typical style for
referenced work. Standards)
<label> Number and/or prefix None None <label>[4]</label>
word placed at the
beginning of display <label>[B22]</label>(typical
elements, In this case for standards)
before<mixed-citation>.
<mixed- Bibliographic description publication- Periodical References to magazines <mixed-citation publication-
citation> of a work. Includes a type and journals are considered type="periodical"
combination of periodicals. publication-format="print"> ...
bibliographic reference (required) <refid="ref4">
elements and untagged <label>[4]</label>
text. Spacing and Report <mixed-citation publication- <mixed-citation publication-type="periodical"
punctuation are type="report" publication- publication-format="print">
preserved. format="print"> <person-group>
Thesis <mixed-citation publication- <string-name>
type="thesis" publication- <given-names>E.</given-names>
format="print"> <surname>Tentzeris</surname></string-name>,
Standard <mixed-citation publication- <string-name>
type="standard" publication- <given-names>R.</given-names>
format="print"> <surname>Robertson</surname></string-name>,
Manual <mixed-citation publication- <string-name>
type="manual" publication- <given-names>J.</given-names>
format="print"> <surname>Harvey</surname></string-name>,and
Confproc <mixed-citation publication- <string-name>
type="confproc" publication- <given-names>L.</given-names>
format="print"> <surname>Katehi</surname </string-name>
Confpaper <mixed-citation publication- </person-group>,“<article-
type="confpaper" title>Stabilityanddispersion
publication-format="print"> analysisofbattle-lemarie-basedMRTDschemes</article-
Patent <mixed-citation publication- title>,”
type="patent" publication- <source>IEEETrans.Microw.TheoryTech.</source>,vol.
format="print"> <volume>47</volume>,
Unpubd <mixed-citation publication- no.<issue>7</issue>,pp.<fpage>1004</fpage>–
type="unpubd" publication- <lpage>1013</lpage>,
format="other"> <month>Jul.</month><year>1999</year>.</mixed-
Software <mixed-citation publication- citation>
type="software" publication- </ref>
format="online"> ...
3
Element Element Description Attribute Attribute values Attribute Comments Example CODINGSAMPLE(in context) IEEENOTES
Other <mixed-citation publication- IEEE believes that in most cases, one
type="other "publication- of the publication-type attribute
format="other"> value should be able to be assigned
to a reference, besides "other"."
Online <mixed-citation publication- Other" should only be used when
type="online" publication- the publication-type clearly cannot
format="online"> be identified from the data provided
in a reference. Sometimes,
Book <mixed-citation publication- references have the data in wrong
type="book" publication- order, but the publication-type is
format="print"> still able to be defined. "other"
should not be used in these cases.
Dataset <mixed-citation publication- IEEE does not want "other" to be
type="dataset" publication- used as a generic catch-all for
format="online"> processing references quickly. Every
effort should be made to identify
the correct type of reference.
4
Element Element Description Attribute Attribute values Attribute Comments Example CODINGSAMPLE(in context) IEEENOTES
Allauthors Never use this value. A. If a reference clearly only has a URL,
with no information that would clearly
identify it as one of the IEEE reference
publication-types, then the publication-
type cannot be determined. In this case,
set the @publication-type attribute to
"other". Also set the @publication-
format attribute to "online."
B1. If a reference has a URL, but also has
volume/issue/page number data, then
set the @publication-type attribute to
"periodical". In this case, then set the
@publication-format attribute to
"print."
B2. If a reference has a URL, but does
not have volume/issue/page number
data, then set the @publication-format
attribute to "online". If it is impossible to
tell if the publication-type is one of the
IEEE types, then set the @publication-
type to "other".
C. If a reference does not have a URL,
nor a clear reference to a CD or other
electronic media, then set the
@publication-format attribute to
"print."
D. If a reference has specific information
about a CD, DVD or other media, then
set the @publication-format attribute to
"other." This is a rare case. The vast
majority of IEEE references will be either
"print" or "online".
publisher- Government This is only used for <label>[31]</label><mixed-
type government publications. citation publication-
format="online" publication-
type="manual" publisher-
type=”government”>
<source>FCC Codes of
Regulation, Part 15
</source>.<gov>FCC-
2016.P15</gov>.[Online].Av
ailable:<uri>http://www.acc
ess.gpo.gov/nara/cfr/waisidx
03/</uri></mixed-
citation></ref>
5
Element Element Description Attribute Attribute values Attribute Comments Example CODINGSAMPLE(in context) IEEENOTES
xml:lang 3-character ISO language code Use xml:lang only when <mixed-citationpublication-
referencing a non-English format="print"publication-
language publication. type="book"xml:lang="jpn">
<person- Container element for person- Assignee Persons to whom a patent is <person-group person- If the citation content obviously
group> one or more group-type transferred group-type="assignee"> indicates what the attribute value
contributors in a should be, please apply the appropriate
bibliographic reference. <refid="ref1"><label>[1]</label><mixed- value. If no value is apparent, please
citationpublication-type="periodical"publication- omit this attribute.
Author Content creators <person-group person-
format="print"><person-group person-group-
*frequently used value group-type="author">
type="author"><string-name><given-
Compiler Persons who put together a <person-group person- names>E.</given-names>
composite work from group-type="compiler"> <surname>Tentzeris</surname></string-
multiple sources name>,<string-name><given-names>R.</given-
Director Director <person-group person- names><surname>Robertson</surname></string-
group-type="director"> name>,<string-name><given-names>J.</given-
names><surname>Harvey</surname></string-name>,
Editor Content editors <person-group person-
and <string-name><given-names>L.</given-
group-type="editor">
names><surname>Katehi</surname></string-
guest-editor Content editors who have <person-group person- name></person-group>,“<article-title>Stability
been invited to edit all or group-type="guest-editor"> and dispersion analysis of battle-lemarie-based MRTD
part of a work schemes</article-title>,”<sourcespecific-
inventor Idea, software, or machine <person-group person- use="IEEE">IEEE Trans. Microw. Theory
creators group-type="inventor"> Tech.</source>,vol.<volume>47</volume>,no.<issue>
Transed Editors of a translated <person-group person- 7</issue>,pp.<fpage>1004</fpage>–<lpage>10
version of a work group-type="transed"> 13</lpage>,<month>Jul.</month><year>1999</year>.
</mixed-citation></ref>
Translator Persons who translated the <person-group person-
cited work from one group-type="translator">
language into another
<etal> Indicator of the presence <string-name> Please place the<etal> tag
of unnamed <prefix>Dr.</prefix> within<person-group>as this represents
contributors. Typically <given-names>Paul unnamed people.
indicated in print with M.</given-names>
the text “etal.” Or with <surname>Starbuck</surna <person-group person-group-type="author"><string- If there are 6 or more authors, after the
an ellipsis. me> name><given-names>A.</given-names> first author, use <etal> and remove all
<suffix>Jr.</suffix> <surname>Furuskar</surname></string-name> other author names.
</string-name> </person-group><etal></etal>,
6
Element Element Description Attribute Attribute values Attribute Comments Example CODINGSAMPLE(in context) IEEENOTES
<string-name> Container element for name-style western "western" is the default
personal names eastern value.
captured with mixed- given-only
content where the order islensk "eastern" Is used for native,
of the name non-Latin, Asian names, in
components is not Asian characters.
enforced.
"given-only" is used when
the language origin is
unknown
7
Element Element Description Attribute Attribute values Attribute Comments Example CODINGSAMPLE(in context) IEEENOTES
<series> Series information about content- series-title These attribute values are <refid="ref35">
a journal or book in a type series-number the most common. Please <label>[35]</label>
bibliographic reference volume-title contact IEEE if any other <mixed-citationpublication-format="print"publication-
or product. types are encountered. type="book"><person-groupperson-group-
Remarks type="author"><string-name><given-
names>A.</given-
names><surname>Taflove</surname></string-
name></person-group>,<sourcecontent-
type="volume-title">Computational Electrodynamics:
The Finite-Difference Time-Domain
Method</source>.in<series
content-type="series-title">Computational
Electrodynamics</series>,<series content-
type="series-number">II</series>,
vol.<volume>3</volume>, <edition>2</edition>nd ed.,
<publisher-loc>Norwood, MA</publisher-loc>:
<publisher-name>Artech House</publisher-name>,
<year>1996</year>.</mixed-citation>
</ref>
<volume> Number of a journal (or none To tag "volume-title" please refer to the
other document) within sample used in<source>. The "volume-
a series. title" refers to the special title given to a
single volume of a series.
8
Element Element Description Attribute Attribute values Attribute Comments Example CODINGSAMPLE(in context) IEEENOTES
<lpage> Page number on which a none Trans. Microw. Theory Tech.</source>,vol.
document ends. <volume>47</volume>, no.<issue>7</issue>,
pp.<fpage>1004</fpage>–<lpage>1013</lpag
e>,
<month>Jul.</month><year>1999</year>.</mixed-
<month> Names one of the none citation></ref> Please capture the month and year from
months of the year. the source reference as the author
provided. The ISO-8601-date attribute,
while required in article metadata,
should not be used in references.
<year> Numerical, 4-digit year. none
9
Element Element Description Attribute Attribute values Attribute Comments Example CODINGSAMPLE(in context) IEEENOTES
<conf-date> As part of a bibliographic none Please refer to the ISO3166-12- <conf-date>Oct. </string-name>,<string-name> The iso-8601-date attribute is not used
reference (<mixed- upper-case letter alphabetic 5–8,2010</conf- <given-names>G.</given-names> within the<conf-date>if it is
citation>), the date(s) on country code list. date> <surname>Toso</surname></string- within<mixed-citation>.
which a conference was name>,and<string-name>
held. <given-names>P.</given-names>
<surname>Angeletti</surname>
</string-name>
</person-group>,”<article-title>Analytical
placement technique for sparse arrays</article-title>,
” presented at the<conf-name> 32nd ESA
Antenna Workshop</conf-name>,<conf-
loc>Noordwijk, The Netherlands</conf-loc>,<conf-
date>Oct. 5–8,2010</conf-date>.</mixed-
citation>
</ref>
<patent> Identification country <patent <refid="ref25"><label>[25]</label><mixed-citation For country codes please refer to the
information for a patent country="usa">U.S.Patent35 publication-type="patent" publication- ISO3166-1, alpha-3(three-letter country
in a bibliographic 94806</patent> format="print"><person-group person-group- codes)
reference or product. type="inventor"><string-name><given-
names>W.W.</given-
names><surname>Black</surname></string-
name>and<string-name><given-names>A.</given-
names><surname>Clavin</surname></string-
name></person-group>,“<article-title>Dipole
Augmented Slot Radiating Element</article-
title>,”<patent country="usa">U.S. Patent
3594806</patent>,<month>Jul.</month><year>1971<
/year>.</mixed-citation></ref>
10
Element Element Description Attribute Attribute values Attribute Comments Example CODINGSAMPLE(in context) IEEENOTES
<pub-id> Identifier of a pub-id-type Note: The first 3 values on this list arnumber: Article number <refid="ref29"><label>[29]</label><mixed-citation When a reference includes a DOI, please
publication cited in a are the most commonly used. The from a particular Society (for publication-format="print"publication- use<pub-id> to capture it. Do not
bibliographic reference other values are only rarely used. example, an LMAG article type="periodical"><person-group person-group- use<object-id>.The IEEE Tag Library does
or as part of information number) type="author"><string-name><given- show an example where<object-id>is
about a related article or arnumber names>E.</given- used, but this will be corrected in the
reviewed product. doi doi: DOI( Digital Object names><surname>Tentzeris</surname></string- future.
std-designation Identifier) name>,<string-name><given-names>R.</given-
names><surname>Robertson</surname></string-
art-access-id paper-number: An article name>,<string-name><given-names>J.</given-
articleid identification number from names><surname>Harvey</surname></string-
artid an entity other than IEEE name>,and<string-name><given-names>L.</given-
arxiv Publishing Operations, used names><surname>Katehi</surname></string-
csfilenumber to identify another article or name></person-group>,“<article-title>Mutual
coden another version of an article. Coupling Effects for Radar Cross Section (RCS) of a
doaj The paper number will be Seriesfed Dipole Antenna Array,</article-
inspec printed on the last line in an title>”<source>International Journal of
isbn abstract. (Within<related- Antennas and Propagation</source>,ArticleID<pub-id
issid article>, IEEE will use <pub- pub-id-type="arnumber">601532</pub-
lccn id pub-id-type="paper- id>,pp.<fpage>20</fpage>–<lpage>30</lpage>
manuscript number"> to identify the ,<month>August</month><year>2012</year>.</mixe
medline article ID from the d-citation></ref>
other conference in which an
paper-number article originally appeared.).
pii
pmcid std-designation: Number
pmid of a national, international,
pub-id or industry standard.
publisher-id
sici
11
Element Element Description Attribute Attribute values Attribute Comments Example CODINGSAMPLE(in context) IEEENOTES
<uri> This identifies a Uniform <uri>http://www.access.gpo If <uri> is the final element in </mixed-
Resource Indicator (such .gov/nara/cfr/waisidx03/ citation> do not include a single period
as a URL) that may be </uri> before </mixed-citation>.
used as a live link,
typically naming a
website, such as:
<uri>http://www.ieee.org
</uri>).
12
Element Element Description Attribute Attribute values Attribute Comments Example CODINGSAMPLE(in context) IEEENOTES
<date-in- Non-publication date Accessed:<date-in-citation>
citation> used within a <month>Nov.</month>
bibliographic reference. <year>2010</year>
</date-in-citation>
<gov> Container element for <gov>NASA Technical
the identification Memorandum 85033</gov>
information (typically
the title and/or an
identification number)
for a cited governmental
report or other
government publication.
13
Section 4. Packaging
Two types of reference deliveries can be made.
• The first is references only. In this case the references should be packaged as described in “Reference Only
Delivery” below.
• The second is as part of a “Content Delivery XML” submission. In this case the references should be
packaged as described in “Content Delivery XML” below.
14