DTD elements declaration and usage document
$Id: elemdoc.html,v 1.3 1998/02/12 10:13:34 wes Exp $
Author: Jörgen Westerling
This document describes all elements used in the HUTpubl DTD, their intended use and their attributes and their use. The elements are listed in alphabetical order. Below the element definitions you can find a description of the current element and its attributes. Some elements have their name rendered in a lighter gray color. These elements are used as metadata in describing the document. The average writer and user of the HUTpubl system can ignore these.
Most of the elements in the HUTpubl DTD have a fixed set of standard attributes. These attributes occur in every element where the %commonatts; entity can be found in the elements ATTLIST specification. The attributes and their intended use are described here to avoid repetition for every element definition.
<!ENTITY % commonatts "Id ID #IMPLIED
Lang CDATA #IMPLIED
XRefLabel CDATA #IMPLIED" >
- Id
- The Id attribute is supplied for generating unique identifiers for cross-referencing within a document. This value is optional and need not be supplied by the writer and if it is not, the formatting system will generate it.
- Lang
- The Lang attribute is supplied for indicating the language in which the text is written. This value is optional and if it is not given the system makes no presumptions about language. The value of this attribute can be any text string but it is recommended that the language is indicated using the 2 letter country codes found in the ISO 3166 standard. For example FI for Finland and SE for Sweden.
- XRefLabel
- The XRefLabel attribute assigns a label to the cross reference, if there needs to be a user specified text in the element that is cross references. It is used in for example bibliographical references.
Many of the inline elements in the HUTpubl DTD are grouped into parameter entities to make the readability of the DTD better. These parameter entities occur frequently in the specifications for container elements in the DTD. The parameter entities and their contents are described below.
<!ENTITY % words "abbrev | abbrdef | definition | footnote | glossdef |
glossterm | term | typed | quote" >The %words; parameter entity contains element names for elements that are used to mark up single words or a group of words inline with the running text.
<!ENTITY % computer "code | keyboard | output | variable" >
The %computer; parameter entity contains element names for elements that are used to mark up parts of the text that are computer-related.
<!ENTITY % styles "emphasis | strong | preformat" >
The %styles; parameter entity contains element names for elements that are used to mark up parts of the text that are to be rendered visually different from the rest of the text.
<!ENTITY % inlobj "inlinemath | inlinepict" >
The %inlobj; parameter entity contains element names for elements that occur inline with the running text but are not word-level mark-up.
<!ENTITY % ref "link | target | xref" >
The %ref; parameter entity contains element names for elements that are used to mark up cross references, links and their targets.
<!ENTITY % floating "blockquote | equation | figure | mmedia | table" >
The %floating; parameter entity contains element names for elements that are not part of the running text, but isolated "floating" elements.
<!ENTITY % lists "orderedlist | itemizedlist | desclist" >
The %list; parameter entity contains element names for the different kinds of lists.
<!ENTITY % phrase "#PCDATA | subscript | superscript | %ref;" >
The %phrase; parameter entity consists of
<!ENTITY % char "%words; | %computer; | %phrase;" >
The %char; parameter entity contains element names for elements that are used to mark up parts of the text that are computer-related.
<!ENTITY % inlines "%char; | %styles; | %inlobj;" >
The %inlines; parameter entity contains element names for elements that are used to mark up parts of the text that are computer-related.
These are the HUTpubl elements in alphabetical order. By traversing the link you will be taken to the part of the document that describes the element in question and when to use it.
biblother - blockquote - body - book - caption - chapter - code - compiled - comptitle - conference
confproc - contents - contributors - copyright - coverage - date - definition - descdata - desclist - description
descterm - edition - editor - emphasis - entry - equation - figlist - figure - footnote - foreword
format - front - glossary - glossdef - glossterm - graphic - head - holder - HUTpubl - identifier
index - inlinemath - inlinepict - itemizedlist - keyboard - keyword - keywords - language - link - listitem
maganame - maganr - magazine - math - metadata - mmedia - netres - orderedlist - output - pages
para - patent - patholder - patid - patname - preformat - publisher - publwhere - publyear - quote
rights - relation - row - sect1 - sect2 - sect3 - sect4 - serial - serialid - source
standard - standid - standname - strong - subject - subscript - superscript - symlist - table - target
tbody - term - tfoot - thead - title - toc - totpages - type - typed
url - variable - volnr - xref - year
abbrev
<!ELEMENT abbrev - - (#PCDATA) >
<!ATTLIST abbrev %commonatts; >
The abbrev element is used for marking up abbreviations in the text. The abbreviations can then be collected into to a list of abbreviations together with their definitions which are marked up by the abbrdef element. The element uses the standard attributes.
abbrdef
<!ELEMENT abbrdef - - (#PCDATA) >
<!ATTLIST abbrdef %commonatts; >
The abbrdef element is used for marking up abbreviation definitions in the text. These definitions can then be collected into a list of abbreviations together with corresponding abbreviations. The element uses the standard attributes.
abbrlist
<!ELEMENT abbrlist - O EMPTY -- included automatically -- >
The abbrlist element is an element that contains a list of all the abbreviations and their corresponding definitions in the text. It is generated automatically by the processing application, so the user need not concern himself with it. The element has no attributes. The end tag for this element can be omitted.
abstract
<!ELEMENT abstract - O (head, para+) >
<!ATTLIST abstract %commonatts; >
The abstract element is a container that contains one or more paragraphs of text in the abstract part of the text. The reason for allowing more than one abstract is that they can be in meny different languages. The element uses the standard attributes. The end tag for this element can be omitted because it is a required element in its content group.
appendix
<!ELEMENT appendix - - (head?, para+) >
The appendix element is the top level container for appendixes at the end of the publication. It contains an optional head element and one or more para elements. The element has no attributes.
applnr
<!ELEMENT applnr - O (#PCDATA) >
The applnr element is used for marking up a patent application nnumber in a patent element in the bibl container. The element has no attributes. The end tag for this element can be omitted.
appldate
<!ELEMENT appldate - O (#PCDATA) >
The appldate element is used for marking up a patent application date in a patent element in the bibl container element. The element has no attributes. The end tag for this element can be omitted.
author
<!ELEMENT author - - (#PCDATA) >
<!ATTLIST author Scheme "Internal | AACR2 | TEI | MARC" #IMPLIED
Type "Name | Email | Postal | Phone | Fax |
Affiliation | HomeEmail | HomePostal |
HomePhone | HomeFax | Homepage |
Keywords | Order | PGPKey" #IMPLIED >The author element is used for marking up the author of the publication or authors in different elements in the bibliography (bibl). This element is the Dublin Core creator element. The name has been modified to be compatible with the DocBook DTD. The element has the following optional attributes:
- Scheme
- The scheme attribute is used for indicating which cataloguing system is used for the element. If none of the others are suitable the `Internal' value for the attribute should be used.
- Type
- The type attribute is used for indicating which of the different parts of an authors information is marked up in the author element (author) in question.
<author scheme="internal" type="name">John Doe</author> <author scheme="internal" type="email">john.doe@foo.com</author> <author scheme="internal" type="phone">555-656543</author>
back
<!ELEMENT back - - (bibl, appendix*, index?, glossary?) >
The back element is the top level container for the back matter of a publication. It contains a bibliography (bibl), zero or more appendixes (appendix), an optional index and an optional glossary. The element has no attributes.
bibl
<!ELEMENT bibl - O (head?, (magazine | book | serial | confproc |
compiled | standard | patent |
netres, biblother)*) >The bibl element is a container for the publications bibliography. It contains an optional heading (head), and zero or more entries of the following types: magazine, book, serial, conference proceedings (confproc), compiled works (compiled), standard, patent, net resource (netres) or other bibliographic references (biblother). The end tag of this element can be omitted. The element has no attributes.
biblother
<!ELEMENT biblother - O (author+, publyear?, title?, contents?) >
<!ATTLIST biblother %commonatts; >
The biblother element is a container for bibliographic items that do not fit any of the other categories. It contains one or more authors (author), an optional publication year (publyear), an optional title (title) and the contents of the resource (contents) if it is not clearly stated in the title. The end tag of this element can be omitted. The element uses the standard attributes.
blockquote
<!ELEMENT blockquote - - (#PCDATA) >
<!ATTLIST blockquote %commonatts; >
The blockquote element is used for marking up larger quotations that should appear as a separate block and not in the running text. The element uses the standard attributes.
body
<!ELEMENT body - O (chapter+) >
The body element is the top level container for the body of the publication. It contains one or more chapter elements. The end tag for this element can be omitted. The element has no attributes.
book
<!ELEMENT book - O (author+, editor*, publyear?, title, edition?,
publwhere?, publisher?, totpages?) ><!ATTLIST book %commonatts; >
The bookelement is a container used for marking up books in the bibliography. It contains one or more authors (author), zero or more editors (editor), an optional year of publishing (publyear), the title of the book (title), an optional edition (edition), en optional place of publication (publwhere), an optional publisher (publisher) and an optional total numer of pages (totpages). The end tag of this element can be omitted. The element uses the standard attributes.
caption
<!ELEMENT caption - - (%char;)* >
The caption element is a container used for marking up captions of graphics, tables, multimedia objects and the like. The element has no attributes,
chapter
<!ELEMENT chapter - O (head?, (para | %lists; | %floating;)*, sect1*) >
<!ATTLIST chapter %commonatts; >
The chapter element is a container for the chapters in a publication. It contains an optional head (head) followed by zero or more paragraphs (para), lists (orderedlist, itemizedlist and desclist) or floating elements. After these zero or more level one sections can appear (sect1). The end tag of this element can be omitted. The element uses the standard attributes.
code
<!ELEMENT code - - (#PCDATA) >
<!ATTLIST code %commonatts;
file CDATA #IMPLIED >The code element is used for marking up program code fragments. The element uses the standard attributes and an additional file attribute.
- file
- An optional attribute in which a filename can be given to which to save the fragment of code marked up within the code element.
compiled
<!ELEMENT compiled - O (author+, publyear?, title, editor*, comptitle?,
publwhere?, publisher?, pages?) ><!ATTLIST compiled %commonatts; >
The compiled element is a container used for marking up compiled works in the bibliography (bibl). It contains one or more authors (author), an optional publication year (publyear), a title (title), zero or more editors (editor), an optional title of the works (comptitle), an optional place of publication (publwhere), an optional publisher (publisher) and an optional pages which the article resides on (pages). The end tag of this element can be omitted. The element uses the standard attributes.
comptitle
<!ELEMENT comptitle - O (#PCDATA) >
The comptitle element is used for marking up the title of a compiled works within a compiled element in the bibliography (bibl). The end tag of this element can be omitted. The element has no attributes.
conference
<!ELEMENT conference - O (#PCDATA) >
The conference element is used for marking up the name of a conference within a conference proceedings element (confproc) in the bibliography (bibl). The end tag of this element can be omitted. The element has no attributes.
confproc
<!ELEMENT confproc - O (author+, publyear?, title, conference?,
publwhere?, publisher?, pages?) ><!ATTLIST confproc %commonatts; >
The confproc element is a container used for marking up conference proceedings in the bibliography (bibl). It contains one ore more authors (author), an optional publishing year (publyear), a required title (title), an optional conference name (conference), an optional place of publication, i.e. the location of the conference (publwhere), an optional publisher and an optional pages which the paper is located (pages). The end tag of this element can be omitted. The element uses the standard attributes.
contents
<!ELEMENT contents - O (#PCDATA) >
The contents element is used for marking up the contents of a bilbliographic item that does not fit any other category (biblother) in the bibliography (bibl). It is used if the title (title) does not contain all necessary information. The end tag for this element can be omitted. The element has no attributes.
contributors
<!ELEMENT contributors - - (#PCDATA) >
<!ATTLIST contributors Scheme "Internal | AACR2 | TEI | MARC" #IMPLIED
Type "Name | Email | Postal | Phone | Fax |
Affiliation | HomeEmail | HomePostal |
HomePhone | HomeFax | Homepage |
Keywords" #IMPLIED
Role "Editor | Illustrator | Binder | Translator |
MachineReadableCreator | Sponsor | Compiler |
Funder | Composer | Cataloger | Contact |
Reviewer | Proofreader" #IMPLIED >The contributors element is used for marking up contributors to the document in the metadata section (metadata). The element has the following attributes:
- Scheme
- The scheme attribute is used for indicating which cataloguing system is used for the element. If none of the others are suitable the `Internal' value for the attribute should be used.
- Type
- The type attribute is used for indicating which of the different parts of an contributors' information is marked up in the contributors element (contributors) in question.
- Role
- The role attribute is used for indicating which role the contributor has to the document.
<contributors scheme="internal" type="name" role="editor"> John Doe </contributors> <contributors scheme="internal" type="name" role="illustrator"> Jane Doe </contributors>
copyright
<!ELEMENT copyright - O (year+, holder+) >
The copyright element is a container used for marking up the copyright holder of the publication. It contains one or more years for the copyright (year) and one or more holders of the copyright (holder). The end tag of this element can be omitted. The element has no attributes.
<copyright><year>1997</year><holder>ACMEInc.</holder></copyright>
coverage
<!ELEMENT coverage - - (#PCDATA) >
<!ATTLIST coverage Scheme "LatLong | OSGB | ANSI.X3.30-1985 | Freetext"
Type "Spatial | Temporal" >The coverage element is used for marking up the coverage of the publication in question. It can be geographical coverage or time based coverage and such. The element uses the following attributes:
- Scheme
- The scheme attribute is used for indicating which cataloguing system is used for the element. If none of the others are suitable the `Internal' value for the attribute should be used.
- Type
- The type attribute is used for indicating which kind of coverage is in question for the current publication - spatial or temporal.
<coverage scheme="freetext" type="spatial">Worldwide</coverage>
date
<!ELEMENT date - - (#PCDATA) >
<!ATTLIST date Scheme "IETF.RFC-822 | ANSI.X3.30-1985
| ISO.31-1.1992 | FGDC | SSE"
Type "Creation | Current | Modified |
ValidFrom | ValidTo" >The date element is used for marking up different kind of dates related to the document or publication in question. The date can be when the doecument was created, when it was last modified etc. The element uses the following attributes:
- Scheme
- The scheme attribute is used for indicating which classification system is used for the element.
- Type
- The type attribute is used for indicating which kind of date is in question for the current publication.
<date scheme="IETF.RFC-822" type="creation">20 Sep 97</date>
<date scheme="IETF.RFC-822" type="modified">02 Oct 97</date>
definition
<!ELEMENT definition - - (#PCDATA) >
<!ATTLIST definition %commonatts; >
The definition element is used for marking up mathematical or theoretical definitionsof various kinds. The element uses the standard attributes.
descdata
<!ELEMENT descdata - O (para | %lists; | %inlines;)* >
The descdata element is a container used for marking up description data about a description term (descterm) within a description list (desclist). It can contain zero or more paragraphs, lists (ordererlist, itemizedlist, desclist) or inline elements. The end tag of this element can be omitted. The element has no attributes.
desclist
<!ELEMENT desclist - - (descterm, descdata)+ >
<!ATTLIST desclist %commonatts; >
The desclist element is a container for description lists. It can contain one more groups of a description term (descterm) and its corresponding description data (descdata). The element uses the standard attributes.
<desclist> <descterm>This is the first term.</descterm> <descdata>This is the data for the first term.</descdata> <descterm>This is the second term.</descterm> <descdata>This is the data for the second term.</descdata> </desclist>
description
<!ELEMENT description - O (#PCDATA) >
<!ATTLIST description Scheme "Internal | URL | URN"
Type "Freetext | Abstract" >The description element is used for marking up the description of the documentin the metadata container element (metadata). The end tag for this element can be omitted. The element has the following attributes:
- Scheme
- The scheme attribute is used for indicating which classification system is used for the element. If none of the others are suitable the `Internal' value for the attribute should be used.
- Type
- The type attribute is used for indicating in which form the description of the document is given.
descterm
<!ELEMENT descterm - O (%inlines;)* >
The descterm element is a container used for marking up description terms within a description list (desclist). It can contain text and zero or more inline elements The eng tag for this element can be omitted. The element has no attributes.
edition
<!ELEMENT edition - O (#PCDATA) >
The edition element is used for marking up the edition of a book within the book element (book) in the bibliography (bibl). The end tag of this element can be omitted. The element has no attributes.
editor
<!ELEMENT editor - O (#PCDATA) >
The editor element is used for marking up the editor of many of the items in the bibliography (bibl). The end tag for this element can be omitted. The element has no attributes.
emphasis
<!ELEMENT emphasis - - (#PCDATA) >
The empasis element is used for marking up sections of the text that need to be emphasised. The element has no attributes.
<para>This is an example of a text with some <emphasis>important stuff</emphasis> that needs to be emphasised in it.</para>
entry
<!ELEMENT entry - O (%char; | %styles;)* >
The entry element is a container used for marking up an entry in a table row (trow) within a table element (table). Another name for it is a table cell. It can contain almost any element except another table, figures (figure) and equations (equation). The end tag of this element can be omitted. The element has no attributes.
<table> <trow> <entry>first entry</entry> <entry>second entry</entry> </trow> <trow> <entry>third entry</entry> <entry>fourth entry</entry> </trow> </table>
equation
<!ELEMENT equation - O EMPTY >
<!ATTLIST equation %commonatts;
entity ENTITY #IMPLIED
file CDATA #IMPLIED
type (nr | nonr) nr >The equation element is used for marking up mathematical equations that do not occur inline with the normal text flow. The end tag for this element has to be omitted as the element has no content. The content of the element is specified in an external entity or a file. The element uses the standard attributes and has three additional attributes:
- entity
- The entity attribute is used to specify the entity for the graphic object if it resides in an entity.
- file
- The file attribute is used to specify the filename of the graphic object if it is in an external file.
- type
- The type attribute is used to specify if the equation should be numbered using a running number or not. The default is yes. Both of the entity- and file attributes cannot be used at the same time. The equation is either specified by en external entity or an external file.
figlist
<!ELEMENT figlist - O EMPTY -- included automatically -- >
The figlist element is an element that contains a list of all the figures in the publication. It is generated automatically by the processing application, so the user need not concern himself with it. The element has no attributes. The end tag for this element must be omitted as the element has an EMPTY content and is thus only a placeholder for the figure list.
figure
<!ELEMENT figure - - (graphic, caption?) >
<!ATTLIST figure %commonatts; >
The figure element is a container for figures that do not occur inline with the normal text flow. It contains a graphic element (graphic) and an optional catption (caption). The element uses the standard attributes.
<figure> <graphic xreflabel="fig1" file="graphic1.eps"> <caption>This is figure 1.</caption> </figure>
footnote
<!ELEMENT footnote - - (#PCDATA | %styles;| %ref;)* >
<!ATTLIST footnote %commonatts; >
The footnote element is a container used for marking up footnotes. It is an inline element, so the content of the footnote is written directly in the location of the footnote. It can contain text or style elements or cross reference elements. The elements uses the standard attributes.
<para>This is a paragraph with a footnote here <footnote>This is the footnote text</footnote> and the text now continues.</para>
foreword
<!ELEMENT foreword - O (head, para+) >
<!ATTLIST foreword %commonatts; >
The foreword element is a container used for marking up a foreword to the publication if one exists. It contains a head (head) and one or more paragraphs (para). The end tag for this element can be omitted. The element uses the standard attributes.
<foreword> <head>This is the foreword of my publication</head> <para>Here comes the text of the foreword.</para> <para>In one or more paragraphs.</para> </foreword>
format
<!ELEMENT format - - (#PCDATA) >
<!ATTLIST format Scheme "IMT | MIME | Freetext" >
The format element is used for indicating in which format the publication is presented. It is part of the metadata container element. The element has the following attributes:
- Scheme
- The scheme attribute is used for indicating in which standard the format is given.
<format scheme="mime">text/x-html</format>
front
<!ELEMENT front - O (metadata, copyright, abstract+, keywords*,
toc, (abbrlist? & symlist? & figlist?), foreword?) >The front element is a top level container for the front matter of the publication. It contains the metadata of the publication (metadata), the copyright information (copyright), one or more abstracts (abstract), zero or more keywords sections (keywords) if one wishes to give the keywords in many languages for instance, an required table of contents (toc), an optional list of abbreviations (abbrlist), an optional list of symbols (symlist), an optional list of figures (figlist), all three of which can occur in any order and an optional foreword (foreword). The end tag of this element can be omitted. The element has no attributes.
glossary
<!ELEMENT glossary - O EMPTY >
The glossary element is an element that contains a glossary of all the terms in the publication that are marked up by the glossary term (glossterm) element. It is generated automatically by the processing application, so the user need not concern himself with it. The element has no attributes. The end tag for this element must be omitted as the element has EMPTY content and is only a placeholder for the glossary.
glossdef
<!ELEMENT glossdef - - (#PCDATA) >
<!ATTLIST glossdef %commonatts; >
The glossdef element is used to mark up definitions of terms in the text flow that should occur in the glossary (glossary). The element uses the standard attributes.
glossterm
<!ELEMENT glossterm - - (#PCDATA) >
<!ATTLIST glossterm %commonatts; >
The glossterm element is used to mark up terms in the text flow that should occur in the glossary (glossary). The element uses the standard attributes.
graphic
<!ELEMENT graphic - O EMPTY >
<!ATTLIST graphic %commonatts;
entity ENTITY #IMPLIED
file CDATA #IMPLIED >The graphic element is a placeholder for a graphic element. It has an EMPTY content model and the end tag must thus be omitted. The element uses the standard attributes and has two additional attributes. Both of these attributes cannot be used at the same time. The graphic is either specified by en external entity or an external file.
- entity
- The entity attribute is used to specify the entity for the graphic object if it resides in an entity.
- file
- The file attribute is used to specify the filename of the graphic object if it is in an external file.
<graphic file="graphic2.eps">
<graphic entity="graphic3">
head
<!ELEMENT head - - (%phrase;)* >
<!ATTLIST head %commonatts; >
The head element is a container used for marking up the different kinds of heads to many elements in the publication. It can contain text, superscript elements (superscript), subscript elements (subscript) or cross refenrence elements (biblref, link, target, xref). The element uses the standard attributes.
<chapter><head>This is a chapter head with a <subscript>subscript</subscript> in it</head>
holder
<!ELEMENT holder - O (#PCDATA) >
The holder element is used for marking up the hoder of the copyright to the publication. The end tag of this element can be omitted. The element has no attributes.
HUTpubl
<!ELEMENT HUTpubl - - (front, body, back) >
<!ATTLIST HUTpubl type (thesis | report | other) thesis
lang (EN | SE | FI) EN
status (final | draft) draft
version NUTOKEN 0.0
signed CDATA #IMPLIED >HUTpubl is the top-level container element of the DTD. A document always has to have this element as its first element. It must contain one front element, one body element and one back element. The start and end tags are not allowed to be omitted. The HUTpubl element has four attributes:
- type
- Indicates which kind of publication this is. Choices are thesis, report or other. Defaults to thesis.
- lang
- Indicates in which language the publication is written. The language codes can be any of those in ISO 3166 but they have to be specified in the DTD. Available choices are EN, SE and FI for english, swedish and finnish respectively. Defaults to english, EN.
- status
- Indicates the status of the publication. Choices are final or draft. Defaults to draft.
- version
- Indicates the version of the publication. Must be a number (can include a decimal point). Defaults to 0.0.
- signed
- Contains the digitally signed hash of the document.
identifier
<!ELEMENT identifier - - (#PCDATA) >
<!ATTLIST identifier Scheme "URL | URN | ISBN | ISSN | FPI | SICI | Version"
Type "Primary | Copy" >The identifier element is used to uniquely indentify the resource. Examples for networked resources include URLs and URNs (when implemented). Other globally-unique identifiers,such as International Standard Book Numbers (ISBN) or other formal names would also be candidates for this element in the case of off-line resources.It is part of the metadata container element. The element has the following attributes:
- Scheme
- The scheme attribute is used for indicating which kind of identifier is used for the document.
- Type
- The type attribute is used for indicating if the identifier is given for the primary document or for a copy thereof.
<identifier scheme="url" type="primary">http://www.hut.fi/index.html</identifier>
index
<!ELEMENT index - O EMPTY >
The index element is a placeholder for the index of the publication. Its end tag must be omitted because it has an EMPTY content model. The element has no attributes.
inlinemath
<!ELEMENT inlinemath - O EMPTY >
<!ATTLIST inlinemath %commonatts;
entity ENTITY #IMPLIED
file CDATA #IMPLIED >The inlinemath element is used for marking up mathematical equations that should occur inline with the text flow. The element has no content as its substance is located in a file or an external entity. The element uses the standard attributes and has two additional attributes. Both of these attributes cannot be used at the same time. The inline math object is either specified by en external entity or an external file.
- entity
- The entity attribute is used to specify the entity for the graphic object if it resides in an entity.
- file
- The file attribute is used to specify the filename of the graphic object if it is in an external file.
<para>Here is a paragraph that has an equation that should occur inline with the text flow about here <inlinemath file="graphic2.eps"> and then the text just continues.</para>
inlinepict
<!ELEMENT inlinepict - O EMPTY >
<!ATTLIST inlinepict %commonatts;
entity ENTITY #IMPLIED
file CDATA #IMPLIED >The inlinepict element is used for marking up pictures that should occure inline with the text flow. It is a placeholder for the picture with an EMPTY content and its end tag must therefore be omitted. The element uses the standard attributes and has two additional attributes. Both of these attributes cannot be used at the same time. The inline picture is either specified by en external entity or an external file.
- entity
- The entity attribute is used to specify the entity for the graphic object if it resides in an entity.
- file
- The file attribute is used to specify the filename of the graphic object if it is in an external file.
<inlinepict file="inlinepict1.eps">
itemizedlist
<!ELEMENT itemizedlist - - (listitem)+ >
<!ATTLIST itemizedlist %commonatts; >
The itemizedlist element is a container for itemized lists in which the ordering of the list items is not significant. It consists of one or more list items (listitem). The element uses the standard attributes.
<itemizedlist> <listitem>This is item number 1</listitem> <listitem>This is item number 2</listitem> <listitem>This is item number 3</listitem> </itemizedlist>
keyboard
<!ELEMENT keyboard - - (#PCDATA) >
The keyboard element is used for marking up commands that are written on a keyboard of a computer. The element has no attributes.
<para>When reading your mail, the first thing you have to do is to start you mail client. You do this by typing <keyboard>pine </keyboard> on your keyboard. </para>
keyword
<!ELEMENT keyword - O (#PCDATA) >
The keyword element is used for marking up the keywords in the keyword list (keywords). The end tag of this element can be omitted. The element has no attributes.
<keywords> <keyword>SGML</keyword> <keyword>electronic publishing</keyword> <keyword>content model</keyword> </keywords>
keywords
<!ELEMENT keywords - O (keyword+) >
<!ATTLIST keywords %commonatts; >
The keywords element is a container for the keywords in a publication. It consists of one or more keywords (keyword). The end tag for this element can be omitted. The element uses the standard attributes. See example above.
language
<!ELEMENT language - - (#PCDATA) >
<!ATTLIST language Scheme "Freetext | Z3953 | ISO.639 | Computer" >
The language element is used to indicate the language(s) of the intellectual content of the resource. Where practical, the content of this field should coincide with ISO 639. It is part of the metadata container element. The element has the following attributes:
- Scheme
- The scheme attribute is used for indicating which standard or system is used for indicating the language.
<language scheme="iso.639">en</language>
link
<!ELEMENT link - O (#PCDATA) >
<!ATTLIST link %commonatts;
type (hypertext | other) other
linkend IDREF #REQUIRED >The link element is used for marking up different kinds of links in the document. The elements end tag can be omitted. The element uses the standard attributes and has two additional attributes:
- type
- The type attribute indicates the type of the link. The types are hypertext for hypertext across documents and other for other unspecified links. The default is other.
- linkend
- The linkend attribute is a required ID reference attribute that shows where the link points to. Its value corresponds to the referred elements Id attribute.
listitem
<!ELEMENT listitem - O (%lists; | %inlines;)* >
<!ATTLIST listitem mark CDATA #IMPLIED >
The listitem element is a container used for marking up items in a list (orderedlist, itemizedlist). It can contain either other lists or almost any other element type. The end tag for this element can be omitted. The element has one attribute:
- mark
- If this attribute is specified in an itemized list (itemizedlist) context, the items "bullet" symbol is replaced by the character(s) specified in this attribute. Does not apply for list items in ordered lists (orderedlist).
<itemizedlist> <listitem mark="+">Item no 1</listitem> <listitem mark="-">Item no 2</listitem> </itemizedlist>
maganame
<!ELEMENT maganame - O (#PCDATA) >
The maganame element is used for marking up the magazine name in a magazine element (magazine) of the bibliography (bibl). The end tag of this elemenst can be omitted. The element has no attributes.
maganr
<!ELEMENT maganr - O (#PCDATA) >
The maganr element is used for marking up the magazine number in a magazine element (magazine) of the bibliography (bibl). The end tag of this elemenst can be omitted. The element has no attributes.
magazine
<!ELEMENT magazine - O (author+, publyear?, title, maganame?, volnr,
maganr, pages?) ><!ATTLIST magazine %commonatts; >
The magazine element is a container used for marking up magazines in the bibliography (bibl). It consists of one or more authors (author), an optional year of publishing (publyear), a title (title), an optional magazine name (maganame), the volume number of tha magazine (volnr), the issuenumber of the magazine (maganr), and an optional pages the atricle is located on (pages). The end tag of this element can be omitted. The element uses the standard attributes.
math
<!ELEMENT math - - (equation | graphic) >
<!ATTLIST math %commonatts;
type (nr | nonr) nr >The math element is a container for a mathematical formula or equation. It consist of either an equation element (equation) or a graphic element (graphic) which depicts the equation. The element uses the standard attibutes and has an additional attribute:
- type
- The type attribute can have two values, nr and nonr. It tells the formatting application whether the math element should be numered or not. The default is numbered.
metadata
<!ELEMENT metadata - - (title+, author+, (subject | description |
publisher | contributors | date | type |
format | identifier | source | language |
relation | coverage | rights)*) ><!ATTLIST metadata dcVersion CDATA #IMPLIED >
The metadata element is a container for the publications metadata, i.e. information about the author etc. It is based on the Dublin Core metadata elements. It consists of on or more titles (title), one or more autors (author) and then zero or more of the following DC elements: subject, description, publisher, contributors, date, type, format, identifier, source, language, relation, coverage and rights. The description of these elements can be found in the Dublin Code document type definition. The element has one attribute:
- dcVersion
- The dcVersion attribute is used for specifying which version of the Dublin Core metadata elements is in use.
<metadata dcVersion="1.0"> <title>HUTpubl DTD element definitions</title> <author>Jörgen Westerling</author> <language>GB</language> </metadata>
mmedia
<!ELEMENT mmedia - O EMPTY >
<!ATTLIST mmedia %commonatts;
entity ENTITY #IMPLIED
file CDATA #IMPLIED >The mmedia element is used for marking up multimedia objects in the document. It is a placeholder with EMPTY content and therefore the end tag must be omitted. The element uses the standard attributes and has two additional attributes. Both of these attributes cannot be used at the same time. The multimedia object is either specified by en external entity or an external file.
- entity
- The entity attribute is used to specify the entity for the multimedia object if it resides in an entity.
- file
- The file attribute is used to specify the filename of the multimedia object if it is in an external file.
<mmedia file="movie1.mpeg">
netres
<!ELEMENT netres - O (author+, publyear?, title?, url) >
<!ATTLIST netres %commonatts; >
The netres element is a container used to mark up a network resource in the bibliography (bibl). It consists of one or more authors (author), an optional publication year (publyear), an optional title (title) and an uniform resource locator (url). The element uses the standard attributes.
orderedlist
<!ELEMENT orderedlist - - (listitem)+ >
<!ATTLIST orderedlist %commonatts; >
The orderedlist element is a container used for marking up ordered lists, i.e. lists where the order of the elements is significant. It consists of one or many list items (listitem). The element uses the standard attributes.
<orderedlist> <listitem>Item 1</listitem> <listitem>Item 2</listitem> </orderedlist>
output
<!ELEMENT output - - (#PCDATA) >
The output element is used for marking up computer output. The element has no attributes.
<para>If you give your computer the <keyboard>ls</keyboard> command you might see this: <output> directory1 directory3 directory2 directory4 </output> These are your directories.</para>
pages
<!ELEMENT pages - O (#PCDATA) >
The pages element is used for marking up the pages on which an article or such is located in many of the bibliographic elements in the bibliography (bibl). The end tag for this element can be omitted. The element has no attributes.
para
<!ELEMENT para - O (%lists; | %floating; | %inlines;)* >
<!ATTLIST para %commonatts; >
The para element is a container used for marking up paragraphs of text. It is a container that can hold almost any kind of other element. The end tag for this element can be omitted. The element uses the standard attributes.
patent
<!ELEMENT patent - O (patid, patname?, patholder?, applnr?,
appldate?, totpages?) ><!ATTLIST patent %commonatts; >
The patent element is a container used for marking up a patent in the bibliography (bibl). It contains the patent ID (patid), an optional patent name (patname), an optional holder of the patent (patholder), an optional patent application number (applnr), an optional patent application date (appldate) and an optional total amount of pages in the patent (totpages). The end tag of this element can be omitted. The element uses the standard attributes.
patholder
<!ELEMENT patholder - O (#PCDATA) >
The patholder element is used for marking up the holder of a patent in a patent element (patent) in the bibliography (bibl). The end tag for this element can be omitted. The element has no attributes.
patid
<!ELEMENT patid - O (#PCDATA) >
The patid element is used for marking up the patent id in a patent element (patent) in the bibliography (bibl). The end tag for this element can be omitted. The element has no attributes.
patname
<!ELEMENT patname - O (#PCDATA) >
The patname element is used for marking up the patent name in a patent element (patent) in the bibliography (bibl). The end tag for this element can be omitted. The element has no attributes.
preformat
<!ELEMENT preformat - - RCDATA >
<!ATTLIST preformat %commonatts; >
The preformat element is used for marking up portions of text in the document that should retain its given formatting including spaces, tabs, newlines etc. The element uses the standard attributes.
<preformat>This portion of text will retain its formatting upon processing.</preformat>
publisher
<!ELEMENT publisher - - (#PCDATA) >
<!ATTLIST publisher Scheme "Internal | AACR2 | TEI | MARC"
Type "Name | Email | Postal | Phone |Fax |
Affiliation | HomeEmail | HomePostal |
HomePhone | HomeFax | Homepage | Keywords" >The publisher element is used for indicating the entity responsible for making the resource available in its present form, such as a publishing house, a university department, or a corporate entity. It is part of the metadata container element. The element has the following attributes:
- Scheme
- The scheme attribute is used for indicating which cataloguing system is used for the element. If none of the others are suitable the `Internal' value for the attribute should be used.
- Type
- The type attribute is used for indicating which of the different parts of a publishers information is marked up in the element in question.
<publisher scheme="internal" type="name">BookHouse Ltd</publisher>
<publisher scheme="internal" type="email">info(bh.com</publisher>
<publisher scheme="internal" type="phone">555-123456</publisher>
publwhere
<!ELEMENT publwhere - O (#PCDATA) >
The publwhere element is used for marking up where a publication has been published in most of the bibliographic elements in the bibliography (bibl). The end tag for this element can be omitted. The element has no attributes.
publyear
<!ELEMENT publyear - O (#PCDATA) >
The publyear element is used for marking up the year a publication has been published in most of the bibliographic elements in the bibliography (bibl). The end tag for this element can be omitted. The element has no attributes.
quote
<!ELEMENT quote - - (#PCDATA) >
<!ATTLIST quote %commonatts; >
The quote element is used for marking up quotes that occur inline with the text flow as opposite to the blockquote element that is used for larger quotations. The element uses the standard attributes.
<para>And then Mr Doe said: <quote>I don't like you!</quote>.</para>
rights
<!ELEMENT rights - - (#PCDATA) >
<!ATTLIST rights Scheme "Freetext | URL | URN" >
The rights element is a link to a copyright notice, to a rights-management statement, or to a service that would provide information about terms of access to the resource. It can also be free text describing the same thing. The element should be used for more extensive copyright notices than given in the copyright element. It is part of the metadata container element. The element has the following attributes:
- Scheme
- The scheme attribute is used for indicating if the rights-information is behind a link or given directly as free text.
<rights scheme="url">http://foo.org/copyright.html</rights>
relation
<!ELEMENT relation - - (#PCDATA) >
<!ATTLIST relation Scheme "URL | URN | ISBN | ISSN | FPI"
Type "IsParentOf | IsChildOf | IsMemberOf |
IsDerivedFrom | HasBibliographicInfoIn |
IsRevisionHistoryFor | IsCriticalReviewFor |
IsOverviewOf | IsContentRatingFor |
IsTermsAndCOnditionsFor | IsDataFor" >The relation element is used to indicate the relationship of this resource to other resources. The intent of this element is to provide a means to express relationships among resources that have formal relationships to others, but exist as discrete resources themselves. For example, images in a document, chapters in a book, or items in a collection. It is part of the metadata container element. The element has the following attributes:
- Scheme
- The scheme attribute is used for indicating in which form the relation is given.
- Type
- The type attribute is used for indicating what kind of a relationship the given resource has to this resource.
<relation scheme="url" type="IsDerivedFrom">http://foo.org/test.html</relation>
row
<!ELEMENT row - O (entry+) >
The row element is used to mark up a row of a table element (table). It contains one or more entries (entry). The end tag for this element can be omitted. The element has no attributes.
sect1
<!ELEMENT sect1 - O (head?, (para | %lists; | %floating;)*, sect2*) >
<!ATTLIST sect1 %commonatts; >
The sect1 element is a container for a level 1 section within a chapter element (chapter). It contains an optional head (head), zero or more of the following: paragraphs (para), lists (orderedlist, itemizedlist, desclist) and floating elements. After that zero or more subsections can occur (sect2). The end tag of this element can be omitted. The element uses the standard attributes.
<chapter> <sect1> <head>This is the section heading</head> <para>Then comes a paragraph</para> <itemizedlist><listitem>and a list</listitem></itemizedlist> </sect1>
sect2
<!ELEMENT sect2 - O (head?, (para | %lists; | %floating;)*, sect3*) >
<!ATTLIST sect2 %commonatts; >
The sect2 element is a container for a level 2 section (subsection) within a section element (sect1). It contains an optional head (head), zero or more of the following: paragraphs (para), lists (orderedlist, itemizedlist, desclist) and floating elements. After that zero or more sub-subsections can occur (sect3). The end tag of this element can be omitted. The element uses the standard attributes.
sect3
<!ELEMENT sect3 - O (head?, (para | %lists; | %floating;)*, sect4*) >
<!ATTLIST sect3 %commonatts; >
The sect3 element is a container for a level 3 section (sub-subsection) within a subsection element (sect2). It contains an optional head (head), zero or more of the following: paragraphs (para), lists (orderedlist, itemizedlist, desclist) and floating elements. After that zero or more sub-sub-subsections can occur (sect4). The end tag of this element can be omitted. The element uses the standard attributes.
sect4
<!ELEMENT sect4 - O (head?, (para | %lists; | %floating;)*) >
<!ATTLIST sect4 %commonatts; >
The sect4 element is a container for a level 4 section (sub-sub-subsection) within a sub-subsection element (sect3). It contains an optional head (head), zero or more of the following: paragraphs (para), lists (orderedlist, itemizedlist, desclist) and floating elements. The end tag of this element can be omitted. The element uses the standard attributes.
serial
<!ElEMENT serial - O (author+, editor*, publyear,? title, publwhere?,
publisher?, serialid?, totpages?) ><!ATTLIST serial %commonatts; >
The serial element is a container for serials in the bibliography (bibl). It contains one or more authors (author), zero or more editors (editor), an optional publication year (publyear), the publication title (title), an optional place of publication (publwhere), an optional publisher (publisher), an optional id for the serial (serialid) and an optional total number of pages (totpages).The end tag for this element can be omitted. The element uses the standard attributes.
serialid
<!ELEMENT serialid - O (#PCDATA) >
The serialid element is used for marking up the id of a serial publication within the serial publication element (serial) in the bibliography (bibl). The end tag for this element can be omitted. The element has no attributes.
source
<!ELEMENT source - - (#PCDATA) >
<!ATTLIST source Scheme "Freetext | URL | URN | ISBN | ISSN | FPI" >
The source element is used to indicate a string or number used to uniquely identify the work from which this resource was derived, if applicable. For example, a PDF version of a novel might have a source element containing an ISBN number for the physical book from which the PDF version was derived. It is part of the metadata container element. The element has the following attributes:
- Scheme
- The scheme attribute is used for indicating in which format the source is given.
<source scheme="isbn">951-22-3324-X</source>
standard
<!ELEMENT standard - O (standid, publyear?, standname?,
publisher?, pages?) ><!ATTLIST standard %commonatts; >
The standard element is a container for standards in the bibliography (bibl). Ot contains standard identification (standid), an optional year of publication (publyear), an optional standard name (standname), an optional publisher (publisher) and an optional number of pages in the standard (pages). The end tag of this element can be omitted. The element uses the standard attributes.
standid
<!ELEMENT standid - O (#PCDATA) >
The standid element is used for marking up the id of a standard within the standard element (standard) in the bibliography (bibl). The end tag for this element can be omitted. The element has no attributes.
standname
<!ELEMENT standname - O (#PCDATA) >
The standname element is used for marking up the name of a standard within the standard element (standard) in the bibliography (bibl). The end tag for this element can be omitted. The element has no attributes.
strong
<!ELEMENT strong - - (#PCDATA) >
The strong element is used for marking up portions of the text that need to be presented in a visibly noteable format. Usually this element is presented in boldface. The element has no attributes.
<para>This is a text with something that <strong>needs to be stressed<strong>.</para>
subject
<!ELEMENT subject - - (#PCDATA) >
<!ATTLIST subject Scheme "Internal | LCSH | UDC | DDC | NLM | MeSH |
Colon | JEL | RCHME | AAT | ULAN | TGN |
ICONCLASS | SHIC2 | TGM1 | MSC | YKL | SAB"
Type "Keyword | Notes" >The subject element is used to indicate the topic of the resource. Typically, subject will be expressed as keywords or phrases that describe the subject or content of the resource. The use of controlled vocabularies and formal classification schemas is encouraged. It is part of the metadata container element. The element has the following attributes:
- Scheme
- The scheme attribute is used for indicating in which format the subject is given. If none of the other schemes are suitable, `Internal' should be used.
- Type
- The type attribute is used for indicating if the subject is given as a keyword or as notes.
<subject scheme="internal" type="keyword">medicine</subject>
<subject scheme="internal" type="keyword">injections</subject>
<subject scheme="internal" type="keyword">treatment</subject>
subscript
<!ELEMENT subscript - - (#PCDATA) >
The subscript element is used for marking up portions of the text flow that should be represented as subscripted. The element has no attributes.
superscript
<!ELEMENT superscript - - (#PCDATA) >
The superscript element is used for marking up portions of the text flow that should be represented as superscripted. The element has no attributes.
symlist
<!ELEMENT symlist - O EMPTY -- included automatically -- >
The symlist element is an element that contains a list of all the symbols in the publication. It is generated automatically by the processing application, so the user need not concern himself with it. The element has no attributes. The end tag for this element must be omitted as the element has an EMPTY content and is thus only a placeholder for the figure list.
table
<!ELEMENT table - - (caption? & (thead?, tbody, tfoot?)) >
<!ATTLIST table %commonatts; >
The table element is a container for a table in the publication. It contains an optional heading (head), a table body (tbody), an optional table footer (tfoot) and an optional caption that can occur before or after the table body. The element uses the standard attributes.
<table> <thead> <trow><entry>The table header</entry></trow> </thead> <tbody> <trow><entry>first entry in row 1</entry></trow> <trow><entry>second entry in row 2</entry></trow> </tbody> <tfoot> <trow><entry>This is the table footer</entry></trow> </tfoot> </table>
target
<!ELEMENT target - - (#PCDATA) >
The target element is used for marking up a target for a link in the document. It is used with the link element (link) to connect the two. The element has no attributes.
tbody
<!ELEMENT tbody - O (row+) >
The tbody element is a container for the body of a table. It consists of one or more table rows (row). The end tag for this element can be omitted. The element has no attributes.
term
<!ELEMENT term - - (#PCDATA) >
<!ATTLIST term %commonatts; >
The term element is used to mark up terms in the document. The element uses the standard attributes.
<para>Programs are compiled into runnable form with a <term>compiler</term>.</para>
tfoot
<!ELEMENT tfoot - O (row+) >
The tfoot element is a container for the footer of a table. It consists of one or more table rows (row). The end tag for this element can be omitted. The element has no attributes.
thead
<!ELEMENT thead - O (row+) >
The thead element is a container for the header of a table. It consists of one or more table rows (row). The end tag for this element can be omitted. The element has no attributes.
title
<!ELEMENT title - - (#PCDATA) >
<!ATTLIST title Scheme (Internal | AACR2) #IMPLIED
Type (Main | Long | Short | Alternative |
Subtitle | PartTitle | Spine |
Translated) #IMPLIED >The title element is used for marking up the title(s) of the document and the titles of publications in the bibliography (bibl). The element has the following attributes:
- Scheme
- The scheme attribute is used for indicating which cataloguing system is used for the element. If none of the others are suitable the `Internal' value for the attribute should be used.
- Type
- The type attribute is used for indicating which kind of title is marked up in the title element (title) in question.
<title scheme="internal" type="main">The order of things</title>
<title scheme="internal" type="subtitle">How things are</title>
<title scheme="internal" type="translated">Asioiden laita</title>
toc
<!ELEMENT toc - O EMPTY -- included automatically -- >
The toc element is a placeholder for the table of contents of the publication. It is generated automatically by the processing application, so the user need not concern himself with it. The element has no attributes. The end tag for this element must be omitted as the element has an EMPTY content.
totpages
<!ELEMENT totpages - O (#PCDATA) >
The totpages element is used for marking up the total numer of pages in the various kinds of bibliographic items in the bibliography (bibl). The end tag for this element can be omitted. The element has no attributes.
type
<!ELEMENT type - - (#PCDATA) >
<!ATTLIST type Scheme "DCObject | Freetext" >
The type element is used to indicate the category of the resource, such as home page, novel, poem, working paper, technical report, essay, dictionary. For the sake of interoperability, type should be selected from an enumerated list that is under development in the workshop series at the time of publication of this document. See http://sunsite.berkeley.edu/Metadata/types.html for current thinking on the application of this element. It is part of the metadata container element. The element has the following attributes:
- Scheme
- The scheme attribute is used for indicating in which format the type is given. If none of the DC objects are used, `Freetext' should be used.
<type scheme="DCObject">proceedings</subject>
typed
<!ELEMENT typed - - RCDATA >
The typed element is used for marking up portions of the inline text flow that should be presented as text from a teletyper. The element has no attributes.
url
<!ELEMENT url - O (#PCDATA) >
The url element is used for marking up the uniform resource locator of a network resource (netres) in the bibliography (bibl). The end tag of this element can be omitted. The element has no attributes.
variable
<!ELEMENT variable - - (#PCDATA) >
The variable element is used for marking up variables in a computer related context or other context. The element has no attributes.
<para>If you assign the value 5 to the variable <variable>x</variable>, you will have x=5.</para>
volnr
<!ELEMENT volnr - O (#PCDATA) >
The volnr element is used for marking up the volume of a magazine (magazine) in the bibliography (bibl). The end tag of this element can be omitted. The element ha no attributes.
xref
<!ELEMENT xref - O EMPTY >
<!ATTLIST xref type (bibl | fig | table | sect) bibl
refid IDREF #REQUIRED >The xref element is used as a placeholder for cross-references. It has an EMPTY content and the end tag must thus be omitted. The element the following attributes:
- type
- The type attribute specifies which kind of a cross reference is in question. The bibl value is used for bibliographical references, fig is used for references to figures, table for references to tables and sect for references to chapters and/or sections. The default is bibl.
- refid
- The refid attribute is a required ID reference attribute that shows where the cross-reference points to. Its value corresponds to the referred elements Id attribute.
year
<!ELEMENT year - O (#PCDATA) >
The year element is used for marking up the year of the copyright for the publication. The end tag for this element can be omitted. The element has no attributes.
URL: http://www.hut.fi/Yksikot/Kirjasto/HUTpubl/documents/elemdoc.html
$Date: 1998/02/12 10:13:34 $ JmW
© 1997-1998 TKK