Authoring Changes in Classes

The following changes were made to articleauthcustom-classes3.ent:

• Alternatives — Redefined %alternatives-display.class; to remove array and private-char, which are not used in Authoring. Added <alternatives> to %inline-display.class;.
• Chemical Structure — Added <chem-struct> to the override for %simple-display.class;, which adds <chem-struct> to the models of the following elements in the Authoring Tag Set:
  • <chem-struct> (using %chem-struct-elements;)
  • <disp-formula> (using %disp-formula-elements;)
  • <fig> (using %fig-model;)
  • <td> (using %inside-cell;)
  • <th> (using %inside-cell;)
• Citations — Added <element-citation> to the override for %citation.class;, which adds <element-citation> to the models of the following elements in the Authoring Tag Set:
  • entry (using %inside-cell;)
  • <license-p> (using %license-p-elements;)
  • <p> (using %p-elements;)
  • <subtitle> (using %title-elements;)
  • <td> (using %inside-cell;)
  • <th> (using %inside-cell;)
  • <trans-title> (using %title-elements;)
• Display Back Matter — Deleted the parameter entity %display-back-matter.class; since the override and the Suite default were the same..
• References Class — The Authoring Tag Set no longer overrides %references.class;, which is used in the models of <mixed-citation>, <element-citation>, <product>, <related-article>, and <related-object>.
  In articleauthcustom-classes3.ent, removed the %references.class; as duplicative of the Suite default.
  In default-classes3.ent, in %references.class;, added the elements:
  • <chapter-title>,
  • <part-title>,
  • <date-in-citation>,
  • <size>,
  • <string-name>, and
  • <volume-series>.
  
  Also deleted the following elements from %references.class;:
  • <access-date> (replaced by <date-in-citation>),
  • <page-count> (replaced by <size>), and
  • <time-stamp> (replaced by <date-in-citation>).
  
  The default references class (used by all Tag Sets) is now:

  annotation | article-title | chapter-title |
  collab | comment | conf-date | conf-loc | 
  conf-name | conf-sponsor | date |
  date-in-citation | day | edition | email | 
  elocation-id | etal | ext-link | fpage | 
  gov | institution | isbn | issn | 
  issue | issue-id | issue-part | issue-title | 
  lpage | month | name | object-id | 
  page-range | part-title | 
  patent | person-group | pub-id | 
  publisher-loc | publisher-name | role |
  season | series | size | source | std | 
  string-name | supplement | 
  trans-source | trans-title | uri | 
  volume | volume-id | volume-series | year

• Phrase-level Elements — Added <styled-content> to the override for %phrase.class;.
• Roman Emphasis — Added <roman> to the %emphasis.class;.

Authoring Article Metadata

In articleauthcustom-models3.ent, after all the changes to <article-meta> (using the %article-meta-model; override), the final model is:

(title-group, contrib-group, 
(product | supplementary-material)*, 
permissions?, self-uri*, related-article*, 
abstract+, kwd-group?, funding-group*, 
conference*)

In the module articleauthcustom-models3.ent, the following changes were made to the article metadata elements:

• Address Line — In articleauthcustom-models3.ent, changed the model for <addr-line> to include all the elements in the new %address.class; ( <country>, <fax>, <institution>, <phone>, and <addr-line>).
• Collaboration — In articleauthcustom-models3.ent, added new elements to <collab>. Changed the content of %collab-elements; from including %address-link.class; to including %contrib-info.class;, which necessitated removing %address-link.class; to remove duplicate elements.
  Also added %address.class; (<addr-line>, <country>, <fax>, <institution>, and <phone>) to the content of <collab>.
• Funding Information — Replaced the element grouping:

  contract-num*, contract-sponsor*, grant-num*, grant-sponsor*,

  
  with the new “funding-group*”.

Authoring Funding Information

• Replaced Elements — In the module articleauthcustom-models3.ent, deleted the following old Parameter Entity overrides:
  • contract-elements
  • contract-sponsor-elements
  and inserted the following new (equivalent) overrides:
  • %award-id-elements;
  • %funding-source-elements;
• Inside the element <article-meta>, replaced the element grouping (contract-num*, contract-sponsor*, grant-num*, grant-sponsor*,) with the new funding-group*.

Authoring Other Metadata Changes

• Collab — In articleauthcustom-models3.ent, enhanced the model of <collab> (using %collab-elements;) to allow additional elements inside a <collab>, to make it more like a contributor. The original model for <collab> included the face markup and internal cross references:

  %rendition-plus; | %address-link.class;

  • Added the elements of the %contrib-info.class; to this OR mix. That adds the following elements to <collab>:

    address | aff | author-comment | bio | 
    email | etal | ext-link | on-behalf-of |
    role | uri | xref

  • Also added %address.class;, which added the elements:

    addr-line | country | fax | institution | phone

  
  (Implementor’s Note: When %contrib-info.class; was added to <collab>, that caused some duplication errors. Therefore, changed the content of %collab-elements; from including %address-link.class;, since %contrib-info.class; provides the same elements.)
• Keyword Group — In articleauthcustom-models3.ent, overrode the model of <kwd-group> to remove <label> (using %kwd-group-model;):

  (title?, (%kwd.class;)+ )

• related-article-elements — In articleauthcustom-models3.ent, removed the override for the content of <related-article> (%related-article-elements;) so that Publishing and Authoring would share a <related-article> model. The new elements for the mixed-content model are:

  "| %emphasis.class; | %journal-id.class; |
  %phrase-content.class; | 
  %references.class; | %subsup.class;" 

  
  This change deleted the following elements from the model: <abbrev>, <fn>, <inline-formula>, <inline-graphic>, <inline-supplementary-material>, <related-article>, <target>, and <xref>.

Authoring Back Matter Elements

Authoring Structural Elements

• Boxed Text — In articleauthcustom-models3.ent, changed the model of <boxed-text> from using the parameter entity %sec-opt-title-model; to replicating the content of that model. The parameter entity %boxed-text-model; was changed to the following, with <title> replaced by <caption>:

  <!ENTITY % boxed-text-model
  "((%id.class;)*, caption?, (%para-level;)*, 
  (%sec-level;)*, %display-back-matter; )" >
  

• Figure and Supplementary Material —Removed <chem-struct-wrap> from within the following elements:
  • <fig> (using %fig-model;)
  • <supplementary-material> (using %fig-model;)

Authoring Chemical Structures Changes

Although it was not the intent when the Tag Sets were written, most Tag Set users have been treating <chem-struct> as an inline and <chem-struct-wrap> as a block structure. This greatly simplifies all processing with the two and seems quite flexible, so steps were taken to regularize this usage:

• As an inline object, <chem-struct> should be able to be used anywhere that <inline-formula> is used; therefore, <chem-struct> has been added to %inline-math.class; (in the Authoring override in articleauthcustom-models3.ent).
• As an inline object, <chem-struct> should not be used as a block-level object, so it was removed from %block-display.class; (in the Authoring override in articleauthcustom-models3.ent).
• As an inline object, <chem-struct> must be inside <chem-struct-wrap> (using %chem-struct-wrap-model;) (in the Authoring override in articleauthcustom-models3.ent).
• As a block object, <chem-struct-wrap> needs to be everywhere block display objects are used, so it needs to be part of the %block-display.class;, which it already was in the Authoring override (in articleauthcustom-models3.ent).
• As a block object, <chem-struct-wrap> should be inside figures (using %fig-model;), which it already was in the default and the Authoring override (in articleauthcustom-models3.ent).
• Changed the OR group allowed inside a <table-wrap> (using %inside-table-wrap;) to allow <chem-struct-wrap> instead of <chem-struct> in display3.ent.

The element <chem-struct-wrap> has been removed from within the following elements, where it has been allowed in previous versions, allowing only the inline <chem-struct> to be used. [Backward incompatible]

• <td> and <th> (using %inside-cell;)
• <term> (using %term-elements;)

The element <chem-struct> has been removed from within the following elements, where it has been allowed in previous versions, allowing only the block <chem-struct-wrap> to be used. [Backward incompatible]

• <table-wrap> (using %inside-table-wrap;)

Following these changes, <chem-struct> can appear in the following elements:

• <alternatives>
• <article-title>
• <attrib>
• <bold>
• <chem-struct-wrap>
• <mixed-citation>
• <comment>
• <conf-theme>
• <def-head>
• <disp-formula>
• <element-citation>
• <inline-formula>
• <italic>
• <label>
• <license-p>
• <monospace>
• <named-content>
• <overline>
• <p>
• <product>
• <roman>
• <sc>
• <strike>
• <styled-content>
• <sub>
• <subtitle>
• <sup>
• <supplement>
• <td>
• <term>
• <term-head>
• <th>
• <title>
• <trans-title>
• <underline>
• <verse-line>

Following these changes, <chem-struct-wrap> can appear in the following elements:

• <bio>
• <body>
• <boxed-text>
• <fig>
• <license-p>
• <named-content>
• <p>
• <sec>
• <styled-content>
• <table-wrap>

Authoring Attribute Changes

• Article Types — In articleauthoring3.dtd, removed the parameter entity article-types that explicitly named the types of articles and made the value of the @article-type on the element <article> into CDATA.
  In previous Authoring Tag Sets, the following article type values were named explicitly. Since the value is now completely open, these values are reduced to a mention in the documentation as potential article type values.

  abstract | addendum | announcement | 
  article-commentary | book-review | 
  books-received | brief-report | calendar | 
  case-report | correction | discussion |
  dissertation | editorial | in-brief | 
  introduction | letter | meeting-report | 
  news | obituary | oration | other | 
  product-review | rapid-communication | 
  reply | research-article | retraction | 
  review-article

• Citation Types — Removed the override for %citation-atts; as it is now the same as the default, which is described below.
  The previous values for the citation-type attribute used on <mixed-citation> (previously citation) and <nlm-citation> were confusing, mixing together values such as “book” and “thesis” that described the type of publication and “gov” that described the publisher. There was no way to say that something was a government-published book. Therefore, in articleauthcustom-models3.ent, the attribute citation-type was deleted from %citation-atts;, and the following attributes were added for all three types of citations (<mixed-citation>, <element-citation>, and <nlm-citation>):
  • @publication-type — The type of object (journal, book, patent) that contains the cited material. While the attribute values are not constrained, typical values include: journal, book, patent, report, thesis, website, standard, book-part ( a chapter or an article from a book where the entire book is not being cited), conf-proc (conference proceeding), working paper, list (list serve), blog, online-ref (an online reference such as Wikipedia or an online dictionary), court-case, database, communc (a personal communication such as a conversation, letter, or personal email), or discussion (implies group communication, usually face to face, as opposed to an online list discussion). This is the most important of the new attributes and best practice is now to use it whenever possible, as downstream processing many require this information.
  • @publisher-type — Describes the type of organization that publishes the cited material. While not constrained, typical values include: gov (government), std-body (standards body), personal (personal imprint), society, non-profit, ngo, etc. Unless it is important that the cited material is of a particular type, this attribute need not be used. For example, while it may be true that a cited journal was published by a commercial publisher (value “commercial”), that is rarely recorded. This attribute can preserve information about the publisher where a citation has recorded this material.
  • @publication-format — What format of the reference is being cited, for example, print, online, video, audio, etc. This attribute should be used when known for non-print sources.
  • @content-type — Provides a way to preserve or add semantic distinctions.
• Graphic Attributes — In articleauthcustom-models3.ent,
  • Removed the attribute alternative-form-of from:
    • <graphic> (using %graphic-atts;)
    • <inline-graphic> (using %inline-graphic-atts;).
  • Also removed the attribute alt-version from <graphic> (using %graphic-atts;).
  • Also added @specific-use to <graphic> (using %graphic-atts;).
• List — In articleauthcustom-models3.ent, added the following attributes to <list> (using %list-atts;):
  • @list-content (for semantic distinctions)
  • @continued-from (an IDREF-type attribute that can be used to point to the previous list in a series of lists to distinguish the parts of superlists. This element is not intended for generation of numbering.
• List Item — In articleauthcustom-models3.ent, removed the override for %list-item-atts; since it was the same as the Suite default.
• Orientation — In articleauthcustom-models3.ent, added the new attribute @Orientation, that takes the values “portrait” and “landscape”. The attribute was added to %display-atts; (therefore, adding it to the elements <boxed-text>, <chem-struct-wrap>, <fig>, <graphic>, <media>, <preformat>, <supplementary-material>, and <table-wrap>.
• Specific Use Sections — In articleauthcustom-models3.ent, added @specific-use to <sec> (using %sec-atts;).