csp logo

Instructions for using this documentation

Article XML Requirements

Article Objects

ID Syntaxes

File-Naming Conventions

Full-text Examples

DTD

Article object

Math, displayed and inline equations

Element or context:

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

Requirements:

N.B. Use mathML 3.0, following the specifications at https://www.w3.org/Math/draft-spec/mathml.html

  1. Contain displayed equations within a set of <disp-formula> tags, and inline equations within <inline-formula>
  2. Include .gif images for the math, even though mathML is the preferred format. Reference the image file on attribute "altimg" on <mml:math>. Also include a <graphic> image that references the image file. Both the <mml:math> and the <graphic> must be wrapped together within <alternatives> (See the examples below)
  3. If the equation is displayed with a label, set attribute ID on <disp-formula> with a unique id of the form "eq{some number}". Put the label to the right of the mathML inside the <disp-formula> wrapper (see the example, below)
  4. For displayed equations that do not have a label, use an ID of the form "uneq{some number}"
  5. Contain inline equations within a set of <inline-formula> tags with a unique id of the form "ieq{some number}"
  6. For mathML, use the prefix "mml:" for all mathML elements and use an id of the form "m{some number}"
  7. 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.,∬u1, κ
    • 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−/−)
  8. For theorems, lemas, corollaries, postulates, and hypotheses for which there is a label and a title, enclose the entire object within <statement>. See the Examples section, below.
  9. A note on Unicode characters in math: CSP uses MathJax to render mathML online. MathJax has support for the Plane 1 Unicode characters used to represent formatted Greek (Example: &#x1d70f; or 'italic lowercase tau'). If a Plane 1 Unicode character is used to compose the PDF, ensure that the same Unicode character exists in the final XML to be uploaded to the website. If there is a problem with rendering, CSP will work with the vendor to remedy the problem.

Examples

A displayed formula

<disp-formula id="eq1">
<alternatives>
<mml:math display="block" id="m1" altimg="facets-2015-test2eq1.gif">
<mml:mrow><mml:msup><mml:mrow><mml:mi>d</mml:mi></mml:mrow><mml:mrow>
<mml:mn>1</mml:mn></mml:mrow></mml:msup><mml:mo stretchy="false">[</mml:mo>
<mml:mi>n</mml:mi><mml:mo stretchy="false">]</mml:mo><mml:mo>=</mml:mo>
<mml:munderover><mml:mrow><mml:mo>&#x02211;</mml:mo></mml:mrow><mml:mrow><mml:mi>k</mml:mi><mml:mo>=</mml:mo> <mml:mn>0</mml:mn></mml:mrow><mml:mrow><mml:mi>N</mml:mi><mml:mo>&#x02212;</mml:mo><mml:mn>1</mml:mn>
</mml:mrow></mml:munderover><mml:mi>x</mml:mi><mml:mo stretchy="false">[</mml:mo><mml:mi>k</mml:mi>
<mml:mo stretchy="false">]</mml:mo><mml:mi>h</mml:mi><mml:mo stretchy="false">[</mml:mo>
<mml:mi>n</mml:mi><mml:mo>&#x02212;</mml:mo><mml:mi>k</mml:mi><mml:mo stretchy="false">]</mml:mo>
<mml:mo>;</mml:mo><mml:mtext>&#x02009;</mml:mtext><mml:msup><mml:mrow><mml:mi>a</mml:mi></mml:mrow><mml:mrow><mml:mn>1</mml:mn> </mml:mrow></mml:msup><mml:mo stretchy="false">[</mml:mo><mml:mo>=</mml:mo><mml:munderover><mml:mrow>
<mml:mo>&#x02211;</mml:mo></mml:mrow><mml:mrow><mml:mi>k</mml:mi><mml:mo>=</mml:mo><mml:mn>0</mml:mn></mml:mrow>
<mml:mrow><mml:mi>N</mml:mi><mml:mo>&#x02212;</mml:mo><mml:mn>1</mml:mn></mml:mrow></mml:munderover><mml:mi>x</mml:mi>
<mml:mo stretchy="false">[</mml:mo><mml:mi>k</mml:mi><mml:mo stretchy="false">]</mml:mo><mml:mi>g</mml:mi>
<mml:mo stretchy="false">[</mml:mo><mml:mo>&#x02212;</mml:mo><mml:mi>k</mml:mi><mml:mo stretchy="false">]</mml:mo>
</mml:mrow></mml:math> <graphic xlink:href="facets-2015-test2eq1.gif"/></alternatives><label>(1)</label>
</disp-formula>

An inline formula

<inline-formula id="ieq1">
<alternatives>
<mml:math display="inline" id = "m5" altimg="facets-2015-test2ieq1.gif"> <mml:mrow><mml:msub><mml:mrow><mml:mover><mml:mrow><mml:mi>&#x003B1;</mml:mi>
</mml:mrow><mml:mrow><mml:mo stretchy="false">&#x002DC;</mml:mo></mml:mrow>
</mml:mover></mml:mrow><mml:mrow><mml:mi>n</mml:mi></mml:mrow></mml:msub>
<mml:mo>=</mml:mo><mml:msub><mml:mrow><mml:mi>W</mml:mi></mml:mrow>
<mml:mrow><mml:mi>n</mml:mi></mml:mrow></mml:msub><mml:mi>f</mml:mi></mml:mrow> </mml:math><inline-graphic xlink:href="facets-2015-test2ieq1.gif"/>
</alternatives>
</inline-formula>

A theorem

<statement>
<label>Statement 1.</label> <p>The error measurement chosen for comparison is the mean percentage error of the
back-casted wind data compared to the measured met tower data. The mean percentage
error (MPE) is given by<disp-formula id="eq006"><label>(6)</label><mml:math display="block" overflow="scroll" altimg="tcsme-2017-0041eq6.gif"><mml:semantics definitionURL="" encoding=""><mml:mrow><mml:mtext>MPE</mml:mtext><mml:mo>=</mml:mo><mml:mfrac><mml:mrow><mml:msubsup><mml:mo>&#x02211;</mml:mo><mml:mrow><mml:mi>t</mml:mi><mml:mo>=</mml:mo><mml:mn>0</mml:mn></mml:mrow><mml:mi>n</mml:mi></mml:msubsup><mml:mfrac><mml:mrow><mml:msub><mml:mi>X</mml:mi><mml:mi>t</mml:mi></mml:msub><mml:mo>&#x02212;</mml:mo><mml:msub><mml:mi>F</mml:mi><mml:mi>t</mml:mi></mml:msub></mml:mrow><mml:mrow><mml:msub><mml:mi>X</mml:mi><mml:mi>t</mml:mi></mml:msub></mml:mrow></mml:mfrac></mml:mrow><mml:mi>n</mml:mi></mml:mfrac></mml:mrow><mml:annotation encoding="MathType-MTEF"></mml:annotation></mml:semantics></mml:math></disp-formula> where
<italic>X<sub>t</sub></italic> is the measured (met tower) wind speed at
time <italic>t</italic>, and <italic>F<sub>t</sub></italic> is the back-casted wind
speed based on the historical MERRA-2 data and the relationship between the MERRA-2
data and the measured wind speed over the initial study interval.</p></statement>