Page tree

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 10 Next »

A journal issue is built up from articles, each article is a file with an <article> XML-root-element. The article metadata, like the title and authors, and the journal it appears in, with a title, series information etc. are all included in this <article> element.

This document describes a subset of JATS specific for Brill journals. See jats.nlm.nih.org for NLM’s own description of the JATS standard. Their description is normative. This document describes a subset to help uniformity in Brill Journal Article XML.

DOCTYPE


Always add the following <!DOCTYPE> declaration to Brill journal articles:

<!DOCTYPE article PUBLIC "-//NLM//DTD JATS (Z39.96) Journal Publishing DTD v1.1 20151215//EN" "https://jats.nlm.nih.gov/publishing/1.1/JATS-journalpublishing1.dtd">

Article Metadata

elementattribute(s)requireddescription
<article>

xml:lang

xmlns:xlink

xmlns:mml

dtd-version

specific-use

article-type

yes

/article is the root element in JATS.

@xml:lang is required and indicates the main language of the article. Supported values are ISO 639-2 (B).

xmlns:xlink="http://www.w3.org/1999/xlink" is required

Use xmlns:mml="http://www.w3.org/1998/Math/MathML" if and only if the article contains an element from MathML.
Brill uses MathML3.

dtd-version="1.0" is required for all articles

For all Advance Articles, add @specific-use="prepub" to the root element. Do not add <volume> or <issue>.

@article-type:

Kind or type of the article. The author or Brill will notify the typesetter of this value. Usually, it is "research-article".

Brill supports all 29 values for @article-type that NLM prescribes: "abstract", "addendum", "announcement", "article-commentary", "book-review", "books-received", "brief-report", "calendar", "case-report", "collection", "correction", "discussion", "dissertation", "editorial", "in-brief", "introduction", "letter", "meeting-report", "news", "obituary", "oration", "partial-retraction", "product-review", "rapid-communication", "reply", "reprint", "research-article", "retraction", "review-article", "translation".

Optionally, with Brill permission, a typesetter may use "other" as a value for this attribute.

Please Note: for any files that include one of the following values for @article-type:

"correction", "editorial", "introduction", "obituary", "partial-retraction", or "retraction" the element <ali:free_to_read xmlns:ali="http://www.niso.org/schemas/ali/1.0/"/> is Required under <permissions> (as explained in more detail below).

  • <front>

yes
    • <journal-meta>

yes
      • <journal-id>
journal-id-typeyes

Brill uses the E-ISSN as identifier; the type of the identifier is indicated using the @journal-id-type attribute. Contents come from a Master List that Brill will provide typesetters. This element is required twice, once with a @journal-id-type="eissn" and once with @journal-id-type="publisher-id". Note that the hyphen in an ISSN should always be included.

@journal-id-type:  Required attribute. Type of journal identifier or the authority that created a particular journal identifier. Supported values:

  • "eissn": Include the journal’s E-ISSN in this tag.
  • "publisher-id": Include the journal abbreviation in this tag.
      • <journal-title-group>

yes

Contents come from a Master List that Brill will provide typesetters.

        • <journal-title>

yes

Full title of the journal in which the article was published.

        • <journal-subtitle>

no

This is not an issue title. Issue titles are described in the article metadata. This is a permanent subtitle to a journal.

        • <trans-title-group>
xml:langno

For every translation of the journal title, supply a <trans-title-group>.

@xml:lang: required attribute. Indicates the language of the translated title. This attribute should be included here and not on the sub-elements. Supported values are ISO 639-2 (B).

          • <trans-title>

yesThe translation of the title.
          • <trans-subtitle>

noThe translation of the subtitle.
        • <abbrev-journal-title>
abbrev-typeyes

Short form of the title of the journal in which an article is published. Contents come from a Master List that Brill will provide typesetters.

@abbrev-type="ltwa": required attribute/value pair.

      • <issn>
publication-formatyes

Brill requires that both the E-ISSN and ISSN are always used. Contents come from a Master List that Brill will provide typesetters. In case a journal does not have a ISSN, Brill will let the typesetters know. Note that the hyphen in an ISSN should always be included.

@publication-format: required attribute. Indicate whether this ISSN applies to a print or an online version. Supported values:

  • "print"
  • "online"
      • <issn>
publication-formatno

International Standard Book Number, the international code for identifying a particular product form or edition of a publication, typically a monographic publication.

The code is always set without spaces or hyphens.

@publication-format: required attribute. Indicate whether this ISBN applies to a print or an online version. Supported values:

  • "print"
  • "online"
      • <publisher>
specific-useyes

@specific-use: attribute not required. Supported values are:

  • "print"
  • "online"
        • <publisher-name>

yes

Name of the imprint associated with the article or book. Brill will let the typesetters know which imprint to use for the journal.

Currently, for <publisher-name> only the text values below are permitted. (NOTE: historically, other values may exist and should be retained if such files are redelivered, unless expressly noted otherwise.)

  • Brill
  • Brill | Nijhoff
  • Brill | Hotei
  • Brill | Sense
  • Brill | Schöningh
  • Brill | Fink
  • Brill | mentis
  • Vandenhoeck & Ruprecht
  • Böhlau Verlag
  • V&R unipress
        • <publisher-loc>

yesUse the location as given on the Title Page of the journal prelims. If the publisher has more than one location (Leiden | Boston), this still has to specified in one element.
    • <article-meta>

yes

Information concerning the article that identifies or describes the article.

      • <article-id>
pub-id-typeyes

Unique external identifier assigned to an article. Note that for the DOI, any alphabetic characters within the DOI itself should always be included as lower-case in the XML file.

@pub-id-type: required attribute. Type of publication identifier or the organization or system that defined the identifier.

  • Req. "doi"
  • "EM" This is the Editorial Manager manuscript number. Always include if provided.
      • <article-categories>

no
        • <subj-group>
subj-group-typeno@subj-group-type: attribute not required. Type of subject group. For some journals, articles are grouped into categories which this Tag Set calls <subject>s, which may be grouped into <subj-group>s. These subject categories are typically shown in the Table of Contents, at the top of the first print or display page, or on the web splash page for an article. The Brill Desk Editor will provide these when needed
          • <subject>

yes
      • <title-group>

yes
        • <article-title>

yesFull title of an article or other journal component, such as an editorial or book review.
        • <alt-title>
alt-title-typeno@alt-title-type: required attribute. Reason or purpose for a (shorter) title to be included. Brill supports 2 values for @alt-title-type:
  • "toc": Title to be used in the table of contents.
  • "running-head": Title to be used as the running head. This is a shorter version of the regular title. An <alt-title> with this type is optional.

An <alt-title alt-title-type="toc"> is always required to be in a <title-group>, but does not need to be a shorter version of the regular title.

        • <subtitle>


Subordinate part of a title for a document or document component. Refer to the manuscript to see what the author meant as subtitle.

        • <trans-title-group>
xml:langno

For every translation of the articletitle, supply a <trans-title-group>.

@xml:lang: required attribute. Indicates the language of the translated title. This attribute should be included here and not on the sub-elements. Supported values are ISO 639-2 (B).

          • <trans-title>


The translation of the title.
          • <trans-subtitle>


The translation of the subtitle.
      • <contrib-group>

no

Grouping of one or more contributors and information about those contributors. All types of contributors are grouped in one <contrib-group>. Do not add this tag group if an article does not have an author. Note that at most one <contrib-group> is allowed in <article-meta>.

        • <contrib>

contrib-type

corresp

deceased

equal-contrib

yes

A contributor: Container element for information about a single author, editor, or other contributor. If a contribution is without author, do not add <contrib> and <contrib-group>.

@contrib-type: required attribute. Type of contribution made by the contributor. Brill supports following contribution types:

  • "author"
  • "editor"
  • "translator"

@corresp: This atribute is required in case the article has multiple authors. By default this attribute should be assigned to the first listed contributor, unless another contributor is specifically identified as Corresponding Author. Do not include in all other cases. Supported values:

  • "yes"

@deceased: attribute not required. Use if the contributor was deceased when the document was published. Supported values:

  • "yes"
  • "no" Default value, which makes this attributes unnecessary.

@equal-contrib: this is is an optional attribute; there is no default value. Indicates whether or not all contributors contributed equally. If the contributor whom this attribute modifies contributed equally with all other contributors, this attribute should be set to “yes”; if his/her contribution was greater or lesser, then this attribute should be set to “no”.

  • "yes"
  • "no"
          • <contrib-id>

contrib-id-type

authenticated


An ORCID identifier for a contributor. Note that an ORCID identifier should include the complete URL, for example: https://orcid.org/0000-0002-1825-0097

@contrib-id-type="orcid" and @authenticated="true" required

          • <collab>


Group of contributors credited under a single name; includes an organization credited as a contributor. If <collab> is used, <name> is not required.

          • <name>
name-styleyes

Container element for components of personal names, such as a <surname>. Use <name-alternatives> if the name has multiple variants (e.g., in different scripts).

@name-style: attribute not required. Style of processing requested for a structured personal name.

  • "eastern": The name will both be displayed and sorted/inverted with the family name preceding the given name.
  • "western": The name will be displayed with the given name preceding the family name, but will be sorted/inverted with the family name preceding the given name.
  • "given-only": The single name provided is a given name, not a family name/surname. The single name will be both the sort and the display name.

Default value is "western". If an author has only a single name, name-style="given-only" and tag the single name with <given-names>.

            • <surname>

yes

Surname of a person.

            • <given-names>

noAll given names of a person, such as the first name, middle names, maiden name if used as part of the married name, etc. This element will NOT be repeated for every given name a person has.
            • <prefix>

no

Honorifics or other qualifiers that usually precede a person’s name (for example, Professor, Rev., President, Senator, Dr., Sir, The Honorable).

            • <suffix>

no

Qualifiers that follow a person’s name (for example, Sr., Jr., III, 3rd).

          • <name-alternatives>

no

If a contributor’s name has multiple variants, use this element to include all variants. Put the variants in the same order as they would be on the printed page. The contents of this element are identical to the above description of <name>.

            • <name>
xml:langno

child elements /surname, /given-names, /prefix and /suffix as above

@xml:lang: Indicates the language of the name, if in another language than the main language of the article. Supported values are ISO 639-2 (B).

            • <string-name>
xml:langno@xml:lang: Indicates the language of the name, if in another language than the main language of the article. Supported values are ISO 639-2 (B).
          • <email>
xlink:hrefno

The contributor's email address.

@xlink:href: The e-mail address as a mailto: URI.

          • <xref>

ref-type

rid

no

A cross reference to an affiliation or to a footnote. 

Req. @ref-type: required attribute. Supported values:

  • "aff"
  • "fn"

@rid: required attribute. Contains the @id of the affiliation this contributor is associated with, or of the associated author-notes. If the reference is to more than one element, add all IDs here separated by spaces.

        • <aff>
idno

Element used to include an affiliation. Note that for every new affiliation, a separate <aff> element should be included.

@id: required attribute. Unique identifier for the affiliation, which is used in conjunction with <xref ref-type="aff" rid=""/> to refer to this affiliation.

          • <institution-wrap>

no


            • <institution>
content-typeyes

Name of an institution or organization, like Universiteit Leiden or Universiteit van Amsterdam.

This information is provided by Brill, but must be checked. This element can also contain the name of the department, like Leiden University Centre for Linguistics. Provide this value with a @content-type="dept".

@content-type: attribute not required. Use this attribute to specify the extra institution information. Supported values:

  • "dept"
  • More values can come from EM and should not be removed.
            • <institution-id>
institution-id-typeno

A externally defined institutional identifier, from an established identifying authority (for example, “Ringgold”).

@institution-id-type: required attribute. Brill only supports Ringgold identifiers for institutions as part of an affiliation. Supported values:

  • "ringgold"
          • <country>

yes

The country the institution is located in. This is represented separately from an <addr-line>. EM provides this information.

          • <addr-line>
content-typeno

An text line in an address. EM provides this information.


@content-type: attribute not required. Indicates what type of address line information it is. EM provides this information. Supported values include:
  • "city"
  • "zipcode"
  • and more supported by EM.
        • <pub-date>

publication-format

date-type

yes

@publication-format: Req. "online"

@date-type: required attribute.

  • Req. "article". Note: a <pub-date> with this attribute is always required and should include the date of original delivery of the XML for the article to Brill. If the article is originally published in Advance, and later republished in an issue, the original date assigned when the Advance version was delivered should be retained here (i.e., it should never be changed). This date should always be included as the first <pub-date> in the XML.
  • "issue". Note: a <pub-date> with this attribute must be included in addition to the "article" pub-date for all articles appearing in an issue. The date to be included should be the date of delivery of the issue XML package to Brill, and again once the issue is published this date should never be changed again. Note that this means that for any articles that are first published online as part of an issue, both "article" and "issue" will be the same date, while articles previously published in Advance will have a different "article" and "issue" dates
          • <day>

yesA day, in (zero-padded) digits.
          • <month>

yesA month, in (zero-padded) digits.
          • <year>

yes

A year, always in 4 digits. Please note that only a single year may ever be included, i.e., "2018". Double years like "2017-2018" are not allowed.

        • <volume>
content-typeyes

Number of a journal (or other document) within a series. Note that this element should NOT be included in case the article is published as Advance.

@content-type: required attribute. @content-type="number" and @content-type="year" are always required in two separate <volume> tags.

Brill supports 2 values for @content-type with <volume>.

  • Req. "number", use same digit layout as for <issue>
  • Req. "year", always in 4 digits. Please note that only a single year may ever be included, i.e., "2018". Double years like "2017-2018" are not allowed.
        • <issue>

yes

Issue number of a journal. Note that this element should NOT be included in case the article is published as Advance.

  • No leading zeros.
  • The dash between two numerals is always - (U+002D HYPHEN-MINUS).
        • <issue-title>

no

This element can be used to include the theme or special issue title for a journal or BRP issue. Guest Editor(s) can be added as well by including "edited by [name(s)]". Volume and Issue number(s) should not be included in this element.

Example: <issue-title>Special Issue: Questions about trans-thoroughfare Fowl Ambulation, edited by A. de Boer and B. Bauer</issue-title>

        • <fpage>

specific-use

seq

yes

Starting (first) page number of the article.

@specific-use="PDF" required

@seq: required attributeA sequential number starting at 1 per issue that increments for each article in it. This sorts the articles in an issue. For Advance Articles always use @seq=1.

        • <lpage>

yes

Final (last) page number of an article.

        • <page-range>

no

Text describing discontinuous pagination (for example, 8-11, 14-19, 40).

        • <supplementary-material>

xlink:href

specific-use

mimetype

no

A pointer to external resources that support the article or book, but which are not part of the content of the work.

@xlink:href: required attribute. Will be supplied by the Brill Desk Editor.

Supported values are:

  • figshare DOI
  • supplement filename

@specific-use: required. Will be supplied by the Brill Desk Editor.

  • "figshare"
  • "local"

@mimetype: Only to be used when @specific-use="local". Supported values can be found here: https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types/Common_types. If the value to be used is unclear, consult the Brill Production Editor.

          • <caption>

noOnly when @specific-use="local"
            • <title>

yesAdd the title of the supplementary file, will be supplied by the Brill Desk Editor.
        • <history>

no

This container element describes the processing history of the journal article, e.g. dates received and accepted.

          • <date>
@date-typeyes

These date elements should at least provide a <year> and only when that information is available, also the <month> and <day> in two digit numeral values, too.

@date-type: required attribute. Event in the lifecycle of an article that this date is marking (for example, the date the manuscript was received or accepted, the date the electronic preprint was published, or the date of any revision or retraction). Supported values include:

  • "received". Date that article was received.
  • "initial-decision". Date that initial decision was taken on article.
  • "rev-recd". Date that a revised version of the article was received. There may be more than one @date-type with this value.
  • "rev-request". The date revisions were requested. There may be more than one @date-type with this value.
  • "accepted". Date that article was accepted in journal.
  • "version-of-record". Date that the version of record of the article was published (online or print).
  • "pub". The publication date (online or print).
  • "preprint". Preprint dissemination date (online or print).
  • "retracted". The date an article was retracted.
  • "corrected". The date an article was corrected.
            • <day>

no

A day, in (zero-padded) digits.

            • <month>

noA month, in (zero-padded) digits.
            • <year>

yesA year, in (zero-padded) digits.
        • <permissions>

yes
          • <copyright-statement>

yes

Copyright notice or statement, suitable for printing or display.

          • <copyright-year>

yesThe year of copyright. This may not be displayed
          • <copyright-holder>

yes

Name of the organizational or person that holds a copyright.

          • <license>

license-type

xlink:href

xlink:title

yes

A license. Set of conditions under which the content may be used, accessed, and distributed.

@license-type:

  • "ccc". Standard Brill license type. See example for full text.
  • "open-access". Any Open Access license. If used, @xlink:href and @xlink:title are required

@xlink:href: The URL at which the license text can be found. See Creative Commons Licenses.

@xlink:title: If used with a Creative Commons license. Corresponds to @xlink:href. Supported values:

  • "CC-BY"
  • "CC-BY-SA"
  • "CC-BY-ND"
  • "CC-BY-NC"
  • "CC-BY-NC-SA"
  • "CC-BY-NC-ND"
            • <ali:free_to_read>

xmlns:ali

start-date

end-date

yes

required xmlns:ali="http://www.niso.org/schemas/ali/1.0/"

@start_date: optional. Indicates the date on which the free-access license should start. Value should use the following format: "yyyy-mm-dd".

@end_date:optional. Indicates the date on which the free-access license should end. Value should use the following format: "yyyy-mm-dd". The absence of both start_date and end_date dates indicates a permanent free-to-read status.

        • <self-uri>

content-type

required

no

The URI for the (online) PDF-version of the print article. This empty element encloses a link to the PDF.

@content-type: required. For Brill, this is always:

  • "PDF"

@xlink:href: required. The URL at which the PDF can be found.

        • <abstract>
xml:langno

The article's abstract, so a summarized description of the content.

@xml:lang: optional attribute. Indicates the language of the abstract, if different from /article/@xml:lang. This attribute should be included here and not on the sub-elements. Supported values are ISO 639-2 (B).

          • <title>

yesThe title for the abstract. Usually, this is "Abstract", but it can also be "Samenvatting", "Summary" or "Σύνοψις". The Brill Desk Editor will provide you with a title if it is different than "Abstract". Do not add style elements!
          • <p>

yesParagraphs
        • <trans-abstract>
xml:langno

An abstract in another language than the main language of the article.

@xml:lang: Indicates the language on a translated abstract in another language than the main language of the article. Supported values are ISO 639-2 (B).

          • <title>

yesThe title for the translated abstract.
          • <p>

yes See Paragraphs
        • <kwd-group>

kwd-group-type

xml:lang

no

Keyword group. Container element for one set of keywords (such as <kwd>s) used to describe a document.

@kwd-group-type: required. Indicates the type of keyword group, supported values:

"uncontrolled"

In future versions, systems like the US Library of Congress Subject Headings may be used.

@xml:lang: Indicates a keyword grouping in another language than the main language of the article. Supported values are ISO 639-2 (B).

          • <title>

yes

The title for the keyword group. Usually, this is "Keywords"; the Brill Desk Editor will provide you with a title if it is different than "Keywords". Do not add style elements!

          • <kwd>

yesKeyword, like a subject term, key phrase, indexing word etc. The author will supply this information.
        • <funding-group>

noContainer element for information about the funding of the research reported in the article (for example, grants, contracts, sponsors).
          • <award-group>
idno

Container element for information concerning one award under which the work (or the research on which the work was based) was supported.

The value for this @id attribute will be supplied by Brill. If none is supplied, the attribute should be omitted.

            • <funding-source>

noAgency or organization that funded the research on which a work was based.
              • <institution-wrap>

no
                • <institution>

yesName of the funding institution or organization.
                  • <institution-id>
institution-id-typeyes

@institution-id-type: required. For funders, both DOI and Ringgold values are supported. Supported values:

  • "doi"
  • "ringgold"
            • <award-id>

noUnique identifier assigned to an award, contract, or grant. I.e., the grant number.
            • <principal-award-recipient>

noIndividual(s) or institution(s) to whom the award was given (for example, the principal grant holder or the sponsored individual).
            • <principal-investigator>

noIndividual(s) responsible for the intellectual content of the work reported in the document.
          • <funding-statement>

noDisplayable prose statement that describes the funding for the research on which a work was based.
        • <custom-meta-group>

yesContainer element for metadata not otherwise defined in the Tag Suite. Brill requires header files – XML files that do not contain body content – to have the version: header key-value pair. Brill requires full content files – XML files that contain both header and body content and back matter – to have the version: fulltext key-value pair.
          • <custom-meta>

yes
            • <meta-name>

yes

A custom metadata name (or key). Supported value:

  • "version"
            • <meta-value>

yes

A custom metadata value. Supported values:

  • "header"
  • "fulltext"

Body content

/article/body is the element that contains's the article's main text.

elementattribute(s)requireddescription
<body>
no

Main textual portion of the document that conveys the narrative content.

  • <p>

noSee Paragraphs
  • <sec>

noSee Sections
  • <sig-block>

noArea of text and graphic material placed at the end of the body of a document or document component to hold the graphic signature or description of the person(s) responsible for or attesting to the content.
    • <sig>

noOne contributor’s signature and associated material (such as a text restatement of the affiliation) inside a signature block.
      • <graphic>

xlink:href

orientation

position

no

Description of and pointer to an external file containing a still image.

@xlink:href: The URI where the resource can be found.

@orientation: required. Whether the object should be positioned tall (longe edge vertical "portrait") or wide (long edge horizontal "landscape").

  • "portrait"
  • "landscape"

@position: Whether the object must be anchored to its place or may float algorithmically to another location in the document. Also used for margin placement.

  • "anchor" Object must remain on exact location in the text flow.
  • "float" Default value. Object may move to a new column, page, end of document, etc.
  • "margin" The object should be placed in the margin or gutter.

Back content

/article/back is for what goes beyond the main body of the article's text, i.e. references.

elementattribute(s)requireddescription
<back>
noparts at the end of the article that do not belong to the article's main text itself.
  • <ack>

noAcknowledgments. Textual material that names the parties who the author wishes to thank or recognize. Should not be included here if the Acknowledgments were placed in a footnote (in which case they should be included as a <fn>.
    • <title>

no
    • <p>

noSee Paragraphs
    • <sec>

noSee Sections
  • <app-group>

noContainer element for one or more appendices (<app> elements).
    • <app>

noAppendix. Additional material added to a document that typically follows the body of the document. This is ancillary or supporting material, not a direct continuation of the text of the document.
      • <title>

no
      • <p>

noSee Paragraphs
      • <sec>

noSee Sections
    • <def-list>

noSee Definition List
    • <list>

noSee List
  • <fn-group>

noSee Footnotes
  • <glossary>

noSee Glossary
  • <ref-list>

noSee Reference List

Sections

Sections are headed by a <sec> element, which contains two genres of content: title information (a <label> and a <title>) and content (all other elements described).

elementattribute(s)requireddescription
<sec>

id

sec-type


Headed group of material; the basic structural unit of the body of a document.

A section can contain another <sec> recursively. If a sections has a chapter number or a similar label, this MUST be placed in a <label>.

@id See id-syntax. Give a Section an ID to refer to it when the manuscript says things like “See chapter 11”.

@sec-type: Required only if the <sec> starts with a heading title: this attribute is then used to indicate the heading level. Brill supports a maximum of 8 heading levels, same as in the Brill Typographic Style. Note that this attribute should not be used for any other purpose. The following values are permitted:

  • "heading-1"
  • "heading-2"
  • "heading-3"
  • "heading-4"
  • "heading-5"
  • "heading-6"
  • "heading-7"
  • "heading-8"
  • <label>

noThe Section number, like 2 or 15.5.1 or XIV.15.A.β.ii.
  • <title>

yesThe actual heading text of the section.
    • <target/>
idno

This element can be used as a marker to indicate the page number in the PDF. Note that this element can also be included below several other elements, as needed.

@id: See ID syntax. The value here should be given as "Page1", "Page2", etc.

    • <xref>

ref-type

rid

no

Cross reference a footnote. All <xref>s in the text must be clickable in the PDF and online displays. Note that adding footnotes to titles should be avoided if possible.

@ref-type: required. Supported value:

  • "fn": Refers from a text reference to footnote (<fn>). This should include element <sup> and the footnote number/marker.

@rid: required. Contains the @id of the element this element points to. If the reference is to more than one element, add all IDs here separated by spaces.

  • <table-wrap>

noSee Tables
  • <table-wrap-group>

noSee Tables
  • <fig>

noSee Figures
  • <fig-group>

noSee Figures
  • <disp-quote>

noSee Quotations
  • <verse-group>

noSee Verse
  • <def-list>

noSee Definition List
  • <list>

noSee List
  • <p>

noSee Paragraphs
  • <sec>

noUsed recursively
  • <boxed-text>

noContains textual material that is part of the body but is outside the flow of the narrative text (whether enclosed in a box or not). For example, marginalia, sidebars, cautions, tips, warnings, note boxes.
    • <title>



    • <p>



    • <sec>



  • <mml:math>


The MathML spec is not part of BITS / JATS and readers should to refer to its definition: MathML. Do not forget to add @xmlns:mml to <article>.
  • <tex-math>

noSupply the mathematical formula in (La/Xe)TeX text inside a <tex-math>.

Paragraphs

Paragraphs are <p> tags, with similar semantics as the HTML <p> tag. Due to footnotes’ JATS/BITS design, <p> tags may contain anything a <sec> may, but please refrain from adding anything but markup tags in running text.

Do not use <bold>, <italic> or <sc> etc. on places where the Brill Style supplies its use. Those usages are not semantic uses of small caps style, i.e. do not supply <sc> Small Caps in a <caption> Caption element, as captions — per Brill Typographic Style — are always set in small caps.

elementattribute(s)requireddescription
<p>

A text paragraph.
  • <inline-graphic>
xlink:hrefno

Description of and pointer to an external graphic that is displayed or set in the same line as the text. Only use graphics for characters or signs not included in Unicode. Think of Egyptological signs not included in Unicode.

@xlink:href: required. The URI where the resource can be found

  • <xref>

ref-type

rid

no

A cross reference to an object within the document (e.g. a table, affiliation or bibliographic citation). It can be used to reference to anything with an @id. All <xref>s in the text must be clickable in the PDF and online displays.

 @ref-type: required. Contains the type of reference. Possible values:

  • "aff": Refers from a <contrib> to an <aff>. This element is usually empty.
  • "bibr": Refers from a cited source to its place in the bibliography (the <ref>).
  • "fig": Refers from a text reference to the actual figure (<fig> or <fig-group>).
  • "fn": Refers from a text reference to footnote (<fn>). This should include element <sup> and the footnote number.
  • "table": Refers from a text reference to the actual table (<table-wrap> or <table-wrap-group>).

@rid: required. Contains the @id of the element this element points to. If the reference is to more than one element, add all IDs here separated by spaces.

  • <named-content>
content-typeno

We could use this element for a word or subject that has distinct semantics or special significance.

@content-type: When necessary, content-type can be:

  • "frontispiece"
  • "in-memoriam"
  • "verse-line-number"
  • <bold>

noFont bold weight.
  • <italic>

noFont italic style.
  • <sc>

noSmall Caps. Note that any text surrounded by <sc> tags should be included in their proper case (as if they weren't small caps): i.e., any capitals should be included as capitals, not lower case, while proper lower case should be included as such. Note also that as per Brill Typographic Style, <sc> should not be used at all for mixed-case abbreviations.
  • <ext-link>
xlink:hrefno

Link to an external file or resource.

@xlink:href: required. The URI where the resource can be found.

  • <media>

noSee Embedded-video
  • <target>
idno

This element can be used as a marker to indicate the page number in the PDF. Note that this element can also be included below several other elements, as needed.

@id: required. See id-syntax. The value here should be given as "Page1", "Page2", etc.

Right-to-Left and Bi-Directional Text

Indicating that a text uses another text direction than left-to-right can be simply indicated by including the text in correct Unicode (UTF-8) and including attribute @xml:lang for the relevant elements:

elementattribute(s)requireddescription
<p>xml:lang
@xml:lang: Indicates this element (and all sub-elements) are in this particular language. Supported values are ISO 639-2 (B).

Additionally, if the text in an element is bi-directional (e.g., the main text in a <p> is in Arabic, but certain words or parts of a phrase are in English), then the parts of the text in another direction than the main part of the text within that element can be indicated by the following element:

elementattribute(s)requireddescription
<styled-content>xml:lang
@xml:lang: Indicates this element is in this particular language.  Supported values are ISO 639-2 (B).

Footnotes

Footnotes should be included in a /back/fn-group 

elementattribute(s)requireddescription
<fn-group>

Container element for all footnotes. This element appears at the end of the document.
  • <fn>

xml:lang

id

yes

A reference to a <fn> is made with the <xref> element.

@xml:lang: optional. Used if footnote language is different than the main language of the article. Supported values are ISO 639-2 (B).

@id See id-syntax: required. The identifier that links a <xref> with the footnote.

    • <label>


The footnote number. Do not use <sup> here.
    • <p>


See Paragraphs. The actual text of the footnote is put in one or more <p> text paragraphs

Tables


For multiple tables (<table-wrap> elements) that are to be displayed together, use the <table-wrap-group>.

In certain cases, it is permitted to included tables as if they were an image, using the element <fig> See Figures. If doing so, and the table is in the print version divided over multiple pages, please include it as one image here, without repeated heading lines, etc.

elementattribute(s)requireddescription
<table-wrap-group>
noContainer element for tables.
  • <table-wrap>
idno

Wrapper element for a complete table, including the tabular material (rows and columns), caption (including title), footnotes, and alternative descriptions of the table for purposes of accessibility.

@id See id-syntax. A document-unique identifier for the element.

    • <label>

noThe label for a table-wrap.
    • <caption>

noContainer element for the table caption
    • <title>

no

The title for a table-wrap.

    • <p>

noSee paragraphs
    • <table>

cellpadding

frame

no

The rows and columns part of a full table.

@cellpadding: Amount of space, measured in pixels, between the border of a cell and the contents of a table cell.

@frame: Specifies which sides of the table should be given rules, making a box or frame of lines around the table.

      • <thead>

noContainer element for the table header rows of a table.
        • <tr>

no

Container element for all the cells in a single table row.

          • <th>

colspan

rowspan

no

One cell in the table header, as opposed to an ordinary cell in the body of a table.


@colspan: How many columns this element spans, e.g. <th colspan="2"> is two columns wide.

@rowspan: How many rows this element spans, e.g. <th rowspan="4"> is four rows high. This attribute is unusual in headers.

      • <tfoot>

no

Container element for the footer rows within a NISO JATS table.

This element comes after a <thead> and before a <tbody> so that implementation can render the table footer before a (very long) body.

        • <tr>

noContainer element for a table row.
          • <td>

colspan

rowspan

scope

no

One ordinary cell in the body of a table, as opposed to a cell in the table header.

@colspan: How many columns this element spans, e.g. <td colspan="2"> is two columns wide.

@rowspan: How many rows this element spans, e.g. <td rowspan="4"> is four rows high.

@scope: Use this with value "row" as the first <td> when there is a table header on the side of a table.

      • <tbody>

noContainer element that holds the rows and columns in one of the body (as opposed to the header) portions of a table.
        • <tr>

noContainer element for a table row.
        • <td>

colspan

rowspan

scope

no

One ordinary cell in the body of a table, as opposed to a cell in the table header.

@colspan: How many columns this element spans, e.g. <td colspan="2"> is two columns wide.

@rowspan: How many rows this element spans, e.g. <td rowspan="4"> is four rows high.

@scope: Use this with value "row" as the first <td> when there is a table header on the side of a table.

    • <attrib>

noAttribution information. Do not use <sc> tags in this element, as the Small Caps style is part of the Brill Typographic Style and NOT semantic.

Figures

Figures can be graphic or textual material. For figures that have to be displayed together, the element <fig-group> is available. For single figures, use the element <fig> and follow the instructions below.

Note that QR-codes should also be included in this manner, with the direct image of the QR code linked via <graphic> and the relevant URL given in <caption>.

elementattribute(s)requireddescription
<fig-group>

Container element for figures that are to be displayed together.
  • <caption>

no

The caption for a fig-group.

    • <title>

noThe title for a fig-group.
  • <fig>

id

orientation

position

fig-type

yes

Block of graphic or textual material that is identified as a figure, usually bearing a caption and a label such as “Figure 3.” or “Figure”.

@id See id-syntax: A document-unique identifier for the element. Starts with "FIG".

@orientation: required. Whether the object should be positioned tall (longe edge vertical "portrait") or wide (long edge horizontal "landscape").

  • "portrait"
  • "landscape"

@position: Whether the object must be anchored to its place or may float algorithmically to another location in the document. Also used for margin placement.

  • "anchor" Object must remain on exact location in the text flow.
  • "float" Default value. Object may move to a new column, page, end of document, etc.
  • "margin" The object should be placed in the margin or gutter.

@fig-type: The type of figure. Supported values:

  • "graphic"
    • <graphic>
xlink:hrefyes

Description of and pointer to an external file containing a still image.

@xlink:href: required. The URI where the resource can be found.

      • <alt-text>

yesAlternate Text Name. Word or phrase used to provide a very short textual name, description, or purpose-statement for a structure such as a graphic or figure. This element is to be included for accessibility purposes and as such is always required. In this element, repeat the text given in the relevant <caption>``<title> unless Brill provides a specific alt-text.
    • <attrib>

noAttribution information. Do not use <sc> tags in this element, as the Small Caps style is part of the Brill Typographic Style and NOT semant

Quotations


A block quote is in this tag set a <disp-quote>. These can be nested, but regularly contain just a <p> and, optionally an <attrib> attribution.

elementattribute(s)requireddescription
<disp-quote>


  • <label>


The reference number for the block quote.
  • <title>


A title displayed before a block quote.
  • <disp-quote>


used recursively
  • <p>


See paragraphs
  • <attrib>

noAttribution information. Do not use <sc> tags in this element, as the Small Caps style is part of the Brill Typographic Style and NOT semant

List

Ordered and unordered list alike are put in a <list>.

elementattribute(s)requireddescription
<list>

list-type

id

continued-from


Sequence of two or more items, which may or may not be ordered.

@list-type: The following list types are supported:

  • "order" Ordered list. Prefix character is a number or a letter, depending on local style.
  • "bullet" Unordered or bulleted list. Prefix character is a dash conforming to BTS.
  • "alpha-lower" Ordered list. Prefix character is a lowercase alphabetical character.
  • "alpha-upper" Ordered list. Prefix character is an uppercase alphabetical character.
  • "roman-lower" Ordered list. Prefix character is a lowercase roman numeral.
  • "roman-upper" Ordered list. Prefix character is an uppercase roman numeral.
  • "simple" Simple or plain list (No prefix character before each item)

@id See id-syntax: The @id attribute supplies a document-internal unique reference to an element.

@continued-from: To be used if a <list> is a continuation from another <list> earlier in the document. If used, the earlier <list> should include an @id, and the value of said @id should be used as the value of @continued-from here.

  • <list-item>

yesSingle item (one entry) in a list of items.
    • <p>


See Paragraphs

Definition List

A definition list has a special layout: a word/phrase or term on the one hand is paired with descriptions, explanations or definitions on the other hand.

elementattribute(s)requireddescription
<def-list>

list-type

list-content


List in which each item consists of two parts: 1) a word, phrase, term, graphic, chemical structure, or equation, that is paired with 2) one or more descriptions, discussions, explanations, or definitions of it.

@list-type: The following list types are supported:

  • "order" Ordered list. Prefix character is a number or a letter, depending on local style.
  • "bullet" Unordered or bulleted list. Prefix character is a dash conforming to BTS.
  • "alpha-lower" Ordered list. Prefix character is a lowercase alphabetical character.
  • "alpha-upper" Ordered list. Prefix character is an uppercase alphabetical character.
  • "roman-lower" Ordered list. Prefix character is a lowercase roman numeral.
  • "roman-upper" Ordered list. Prefix character is an uppercase roman numeral.
  • "simple" Simple or plain list (No prefix character before each item)

@list-content: Type of list, usually with a semantically meaningful name (for example, a “where-list” for the list of the variables that follows an equation, a “notation-list”, or a “procedure-list” for a list of procedural steps to follow).

  • <title>


A title displayed before a def-list.
  • <term-head>


Heading over the first column (the term column) of a definition list (two-part list).
  • <def-head>


Heading over the second column (the definition column) of a definition list (two-part list).
  • <def-item>

yesOne item in a definition (two-part) list.
    • <term>
idyes

Word, phrase, graphic, chemical structure, equation, or other noun that is being defined or described. This element is typically used in conjunction with a definition in a definition list (two-part list). The term occupies the first column of the two-part list and is the subject of the definition or description, which occupies the second column.

@id See id-syntax: A document-unique identifier for the element.

    • <def>


Definition, explanation, or expansion of a word, phrase, or abbreviation.
      • <p>


See Paragraphs. The actual text of the definition is put in one or more <p> text paragraphs.

Glossary

A glossary typically contains one or more def-lists. If a description is needed before the list begins, a <p> may be included as well. The glossary is part of the back matter of a document.

elementattribute(s)requireddescription
<glossary>


  • <label>


Number and/or prefix word placed at the beginning of display elements (for example, equation, statement, figure). For example "Chapter 1", "Introduction:", "Conclusion:", "Appendix:", etc.
  • <title>


A title displayed before a glossary.
  • <p>


See Paragraphs. For any descriptive text preceding the Glossary.
  • <def-list>


See Definition List

Verse

Verse, like poetry or quoted material where line numbers are important, use <verse-group>. Line numbers however cannot be tagged separately in a <label> according to the BITS/JATS DTD, so instead please use <named-content content-type="verse-line-number">.

elementattribute(s)requireddescription
<verse-group>


  • <label>


The reference number for the verse. This may be referred to in the text.
  • <title>


The title of the verse, e.g. Sonnet 18 or Shall I compare thee to a summer’s day?.
  • <verse-line>


One line of a poem or verse.
  • <attrib>


Attribution information. Do not use <sc> tags in this element, as the Small Caps style is part of the Brill Typographic Style and NOT semantic.

Reference List

A reference list is a list of bibliographic references for a document or a document component. It contains one or more ref elements. Please note that <ref-list> is only allowed in <back>.

elementattribute(s)requireddescription
<ref-list>

Main element for Reference List. Note that this element can be used recursively (so a <ref-list> can contain (multiple) other instance(s) of <ref-list>) to include multiple distinct reference lists (e.g., "Primary Sources", "Secondary Literature", etc.).
  • <title>

noThe title of the ref-list, e.g. References.
  • <p>

noSee Paragraphs. For any descriptive text preceding the Reference List.
  • <ref>
id

One item in a bibliographic list.

@id: required. See id-syntax. A document-unique identifier for the elemen

    • <label>

no

The reference number for a reference. This may be referred to in the text.

    • <mixed-citation>
publication-typeno

Bibliographic description of a work. Includes a combination of bibliographic reference elements and untagged text. Spacing and punctuation are preserved. Note that any punctuation that is not itself part of the proper value of an element, but is dictated only by the reference style, should not be included in the element itself. E.g., if reference style dictates that a journal article title should be surrounded by double quotation marks ("), but these are not normally part of the article title itself, then these double quotation marks should not be included within the element <source>, but instead directly outside it. Similarly, if the Reference list uses an author date style that leads to dates such as "2018a", "2018b", then only the year should be placed inside the element <year>, with the "a" or "b" directly outside it. For example: <year>2018</year>a.

@publication-type: required. Supported values major, need to be tagged fully if used:

  • "book"
  • "journal"
  • "web"

In case of "web", please add <uri>

Supported values minor, full tagging is not needed:

  • "data"
  • "list"
  • "other"
  • "patent"
  • "thesis"
  • "commun" for communiqués
  • "confproc" for conference proceedings.
  • "discussion"
  • "gov"
      • <person-group>
person-group-typeno

Container element for one or more contributors in a bibliographic reference.

@person-group-type: Specify authors and other contributors to a reference. A separate <person-group> element should be used for each role. Supported values are:

  • "all-authors"
  • "assignee"
  • "author"
  • "compiler"
  • "curator"
  • "director"
  • "editor"
  • "guest-editor"
  • "inventor"
  • "transed"
  • "translator"
        • <string-name>

noContainer element for components of personal names unstructured
          • <surname>

noSurname of a person.
          • <given-names>

noAll given names of a person, such as the first name, middle names, maiden name if used as part of the married name, etc. This element will NOT be repeated for every given name a person has.
          • <prefix>

noHonorifics or other qualifiers that usually precede a person’s name (for example, Professor, Rev., President, Senator, Dr., Sir, The Honorable).
          • <suffix>

noQualifiers that follow a person’s name (for example, Sr., Jr., III, 3rd).
      • <collab>

noGroup of contributors credited under a single name; includes an organization credited as a contributor.
      • <article-title>

noFull title of an article or other journal component, such as a book review. When the cited document is a book-chapter, use <chapter-title>
      • <chapter-title>

noTitle of a cited book chapter.
      • <source>

yes

Title of a document (for example, journal, book, conference proceedings) that contains (is the source of) the material being cited in a bibliographic reference or product.

      • <date>

no
        • <year>

yesA year, in (zero-padded) digits.
      • <publisher-name>

no
      • <publisher-loc>

no
      • <volume>

no
      • <issue>

no
      • <fpage>

no
      • <lpage>

no
      • <uri>
xlink:hrefno

Embedded-video

In case any video needs to be displayed directly in the text on the Brill website, we can include it as an "embedded video". Note that any such videos should also be included in the <supplementary-material> of the article. All videos are expected to be uploaded to Figshare, and relevant information will be provided by the Brill Production Editor.

Embedded videos should be included directly under element <p> See Paragraphs.

elementattribute(s)requireddescription
<media>

id

content-type

specific-use

xlink:href

position

orientation

mimetype

mime-subtype


@xmlns:xlink="https://www.w3.org/1999/xlink" required.

@id: required. See id-syntax. A document-unique identifier for the element.

@content-type="figshare" required.

@specific-use="original-format" required.

@xlink:href: required. A link to the video on Figshare, given as a full DOI link. Example: "https://doi.org/10.6084/m9.figshare.example"

@position="anchor" required.

@orientation="portrait" required.

@mimetype="video" required.

@mime-subtype="avi" required.

  • <object-id>

pub-id-type

specific-use

yes

This element should contain the DOI of the article itself. Given as a simple DOI, so no URL. Example: 10.1163/23644583-00401003

@pub-id-type="doi" required.

@specific-use="metadata" required.

id-syntax

Each @id is unique within the XML document. Brill has defined the following @id syntax:

Pre-determined capital letter(s) + six numerical characters.

E.g., <sec id="S000001" sec-type="heading-1">

Note that numbering does not need to be consecutive, just that entire @id needs to be unique within the XML document.

The following pre-determined @id capital letters are supported:

  • AFF : <aff>
  • AWG : <award-group>
  • FN : <fn>
  • IMG : <fig>
  • L : <list>
  • MED : <media>
  • P : <p>
  • Page : <target>
  • R : <ref>
  • S : <sec>
  • T : <table-wrap>
  • TRM : <term>