NCBI Historical Book DTD Content and Attribute Over-ride Module

<!-- ============================================================= -->
<!--  MODULE:    NCBI Historical Book Content & Attribute Module   -->
<!--  VERSION:   2.3                                               -->
<!--  DATE:      February 2007                                     -->
<!--                                                               -->
<!-- ============================================================= -->

<!-- ============================================================= -->
<!--                    PUBLIC DOCUMENT TYPE DEFINITION            -->
<!--                        TYPICAL INVOCATION                     -->
"-//NLM//DTD NCBI Historical Book DTD Content and Attribute Over-ride Module v2.3 20070202//EN"
     Delivered as file ""historical-models.ent"                    -->
<!-- ============================================================= -->

<!-- ============================================================= -->
<!-- SYSTEM:     NCBI Historical Book DTD                          -->
<!--             Archiving and Interchange DTD Suite               -->
<!--                                                               -->
<!-- PURPOSE:    To declare the Parameter Entities (PEs) used to   -->
<!--             over-ride content models or parts of content      -->
<!--             models when making a new DTD from the modules of  -->
<!--             the Archiving and Interchange DTD Suite.          -->
<!--                                                               -->
<!--             Or-groups within models should use mixes or       -->
<!--             classes rather than name elements directly.       -->
<!--                                                               -->
<!--             Note: Since PEs must be declared before they      -->
<!--             are used, this module must be called before the   -->
<!--             content modules that declare elements.            -->
<!--                                                               -->
<!-- CONTAINS:   1) PEs that define OR lists of elements to be     -->
<!--                mixed with #PCDATA in element content models   -->
<!--                (all PEs are named "yyy-elements", where "yyy" -->
<!--                is the name of the primary element whose       -->
<!--                content model will use the declared PE.)       -->
<!--             2) PEs that define complete content models.       -->
<!--                (names ending in the suffix "-model")          -->
<!--             3) PEs that define attribute list or attribute    -->
<!--                value over-rides                               -->
<!--                                                               -->
<!-- CREATED FOR:                                                  -->
<!--             Digital Archive of Journal Articles               -->
<!--             National Center for Biotechnology Information     -->
<!--                (NCBI)                                         -->
<!--             National Library of Medicine (NLM)                -->
<!--                                                               -->
<!-- ORIGINAL CREATION DATE:                                       -->
<!--             December 2004                                     -->
<!--                                                               -->
<!-- CREATED BY: Bart Trawick    (NCBI)                            -->
<!--             Jeff Beck       (NCBI)                            -->
<!--             Michael North   (NLM)                             -->
<!--             Deborah Lapeyre (Mulberry Technologies, Inc.)     -->
<!--             B. Tommie Usdin (Mulberry Technologies, Inc.)     -->
<!--                                                               -->
<!--             Suggestions for refinements and enhancements to   -->
<!--             this DTD should be sent in email to:              -->
<!--                         -->
<!-- ============================================================= -->

<!-- ============================================================= -->
<!--                    DTD VERSION/CHANGE HISTORY                 -->
<!-- ============================================================= -->

Version  Reason/Occasion                   (who) vx.x (yyyy-mm-dd)

     Version 2.3                       (DAL/BTU) v2.3 (2007-02-02)
     Enhancement Release (2.3) following the Working Group meetings 
     of Oct-Nov/2006-Jan/2007. No backward-incompatible changes.
     Archiving loosened even more. New structures for all the DTDs. 
  6. ANNOTATION ATTRIBUTES - Removed the attribute list for
     <annotation>. Now that the Suite also have an -%annotation-atts;
     it can be redefined in this module without being declared in 
     this module.
  5. Updated public identifier to "v2.3 20070202//EN"          

     Version 2.1                       (DAL/BTU) v2.1 (2005-06-30)
     Changed to MathML 2.0 and MathML 2.0 Character Sets
     Added new material requested by NLM/NCBI   

  4. DATE-TYPEs - Deleted the parameter entity that named these,
     since the "date-type" attribute has been set to CDATA by the
     Book model customization module that is used by Historical. 
     The suggested values are retained as part of the documentation.
  3. REFERENCE-TYPES - Book needed the same new reference types
     which Historical already had, so moved the ref-type
     over-ride from this module to the Book override module.
     The Historical DTD first calls bookcustom-models then 
     historical-models, so there is content change in the
     Historical DTD.
  2. PERMISSIONS - Added a new <permissions> wrapper element to
     consolidate copyright and licensing information. For backwards
     compatibility, the new element will be added alongside the
     existing copyright elements. Best practice will be to use the
     new container, but <copyright-statement>, <copyright-year>,
     and <license> will be accepted in their old positions inside
      - Added <permissions> to <book-meta> model
      - Added <copyright-holder> to <permissions>
  1. Updated public identifier to "v2.3 20070202" 

<!-- ============================================================= -->
<!--                    DUPLICATE ATT-LISTS USED IN THE OVER-RIDES -->
<!--                    BELOW, THUS REPEATED HERE                  -->
<!-- ============================================================= -->

<!--                    MIGHT LINK XLINK ATTRIBUTES                -->
<!--                    Attributes for any element that may be a link
                        but need not be one                        -->
<!ENTITY % might-link-atts
            "xmlns:xlink CDATA                            #FIXED
             xlink:type  (simple)                   #FIXED 'simple'
             xlink:href  CDATA                            #IMPLIED 
             xlink:role  CDATA                            #IMPLIED
             xlink:title CDATA                            #IMPLIED
             xlink:show  (embed | new | none | other | replace)
                         (none | onLoad | onRequest | other)          
                                                          #IMPLIED"  >

<!-- ============================================================= -->
<!--                    COMPLETE CONTENT MODEL OVER-RIDES          -->
<!-- ============================================================= -->

<!--                    BOOK METADATA                              -->
<!--                    Content model for the Book Metadata 
                        <book-meta> element                        
                        Added printer
                        Conversion Note: The <history> element is
                        slightly over-loaded as it describes both
                        the history of the work and the history
                        of the electronic transcription           -->
<!ENTITY % book-meta-model
                        "(book-id+, book-title-group,  
                         volume?, volume-id*, edition?, series*,  
                         (contrib-group | aff | author-notes)*, 
                         publisher*, printer*, isbn*, 
                         pub-date*, history?, copyright-statement?, 
                         copyright-year?, permissions?,  
                         self-uri*, alternate-form*, 
                         abstract*, trans-abstract*, kwd-group*, 
                         (%address-link.class; | %custom-meta.class; |
                          %front-back.class;)*)"                     >                      

<!-- ============================================================= -->
<!--                    ATTRIBUTE LIST OVER-RIDES                  -->
<!-- ============================================================= -->

<!--                    ANNOTATION ATTRIBUTES                      -->
<!--                    Attribute list for the <annotation> element,
                        which is defined in %references.ent; This
                        is an over-loaded element, since the
                        <annotation> in the Historical Tag Set has 
                        almost the same semantic but and entirely 
                        different usage from the <annotation>
                        element in the NLM Suite.
                            For the purposes of this Historical Tag 
                        Set, annotations of  historical material 
                        are considered to be of two types: 
                          - those with content, that is those 
                            add words to the text (for example, a
                            penciled marginal note) and those that 
                            merely decorate words already in the 
                            text, for example, a phrase underlined 
                            in pencil.
                          - Text-bearing annotations, whether inline
                            or block-level, use the <annotation> or 
                            the <alt-text> elements. Decorations use 
                            the <named-content> element with the 
                            attribute "content-type" taking values 
                            like "underline" and "yellow 
                           The <annotation> and <named-content>
                        elements are not defined in this module, since
                        they were already part of the NLM Archiving 
                        and Interchange DTD Suite when this DTD was
                        was written. No changes were needed to the
                        <named-content> element except that it is
                        allowed in a few more places through the
                        modification of the %phrase.class; and
                        %emphasis.class; elements.
                           In the Suite, however, the <annotation>
                        element is only used within citations. In 
                        this DTD, it is a block-level element at the 
                        same level as a paragraph (%para-level;) as 
                        well as an inline-element inside textual 
                        passages (%emphasis.class;). New attributes 
                        were  added to <annotation> to describe some 
                        of these new roles/purposes. 
                        Identification of the subject or type of
                        content contained in the annotation.
                           As an example, this attribute could be 
                        used to indicate that additional material,
                        not in the original document, has been 
                        added using this annotation to indicate the
                        modern form of a disease name or technical
                        term. Similarly, this attribute could be 
                        used to mark that an annotation provided 
                        commentary on the material, or to say that 
                        this was penciled marginalia in the printed 
             time-frame Was the annotation added as part of the
                        current editorial process or is this a
                        historical annotation.
                        Values are:
                        current   Annotation is added as part of
                                  making this work accessible 
                                  through the NCBI Bookshelf or
                                  other current archiving project
                                  The work, as examined, was
                                  annotated in this fashion. No
                                  attempt is made at dating the
                                  annotation, penciled notes from 
                                  1863 or 1963 are both historical.
             agent      The person or role of the person who made 
                        the annotation. The agent may not be known
                        and if it is not, this attribute should
                        not be used. While this attribute may
                        take any values; suggested values include:
                          author  - Original content creator 
                          editor  - Content editor 
                                  - Put together a composite work
                                    from multiple sources
                                  - Annotation was added as part
                                    of cataloging or other library
                          owner   - Book came from a known collection
                                    and the owner annotated his/her
                                  - Translated the cited work from 
                                    one language into another
            xlink:href Provides an address or identifier of the
                        object to which the link points, for
                        example a URI or a filename                --> 
<!ENTITY % annotation-atts
                        CDATA                            #IMPLIED 
             time-frame (current | historical)           #IMPLIED
             agent      CDATA                            #IMPLIED
             %might-link-atts;"                                      >             

<!-- ================== End NCBI Historical Content/Attr Over-ride -->