<annotation>

Annotation

Definition

An inline or block-level addition to the text of a work, added after the work was printed. This may be added historically, such as a penciled note in the margin, or added by an editor during the preparation of the digital edition. An <annotation> has textual content, that is, it adds words to the work, it does not merely surround words already on the printed page.

Remarks

For the purposes of the NCBI Historical DTD, annotations of historical material are considered to be of two types: 1) those with content (that is, those that add words to the text, for example, a penciled marginal note) and 2) those that merely decorate words already in the text (for example, a phrase underlined in pencil). Text-bearing annotations are tagged with either the <alt-term> element (which provide alternatives to words or phrases) or the <annotation> element (which contains words added to the printed text and which may be used at the inline or block-level). By contrast, decorations use the <named-content> element with the attribute content-type taking a value such as “pencil underline” or “yellow highlight”.

In the NCBI Book Suite, the <annotation> element is only used within citations. In the NCBI Historical DTD, it is a block-level element at the same level as a paragraph as well as an inline-element inside textual passages. New attributes were added to <annotation> to describe some of these new roles/purposes.

Attributes

agent Agent
content-type Type of Content
time-frame Time Frame
xlink:actuate Actuating the Link
xlink:href Href (Linking Mechanism)
xlink:role Role of the Link
xlink:show Showing the Link
xlink:title Title of the Link
xlink:type Type of Link
xmlns:xlink XLink Namespace Declaration

Related Elements

This element is not related to the MathML <annotation> element, which is a mathematical term only used with equations.

Model Information

Content Model

<!ELEMENT  annotation   ((%just-para.class;)+)                       >

Description

Any one of:

Tagged Examples

Example 1

For a historical note describing text:


...
<body>
<annotation agent="Amanda Reyes" content-type="Historical
Note">
<p>This text is a description of the
Friends Asylum by Robert Waln, Jr.. The author
lived from 1794 to 1825, and came from a
prominent Philadelphia Quaker family. He is
best known for his writings and research on
China. The text originally appeared in the
<italic>Philadelphia Journal of the Medical
and Physical Sciences</italic>, which later
became the <italic>American Journal of Medical
Sciences</italic>, and continues to be in
publication.</p>
...
</annotation>
...
</body>
...

Example 2

For handwritten notes added to text:


...
<sec>
<title>
<page-start></page-start>half-title page</title>
<annotation xmlns:xlink="http://www.w3.org/1999/xlink"
xlink:type="simple" content-type="handwritten">
<p>
<preformat xml:space="preserve">Med. Hist.
WX
W217a
1825
c.1.</preformat>
<preformat xml:space="preserve">
<strike>WX
28
AP4
F8A8W
1825
c.1</strike>
</preformat>
</p>
<p>SKERRETT&mdash; LOCUST STREET;</p>
<p>PHILADELPHIA.</p>
</annotation>
</sec>
...

Module

references.ent