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
element | attribute(s) | required | description |
---|---|---|---|
<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. dtd-version="1.1" is required for all articles For all Advance Articles, add @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: Optionally, with Brill permission, a typesetter may use Please Note: for any files that include one of the following values for
|
| yes | ||
| yes | ||
| journal-id-type | yes | 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:
|
| yes | Contents come from a Master List that Brill will provide typesetters. | |
| yes | Full title of the journal in which the article was published. | |
| no | This is not an issue title. Issue titles are described in the article metadata. This is a permanent subtitle to a journal. | |
| xml:lang | no | 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). |
| yes | The translation of the title. | |
| no | The translation of the subtitle. | |
| abbrev-type | yes | 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. |
| publication-format | yes | 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. for e-only journals NO empty <issn> with the publication-format="print" should be included. (empty elements give a problem in the DOI registration). @publication-format: required attribute. Indicate whether this ISSN applies to a print or an online version. Supported values:
|
| specific-use | yes | @specific-use: attribute not required. Supported values are:
|
| 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.)
| |
| yes | Use 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. | |
| yes | Information concerning the article that identifies or describes the article. | |
| pub-id-type | yes | 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.
|
| no | ||
| subj-group-type | no | @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. If needed, the @subj-group-type="toc-heading" 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 |
| yes | ||
| yes | ||
| yes | Full title of an article or other journal component, such as an editorial or book review. | |
| alt-title-type | no | @alt-title-type: required attribute. Reason or purpose for a (shorter) title to be included. Brill supports 2 values for @alt-title-type:
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. |
| Subordinate part of a title for a document or document component. Refer to the manuscript to see what the author meant as subtitle. | ||
| xml:lang | no | 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). |
| The translation of the title. | ||
| The translation of the subtitle. | ||
| 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-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:
@corresp: : In case of multiple authors, this attribute should be used to identify the corresponding author. It is up to the authors to decide to which contributor it is applied, and pass this information to the involved Production Editor. Multiple contributors with this attribute are possible. Supported values:
@deceased: attribute not required. Use if the contributor was deceased when the document was published. Supported values:
@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”.
|
| 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 Note that <contrib-id> - if available - must be the first element in <contrib> | |
| Group of contributors credited under a single name; includes an organization credited as a contributor. If <collab> is used, <name> is not required. | ||
| name-style | yes | 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.
Default value is "western". If an author has only a single name, name-style="given-only" and tag the single name with <given-names>. |
| yes | Surname of a person. | |
| no | All 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. | |
| no | Honorifics or other qualifiers that usually precede a person’s name (for example, Professor, Rev., President, Senator, Dr., Sir, The Honorable). | |
| no | Qualifiers that follow a person’s name (for example, Sr., Jr., III, 3rd). | |
| 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>. | |
| xml:lang | no | 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). |
| xml:lang | no | @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). |
| xlink:href | no | The contributor's email address. @xlink:href: The e-mail address as a mailto: URI. |
| ref-type rid | no | A cross reference to an affiliation or to a footnote. Req. @ref-type: required attribute. Supported values:
@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. |
| id | no | Element used to include an affiliation. Note that for every new affiliation, a separate @id: required attribute. Unique identifier for the affiliation, which is used in conjunction with <xref ref-type="aff" rid=""/> to refer to this affiliation. |
| no | ||
| content-type | yes | 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:
|
| institution-id-type | no | 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:
|
| yes | The country the institution is located in. This is represented separately from an | |
| content-type | no | An text line in an address. EM provides this information.
|
| publication-format date-type | yes | @publication-format: Req. "online" @date-type: required attribute.
|
| yes | A day, in (zero-padded) digits. | |
| yes | A month, in (zero-padded) digits. | |
| 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. | |
| content-type | yes | 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>.
|
| yes | Issue number of a journal. Note that this element should NOT be included in case the article is published as Advance.
| |
| 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> | |
| 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. |
| yes | Final (last) page number of an article. | |
| no | Text describing discontinuous pagination (for example, 8-11, 14-19, 40). | |
| 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:
@specific-use: required. Will be supplied by the Brill Desk Editor.
@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. See Supplementary material for more information, |
| no | Only when @specific-use="local" | |
| yes | Add the title of the supplementary file, will be supplied by the Brill Desk Editor. | |
| no | This container element describes the processing history of the journal article, e.g. dates received and accepted. | |
| @date-type | yes | 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:
|
| no | A day, in (zero-padded) digits. | |
| no | A month, in (zero-padded) digits. | |
| yes | A year, in (zero-padded) digits. | |
| yes | ||
| yes | Copyright notice or statement, suitable for printing or display. | |
| yes | The year of copyright. This may not be displayed | |
| yes | Name of the organizational or person that holds a copyright. | |
| license-type xlink:href xlink:title | yes | A license. Set of conditions under which the content may be used, accessed, and distributed. @license-type:
@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:
|
| 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. |
| 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:
@xlink:href: required. The URL at which the PDF can be found. |
| xml:lang | no | 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). |
| yes | The 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! | |
| yes | Paragraphs | |
| xml:lang | no | 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). |
| yes | The title for the translated abstract. | |
| yes | See Paragraphs | |
| 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). |
| 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! | |
| yes | Keyword, like a subject term, key phrase, indexing word etc. The author will supply this information. | |
| no | Container element for information about the funding of the research reported in the article (for example, grants, contracts, sponsors). | |
| id | no | 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. |
| no | Agency or organization that funded the research on which a work was based. | |
| no | ||
| yes | Name of the funding institution or organization. | |
| institution-id-type | yes | @institution-id-type: required. For funders, both DOI and Ringgold values are supported. Supported values:
|
| no | Unique identifier assigned to an award, contract, or grant. I.e., the grant number. | |
| no | Individual(s) or institution(s) to whom the award was given (for example, the principal grant holder or the sponsored individual). | |
| no | Individual(s) responsible for the intellectual content of the work reported in the document. | |
| no | Displayable prose statement that describes the funding for the research on which a work was based. | |
| yes | Container 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. | |
| yes | ||
| yes | A custom metadata name (or key). Supported value:
| |
| yes | A custom metadata value. Supported values:
|
Body content
/article/body is the element that contains's the article's main text.
element | attribute(s) | required | description |
---|---|---|---|
<body> | no | Main textual portion of the document that conveys the narrative content. | |
| no | See Paragraphs | |
| no | See Sections | |
| no | Area 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. | |
| no | One contributor’s signature and associated material (such as a text restatement of the affiliation) inside a signature block. | |
| 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").
@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.
|
Back content
/article/back is for what goes beyond the main body of the article's text, i.e. references.
element | attribute(s) | required | description |
---|---|---|---|
<back> | no | parts at the end of the article that do not belong to the article's main text itself. | |
| no | Acknowledgments. 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>. | |
| no | ||
| no | See Paragraphs | |
| no | See Sections | |
| no | Container element for one or more appendices (<app> elements). | |
| no | Appendix. 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. | |
| no | ||
| no | See Paragraphs | |
| no | See Sections | |
| no | See Definition List | |
| no | See List | |
| no | See Footnotes | |
| no | See Glossary | |
| no | See 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).
element | attribute(s) | required | description |
---|---|---|---|
<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:
| |
| no | The Section number, like 2 or 15.5.1 or XIV.15.A.β.ii. | |
| yes | The actual heading text of the section. | |
| id | no | 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. |
| 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:
@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. |
| no | See Tables | |
| no | See Tables | |
| no | See Figures | |
| no | See Figures | |
| no | See Quotations | |
| no | See Verse | |
| no | See Definition List | |
| no | See List | |
| no | See Paragraphs | |
| no | Used recursively | |
| no | Contains 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. | |
| |||
| |||
| |||
| 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>. | ||
| no | Supply 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.
element | attribute(s) | required | description |
---|---|---|---|
<p> | A text paragraph. | ||
| xlink:href | no | 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 |
| 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:
@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. |
| content-type | no | 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:
|
| no | Font bold weight. | |
| no | Font italic style. | |
| no | Small 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. | |
| xlink:href | no | Link to an external file or resource. @xlink:href: required. The URI where the resource can be found. |
| no | See Embedded-video | |
| id | no | 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:
element | attribute(s) | required | description |
---|---|---|---|
<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:
element | attribute(s) | required | description |
---|---|---|---|
<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
element | attribute(s) | required | description |
---|---|---|---|
<fn-group> | Container element for all footnotes. This element appears at the end of the document. | ||
| 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. |
| The footnote number. Do not use <sup> here. | ||
| 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.
element | attribute(s) | required | description |
---|---|---|---|
<table-wrap-group> | no | Container element for tables. | |
| id | no | 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. |
| no | The label for a table-wrap. | |
| no | Container element for the table caption | |
| no | The title for a table-wrap. | |
| no | See paragraphs | |
| 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. |
| no | Container element for the table header rows of a table. | |
| no | Container element for all the cells in a single table row. | |
| colspan rowspan | no | One cell in the table header, as opposed to an ordinary cell in the body of a table.
@rowspan: How many rows this element spans, e.g. <th rowspan="4"> is four rows high. This attribute is unusual in headers. |
| 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. | |
| no | Container element for a table row. | |
| 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. |
| no | Container element that holds the rows and columns in one of the body (as opposed to the header) portions of a table. | |
| no | Container element for a table row. | |
| 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. |
| no | 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. |
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>.
element | attribute(s) | required | description |
---|---|---|---|
<fig-group> | Container element for figures that are to be displayed together. | ||
| no | The caption for a fig-group. | |
| no | The title for a fig-group. | |
| 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").
@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.
@fig-type: The type of figure. Supported values:
|
| xlink:href | yes | Description of and pointer to an external file containing a still image. @xlink:href: required. The URI where the resource can be found. |
| yes | Alternate 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. | |
| no | Attribution 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.
element | attribute(s) | required | description |
---|---|---|---|
<disp-quote> | |||
| The reference number for the block quote. | ||
| A title displayed before a block quote. | ||
| used recursively | ||
| See paragraphs | ||
| no | Attribution 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>.
element | attribute(s) | required | description |
---|---|---|---|
<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:
@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. | |
| yes | Single item (one entry) in a list of items. | |
| 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.
element | attribute(s) | required | description |
---|---|---|---|
<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:
@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). | |
| A title displayed before a def-list. | ||
| Heading over the first column (the term column) of a definition list (two-part list). | ||
| Heading over the second column (the definition column) of a definition list (two-part list). | ||
| yes | One item in a definition (two-part) list. | |
| id | yes | 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. |
| Definition, explanation, or expansion of a word, phrase, or abbreviation. | ||
| 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.
element | attribute(s) | required | description |
---|---|---|---|
<glossary> | |||
| 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. | ||
| A title displayed before a glossary. | ||
| See Paragraphs. For any descriptive text preceding the Glossary. | ||
| 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">.
element | attribute(s) | required | description |
---|---|---|---|
<verse-group> | |||
| The reference number for the verse. This may be referred to in the text. | ||
| The title of the verse, e.g. Sonnet 18 or Shall I compare thee to a summer’s day?. | ||
| One line of a poem or verse. | ||
| 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>.
element | attribute(s) | required | description |
---|---|---|---|
<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.). | ||
| no | The title of the ref-list, e.g. References. | |
| no | See Paragraphs. For any descriptive text preceding the Reference List. | |
| id | One item in a bibliographic list. @id: required. See id-syntax. A document-unique identifier for the elemen | |
| no | The reference number for a reference. This may be referred to in the text. | |
| publication-type | no | 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:
In case of "web", please add <uri> Supported values minor, full tagging is not needed:
|
| person-group-type | no | 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:
|
| no | Container element for components of personal names unstructured | |
| no | Surname of a person. | |
| no | All 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. | |
| no | Honorifics or other qualifiers that usually precede a person’s name (for example, Professor, Rev., President, Senator, Dr., Sir, The Honorable). | |
| no | Qualifiers that follow a person’s name (for example, Sr., Jr., III, 3rd). | |
| no | Group of contributors credited under a single name; includes an organization credited as a contributor. | |
| no | Full title of an article or other journal component, such as a book review. When the cited document is a book-chapter, use <chapter-title> | |
| no | Title of a cited book chapter. | |
| 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. | |
| no | ||
| yes | A year, in (zero-padded) digits. | |
| no | ||
| no | ||
| no | ||
| no | ||
| no | ||
| no | ||
| xlink:href | no |
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.
element | attribute(s) | required | description |
---|---|---|---|
<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. | |
| 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>