<!-- ============================================================= -->
<!-- MODULE: List Element Classes -->
<!-- VERSION: 1.0 -->
<!-- DATE: December 2002 -->
<!-- -->
<!-- ============================================================= -->
<!-- ============================================================= -->
<!-- PUBLIC DOCUMENT TYPE DEFINITION -->
<!-- TYPICAL INVOCATION -->
<!--
"-//NLM//DTD Archiving and Interchange DTD Suite List Class Elements v1.0 20021201//EN"
Delivered as file "list.ent" -->
<!-- ============================================================= -->
<!-- ============================================================= -->
<!-- SYSTEM: NLM Archiving and Interchange DTD Suite -->
<!-- -->
<!-- PURPOSE: Names all elements in the list class. These are -->
<!-- all lists except the lists of bibliographic -->
<!-- references (citations). Lists are considered -->
<!-- to be composed of items. -->
<!-- -->
<!-- CONTAINS: 1) Default definition of the list class -->
<!-- 2) Definition List attributes -->
<!-- 3) Definition Lists <def-list> -->
<!-- 4) Ordinary lists (number, bullet, plain) <l> -->
<!-- -->
<!-- CREATED FOR: -->
<!-- Digital archives and publishers who wish to -->
<!-- create a custom XML DTD for original markup of -->
<!-- journal literature, books, and related material, -->
<!-- or for archiving and transferring such material -->
<!-- between archives. -->
<!-- -->
<!-- This DTD is in the public domain. An organization -->
<!-- that wishes to create its own DTD from the suite -->
<!-- may do so without permission from NLM. However, -->
<!-- NLM requests that the following statement be -->
<!-- included as a comment in all derivative DTDs or -->
<!-- DTD modules: -->
<!-- "Created using the NLM Archiving and Interchange -->
<!-- DTD suite." -->
<!-- -->
<!-- Suggestions for refinements and enhancements to -->
<!-- the DTD suite should be sent in email to: -->
<!-- pmc@ncbi.nlm.nih.gov -->
<!-- The suite has been set up to be extended using a -->
<!-- new DTD and a customization module to redefine -->
<!-- the many Parameter Entities. Do not modify the -->
<!-- suite directly or redistribute modified versions -->
<!-- of the suite. -->
<!-- -->
<!-- ORIGINAL CREATION DATE: -->
<!-- December 2002 -->
<!-- -->
<!-- CREATED BY: Jeff Beck (NCBI) -->
<!-- Deborah Lapeyre (Mulberry Technologies, Inc.) -->
<!-- Bruce Rosenblum (Inera Inc.) -->
<!-- -->
<!-- NLM thanks the Mellon Foundation's e-Journal -->
<!-- Archiving Program and Harvard University -->
<!-- Libraries for their contribution to Version 1.0 -->
<!-- of the suite: first, for proposing that a draft -->
<!-- archiving NLM DTD for life sciences journals be -->
<!-- extended to accommodate journals in all -->
<!-- disciplines, and then for funding Bruce -->
<!-- Rosenblum's collaboration with other DTD authors -->
<!-- in completing Version 1.0. -->
<!-- -->
<!-- ============================================================= -->
<!-- ============================================================= -->
<!-- DTD VERSION\CHANGE HISTORY -->
<!-- ============================================================= -->
<!--
=============================================================
Version Reason/Occasion (who) vx.x (yyyy-mm-dd)
-->
<!-- ============================================================= -->
<!-- PARAMETER ENTITY DEPENDENCIES
Requires the following parameter entities
be defined before calling this module,
usually accomplished in the Customization
Module for the specific DTD:
%block-math;
%simple-display;
%simple-phrase; -->
<!-- ============================================================= -->
<!-- ============================================================= -->
<!-- DEFAULT DEFINITION OF THE LIST CLASS -->
<!-- ============================================================= -->
<!-- LIST CLASS ELEMENTS -->
<!-- All the types of lists that may occur
as part of the text, therefore excluding
Bibliographic Reference Lists <ref-list> -->
<!ENTITY % list.class "def-list | list" >
<!-- ============================================================= -->
<!-- DEFAULT PE FOR ATTRIBUTE LISTS -->
<!-- ============================================================= -->
<!-- DEFAULT LIST CLASS ATTRIBUTES -->
<!-- Default attribute lists to be used for most
of the types of lists. -->
<!ENTITY % list-atts
"id CDATA #IMPLIED
list-type CDATA #IMPLIED
prefix-word
CDATA #IMPLIED
list-content
CDATA #IMPLIED" >
<!-- DEFAULT DEFINITION LIST ATTRIBUTES -->
<!-- Default attribute lists to be used for
Definition (2-part) lists -->
<!ENTITY % def-list-atts
"" >
<!-- ============================================================= -->
<!-- DEFINITION LIST -->
<!-- ============================================================= -->
<!-- APPENDIX MATTER MODEL -->
<!-- Content model for the <def-list> element -->
<!ENTITY % def-list-model
"label?, title?, term-head?, def-head?,
def-item*, def-list*" >
<!-- DEFINITION LIST -->
<!ELEMENT def-list (%def-list-model;) >
<!-- id A unique identifier so that the list
may be referenced by an <xref> element
list-type List prefix types. Type describes the
type of prefix character to be used before
each list item:
order - Ordered list. Prefix character is
a number or a letter, depending on
style
bullet - Unordered list. Prefix character
is a bullet, dash, or other symbol
alpha-lower - Ordered list. Prefix
character is a lowercase alphabetical
character
alpha-upper - Ordered list. Prefix
character is an uppercase alphabetical
character
roman-lower - Ordered list. Prefix
character is a lowercase roman
numeral
roman-upper - Ordered list. Prefix
character is an uppercase roman
numeral
simple - simple or plain list (no prefix
character)
prefix-word
Holds a word, such as "Step" or "Process"
that is to be added to each item of a list.
The word is in addition to any prefix
characters such as numbers or bullets,
and typically follows the prefix character.
For example, A list type of "1" and a
prefix word of "Step", would produce:
"Step 1. ssss", "Step 2. ssss", etc.
Note that the word is "Step" and not "Step ".
The odd man out is the unordered list,
type "2", which is the only case in which
the prefix character would precede the
prefix word: - Step - Step, but the
combination is not usually sensible.
list-content
There are some list models in use in journal
DTDs, where a specific named list has been
created instead of using <list> or <def-list>.
The "list content" attribute should be used
to preserve the semantic information
concerning such lists types. Potential
values include: "procedure", "where-list"
(used in equations), "synonymy",
"compound-info", "algorithm", "notation",
etc. For example, if a list were tagged as
<procedure>
<list-item>...</list-item>
</procedure>
that tagging could be preserved as:
<list list-content="procedure">
<list-item>...</list-item>
</list> -->
<!ATTLIST def-list
%list-atts;
%def-list-atts; >
<!-- DEFINITION LIST HEAD ELEMENTS -->
<!-- Elements for use in the <def-list> element -->
<!ENTITY % def-list-head-elements
"| %simple-phrase;" >
<!-- DEFINITION LIST: TERM HEAD -->
<!-- Title over the first (term) column of a
two-part list -->
<!ELEMENT term-head (#PCDATA %def-list-head-elements;)* >
<!-- DEFINITION LIST: DEFINITION HEAD -->
<!-- Title over the second (definition) column
of a two-part list -->
<!ELEMENT def-head (#PCDATA %def-list-head-elements;)* >
<!-- DEFINITION LIST: DEFINITION ITEM -->
<!-- A term and definition pair inside a
definition or two-part list
of a two-part list -->
<!ELEMENT def-item (term, def*) >
<!--ELEM def Defined in %common.ent; -->
<!-- DEFINITION LIST: TERM ELEMENTS -->
<!-- The elements that can be included along with
data characters inside the content model of
a <term>. -->
<!ENTITY % term-elements
"| %block-math; | %simple-display.class; |
%simple-phrase;" >
<!-- DEFINITION LIST: TERM -->
<!-- The word, phrase, picture, or other noun
being defined or description that occupies
the first column of a definition or 2-part
list and is the subject of the definition or
description. -->
<!ELEMENT term (#PCDATA %term-elements;)* >
<!-- id Unique identifier so the element may be
referenced
rid Points to the identifier of a definition,
so that a term and definition may be linked
-->
<!ATTLIST term
rid IDREFS #IMPLIED
id ID #IMPLIED >
<!-- ============================================================= -->
<!-- LIST ELEMENTS (PARAGRAPH-LEVEL ELEMENTS) -->
<!-- ============================================================= -->
<!-- LIST MODEL -->
<!-- Content model for the <list> element -->
<!ENTITY % list-model "label?, title?, list-item+" >
<!-- LIST -->
<!ELEMENT list (%list-model;) >
<!-- id A unique identifier so that the list
may be referenced by an <xref> element
list-type List prefix types. Type describes the
type of prefix character to be used before
each list item:
order - Ordered list. Prefix character is
a number or a letter, depending on
style
bullet - Unordered list. Prefix character
is a bullet, dash, or other symbol
alpha-lower - Ordered list. Prefix
character is a lowercase alphabetical
character
alpha-upper - Ordered list. Prefix
character is an uppercase alphabetical
character
roman-lower - Ordered list. Prefix
character is a lowercase roman
numeral
roman-upper - Ordered list. Prefix
character is an uppercase roman
numeral
simple - simple or plain list (no prefix
character)
prefix-word
Holds a word, such as "Step" or "Process"
that is to be added to each item of a list.
The word is in addition to any prefix
characters such as numbers or bullets,
and typically follows the prefix character.
For example, a list type of "1" and a
prefix word of "Step", would produce:
"Step 1. aaaa", "Step 2. bbbb", etc.
Note that the word is "Step" and not "Step ".
The odd man out is the unordered list,
type "2", which is the only case in which
the prefix character would precede the
prefix word: - Step - Step, but the
combination is not usually sensible.
list-content
There are some list models in use in journal
DTDs, where a specific named list has been
created instead of using <list> or <def-list>.
The "list content" attribute should be used
to preserve the semantic information
concerning such lists types. Potential
values include: "procedure", "where-list"
(used in equations), "synonymy",
"compound-info", "algorithm", "notation",
etc. For example, if a list were tagged as
<procedure>
<list-item>...</list-item>
</procedure>
that tagging could be preserved as:
<list list-content="procedure">
<list-item>...</list-item>
</list> -->
<!ATTLIST list
%list-atts; >
<!-- LIST ITEM -->
<!ELEMENT list-item (p | %list.class;)+ >
<!-- id A unique identifier so that the list item
may be referenced by an <xref> element -->
<!ATTLIST list-item
id CDATA #IMPLIED >
<!-- ================== End List Class Module ==================== -->