Vendor documentation for the HighWire Abstract DTD (abhw.dtd) Abstract Access Affiliation Article ArticleId ArticleIdList ArticleSet ArticleTitle Author AuthorList AuthorSymbols b Collaboration Caption Copyright CorporateAuthor Collaboration Day Degrees DocumentType EmailAddress Figure FirstName Footnotes History inf Issn Issue it Journal JournalTitle KeyWord LastName Link MiddleName Month p PubDate PublisherName RelatedArticle Replaces Season ShortTitle Suffix sup TOCSection TopicCollection unl URL Year This document summarizes usage guidelines for the HighWire Abstract DTD. You can view a copy of the most recent version of the DTD here.

 

<ArticleSet> The top level container element. (Required: one occurance). The Article element is required within ArticleSet.

 

<Article> Another container element, appearing within ArticleSet and containing all other elements. Although the DTD allows more than one Article to appear within ArticleSet, we ask that only one be included. (Required: one occurance, please).

 

<Journal> Contains information specific to the journal. (Required: one occurance). Elements found within Journal include: PublisherName -- The name of the publisher (required: one occurance). JournalTitle -- The official title of the journal (required: one occurance). Issn -- The journal's ISSN. Please omit entities from within this element (optional: zero or one occurances).

 

<Copyright> The name of the copyright holder. (Optional: zero or one occurances).

 

<Replaces> This element is used solely to replace one version of a file with another version. Use of Replaces is discouraged. Replacing existing versions of published articles rather than publishing new versions obscures publication history, and can make the online journal difficult for readers to cite with confidence. Also, the selfop feature allows publication of new versions, rendering the element unnecessary and deprecated. It will eventually be removed from the DTD entirely. If used, please note that its Indicator attribute is required, and the element itself should remain empty. (Optional: zero or one occurance). Attribute(s): Indicator -- Must be either "yes" or "no".

 

<Access> This element serves as an access indicator. It has one required attribute (Type) which must be set to either "free" or "openaccess". (Optional: zero or one occurances). Attribute(s): Type -- Must be set to either "free" or "openaccess"

 

<RelatedArticle> This element is used to create hyperlinks between related articles. Volume/Issue/FirstPage attributes should be used if the related article is already in print; the pii attribute should be used if the related article is not yet in print. (Optional: zero, one or more occurances). Attribute(s): Type -- Must be "iti" (In This Issue, most common relationship), "err" (Erratum), or "ret" (Retraction) Volume -- Required if the related article is in print Issue -- Optional if the related article is in print FirstPage -- Required if the related article is in print pii -- Required if the related article is not yet in print

 

<History> The publication history of the article. (Optional: zero or one occurrance). It has one child element -- PubDate -- at least one instance of which is required: PubDate -- Attribute(s): PubStatus -- Must be either "received", "revised", or "accepted". (Required: one occurance). The following elements can appear within PubDate: Year (required: one occurrance). If left empty, our system will default to the current year, so it is adviseable to include the correct value in this element. Month (optional: one occurance). If left empty, the system may drop the entire PubDate from the display. Day (optional: one occurance). If left empty, the system may drop the entire PubDate from the display. Season (optional: one occurance if used, use only if a Month is not available) If you plan to use only the Year element within PubDate, please notify HighWire.

 

<ArticleTitle> The main title of the article. (Optional: zero or one occurance).

 

<ShortTitle> An abbreviated version of the article's title. Sometimes referred to as a "running head" in publishing parlance. (Optional: zero or one occurance).

 

<AuthorList> A container element. (Optional: zero or one occurances). The Author element is required within ArticleSet.

 

<Author> Contains author information. (Required: one or more occurances). Attribute(s): Corresponding -- This attribute should be set to "true" if the author in question is the article's corresponding author. It should be omitted if the author is not the article's corresponding author. (Optional: zero or one occurance). The following elements can appear within Author: FirstName: The author's first name (required: one occurance). MiddleName: The author's middle name (optional: zero or one occurance). LastName: The author's last name (required: one occurance). Suffix: Any generational suffix, such as "Jr." or "III" (optional: zero or one occurance). Degrees: Any degrees, such as "M.D." or "Ph.D." (optional: zero or one occurance). OR CorporateAuthor: A group that authored an article. (Required: one occurance) if neither FirstName/LastName nor Collaboration is present. OR Collaboration: A group that the article's authors are part of, such as "on behalf of the Scientific Study Group". (Required: one occurance) if neither FirstName/LastName nor CorporateAuthor is present. Omit serial "and" and preceding punctuation (such as comma) if an article's last author is a Collaboration. NOTE: The default author typing behavior is to suppress the last author in the content box if the last author is a Collaboration. AND AuthorSymbols: symbols used to visually connect authors with specific affiliations (optional: zero or one occurance). NOTE: the symbols must also be included within the appropriate Affiliation elements. EmailAddress: the e-mail address of the corresponding author (optional: zero or one occurance). URL: the url of the corresponding author. (optional: zero or one occurance). Affiliation: The author's individual affiliation, or else a single affiliation block repeated, depending on what style the journal requires (optional: zero or one occurance). Example of each author having a separate affiliation: <AuthorList> <Author><FirstName>Thomas</FirstName><LastName>Anderson</LastName><Affiliation>First Department of Medicine, University of Edamame.</Affiliation></Author> <Author><FirstName>Alex</FirstName><LastName>Rogan</LastName><Affiliation>Second Department of Medicine, Maki College.</Affiliation></Author> <Author><FirstName>Willis</FirstName><LastName>Davidge</LastName><Affiliation>Third Department of Medicine, Nigiri University.</Affiliation></Author> </AuthorList> Example of resulting display: Thomas Anderson1, Alex Rogan2, and Willis Davidge3 1First Department of Medicine, University of Edamame. 2Second Department of Medicine, Maki College. 3Third Department of Medicine, Nigiri University. Example of a block affiliation: <AuthorList> <Author><FirstName>Thomas</FirstName><LastName>Anderson</LastName><Affiliation>First Departmentof Medicine, University of Edamame (T.A.); Second Department of Medicine, Maki College (A.R.); and Third Department of Medicine, Nigiri University (W.D.).</Affiliation></Author> <Author><FirstName>Alex</FirstName><LastName>Rogan</LastName><Affiliation>First Department of Medicine, University of Edamame (T.A.); Second Department of Medicine, Maki College (A.R.); and Third Department of Medicine, Nigiri University (W.D.).</Affiliation></Author> <Author><FirstName>Willis</FirstName><LastName>Davidge</LastName><Affiliation>First Department of Medicine, University of Edamame (T.A.); Second Department of Medicine, Maki College (A.R.); and Third Department of Medicine, Nigiri University (W.D.).</Affiliation></Author> </AuthorList> Example of resulting display: Thomas Anderson1, Alex Rogan1, and Willis Davidge1 1First Department of Medicine, University of Edamame (T.A.); Second Department of Medicine, Maki College (A.R.); and Third Department of Medicine, Nigiri University (W.D.).

 

<DocumentType> The top level descriptor of the article. For example, "Article" or "Editorial". (Optional: zero or one occurance).

 

<TOCSection> The name of the section the article fits into on the table of contents. This element is used primarily to generate the papbysection page. The element is necessary if you intend to organize articles by section as well as by date. (Optional: zero, one or more occurances).

 

<TopicCollection> Used if the article should be further categorized into a subject collection/s. (Optional: zero, one or more occurances).

 

<KeyWord> Can be used multiple times, once for each keyword in an article. NOTE: Please omit the text string "Keyword" and any trailing and/or separating punctuation that appears in print, as this punctuation will be generated by the system during loading. (Optional: zero, one or more occurances).

 

<ArticleIdList> A container element. (Required: one occurance). The ArticleId element is required within ArticleIdList.

 

<ArticleId> Contains identifying information specific to the article. (Required: one or more occurances). Attribute(s): IdType -- This attribute should be set to "pii" when ArticleId contains the article's PII value, and to "doi" when ArticleId contains the article's DOI value. Only one of these two values is required by the DTD, but HighWire requires that all files include both.

 

<Abstract> The abstract of the article. (Required: one occurance), although it may be left empty if there is no abstract. If the abstract contains multiple paragraphs, use <p> and </p> to begin and end each paragraph. If not, <p> (and </p>) can be omitted.

 

<Footnotes> Footnotes to the article. This element is typically used to contain more elaborate affiliation and/or correspondence information than can be included within the Author element. The p element is not required, but should be used if the footnotes contain more than one paragraph.

 

<Figure> Figures contained in the Abstract. HighWire does not currently support the use of this element. Attribute(s): Loc -- Location of figure. There is one allowable value to this attribute - "Fixed" - which is required. The following elements can be used within Figure: Caption -- The figure's caption (optional: zero or one occurance). Link -- Link to the figure (required: one occurance). Attribute(s): Locator -- The name of the figure, minus the file extension (required: one occurance).

 

Character Formatting The following elements can be used to format data: sup -- superscript inf -- subscript it -- italics b -- bold unl -- underline p -- paragraph