Module Documentation: eml-text

Back to EML Contents

The eml-text module - Text field formatting

The eml-text module is a wrapper container that allows general text descriptions to be used within the various modules of eml. It can include either structured or unstructured text blocks. It isn't really appropriate to use this module outside of the context of a parent module, because the parent module determines the appropriate context to which this text description applies. The eml-text module allows one to provide structure to a text description in order to convey concepts such as sections (paragraphs), hierarchy (ordered and unordered lists), emphasis (bold, superscript, subscript) etc. The structured elements are a subset of

DocBook

so the predefined DocBook stylesheets can be used to style EML fields that implement this module.

Module details

Recommended Usage: any module
Stand-alone: no
Imports: eml-documentation, http://www.w3.org/2009/01/xml
Imported By:
View an image of the schema: eml-text image

Element Definitions:

text 

This element has no default value.
Content of this field: Description of this field:
Type: TextType
The "text" element allows for both formatted and unformatted text blocks to be included in EML. It can contain a number of relevant subsections that allow the use of titles, sections, and paragraphs in the text block. This markup is a subset of DocBook.

section 

This element has no default value.
Content of this field: Description of this field:
Type: SectionType
The "section" element allows for grouping related paragraphs of text together, with an optional title. This markup is a subset of DocBook.

para 

This element has no default value.
Content of this field: Description of this field:
Type: ParagraphType
The "paragraph" element allows for both formatted and unformatted text blocks to be included in EML. It can be plain text or text with a limited set of markup tags, including emphasis, subscript, superscript, and lists. This markup is a subset of DocBook.

value 

This element has no default value.
Content of this field: Description of this field:
Type: i18nString
Language translation as specified by the xml:lang attribute

itemizedlist 

This element has no default value.
Content of this field: Description of this field:
Type: ListType
A list of items in a text paragraph. The list is generally displayed as a bulleted list. This markup is a subset of DocBook.

orderedlist 

This element has no default value.
Content of this field: Description of this field:
Type: ListType
An ordered list of items in a text paragraph. The list is generally displayed as a numbered list. This markup is a subset of DocBook.

emphasis 

This element has no default value.
Content of this field: Description of this field:
Elements: Use: How many:
A sequence of (
valueoptionalunbounded
)
Attributes: Use: Default Value:
xml:lang
A span of emphasized text in a paragraph. Emphasized text is generally rendered as boldfaced or otherwise distinct from the surrounding text. This markup is a subset of DocBook.

value 

This element has no default value.
Content of this field: Description of this field:
Type: i18nString

subscript 

This element has no default value.
Content of this field: Description of this field:
Type: SubSuperScriptType
A subscript in a text paragraph. This markup is a subset of DocBook.

superscript 

This element has no default value.
Content of this field: Description of this field:
Type: SubSuperScriptType
A superscript in a text paragraph. This markup is a subset of DocBook.

literalLayout 

This element has no default value.
Content of this field: Description of this field:
Elements: Use: How many:
A sequence of (
valueoptionalunbounded
)
This element specifies that the structure of the text within the tag, specifically the whitespace, should not be altered.

value 

This element has no default value.
Content of this field: Description of this field:
Type: i18nString

ulink 

This element has no default value.
Content of this field: Description of this field:
Elements: Use: How many:
A sequence of (
citetitlerequired
)
Attributes: Use: Default Value:
urloptional
this element and its children allow paragraphs to contain urls and titles for anchor tags. This markup is a subset of DocBook.

citetitle 

This element has no default value.
Content of this field: Description of this field:
Type: i18nString
the citetitle element contains a text title for the url. It can be displayed in an anchor tag. This markup is a subset of DocBook.
Example(s):
The Dublin Core Metadata Initiative

title 

This element has no default value.
Content of this field: Description of this field:
Type: i18nString
The optional title for a section. This markup is a subset of DocBook.

para 

This element has no default value.
Content of this field: Description of this field:
Type: ParagraphType
The "paragraph" element allows for both formatted and unformatted text blocks to be included in EML. It can be plain text or text with a limited set of markup tags, including emphasis, subscript, superscript, and lists. This markup is a subset of DocBook.

section 

This element has no default value.
Content of this field: Description of this field:
Type: SectionType
The "section" element allows for grouping related paragraphs of text together, with an optional title. This markup is a subset of DocBook.

listitem 

This element has no default value.
Content of this field: Description of this field:
Elements: Use: How many:
A choice of (
pararequired
OR
itemizedlistrequired
OR
orderedlistrequired
)
An item in a list of items. Each list item is formatted as a bulleted or numbered item depending on the list type in which it resides. List items contain paragraphs which in turn can be plain text or text with a limited set of markup tags, including emphasis, subscript, superscript, and lists. This markup is a subset of DocBook.

para 

This element has no default value.
Content of this field: Description of this field:
Type: ParagraphType
The "paragraph" element allows for both formatted and unformatted text blocks to be included in EML. It can be plain text or text with a limited set of markup tags, including emphasis, subscript, superscript, and lists. This markup is a subset of DocBook.

itemizedlist 

This element has no default value.
Content of this field: Description of this field:
Type: ListType
A list of items in a text paragraph. The list is generally displayed as a bulleted list. This markup is a subset of DocBook.

orderedlist 

This element has no default value.
Content of this field: Description of this field:
Type: ListType
An ordered list of items in a text paragraph. The list is generally displayed as a numbered list. This markup is a subset of DocBook.

value 

This element has no default value.
Content of this field: Description of this field:
Type: i18nString
Language translation as specified by the xml:lang attribute

subscript 

This element has no default value.
Content of this field: Description of this field:
Type: SubSuperScriptType
A subscript in a text paragraph. This markup is a subset of DocBook.

superscript 

This element has no default value.
Content of this field: Description of this field:
Type: SubSuperScriptType
A superscript in a text paragraph. This markup is a subset of DocBook.

Attribute Definitions:

xml:lang

xml:lang

url

Use: optional

the url attribute contains the location of the work for a link. This markup is a subset of DocBook.
Example(s):
url="http://dublincore.org/documents/usageguide/"

xml:lang

xml:lang

xml:lang

xml:lang

Specifies the language
Example(s):
xml:lang="en-US"

Complex Type Definitions:

TextType 

Content of this field: Description of this field:
Elements: Use: How many:
A choice of (
sectionoptionalunbounded
OR
paraoptionalunbounded
)
Attributes: Use: Default Value:
xml:lang
The "text" element allows for both formatted and unformatted text blocks to be included in EML. It can contain a number of relevant subsections that allow the use of titles, sections, and paragraphs in the text block. This markup is a subset of DocBook.

ParagraphType 

Content of this field: Description of this field:
Elements: Use: How many:
A choice of (
valueoptionalunbounded
OR
itemizedlistrequired
OR
orderedlistrequired
OR
emphasisrequired
OR
subscriptrequired
OR
superscriptrequired
OR
literalLayoutrequired
OR
ulinkoptional
)
Attributes: Use: Default Value:
xml:lang
The "paragraph" element allows for both formatted and unformatted text blocks to be included in EML. It can be plain text or text with a limited set of markup tags, including emphasis, subscript, superscript, lists and links. This markup is a subset of DocBook.

SectionType 

Content of this field: Description of this field:
Elements: Use: How many:
A sequence of (
titleoptional
A choice of (
pararequired
OR
sectionrequired
)
)
Attributes: Use: Default Value:
xml:lang
The "section" element allows for grouping related paragraphs (or other sections) of text together, with an optional title. This markup is a subset of DocBook.

ListType 

Content of this field: Description of this field:
Elements: Use: How many:
A sequence of (
listitemrequiredunbounded
)
A list of items in a text paragraph. The ListType is used by both orderedlist elements and itemizedlist elements. This markup is a subset of DocBook.

SubSuperScriptType 

Content of this field: Description of this field:
Elements: Use: How many:
A choice of (
valueoptionalunbounded
OR
subscriptrequired
OR
superscriptrequired
)
Attributes: Use: Default Value:
xml:lang
A subscript or a superscript in a text paragraph. This type is used by both subscript and superscript elements to define their recursive content. This markup is a subset of DocBook.

i18nString 

Content of this field: Description of this field:

Derived from: xs:string (by xs:extension)

Elements: Use: How many:
xml:lang
Language translation as specified by the xml:lang attribute

Web Contact: jones@nceas.ucsb.edu