<!-- ============================================================= --> <!-- MODULE: Bibliographic Reference (Citation) Class --> <!-- Elements --> <!-- VERSION: 1.0 --> <!-- DATE: December 2002 --> <!-- --> <!-- ============================================================= --> <!-- ============================================================= --> <!-- PUBLIC DOCUMENT TYPE DEFINITION --> <!-- TYPICAL INVOCATION --> <!-- "-//NLM//DTD Archiving and Interchange DTD Suite Bibliographic Reference (Citation) Class Elements v1.0 20021201//EN" Delivered as file "references.ent" --> <!-- ============================================================= --> <!-- ============================================================= --> <!-- SYSTEM: NLM Archiving and Interchange DTD Suite --> <!-- --> <!-- PURPOSE: Defines the bibliographic reference elements --> <!-- --> <!-- --> <!-- CONTAINS: 1) Default definition of the references class --> <!-- 2) Parameter Entities for attribute lists --> <!-- 3) Models for the bibliographic reference --> <!-- class elements in alphabetical order --> <!-- --> <!-- 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: %emphasis.class; %para-level; %simple-phrase; --> <!-- ============================================================= --> <!-- ============================================================= --> <!-- DEFAULT REFERENCES CLASS --> <!-- ============================================================= --> <!-- BIBLIOGRAPHIC REFERENCE (CITATION)CLASS --> <!-- The elements that may be included inside a Citation (bibliographic reference) --> <!ENTITY % references.class "access-date | annotation | article-title | collab | comment | conf-date | conf-loc | conf-name | day | edition | email | elocation-id | etal | fpage | gov | issn | isbn | issue | lpage | month | name | patent | person-group | pub-id | publisher-loc | publisher-name | season | series | source | std | supplement | time-stamp | trans-source | trans-title | volume | year" > <!--ELEM article-title Defined in %common.ent; --> <!--ELEM collab Defined in %common.ent; --> <!--ELEM conf-date Defined in %common.ent; --> <!--ELEM conf-loc Defined in %common.ent; --> <!--ELEM conf-name Defined in %common.ent; --> <!--ELEM day Defined in %common.ent; --> <!--ELEM elocation-id Defined in %common.ent; --> <!--ELEM email Defined in %common.ent; --> <!--ELEM fpage Defined in %common.ent; --> <!--ELEM issn Defined in %common.ent; --> <!--ELEM issue Defined in %common.ent; --> <!--ELEM lpage Defined in %common.ent; --> <!--ELEM month Defined in %common.ent; --> <!--ELEM publisher-loc Defined in %common.ent; --> <!--ELEM publisher-name Defined in %common.ent; --> <!--ELEM season Defined in %common.ent; --> <!--ELEM title Defined in %common.ent; --> <!--ELEM trans-title Defined in %common.ent; --> <!--ELEM volume Defined in %common.ent; --> <!--ELEM year Defined in %common.ent; --> <!-- ============================================================= --> <!-- PARAMETER ENTITIES FOR ATTRIBUTE LISTS --> <!-- ============================================================= --> <!-- PERSON GROUP ATTRIBUTES --> <!-- Attributes for the <person-group> element --> <!ENTITY % person-group-atts "person-group-type CDATA #IMPLIED" > <!-- PUBLICATION IDENTIFIER ATTRIBUTES --> <!-- Attributes for the <pub-id> element --> <!ENTITY % pub-id-atts "pub-id-type (%pub-id-types;) #IMPLIED" > <!-- xml:lang The language in which the value of the element is expressed. Recommended best practice is to use values as defined in RFC 1766, typically 2-letter language codes such as "FR" (French), "EN" (English), and "DE" (German). These values are NOT case sensitive, so "EN" = "en". The values may include hyphenated differentiators such as "EN-AU" (Australian English) and "EN-US" (United States English). --> <!-- SOURCE ATTRIBUTES --> <!-- Attributes for the <source> and <trans-source> elements --> <!ENTITY % source-atts "xml:lang NMTOKEN #IMPLIED" > <!-- ============================================================= --> <!-- BIBLIOGRAPHIC REFERENCE LIST ELEMENTS --> <!-- ============================================================= --> <!-- REFERENCE LIST MODEL --> <!-- Content model for the <ref-list> element --> <!ENTITY % ref-list-model "title?, (%para-level;)*, ref*, ref-list*" > <!-- REFERENCE LIST (BIBLIOGRAPHIC REFERENCE LIST) --> <!-- List of references (citations) for the article. Often called "References", "Bibliography", or "Additional Reading". No distinction is made between lists of cited references and lists of suggested references. Authoring Note: The optional paragraph-level elements after the title allow for those rare cases where there is explanatory material inside the list, before the references. There may also be similar explanatory material inside each reference group. Explanatory material preceding a citation will need to be placed inside the citation. --> <!ELEMENT ref-list (%ref-list-model;) > <!-- REFERENCE ITEM MODEL --> <!ENTITY % ref-model "label?, (citation | note)+" > <!-- REFERENCE ITEM --> <!-- One item in a bibliographic list, typically a citation describing a referenced work, but some journals may place notes in this list as well as citations. Conversion Note: There is usually a number or other label preceding each citation, which the tagger may choose to preserve using the label attribute. --> <!ELEMENT ref (%ref-model;) > <!-- id Unique identifier so that citation can be referenced --> <!ATTLIST ref id ID #IMPLIED > <!--ELEM citation Defined in %common.ent; --> <!-- NOTE IN A REFERENCE LIST MODEL --> <!ENTITY % note-model "label?, p+" > <!-- NOTE IN A REFERENCE LIST --> <!-- Used to tag non-citation material that sometimes within a reference list, for example, used to tag end note material when such a note is placed within a reference list. Authoring Note: For conversion use only. For creating new reference lists, notes should not be intermingled with citations. --> <!ELEMENT note (%note-model;) > <!-- id Unique identifier so that citation can be referenced --> <!ATTLIST note id ID #IMPLIED > <!-- ============================================================= --> <!-- BIBLIOGRAPHIC REFERENCE CLASS --> <!-- ============================================================= --> <!-- ACCESS DATE FOR CITED WORK --> <!-- The date on which the work which is cited was examined. Some online resources are changing so quickly that a citation to the resource is not complete without the date on which the cited resource was examined, since a day before or a day later the relevant material might be different. Related Elements: The related element <time-stamp> is used to record not the time when a cited resource was examined, but the time stamp that was found on the resource when it was examined, for time-stamped resources. --> <!ELEMENT access-date (#PCDATA) > <!--ELEMENT access-date (#PCDATA | day | month | year)* --> <!-- ANNOTATION IN A CITATION --> <!-- Most citations just provide the bibliographic information for a cited reference but a few describe or comment upon the nature or quality of the reference or summarize its findings. Display Note: All of the other reference elements are inline elements. In contrast, an Annotation may be considered a block element, with space before it and after it.--> <!ELEMENT annotation (p+) > <!-- COMMENT IN A CITATION --> <!-- Used to mark unstructured text within an otherwise element structured reference. In an unstructured reference, this text would merely be data characters. Typical comments could include: <comment>[Abstract]</comment> <comment>translated from Russian</comment> Design Note: The <comment> element is defined here largely for the sake of conversion, to preserve the semantic markup when translating from other DTDs. Authoring and Conversion Note: The Comment element should be used to mark substantive text only; it should NOT be used to markup punctuation that occurs between elements. Display Note: Comments should appear inline with other reference elements. This is a very different rendering from that given the similar element Annotation, which is typically a longer commentary concerning a citation that is rendered as a block element. --> <!ELEMENT comment (#PCDATA | %simple-phrase;)* > <!-- EDITION, CITED --> <!-- The edition number of a cited publication --> <!ELEMENT edition (#PCDATA %just-rendition;)* > <!-- GOVERNMENT REPORT, CITED --> <!-- The identification information (typically the title and/or an identification number) for a cited governmental report or other government publication --> <!ELEMENT gov (#PCDATA %rendition-plus;)* > <!-- ISBN --> <!-- International Standard Book Number --> <!ELEMENT isbn (#PCDATA) > <!-- OTHER REFERENCE ELEMENTS --> <!-- Elements that may be used inside the <other-ref> element. --> <!ENTITY % other-ref-elements " | %ext-links.class; | %label.class; | %references.class; | %simple-text;" > <!-- OTHER REFERENCE --> <!-- A container element to hold the content of a citation when it is not one of the known, well structured types, for example it is a personal communication. Design Note: This element was added for use in more prescriptive authoring DTDs, where a Citation might be given a model with specific elements in specific order. This element is never intended for conversion from another DTD. Authoring/Conversion Comment: This element should NOT repeat NOT be used to tag an ordinary book or journal citation. Remarks: An other-ref may contain any of the following, so that PubMed Central or other matching processing can make the citation into a live link: source The MEDLINE abbreviation of the journal name article-title Title of the article volume Volume of the journal issue Issue of the journal fpage Page number on which the article starts name Of an author or editor year Year of publication month Month of publication (if present) day Date of publication (if present) --> <!ELEMENT other-ref (#PCDATA %other-ref-elements;)* > <!-- PATENT NUMBER, CITED --> <!-- The identification information (typically the patent number or number and name) for a cited patent --> <!ELEMENT patent (#PCDATA %just-rendition;)* > <!-- PERSON GROUP FOR A CITED PUBLICATION --> <!-- Wrapper element for one or more authors, editors, translators, etc. named in a cited reference. Remarks: Similar to the <contrib-group> element in the metadata, but could not use the same name (as this is a DTD not a schema) since the content is different. --> <!ELEMENT person-group (name | aff |etal)* > <!-- person-group-type Identifies the "role" of the persons being named, a group of authors, a group of editors, members of the G&S chorus, etc. Valid Types include: author - Content creators editor - Content editors guest-editor - Content editor that has been invited to edit all or part of a work inventor - Idea, software, or machine creator assignee - Person to whom a patent is awarded translator - Translated the cited work from one language into another trans-editor - Editor of a translated version of a work all-authors - Used to identify a complete list of authors when a subset of the author group is used elsewhere in the citation. This may occur, for example, when a citation identifies both a book and a chapter within the book. complier - Put together a composite work from multiple sources --> <!ATTLIST person-group %person-group-atts; > <!-- PUBLICATION IDENTIFIER FOR A CITED PUBLICATION --> <!-- The identifier of a publication such as a related journal article that is listed within a Citation <citation> inside the bibliographic reference list <ref-list> of an article. --> <!ELEMENT pub-id (#PCDATA) > <!-- pub-id-type The "pub-id-type" attribute names the type of identifier, or the organization or system that defined this identifier for the identifier of the journal article or a cited publication. Used on the <article-id> element, which holds an identifier for the entire article. Also used on the <pub-id> element, which is an identifier for a publication cited in a bibliographic reference (citation). Valid Types include: coden - Obsolete PDB/CCDC identifier, may be present on older articles doi - Digital Object Identifier for the publication being referenced medline- NLM Medline identifier other - None of the named identifiers pii - Publisher Item Identifier, see /epub/piius.htm pmid - PUBMED ID (see www.ncbi.nlm.nih.gov/entrez/ query.fcgi?db=PubMed) publisher-id - Publisher's identifying number such as an 'article-id', 'artnum', 'identifier', 'article- number', etc. sici - Serial Item and Contribution Identifier (SICI). A journal article may have more than one SICI, one for a print version and one for an electronic version. --> <!ATTLIST pub-id %pub-id-atts; > <!-- SERIES --> <!-- Container element for any series information used in a citation. For example, within a citation to a non-journal item that spans multiple volumes, this element could contain the unique title of the entire series: <citation citation-type="book"> <name>...</name> and <name>...</name> <year>1989</year>. <series>The Birds of South America</series>. <volume>1</volume>. <source>The Oscine Passerines</source>. <publisher-name>University of Texas Press</publisher-name> , <publisher-loc>Austin</publisher-loc> </citation> --> <!ELEMENT series (#PCDATA %rendition-plus;)* > <!-- STANDARD, CITED --> <!-- The identification information (typically the standard number, organization, and name) for a cited standard, where "standard" is defined as a document produced by a recognized standards body such ISO, IEEE, OASIS, ANSI, etc. --> <!ELEMENT std (#PCDATA %rendition-plus;)* > <!-- SOURCE ELEMENTS --> <!-- The elements that can be included along with data characters inside the content model of a source. --> <!ENTITY % source-elements "| %emphasis.class; | %ext-links.class; | %subsup.class;" > <!-- SOURCE --> <!-- Within a citation, this is the title of a journal, book, conference proceedings, etc. that is the source of the cited material. --> <!ELEMENT source (#PCDATA %source-elements;)* > <!-- xml:lang The language in which the value of the element is expressed. Recommended best practice is to use values as defined in RFC 1766, typically 2-letter language codes such as "FR" (French), "EN" (English), and "DE" (German). These values are NOT case sensitive, so "EN" = "en". The values may include hyphenated differentiators such as "EN-AU" (Australian English) and "EN-US" (United States English). --> <!ATTLIST source %source-atts; > <!-- TIME STAMP FOR CITED WORK --> <!-- Used to record any time stamp that was found on the cited resource when it was examined, for resources such as databases that may use a time signature to identify different versions. Note: This is not the time when the cited resource was examined, but rather the time it was produced, distributed, whatever milestone the resource creators chose to stamp time stamp. Related Element: <access-date> is the date on which the cited work was examined. Some online resources are changing so quickly that a citation to the resource is not complete without the date. --> <!ELEMENT time-stamp (#PCDATA) > <!-- TRANSLATED SOURCE --> <!-- Within a citation, this is the title of a journal, book, conference proceedings, etc. that is the source of the cited material, but with the source name given in a different language from the source as given in the <source> element. For example, if an article is originally in French, the <source> name would be the French name and the <trans-source> might be in English. --> <!ELEMENT trans-source (#PCDATA %source-elements;)* > <!-- xml:lang The language in which the value of the element is expressed. Recommended best practice is to use values as defined in RFC 1766, typically 2-letter language codes such as "FR" (French), "EN" (English), and "DE" (German). These values are NOT case sensitive, so "EN" = "en". The values may include hyphenated differentiators such as "EN-AU" (Australian English) and "EN-US" (United States English). --> <!ATTLIST trans-source %source-atts; > <!-- ================== End Bibliographic Class Module =========== -->