XML requirements for
CSP's NRC Research Press journals

Instructions for using this documentation

■ Revision history

Article XML Requirements

■ Journal Metadata

▼ Article Objects ▲

ID Syntaxes

■ Table of ID Syntaxes

File-Naming Conventions

■ Filenames

DTD

■ DTDs currently in use

Article object

Math, displayed and inline equations

Element or context:

<disp-formula>, <inline-formula>, <mml:math>

Requirements:

NOTE: Until further notice from CSP and effective 16 May 2018, comment out the the <alternatives> tags and all mathML per the example below. The purpose of this is that we will be gradually phasing in full-text mathML, which means that CSP will be selectively displaying the mathML online in the future.

Contain displayed equations within a set of <disp-formula> tags with a unique id of the form "eq{some number}"
Contain inline equations within a set of <inline-formula> tags with a unique id of the form "ieq{some number}"
Within <disp-formula> or <inline-formula>, use a set of <alternatives> tags to contain both the mathML and math graphics (.gifs). For all mathML elements, use the prefix "mml:" See note, above.
If a displayed equation has a label (e.g., "Eq. 1"), then contain the label within a <label>, and place it either at the beginning of the contents of the <disp-formula> element, before <alternatives> (all journals except for cjp), or just before the closing </disp-formula> tag (cjp only); note that label should include any punctuation, parentheses, or brackets required)
For math .gifs, the following two requirements apply:
- Reference the .gif file using a <graphic> element with the attribute 'xlink:href' set to the name of the math .gif file
- Set the attribute 'altimg' of <mml:math> to the exact name of the math .gif file referenced in <graphic>
Do NOT apply mathML to any of the following, because they are not math (use regular characters with or without Unicode instead):
- Units of measure (e.g., 43.2 ± 6.5 mL/kg)
- Single characters or combinations of characters that are not part of a math expression e.g.,∬u¹, κ
- Symbols that have Greek in them (unless they are part of an equation)
- Expressions of probability (e.g., p < 0.5)
- Genotypes and phenotypes (e.g., CypD^−/−)

Examples

A displayed formula

<disp-formula id="eq3">
   <label>[Eq. 3]</label>
   <!--<alternatives>-->
   <graphic xlink:href="p2012-039eq3.gif"/>
   <!--<mml:math id="m70" altimg="p2012-039eq3.gif" display="block" overflow="scroll">
   ...
   </mml:math>
   </alternatives>-->
 </disp-formula>

An inline formula

<inline-formula id="ieq1">
<!--<alternatives>-->
<inline-graphic xlink:href="p2012-039ieq1.gif"/>
<!--<mml:math id="m2" altimg="p2012-039ieq1.gif">
...
</mml:math>
</alternatives>-->
</inline-formula>

XML requirements forCSP's NRC Research Press journals