XML requirements for
CSP's NRC Research Press journals

Instructions for using this documentation

• ■ Revision history

Issue XML Requirements

• ■ Article type order
• ■ Issue metadata for continuous publication

Article XML Requirements

• ■ Journal Metadata

ID Syntaxes

• ■ Table of ID Syntaxes

File-Naming Conventions

• ■ Filenames

Full-text Examples

• ■ Full-Text Examples

DTD

• ■ DTDs currently in use

Article metadata

<article>

Element or context:

/ {the root element}, <article-categories>, <subj-group>, <subject>

For information on the order in which article types are to appear in the TOC, see Article type order

Notes

• Article XML files should declare the UTF-8 character encoding, and special characters above the ASCII set should be represented with Unicode hexidecimal entities.
• Values for @article-type are not necessarily equivalent to the paper type (publication type). Please see the chart below for which value of @article-type to use with each paper type.
• Note that, in a few cases, FACETS currently uses different values for attribute 'article-type' on <article>, or for the paper type code for <compound-subject-part>. Please see anything marked "*FACETS only" in the table below.

Requirements:

1. Set the attributes on the root element <article> as follows:
   • xml:lang — Required. Use values 'en' for English or 'fr' for French
   • xmlns:mml — Fixed value "http://www.w3.org/1998/Math/MathML"
   • xmlns:xlink — Fixed value "http://www.w3.org/1999/xlink"
   • article-type — Required. The table at the bottom of this page indicates which value for @article-type to use for each paper type
2. Set @article-type on <article> according to the paper type (see the chart below)
3. On the parent <subj-group>, use subj-group-type="paper-type".
4. Use a paper type code (see the chart, below, and the example) to represent a paper type. This code should be captured within <compound-subject-part> with attribute 'content-type' set to "code". Repeat the code on the line below within <compound-subject-part> with attribute 'content-type' set to "label"
5. Add the article paper type for the heading on the pdf using the chart below.
   • Set @subj-group-type on the parent <subj-group> element to "heading".
   • Set @xml:lang on <subj-group>.

Retired article types (as of February 22, 2024)

<article article-type="note" xml:lang="en" dtd-version="1.1" 
xmlns:mml="http://www.w3.org/1998/Math/MathML" 
xmlns:xlink="http://www.w3.org/1999/xlink" 
mlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
...
<article-categories>
...
<subj-group subj-group-type="banner" xml:lang="en"><subject>Current opinion</subject></subj-group>
<subj-group subj-group-type="banner" xml:lang="fr"><subject>Opinion courante</subject></subj-group>
<subj-group subj-group-type="paper-type">
	<compound-subject>
        <compound-subject-part content-type="code">current-opinion</compound-subject-part>
        <compound-subject-part content-type="label">current-opinion</compound-subject-part>
	</compound-subject>
</subj-group>
...
</article-categories>