Enscribe
Emphasis & marking

Marks the author places on their own words — emphasis and the small typographic and semantic marks.

<abbr> Specification

category inline-formatting · eHTML <abbr> · JATS <abbrev> · content prose<children>

attribute kind values / default notes
title kwarg The abbreviation’s expansion.

Produced by: canonical <abbr>.

Examples The <abbr title="Document Object Model" | DOM> is the browser API for HTML.

The DOM is the browser API for HTML.

Minipage 4.

Standard pattern — abbreviation with its expansion as the title kwarg. Browsers show the expansion in a hover tooltip.

Using <abbr | CSS> selectors.

Using CSS selectors.

Minipage 5.

Bare abbreviation, no title. Acceptable when the expansion has already been introduced earlier in the document.

<b> Specification

category inline-formatting · eHTML <b> · JATS <bold> · content prose<children>

attribute kind values / default notes
type kwarg keyword product-name lead offset other

Produced by: canonical <b>, markdown **…**.

Examples The keyword <b type=keyword | recursion> is fundamental.

The keyword recursion is fundamental.

Minipage 6.
Use <b type=product-name | Acrobat> to read the file.

Use Acrobat to read the file.

Minipage 7.
<em> Specification

category inline-formatting · eHTML <em> · JATS <italic> · content prose<children>

No kwargs or boolean flags.

Produced by: canonical <em>.

Examples This has *emphasized* content.

This has emphasized content.

Minipage 8.

Plain markdown with single asterisks (or single underscores) produces the visual <i>, not the semantic <em> — markdown emphasis maps to the visual tag. <em> is reached only by the explicit form.

<em | emphasized>
emphasized
Minipage 9.

The explicit form is reached for when attributes are needed.

<em #key-term .highlighted | distinguishing feature>
distinguishing feature
Minipage 10.
<i> Specification

category inline-formatting · eHTML <i> · JATS <italic> · content prose<children>

attribute kind values / default notes
type kwarg foreign taxonomic technical thought ship-name other Optional classification of the italic’s role.

Produced by: canonical <i>, markdown *…* (or _…_).

Examples The species is <i type=taxonomic | Loxodonta africana>.

The species is Loxodonta africana.

Minipage 11.
The French <i type=foreign | tour de force> is impressive.

The French tour de force is impressive.

Minipage 12.
The technical term <i type=technical | mitochondria> refers to organelles.

The technical term mitochondria refers to organelles.

Minipage 13.
<kbd> Specification

category inline-formatting · eHTML <kbd> · JATS <(no direct JATS counterpart; HTML-native)> · content prose<children>

No kwargs or boolean flags.

Produced by: canonical <kbd>.

Examples Press <kbd | Ctrl+C> to copy.

Press Ctrl+C to copy.

Minipage 14.

Single chord as a kbd block. Browsers render <kbd> in a monospace font by default, distinguishing it from surrounding prose.

Press <kbd | <kbd | Ctrl>+<kbd | C>> to copy.

Press Ctrl+C to copy.

Minipage 15.

Nested <kbd> distinguishes individual keys in a chord. Browsers render the outer block as the chord and the inner blocks as individual keys, both monospace.

<output> Specification

category inline-formatting · eHTML <output> · JATS <(no direct JATS counterpart; HTML-native)> · content prose<children>

No kwargs or boolean flags.

Produced by: canonical <output>.

Examples The function returns <output | 42> for the test input.

The function returns 42 for the test input.

Minipage 16.

Result of a calculation in prose. <output> is semantically distinct from <samp> — <samp> is what a program prints (a display artifact); <output> is the result of a computation (a semantic value). Browsers render both similarly.

<s> Specification

category inline-formatting · eHTML <s> · JATS <strike> · content prose<children>

attribute kind values / default notes
type kwarg outdated retracted deleted other

Produced by: canonical <s>, markdown ~~…~~.

Examples The price is ~~$50~~ now $40.

The price is ~~40.

Minipage 17.

GFM’s tilde syntax produces <s> elements. The most common authoring path for casual strikethrough.

The claim <s type=retracted | was unsupported> has been corrected.

The claim was unsupported has been corrected.

Minipage 18.
<samp> Specification

category inline-formatting · eHTML <samp> · JATS <(no direct JATS counterpart; HTML-native)> · content prose<children>

No kwargs or boolean flags.

Produced by: canonical <samp>.

Examples The command prints <samp | Hello, world!> to stdout.

The command prints Hello, world! to stdout.

Minipage 19.

Sample output from a program. Browsers render <samp> in a monospace font by default, distinguishing it from surrounding prose.

Set <var | threshold> to <samp | 0.05>.

Set threshold to 0.05.

Minipage 20.

<samp> for the sample value paired with <var> for the variable name — the natural pair for documenting configuration in technical writing.

<strong> Specification

category inline-formatting · eHTML <strong> · JATS <bold> · content prose<children>

No kwargs or boolean flags.

Produced by: canonical <strong>.

Examples This is **strongly emphasized** content.

This is strongly emphasized content.

Minipage 21.

Plain markdown with double asterisks (or double underscores) produces the visual <b>, not the semantic <strong> — markdown emphasis maps to the visual tag. <strong> is reached only by the explicit form.

<strong | important>
important
Minipage 22.
<strong #critical .warning | This is critical.>
This is critical.
Minipage 23.
<sub> Specification

category inline-formatting · eHTML <sub> · JATS <sub> · content prose<children>

No kwargs or boolean flags.

Produced by: canonical <sub>.

Examples Water is H<sub | 2>O.

Water is H2O.

Minipage 24.
The vector x<sub | i> represents the i-th component.

The vector xi represents the i-th component.

Minipage 25.
<sup> Specification

category inline-formatting · eHTML <sup> · JATS <sup> · content prose<children>

No kwargs or boolean flags.

Produced by: canonical <sup>.

Examples The 1<sup | st> edition of the work.

The 1st edition of the work.

Minipage 26.
The function f(x) = x<sup | 2>.

The function f(x) = x2.

Minipage 27.
The isotope <sup | 12>C is abundant.

The isotope 12C is abundant.

Minipage 28.
<term> Specification

category inline-formatting · eHTML <term> · JATS <named-content> · content prose<children>

No kwargs or boolean flags.

Produced by: canonical <term>.

Examples An <term | eigenvector> is a non-zero vector that scales under a linear transformation.

An eigenvector is a non-zero vector that scales under a linear transformation.

Minipage 29.

Standard term introduction. The element marks the word as “this is a term being introduced,” typically rendered in italic or bold by default CSS.

An <term #term:eigenvector | eigenvector> is a non-zero vector that scales under a linear transformation. Later we generalize <term | eigenvector>s to operators.

An eigenvector is a non-zero vector that scales under a linear transformation. Later we generalize eigenvectors to operators.

Minipage 30.

First introduction carries an id so later references can link back to it. Subsequent uses of the same term (without an id) still mark it as a term being referenced, distinct from running prose, without re-asserting the introduction.

<u> Specification

category inline-formatting · eHTML <u> · JATS <underline> · content prose<children>

attribute kind values / default notes
type kwarg misspelling proper-name editorial-correction other

Produced by: canonical <u>.

Examples The author wrote <u type=misspelling | recieve> in the original.

The author wrote recieve in the original.

Minipage 31.
The Chinese name <u type=proper-name | 王明> appears here.

The Chinese name 王明 appears here.

Minipage 32.
<var> Specification

category inline-formatting · eHTML <var> · JATS <(no direct JATS counterpart; HTML-native)> · content prose<children>

No kwargs or boolean flags.

Produced by: canonical <var>.

Examples The function takes a parameter <var | n> and returns <var | n>²+1.

The function takes a parameter n and returns n²+1.

Minipage 33.

Variable names in prose. Browsers render <var> in italic by default, distinguishing it from surrounding prose.

Set <var | threshold> to <samp | 0.05>.

Set threshold to 0.05.

Minipage 34.

<var> for the variable name and <samp> for a sample value — the natural pair for documenting configuration in technical writing.