2.1 Generic Text and Formatting Elements
2.1 SECTIONS: Heading | Paragraph | Note
Description:Subelements: Tagging Example 1:Use judgment in deciding when to place punctuation in an encoded document and when to let a stylesheet supply the punctuation; see the Application Guidelines for further guidance.
Remember that finding aids viewed externally using a different stylesheet or HTML encoding scheme may not supply the punctuation your internal stylesheet does, and determine whether this is an acceptable risk. Also remember that if some finding aids include the punctuation and others supply by stylesheet, it will be difficult to program the HTML transformation consistently to avoid double punctuation where it is already present.
If container lists are created in a database, it is more logical to assume that commas don't need to be included. If the document already exists in a word processing format, the commas are already present and extra work is required to strip them out. If in doubt, omit punctuation.
Whitespace outside the element for inline title element
in ...</p>
The publication of A Walk in the Woods in 1996 resulted in ...Tagging Example 2:
Punctuation outside the element for inline <emph> element
On the good ship Lollipop, life was easy.Tagging Example 3:
Period included at end of inline <title> element as required by editorial practice
Shirley Jackson wrote "The Lottery."Comments:
- Put whitespace outside the element for inline element. See Example 1.
- Put punctuation outside the element for inline element. See Example 2.
- Include punctuation at end of inline element when editorial practice dictates. See Example 3.
2.1.1 Heading
Tag:Description:<head>
- Headings are used to identify blocks of text within a finding aid for display and navigation (where <head> is not available, the label attribute is used to identify text but not to aid in navigation).
- Heads always appear as the first subelement within a section of text, and should be used to ensure that a direct link to that section is included in the navigator or table of contents for the finding aid.
- Heads are not used within components in the <dsc>; in that instance, <unittitle> elements for components with LEVEL attribute set to "series" or "subseries" may be pulled into the navigation frame.
Heads provided for both Administrative Information section and provenance paragraph
<head>Administrative Information</head>
<acqinfo encodinganalog="541">
<head>Provenance</head>
<p>
The papers of Susan Q. Archivista, archivist and philanthropist, were
given to the Library of Congress by Josiah Quincy and Sally Rae
Archivista in 1978. An addition to the collection includes items
purchased by the Library in 1998.
</p>
</acqinfo>
</descgrp>
Heads provided for both Administrative Information section and provenance paragraph
Archivista Papers | Administrative Information
*Collection Summary |
*Administrative Information | Provenance
*Provenance | The papers of Susan Q. Archivista,
| archivist and philanthropist, were
| given to the Library of Congress
| by Josiah Quincy and Sally Rae
| Archivista in 1978. An addition
| to the collection includes items
| purchased by the Library in 1998.
Display of heads in navigator illustrated: provenance head is subordinate to that for <descgrp>
Comments:Repeatable: noHeadings are illustrated for each element for which they are valid.
Order: first element within any section where valid
Revision Date: 05/07/03
2.1.2 Paragraph
Description:Tagging Example 1:The paragraph element is an important structural element within EAD. It must be used within many elements before text can be inserted, and can be used to format text within those elements into one or multiple units. Within paragraph, many other elements are available for use within text, including reference and linking elements, formatting elements, controlled access elements, and some <did> subelements.
Paragraph used within <separatedmaterial>; linking and controlaccess elements available within <p>
<p>An extensive collection of additional Olmsted Associates
records, including graphic material related to this collection, is
located at the Frederick Law Olmsted National Historical Site in
Brookline, Massachusetts. Records for the period 1870-1910 also are
included in the Subject File of the <archref href="&eadmss.ms001019;" show="new" actuate="onload"><origination>Frederick Law Olmsted</origination>
Papers </archref> in the Library of Congress.</p>
</separatedmaterial>
Paragraph used within <separatedmaterial>; linking and controlaccess elements available within <p>
An extensive collection of additional Olmsted Associates records, including graphic material related to this collection, is located at the Frederick Law Olmsted National Historical Site in Brookline, Massachusetts. Records for the period 1870-1910 also are included in the Subject File of the Frederick Law Olmsted Papers in the Library of Congress.Tagging Example 2:
Less detailed tagging: published titles tagged with <title> and no attribute. Single and double quotes from keyboard used rather than <title> tagging for names of poems and <emph> for Hoosier poet.
James Whitcomb Riley was born in Greenfield, Indiana, and is known as
the "Hoosier poet." He was on the staff of the <title>Indianapolis
Journal, </title> 1877-1885, and his contributions to that newspaper
established his fame as a poet. Typescript poems in the papers include
"The Name of Old Glory," "The Lisper," "The Young Old Man," and "At
'The Literary.' "
</p>
Display is identical with that of Example 3
James Whitcomb Riley was born in Greenfield, Indiana, and is known as the "Hoosier poet." He was on the staff of the Indianapolis Journal, 1877-1885, and his contributions to that newspaper established his fame as a poet. Typescript poems in the papers include "The Name of Old Glory," "The Lisper," "The Young Old Man," and "At 'The Literary.'"Tagging Example 3:
More detailed tagging: published titles tagged with <title> and render attribute. Double quotes from keyboard deleted in favor of <title> tagging for names of poems and <emph> for Hoosier poet.
James Whitcomb Riley was born in Greenfield, Indiana, and is known as
the <emph render="doublequote">Hoosier poet.</emph> He was on the staff of
the <title render="italic">Indianapolis Journal</title>, 1877-1885,
and his contributions to that newspaper established his fame as a
poet. Typescript poems in the papers include <title render="doublequote">
The Name of Old Glory, </title> <title render="doublequote">The
Lisper, </title> <title render="doublequote">The Young Old Man,</title> and
<title render="doublequote">At <emph render="singlequote">The Literary.</emph>
</title>
</p>
Display is identical with that of Example 2
James Whitcomb Riley was born in Greenfield, Indiana, and is known as the "Hoosier poet." He was on the staff of the Indianapolis Journal, 1877-1885, and his contributions to that newspaper established his fame as a poet. Typescript poems in the papers include "The Name of Old Glory," "The Lisper," "The Young Old Man," and "At 'The Literary.'"Comments:
- Although paragraphs can be used in many places on their own, be sure to encode the text as specifically as is appropriate for consistency in display and retrieval. For example, you may need to use <note><p> rather than <p> alone.
- Titles (such as titles of published works) are among the data and elements found with paragraphs. By standard practice at LC and elsewhere, an encoded <title> displays as italic unless otherwise specified. See Example 2.
- Titles of unpublished works and other titles customarily given in double quotes may be handled in one of two ways: they need not be encoded as titles, and keyboarded double quotes ("") may be retained in the XML document. Single and double quotation marks may be keyboarded in rather than using the Unicode numeric character references such as ' (left single quote) and ” (right double quote.) See Example 2.
- Alternately, one may explicitly encode <title render="italic"> for published titles and <title render="doublequote"> for unpublished or other quoted titles. See Example 3. Although the second alternative is most precise, it need not be considered if there is no anticipated use of the <title> tag for searching or building a browse list of titles.
Revision Date: 05/24/04
2.1.3 Note
Tag:Description:<note>
See Also:The <note> element is available in many places as explanatory text. This element is used for supplementary data such as footnotes and should not be used when more specific elements are available.
Encoding Analog:Section 3.3.1.9, Note (within high-level <did>) Go to Section
Other Attributes:500$a
Subelements:Use as appropriate when notes should appear as footnotes, endnotes, or linked notes:
- actuate="onload" or "onrequest"
- type="footnote" or "endnote"
- show="embed" or "new"
See Tag Library for full list of attributes and their values.
Tagging Example 1:
- <p>
See Tag Library for full list of valid subelements.
Note is short explanatory text; no special display required
<did>
<unittitle encodinganalog="245$a">Diary, author unknown</unittitle>
<note encodinganalog="500">
<p>
A study of this item in 1982 concluded that it came from the Shaker
community at Union Village, Ohio, and not Pleasant Hill.
</p>
</note>
</did>
</c02>
Note is short explanatory text; no special display required
Diary, author unknown A study of this item in 1982 concluded that it came from the Shaker community at Union Village, Ohio, and not Pleasant Hill.Comments:
- The display of notes as footnotes or endnotes may be controlled by use of the ACTUATE and SHOW attributes which control linking behavior. Setting the TYPE attribute as "footnote" or "endnote" may facilitate the placement of the notes by the stylesheet used for printing.
Revision Date: 05/07/03