Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Live Search
spaceKeyEUDR
placeholderSearch this space

On this page

Table of Contents

In this section

Child pages (Children Display)
pageJATS/NLM XML Export

Author Names

The eXtyles Advanced Process for Author Processing will parse paragraphs with author names into their constituent elements (surname, given names, initials, prefixes, and suffixes) as well as identifying organizational authors. eXtyles can also be configured to distinguish between various types of contributors (e.g. authors and editors) depending on context in the document.

The author list must be reviewed after running Author Processing to ensure that the various elements have been correctly identified. Certain situations can cause problems for Author Processing in the standard eXtyles configuration:

  • names in non-Western order (i.e. Surname Given-Names)

  • multi-word surnames separated by spaces

  • unusual or non-standard degree names. 

Please be aware that degree names must be explicitly listed in an eXtyles data file.

If you find that a degree is not shaded with the correct color, then it’s likely that it is not listed in the eXtyles data file and eXtyles misapplied the au_orgname character style instead.

When this happens, please fix the character style manually and report the missing degree to eXtyles Support.

ikl

Info

Errors in Author Processing can be corrected by careful hand tagging.

Info

Introductory text in an "author" paragraph, such as "Edited by", must also be styled, in this case as au_prefix.

ORCIDs

ORCIDs are generally collected by online submission systems and made available to publishers in XML transmittal files.

This metadata can be imported into your Word file using the Metadata Browse/Import function in the Document Information dialog, and the ORCID and author information can then be synchronized, validated, and merged with the Author paragraph in the Word file during Author Processing (see ORCID Support in Author Processing).

ORCIDs can also be manually inserted into your Word file If ORCID(s) are included in the author line of a manuscript in this form:

Screenshot of an example author list with applied character styles to each name and ORCIDs in parentheses after each name

then eXtyles will export them as:

Code Block
languagexml
<ext-link ext-link-type="orcid" xlink:href="http://orcid.org/0000-0001-6858-8806"/>
http://orcid.org/0000-0001-6858-8806
</ext-link>

inside the <contrib> element when using the NLM DTD (any version), or as:

Code Block
languagexml
<contrib-id contrib-id-type="orcid">http://orcid.org/0000-0001-6858-8806</contrib-id>

when using JATS, which added the new contrib-id element.

Author Affiliations

Author affiliations can be edited as one affiliation per paragraph or multiple affiliations in a single paragraph.

Option 1: One affiliation per paragraph

In the "one affiliation per paragraph" style, when superscript letters, numbers, or symbols are used to link affiliations to authors, the linking character must be at the start of the affiliation paragraph.

The following author list and affiliations will parse correctly:

Screenshot of an author and affiliation list. The author list and affiliation footnotes are correctly character-styled matched

This style makes good use of space if multiple authors share affiliations. The example yields the following XML:

Code Block
languagexml
<contrib-group>
<contrib contrib-type="author">
<name><surname>Růžek</surname><given-names>Daniel</given-names></name>
<xref ref-type="aff" rid="aff1"><sup>1</sup></xref>
</contrib>
<contrib contrib-type="author">
<name><surname>Kilian</surname><given-names>Patrik</given-names></name>
<xref ref-type="aff" rid="aff2"><sup>2</sup></xref>
</contrib>
<contrib contrib-type="author">
<name><surname>Tlustý</surname><given-names>Martin</given-names></name>
<xref ref-type="aff" rid="aff3"><sup>3</sup></xref>
</contrib>
<contrib contrib-type="author">
<name><surname>Gelbič</surname><given-names>Ivan</given-names></name>
<xref ref-type="aff" rid="aff4"><sup>4</sup></xref>
</contrib>
<aff id="aff1"><label>1</label>Institute of Parasitology, Biology Centre of the Academy of Sciences of the Czech Republic, Branišovská 31, CZ-37005 České Budějovice, Czech Republic</aff>
<aff id="aff2"><label>2</label>Institute of Parasitology, Biology Centre of the Academy of Sciences of the Czech Republic and Faculty of Science, University of South Bohemia, Branišovská 31, CZ-37005 České Budějovice, Czech Republic </aff>
<aff id="aff3"><label>3</label>Pierre de Coubertin High School, František Křižík Sq. 860, CZ-39030 Tábor, Czech Republic </aff>
<aff id="aff4"><label>4</label>Institute of Entomology, Biology Centre of the Academy of Sciences of the Czech Republic, Branišovská 31, CZ-37005 České Budějovice, Czech Republic</aff>
</contrib-group>

Option 2: Alternating author and affiliation paragraphs

Alternatively, each author’s name can be followed by their affiliation, without the need for affiliation numbers or footnote symbols, as follows:

Screenshot of author and affiliation list. Author names have been character styled and affiliations come directly after each author name. Each piece of content is in a separate paragraph

The XML output from this style is similar to the first example, but there are no links between the author and their affiliation. Instead, each author appears with their affiliation in a separate <contrib-group> element:

Code Block
languagexml
<contrib-group>
<contrib contrib-type="author">
<name><surname>Růžek</surname><given-names>Daniel</given-names></name>
</contrib>
<aff id="aff1">Institute of Parasitology, Biology Centre of the Academy of Sciences of the Czech Republic, Branišovská 31, CZ-37005 České Budějovice, Czech Republic</aff>
</contrib-group>

Option 3: All affiliations in one paragraph

Affiliations 1, 2, and 4 in this example share a street address, and editorially it might be preferable to combine the addresses into a single paragraph and save space.

eXtyles supports this editorial style, and it is possible to obtain correct XML if the affiliations are set up like this:

Screenshot of an author list with the authors character-styled with footnotes listed first with the affiliations listed in a single paragraph after. The footnotes 1, 2, and 4 are matched with specific departments within a single university, while footnote 3 is matched with the school as a whole

which yields this XML:

Code Block
languagexml
<contrib-group>
<contrib contrib-type="author">
<name><surname>Růžek</surname><given-names>Daniel</given-names></name>
<xref ref-type="aff" rid="aff1"><sup>1</sup></xref>
</contrib>
<contrib contrib-type="author">
<name><surname>Kilian</surname><given-names>Patrik</given-names></name>
<xref ref-type="aff" rid="aff3"><sup>2</sup></xref>
</contrib>
<contrib contrib-type="author">
<name><surname>Tlustý</surname><given-names>Martin</given-names></name>
<xref ref-type="aff" rid="aff4"><sup>3</sup></xref>
</contrib>
<contrib contrib-type="author">
<name><surname>Gelbič</surname><given-names>Ivan</given-names></name>
<xref ref-type="aff" rid="aff2"><sup>4</sup></xref>
</contrib>
<aff>Institutes of Parasitology<target id="aff1"><sup>1</sup></target> and Entomology<target id="aff2"><sup>4</sup></target>, Biology Centre of the Academy of Sciences of the Czech Republic, and Faculty of Science, University of South Bohemia<target id="aff3"><sup>2</sup></target>, Branišovská 31, CZ-37005 České Budějovice, Czech Republic; <target id="aff4"><sup>3</sup></target>Pierre de Coubertin High School, František Křižík Sq. 860, CZ-39030 Tábor, Czech Republic</aff>
</contrib-group>

The affiliation IDs are assigned in the order in which they appear in the affiliation paragraph, which does not necessarily correspond to the actual numbers used.

Info

If you would like to be able to support this affiliation style in your content, you should discuss it with any downstream vendors such as online hosting providers, as they may not be able to support this presentation style by default.

Correspondence Details

Similar to affiliations, eXtyles supports linking correspondence details either with or without a footnote symbol.

Both of the following examples will yield the correct correspondence details in the XML:

  1. Corresponding author indicated by a footnote symbol (note style names in brackets)

    Screenshot of a character-styled author list with footnotes, an affiliations list, and a correspondence line. The correspondence has a footnote symbol that is also visible in the author list

    Within the XML, the corresponding author’s name is tagged as follows:

    Code Block
    languagexml
    <contrib contrib-type="author" corresp="yes">
    <name><surname>Gelbič</surname><given-names>Ivan</given-names></name>
    <xref ref-type="aff" rid="aff4"><sup>4</sup></xref>
    <xref ref-type="corresp" rid="cor1">*</xref>
    </contrib>


    A <corresp> element then appears within the <author-notes>. For this example, the element reads:

    Code Block
    <corresp id="cor1">
    <label>*</label>Author for correspondence.
    </corresp>
  2. Corresponding author named in a “correspondence” paragraph without a footnote symbol

    Screenshot of a character-styled author list with footnotes for affiliations. The correspondence does not have a footnote symbol

    A <corresp> element then appears within the <author-notes>. For this example, the element reads:

    Code Block
    <corresp id="cor1">
    <bold>Correspondence:</bold> Ivan Gelbič (<email xlink:href="gelbic@entomology.cz">gelbic@entomology.cz</email>).
    </corresp>
Note

In this example, the corresponding author’s name should match their name in the author line in order for eXtyles to successfully add the appropriate XML (corresp="yes") to the author’s name within the <contrib-group>.

The matching process is more robust if both the given name(s) and surname appear in the correspondence paragraph, rather than just the surname.

Info

The <xref ref-type="corresp"> element appears only if a footnote symbol is used to indicate the corresponding author.

Tip

By default, eXtyles will automatically identify and tag email addresses within Affiliation and Correspondence paragraphs.

Please contact eXtyles Support if you have email addresses in other paragraphs that should be automatically tagged.

Hand-tagging Elements of Author Affiliations and Correspondence Details

Beyond email addresses, eXtyles does not add further granular structure to author affiliations or correspondence paragraphs by default.

However, support is available for a number of individual elements within author affiliation information. With the exception of the country (see below), these elements must be identified manually and tagged carefully by hand.

The elements that are currently supported are Institution, Country, Phone, Fax, and the generic element Address Line. These elements are respectively represented by the following character styles:

  • af_institution

  • af_country

  • af_phone

  • af_fax

  • af_addr-line.

These character styles can be applied to either Affiliation or Correspondence paragraphs.

Here is an example of a hand-tagged Affiliation and Correspondence section:

Screenshot of the author, affiliation, and correspondence section. In addition to the character-styled author name, the institution, address, country, phone, and fax are visibly character styledImage RemovedScreenshot of the author, affiliation, and correspondence section. In addition to the character-styled author name, the institution, address, country, phone, and fax are visibly character styledImage Added

This would generate the following XML:

Code Block
languagexml
<contrib-group>
<contrib contrib-type="author"><name>
<surname>Venter</surname><given-names>J. Craig</given-names>
</name></contrib>
<aff id="aff1"><institution>Synthetic Genomics Inc.</institution>,
<addr-line>11149 North Torrey Pines Road</addr-line>,
<addr-line>La Jolla</addr-line>, <addr-line>CA 92037</addr-line>,
<country>USA</country></aff>
</contrib-group>
<author-notes><corresp id="cor1">Correspondence: <email xlink:href="jcraigventer@synthetic.com">jcraigventer@synthetic.com</email>.
Phone: <phone>+1 555 123 4567</phone>; Fax: <fax>+1 555 987 6543</fax>.
</corresp></author-notes>
Info

There is no requirement for all of the text in either the Affiliation or Correspondence paragraph to be hand-tagged

Only those elements that you want to identify in the XML need to be tagged.

Info

It is possible for eXtyles to parse the country from the affiliation automatically, although this setting is off by default.

Contact eXtyles Support if you require the ability to hand-tag elements of author affiliations and/or you require automatic tagging of countries within affiliations.

Author Biographies

Author biographies can be set up two different ways, depending on your eXtyles configuration.

Option 1

By default, authors are not linked to their biographies in the XML file during export, and are placed in the <back> of the XML file.

Author biographies may be placed anywhere in the Word document.

In this example, the author biography appears after the author affiliation:

Screenshot of Draft View in Word with the Authors, Affiliations, and Author_Biography visible

When exported to XML, author and affiliation are contained in the <front> section of the XML:

Code Block
<contrib-group>
<contrib contrib-type="author"><name>
<surname>Alampay</surname><given-names>Erwin A.</given-names>
</name></contrib>
<aff>National College of Public Administration and Governance
(NCPAG), Raul P. de Guzman St., University of the Philippines, Diliman,
Quezon City 1101, Philippines</aff>
</contrib-group>

and the author biography is in the <back> section:

Code Block
<back>
<bio>
<p>Erwin A. Alampay is an Associate Professor at the National College of
Public Administration and Governance, University of the Philippines.</p>
</bio>
</back>

Option 2

eXtyles can be configured to link authors to their biographies and to move the biography paragraph into the author’s <contrib> element from wherever the paragraph appears in the Word document.

This second configuration yields the following XML:

Code Block
languagexml
<contrib-group>
<contrib contrib-type="author" rid="bio1"><name>
<surname>Alampay</surname><given-names>Erwin A.</given-names></name>
<xref ref-type="aff" rid="aff1">1</xref>
<bio id="bio1">
<p>*Erwin A. Alampay is an Associate Professor at the National College of
Public Administration and Governance, University of the Philippines.</p>
</bio></contrib>
<aff id="aff1"><label>1</label>National College of Public Administration
and Governance (NCPAG), Raul P. de Guzman St., University of the Philippines,
Diliman, Quezon City 1101, Philippines</aff>
</contrib-group>

With linked biographies, the <bio> element can also be placed in within the <back> section of the XML file, depending on your export filter configuration.

Note

Linking requires an exact match between the authors’ names in the author paragraph and the biography paragraph.

Tip

If you require linking between biographies and authors, please contact eXtyles Support

Author Contributions

The JATS and NLM Book DTDs do not contain an element that is specifically designed to accommodate details of authors’ contributions to a study.

Within the eXtyles JATS configuration, the most appropriate paragraph style to use is Author_Footnote.

There are a couple of limitations to the use of Author_Footnote to accommodate author contribution information:

  1. Each paragraph of the author contribution information will be exported as a separate footnote in the XML.

  2. There is no style for a distinct Contributors heading paragraph; a run-in head should be used.

Example:

This paragraph in Word, styled as Author_Footnote:

Contributors: Some information about contributors.

would be rendered as follows in the XML by default:

Code Block
languagexml
<author-notes>
<fn id="afn1"><p><bold>Contributors:</bold> Some information about contributors.</p></fn>
</author-notes>

More sophisticated handling of author contribution information (for example, inclusion of an fn-type attribute, e.g. fn-type="contributors") would require additional customization of your export filter.