Scope of Application
This document includes instructions regarding the delivery of XML files of books/chapters, yearbook issues and journal issues/articles.
Please note that, yearbook XML deliveries (objects that only consists of one or two ISSNs, but no ISBN) must follow journal requirements. When referring to journals within these guidelines, the requirements also apply to yearbooks.
It must be read in close consideration with the De Gruyter Variables and IDs guidelines [1] in order to receive further and important information about variables and IDs for De Gruyter products.
The document considers the following types of XML deliveries:
Online Data: This data package includes PDF and XML files as well as asset files and is used to publish content on our platform.
-
Books
-
Journal Issues
-
Journal Articles (Ahead of Print and Just Accepted)
Within Books Online Data deliveries each book-part/chapter is represented by a separate XML and PDF file.
Book Archive XML: This is the (media)-neutral XML version for our book content. Rather than having an XML file for each chapter, the entire book content is integrated within one XML file. A PDF file is not part of this delivery. Media and Graphic files should be delivered in the best possible quality.
Books Law XML: This subset of rules applies to book law XML deliveries only. It is based on the Book Archive XML guidelines and need to follow them if not stated otherwise.
Please follow the BITS Tag library [2] (Book Archive XML) and the JATS Tag library guidelines [3] (Journal Article-XML) for anything not covered by this guideline and contact us (Production Standards and Solutions Team) to confirm the implementation.
Pub Med Central: This data package is created for Open Access journal articles that should be published on Pub Med Central [4].
Please follow the Pub Med Central File Submission Specifications [5] for anything not covered by this guideline.
Introductory Remarks
Paragraphs that have been added or changed compared to the previous version of the guidelines as well as the respective heading are marked in yellow.
To display only book (Online Data/Archive XML) or journal (Online Data/Pub Med Central) related instructions, please use one of the filters shown within the right margin. Additionally the section headings are marked, whenever a specific instruction only applies to:
-
Books [B]
-
Books Online Data [BO]
-
Books Archive XML [BA]
-
Books Law XML [BL]
-
Journals [J]
-
Journals Online Data [JO]
-
Journals PMC [PMC]
Requirement Level
The key words "must", "must not", "required", "shall", "shall not", "should", "should not", "recommended", "may", and "optional" in this document are to be interpreted as described in RFC 2119 [6].
They are underlined throughout the document and its significance is shown on mouse over.
Schema
Books Online DataBO
In order to create XML data for books the following NLM based DTD for validating the XML files must be used.
Atypon Systems NCBI Book DTD Suite v3.0.2To access the files, please see the De Gruyter Production Wiki [7]. For referencing the DTD within the XML files the following declaration is required:
<!DOCTYPE book PUBLIC "-//Atypon//DTD Atypon Systems NCBI Book DTD Suite v3.0.2 20110228//EN" "atypon-book3.dtd">Books Archive XMLBA
In order to create Archive XML Data for books the following schema for validating the XML files must be used:
Book Interchange Tag Suite (BITS) Version 2.0You can access the schema files at the Book Interchange Tag Set website [9]. The following XML Model Processing Instruction to associate the XML with the RNG schema shall be used:
<?xml-model href="http://jats.nlm.nih.gov/extensions/bits/2.0/rng/BITS-book2.rng" type="application/xml" schematypens="http://relaxng.org/ns/structure/1.0" title="Book Interchange Tag Set Version 2.0" ?>Books Law XMLBL
In order to create Book Law XML Data for books the following DTD for validating the XML files must be used:
DG LEGAL BOOK DTD 1.0You can access the DTD files within the De Gruyter Production Wiki [8]. For referencing the DTD within the XML files the following declaration is required:
<!DOCTYPE book PUBLIC "-//DG//DTD BITS Legal Book DTD v1.0//EN" "DG-legal-book.dtd">JournalsJ
Issue-XMLJO
The following DTD for the Issue-XML must be used:
Atypon Systems Archival NLM DTD Suite Issue-XML DTD v3.0.2To associate the Issue-XML with the DTD, the following declaration is required:
<!DOCTYPE issue-xml PUBLIC "-//Atypon//DTD Atypon Systems Journal Archiving and Interchange NLM DTD v3.0.2 20101108//EN" "issuexml.dtd">Article-XMLJ
Journals OnlineJO
The following Schema for Article-XML files must be used:
JATS (Z39.96) Journal Publishing DTD v1.1You can access the schema files via the Journal Publishing Tag Set website [10]. The following Doctype Declaration to associate the XML with the DTD is required:
<!DOCTYPE article PUBLIC "-//NLM//DTD JATS (Z39.96) Journal Publishing DTD v1.1 20151215//EN" "JATS-journalpublishing1.dtd">Pub Med CentralPMC
The following Schema for Article-XML files must be used:
JATS (Z39.96) Journal Publishing DTD v1.0You can access the schema files via the Journal Publishing Tag Set website [11]. The following Doctype Declaration to associate the XML with the DTD is required:
<!DOCTYPE article PUBLIC "-//NLM//DTD JATS (Z39.96) Journal Publishing DTD v1.0 20120330//EN" "JATS-journalpublishing1.dtd">Attributes and Namespaces
All XML files (except the Issue-XML) shall use the @xml:lang attribute to define the main language of the content (see section Languages).
Attribute:
@xml:lang
Attribute value: Language code according to ISO 639-1 [12]
Namespaces
The following namespaces must be defined within all XML files:
| Attributes | Attribute values |
|---|---|
@xmlns:xlink
|
http://www.w3.org/1999/xlink
|
@xmlns:mml
|
xmlns:mml=http://www.w3.org/1998/Math/MathML
|
The following namespace must be defined whenever free acess tagging is used (see section Free Access):
| Attributes | Attribute values |
|---|---|
@xmlns:ali
|
http://www.niso.org/schemas/ali/1.0/
|
Attributes for BooksB
For Book XML files the attribute @dtd-version
shall be included within the root element <book>:
Books Online DataBO
Attribute:
@dtd-version
Attribute value:
3.0
Example:
<book xml:lang="en" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:mml="http://www.w3.org/1998/Math/MathML" dtd-version="3.0">Books Archive XMLBA
| Attributes | Attribute values |
|---|---|
@dtd-version
|
2.0
|
@book-type
|
monograph, collection,
critical-edition, textbook, professional, handbook,
reference-work, commentary, directory,
individual-purchase
|
For Book Archive XML deliveries the attribute @book-type
must be included within the root element book.
Example:
<book dtd-version="2.0" book-type="textbook" xml:lang="en" xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:xlink="http://www.w3.org/1999/xlink">Attributes for JournalsJ
Article-XMLJ
Journals Online DataJO
| Attributes | Attribute values |
|---|---|
@article-type
|
research-article, article-commentary, book-review,
brief-report, calendar, case-report, erratum, corrigenda,
editorial, interview, letter, news, proceedings-paper,
rapid-communication, reply, retraction, review-article,
miscellaneous, frontmatter, graphical-abstract, meeting-report,
index, abstract, obituary
|
@dtd-version
|
1.1 |
Example:
<article article-type="research-article" dtd-version="1.1" xml:lang="en" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:mml="http://www.w3.org/1998/Math/MathML">Pub Med CentralPMC
| Attributes | Attribute values |
|---|---|
@article-type
|
book-review, books-received, brief-report, calendar,
case-report, correction, data-paper, discussion, editorial,
expression-of-concern, in-brief, introduction, letter,
meeting-report, methods-article, news, obituary, oration, other,
product-review, reply, research-article, retraction,
review-article, systematic-review
|
@dtd-version
|
1.0 |
The following replacements for @article-types with regard to De Gruyter guidelines must be used:
@article-types for Journals Online |
@article-types for Pub Med Central |
|---|---|
erratum, corrigenda
|
correction
|
miscellaneous, interview, proceedings-paper,
rapid-communication
|
other
|
Example:
<article article-type="research-article" dtd-version="1.0" xml:lang="en" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:mml="http://www.w3.org/1998/Math/MathML">General structure
Books - Online DataBO
Book XMLBO
Within the Online Data, the Book XML represents the structure of the book and is used to create the Table of Contents online. It is structured as follows:
<book>
<book-series-meta /> <!-- meta information on the series -->
<book-meta/> <!-- meta information on the book -->
<body>
<book-part book-part-type="book-toc-page-order" /> <!-- containing the toc of a book -->
</body>
</book>For detailed information, please see section Table of Contents.
Chapter XMLBO
Within the Online Data, each chapter is tagged within a separate XML file. The basic structure of those XML files is as follows:
<book>
<book-series-meta /> <!-- meta information on the series -->
<book-meta/> <!-- meta information on the book -->
<body> <!-- containing the chapters of a book -->
<book-part>
<book-part-meta/> <!-- meta information on the book part -->
<body/> <!-- content of the book part -->
<back/> <!-- backmatter of the book part -->
</book-part>
</body>
<back> <!-- material following the narrative flow, e.g. appendices, references. -->
<ref-list/>
<app-group/>
<index/>
...
</back>
</book>Please note that information, that belongs to the backmatter of a chapter, shall be included within the <back> element within <body>
(//book-part/back) rather than within <book> directly (book/back).
Books - Archive XMLBA
The basic structure of the XML file is as follows:
<book>
<collection-meta/> <!-- meta information on the book series -->
<book-meta/> <!-- meta information on the book -->
<front-matter> <!-- acknowledgement/dedication and similar information -->
<ack/>
<dedication/>
<preface/>
...
</front-matter>
<book-body> <!-- containing the chapters of a book -->
<book-part book-part-type="part">
<book-part-meta/> <!-- meta information on the book part -->
<body> <!-- content of the book part -->
<book-part book-part-type="chapter">
<book-part-meta/> <!-- meta information on the book part -->
<body/> <!-- content of the book part -->
<back/> <!-- backmatter of the book part -->
</book-part>
</body>
<back/> <!-- backmatter of the book part -->
<book-part/>
...
</book-body>
<book-back> <!-- material following the narrative flow, e.g. appendices, references. -->
<ref-list/>
<book-app-group/>
...
</book-back>
</book>Books - Law XMLBL
In contrast to the general Books Archive XML structure it allows <ref-list> within <front-matter.
<book>
<collection-meta/> <!-- meta information on the book series -->
<book-meta/> <!-- meta information on the book -->
<front-matter> <!-- acknowledgement/dedication and similar information -->
<ack/>
<dedication/>
<preface/>
<ref-list/>
...
</front-matter>
<book-body> <!-- containing the chapters of a book -->
<book-part>
<book-part-meta/> <!-- meta information on the book part -->
<body> <!-- content of the book part -->
<book-part>
<book-part-meta/> <!-- meta information on the book part -->
<body/> <!-- content of the book part -->
<back/> <!-- backmatter of the book part -->
</book-part>
</body>
<back/> <!-- backmatter of the book part -->
<book-part/>
...
</book-body>
<book-back> <!-- material following the narrative flow, e.g. appendices, references. -->
<ref-list/>
<book-app-group/>
...
</book-back>
</book>JournalsJ
Issue-XMLJO
The root element <issue-xml> within the Issue-XML represents the structure of the journal issue (ToC, see section Table of Contents), it shall contain the following elements:
<journal-meta>, <issue-meta>, <toc>:
<issue-xml>
<journal-meta>…</journal-meta> <!-- journal metadata such as title, ISSN, publisher -->
<issue-meta>…</issue-meta> <!-- issue metadata such as issue, volume number, pub date -->
<toc>…</toc> <!-- ToC representing the article structure of the issue -->
</issue-xml>Article-XMLJ
The root element <article> within the Article-XML files represents the article structure including metadata information and the content itself. It contains the elements <front>, <body> and
<back>.
<article>
<front>
<journal-meta/> <!-- journal metadata (title, ISSN...) -->
<article-meta/> <!-- article metadata (title, keywords, abstract...) -->
<notes/> <!-- additional article information (correction note...) -->
</front>
<body/> <!-- article content -->
<back>
<fn-group/> <!-- Additional article information (conference note) -->
<ref-list/> <!-- references -->
...
</back>
</article>General Tagging Practice
The following rules apply to all XML-files delivered to De Gruyter. XML-files delivered to De Gruyter must be well-formed [13] and valid XML documents.
Entities
Only predefined entities and numerical character references shall be used.
Any entities other than predefined general entities for XML delimiters (lt, gt, amp, apos, quot) and numeric character references [14] must not be referenced and/or be declared in XML documents delivered to De Gruyter. Also external entities which might be declared in a DTD must not be referenced.
The XML special character module of the NLM DTDs declares many entities for characters which are not within the range of printable ASCII 32-127 [15] (often referred to as “special characters”). An XML document that references these entities might be well formed, and a valid instance of the DTD, but will be considered incorrect by De Gruyter.
Unicode
For character encoding in De Gruyter-XML files usage of UTF-8 [16] is required.
In order to avoid problems with rendering the XML, De Gruyter restricts the ranges of characters to be used to a subset of the available range.
Characters should be represented by the according byte/byte sequence as per UTF-8. However, in some cases, e.g. where there is no actual glyph for a character (whitespace characters) it might be beneficial to capture a numerical character representation (NCR).
The section Allowed Unicode Ranges offers details for which characters an NCR is either allowed or required. NCRs should be captured with hexadecimal numbers, 4 digits, uppercase letters (Regex:
^&#x[0-9A-F]{4}$).
Characters which are canonically equivalent must be normalized to Normalization Form C [17] [18]. Ligatures (FB00 to FB06) must be replaced by the respective individual Unicode characters that are represented within the ligature.
If single characters cannot be represented using Unicode characters, they must be replaced by the element <private-char> containing an
<inline-graphic>
. The attributes @name and @description
may be used to describe the character. Please get back to your Production Editor if this is the case.
Example:
<p>This is some text showing a private char <private-char description="number eight in white on a black background within a white circle" name="eight"><inline-graphic xlink:href="graphic/b_9783110365344-003_ingr_004.png"/></private-char> inline</p>Continuous Makeup ArticlesJ
When more than one article starts on the same page in a printed journal, treat each as an individual article. Tag each in its own file with a unique file name. Articles that start on the same page will have the same <fpage>.
Frontmatter pagesB
Information that is typically displayed on frontmatter pages (such as series information, book title, copyright page...) should be tagged using the respective metadata elements, for example:
-
Series Title:
/book/collection-meta/title-group -
Book Title:
/book/book-meta/book-title-group -
Editors/Editorial Board:
/book/book-meta/contrib-group -
Copyright Information:
/book/book-meta/permissions -
...
This information must not be tagged using <p> elements:
✘ Don't
<front-matter>
<front-matter-part book-part-type="frontmatter" id="b_9783110295207-fm1" seq="14">
<named-book-part-body>
<p content-type="no_indent">Anne A. Author</p>
<p><bold>Philosophical Book Title</bold></p>
</named-book-part-body>
</front-matter-part>
<front-matter-part book-part-type="frontmatter" id="b_9783110295207-fm2" seq="15">
<named-book-part-body>
<p content-type="no_indent"><bold>Philosophical Series Title</bold></p>
<p><bold>Editor-in Chief</bold></p>
<p>Esther Editor, Bethesda, Maryland, USA</p>
</named-book-part-body>
</front-matter-part>
<front-matter-part book-part-type="frontmatter" id="b_9783110295207-fm3" seq="16">
<named-book-part-body>
<p content-type="no_indent">Anne A. Author</p>
<p>Philosophical Book Title</p>
<p>DE GRUYTER</p>
</named-book-part-body>
</front-matter-part>
<front-matter-part book-part-type="frontmatter" id="b_9783110295207-fm4" seq="17">
<named-book-part-body>
<p>ISBN 978-3-11-029520-7</p>
<p>e-ISBN (PDF) 978-3-11-029521-3</p>
<p>e-ISBN (EPUB) 978-3-11-029522-3</p>
<p>© 2020 Walter de Gruyter GmbH, Berlin/Boston</p>
<p>Typesetting: Typesetter GmbH</p>
<p>Printing and binding: Printing GmbH</p>
<p><ext-link ext-link-type="uri">www.degruyter.com</ext-link></p>
</named-book-part-body>
</front-matter-part>
</front-matter>Instead, this metadata information must be captured using the respective elements usually within collection-meta and book-meta:
✔ Do
<book>
<collection-meta>
<title-group>
<title>Philosophical Series Title</title>
</title-group>
<contrib-group>
<contrib contrib-type="series_editor">
<name>
<surname>Editor</surname>
<given-names>Esther</given-names>
</name>
</contrib>
</contrib-group>
...
</collection-meta>
<book-meta>
...
<book-title-group>
<book-title>Philosophical Book Title</book-title>
</book-title-group>
<contrib-group>
<contrib contrib-type="author">
<name>
<surname>Author</surname>
<given-names>Anne A.</given-names>
</name>
</contrib>
</contrib-group>
...
<isbn publication-format="ppub">9783110295207</isbn>
<isbn publication-format="epub">9783110295213</isbn>
<isbn publication-format="original_epub">9783110295223</isbn>
<publisher>
<publisher-name>De Gruyter</publisher-name>
</publisher>
<permissions>
<copyright-statement>© 2020 Walter de Gruyter GmbH, Berlin/Boston</copyright-statement>
<copyright-year>2020</copyright-year>
<copyright-holder>Walter de Gruyter GmbH</copyright-holder>
</permissions>
...
</book-meta>
...
</book>Additional Material
Additional material, such as Also of Interest or Series Overview pages, should not be included within the XML delivery at all.
Table of Contents
The table of contents of the book title front-matter/toc and front-matter/toc-group
must not be included within the XML delivery.
Empty Elements
Elements (without attributes) that are supposed to contain content must not be empty. In case there is no matching value for a given element related with the respective article, the element must be omitted. If the element is required, do not capture placeholder text or whitespace. Instead contact your respective production editor or the author in order to obtain the required information.
Formatted Text
As a rule, use formatted text (<bold>, <italic>, <sc>, etc) only to emphasize a piece of information. Do not set entire elements in formatted text. For example, if a
<title> is set completely in boldface, do not tag the <bold>. However, if a title has a word or some words set in boldface for emphasis, tag those words using <bold>. Mainly this will apply to
<title>, <p> in <abstract>, and <label>. It might also show up in <aff> and “special” sections, like <ack>.
Languages
Every content needs to be identified with @xml:lang. Unlike nearly all other attributes in XML, the value of language is inherited. This means that all elements inside the one with the language attribute (its descendants) are assumed to be in the same language,
unless they explicitly set their own @xml:lang attribute.
In general, the rule for tagging language is that the main language of the book/article must be set in the @xml:lang on <book> or <article>. Any
paragraph within the Book or Article-XML file that is in a different language must be tagged with an @xml:lang to identify the language of that piece.
Language values need to be inserted using the ISO 639-1 standard values [12].
Bidirectional content
If the direction of inline content (left-to-right or right-to-left) cannot be managed by the Unicode Bidirectional Algorithm [19], the element <named-content> including the attributes
@content-type and @specific-use
must to be used to mark the correct direction.
| Attribute | Attribute values |
|---|---|
@content-type
|
rtl, ltr
|
@specific-use
|
bidi
|
Example:
<p>The title says <named-content content-type="rtl" specific-use="bidi">"פעילות הבינאום, W3C"</named-content> in Hebrew.</p>This will display the content as follows:
The title says "W3C, פעילות הבינאום" in Hebrew.
Required Elements
All elements that must to be delivered within every archive XML file are listed below using the respective XPath expressions.
BooksB
Books Online DataBO
Book XMLBO
/book/book-meta/book-id
/book/book-meta/book-title-group/book-title
/book/book-meta/contrib-group/contrib
/book/book-meta/publisher/publisher-name
/book/book-meta/isbn
/book/book-meta/pub-date
/book/book-meta/permissions/copyright-statement
/book/book-meta/permissions/copyright-year
/book/book-meta/permissions/copyright-holder
/book/book-meta/counts/page-count
/book/body/book-part[@book-part-type="book-toc-page-order"]Chapter XMLBO
/book/book-meta/book-id
/book/book-meta/book-title-group/book-title
/book/book-meta/contrib-group/contrib
/book/book-meta/publisher/publisher-name
/book/book-meta/isbn
/book/book-meta/pub-date
/book/book-meta/permissions/copyright-statement
/book/book-meta/permissions/copyright-year
/book/book-meta/permissions/copyright-holder
/book/book-meta/counts/page-count
//book-part/book-part-meta/book-part-id
//book-part/book-part-meta/title-group/title
//book-part/book-part-meta/fpage
//book-part/book-part-meta/lpage
//book-part/book-part-meta/permissions/copyright-statement
//book-part/book-part-meta/permissions/copyright-year
//book-part/book-part-meta/permissions/copyright-holder
//book-part/book-part-meta/counts/page-count
Books Archive XMLBA
/book/book-meta/book-id
/book/book-meta/book-title-group/book-title
/book/book-meta/contrib-group/contrib
/book/book-meta/pub-date
/book/book-meta/isbn
/book/book-meta/publisher/publisher-name
/book/book-meta/permissions/copyright-statement
/book/book-meta/permissions/copyright-year
/book/book-meta/permissions/copyright-holder
/book/book-meta/counts/book-page-count
//book-part-meta[not(parent::book-part[@book-part-type='part'])]/book-part-id[@book-part-id-type="doi"]
//book-part/book-part-meta/title-group/title
//book-part-meta[not(parent::book-part[@book-part-type='part'])]/contrib-group/contrib
//book-part-meta[not(parent::book-part[@book-part-type='part'])]/fpage
//book-part-meta[not(parent::book-part[@book-part-type='part'])]/lpage
//book-part-meta[not(parent::book-part[@book-part-type='part'])]/permissions/copyright-statement
//book-part-meta[not(parent::book-part[@book-part-type='part'])]/permissions/copyright-year
//book-part-meta[not(parent::book-part[@book-part-type='part'])]/permissions/copyright-holder
//book-part-meta[not(parent::book-part[@book-part-type='part'])]/counts/book-count[@count-type="chapter-page-count"]JournalsJ
Issue-XMLJO
/issue-xml/journal-meta/journal-id
/issue-xml/journal-meta/journal-title-group/journal-title
/issue-xml/journal-meta/issn
/issue-xml/journal-meta/publisher/publisher-name
/issue-xml/issue-meta/pub-date
/issue-xml/issue-meta/volume
/issue-xml/issue-meta/issue
/issue-xml/issue-meta/issue-id
/issue-xml/toc
Article-XMLJ
Journals OnlineJO
/article/front/journal-meta/journal-id
/article/front/journal-meta/journal-title-group/journal-title
/article/front/journal-meta/issn
/article/front/journal-meta/publisher/publisher-name
/article/front/article-meta/article-id
/article/front/article-meta/title-group/article-title
/article/front/article-meta/pub-date
/article/front/article-meta/volume
/article/front/article-meta/issue
/article/front/article-meta/fpage AND /article/front/article-meta/lpage
OR
/article/front/article-meta/elocation-id
/article/front/article-meta/permissions/copyright-statement
/article/front/article-meta/permissions/copyright-year
/article/front/article-meta/permissions/copyright-holder
/article/front/article-meta/related-article
/article/front/article-meta/counts/page-count
Pub Med CentralPMC
/article/front/journal-meta/journal-id
/article/front/journal-meta/journal-title-group/journal-title
/article/front/journal-meta/issn
/article/front/journal-meta/publisher/publisher-name
/article/front/article-meta/article-id
/article/front/article-meta/article-categories/subj-group[@subj-group-type='heading']
/article/front/article-meta/title-group/article-title
/article/front/article-meta/pub-date
/article/front/article-meta/volume
/article/front/article-meta/issue
/article/front/article-meta/fpage AND /article/front/article-meta/lpage
OR
/article/front/article-meta/elocation-id
/article/front/article-meta/permissions/copyright-statement
/article/front/article-meta/permissions/copyright-year
/article/front/article-meta/related-article
/article/front/article-meta/counts/page-count
Table of ContentsBOJO
The Table of Contents must to be included for the Online Data. It is integrated within the Book XML and Issue-XML file.
Books Online DataBO
/book/body/book-part[@book-part-type='book-toc-page-order']The table of contents shall be included in the Book XML file. It reflects the part/chapter structure of the title. Each entry representing a chapter (<book-part>)
must contain the following elements: <book-part-id>, <title-group>, <fpage>, <lpage>,
<alternate-form
alternate-form-type="pdf">, <alternate-form
alternate-form-type="xml">. A
<bookpart> element representing a "part" must contain the element <title-group>.
Attribute:
@book-part-type
Attribute value:
book-toc-page-order
Example:
<body>
<book-part book-part-type="book-toc-page-order">
<body>
<book-part book-part-type="frontmatter">
<book-part-meta>
<book-part-id pub-id-type="doi">10.1515/9783110339406-001</book-part-id>
<title-group>
<title>Frontmatter</title>
</title-group>
<fpage>i</fpage>
<lpage>iv</lpage>
<alternate-form xlink:href="9783110339406-001.pdf" alternate-form-type="pdf"/>
<alternate-form xlink:href="9783110339406-001.xml" alternate-form-type="xml"/>
</book-part-meta>
</book-part>
<book-part book-part-type="chapter">
<book-part-meta>
<book-part-id pub-id-type="doi">10.1515/9783110339406-002</book-part-id>
<title-group>
<title>1. Religiöse Dichtungen</title>
</title-group>
<fpage>1</fpage>
<lpage>72</lpage>
<alternate-form xlink:href="9783110339406-002.pdf" alternate-form-type="pdf"/>
<alternate-form xlink:href="9783110339406-002.xml" alternate-form-type="xml"/>
</book-part-meta>
</book-part>
<book-part book-part-type="part">
<book-part-meta>
<title-group>
<title>Textkritischer Apparat und Erläuterungen zu Band III</title>
</title-group>
</book-part-meta>
<body>
<book-part book-part-type="chapter">
<book-part-meta>
<book-part-id pub-id-type="doi">10.1515/9783110339406-003</book-part-id>
<title-group>
<title>2. Theoretische Dichtungen</title>
</title-group>
<fpage>21</fpage>
<lpage>68</lpage>
<alternate-form xlink:href="9783110339406-003.pdf" alternate-form-type="pdf"/>
<alternate-form xlink:href="9783110339406-003.xml" alternate-form-type="xml"/>
</book-part-meta>
</book-part>
</body>
</book-part>
</body>
</book-part>
</body>Books Archive XMLBA
For Book Archive XML deliveries the table of contents (front-matter/toc and front-matter/toc-group) must be omitted. This also applies to chapter ToCs, they
must not be included.
JournalsJO
/issue-xml/toc[@toc-type="page-order"]The Table of Contents for issues is included within the Issue-XML using the element <toc>. It must include, at a minimum, <issue-article-meta> and
<article-id> elements for each article that should appear in the table of contents. In case there are one or two levels of subject headings these elements
shall be wrapped in <issue-subject-group>. It is included within the Issue XML.
Attribute:
@toc-type
Attribute value:
page-order
Example:
<toc toc-type="page-order">
<issue-article-meta>
<article-id pub-id-type="doi">10.1515/hsz-2020-frontmatter3</article-id>
</issue-article-meta>
<issue-subject-group>
<issue-subject-title>
<subject>Reviews</subject>
</issue-subject-title>
<issue-article-meta>
<article-id pub-id-type="doi">10.1515/hsz-2019-0264</article-id>
</issue-article-meta>
<issue-article-meta>
<article-id pub-id-type="doi">10.1515/hsz-2019-0326</article-id>
</issue-article-meta>
</issue-subject-group>
<issue-subject-group>
<issue-subject-title>
<subject>Research Articles/Short Communications</subject>
</issue-subject-title>
<issue-subject-group>
<issue-subject-title>
<subject>Genes and Nucleic Acids</subject>
</issue-subject-title>
<issue-article-meta>
<article-id pub-id-type="doi">10.1515/hsz-2019-0316</article-id>
</issue-article-meta>
</issue-subject-group>
<issue-subject-group>
<issue-subject-title>
<subject>Cell Biology and Signaling</subject>
</issue-subject-title>
<issue-article-meta>
<article-id pub-id-type="doi">10.1515/hsz-2018-0442</article-id>
</issue-article-meta>
<issue-article-meta>
<article-id pub-id-type="doi">10.1515/hsz-2019-0184</article-id>
</issue-article-meta>
</issue-subject-group>
</issue-subject-group>
</toc>The tag <issue-subject-title>
must not be included for frontmatter articles.
Cover FileJO
The cover file contains the first page of the cover ("U1") without any crop marks. If it shall be included within the Online delivery, it must be inserted within the
Issue-XML using the element <cover>. This includes a <graphic> tag which links the Cover PDF.
Example:
<toc toc-type="page-order">
<cover>
<graphic xlink:href="cmam.2016.16.issue-1_cover.pdf"/>
</cover>
<issue-subject-group>
<issue-subject-title>
<subject>Original Articles</subject>
</issue-subject-title>
<issue-article-meta>
<article-id pub-id-type="doi">10.1515/cmam-2016-frontmatter1</article-id>
</issue-article-meta>
</issue-subject-group>
...
</toc>Please see section Cover File and Folder Structure Online Issues for detailed information on the naming convention and the position within the ZIP delivery.
Metadata Elements
The metadata elements described in this section may be part of the <collection-meta> (Book Archive XML), <book-meta> or <book-part-meta> for book
content as well as <article-meta>, <issue-meta> or <journal-meta> for journal content. The XPath expression shows in which constellation the element is allowed.
IDs
Information on how to build the DOI can be found within the De Gruyter Variables and ID guidelines [1]. The DOIs must conform to these specifications.
Title-IDB
/book/book-meta/book-idThe title ID is captured using the element <book-id>.
Books Online DataBO
Attribute:
@pub-id-type
Attribute value:
title
Element value:
{Title-ID}
Example:
<book-id pub-id-type="title">514363</book-id>Books Archive XMLBA
Attribute:
@book-id-type
Attribute value:
title
Element value:
{Title-ID}
Example:
<book-id book-id-type="title">514363</book-id>Book-IDB
/book/book-meta/book-idThe element <book-id> holds the DOI of the Book.
Books Online DataBO
Attribute:
@pub-id-type
Attribute value:
doi
Element value:
{DOI-book}
Example:
<book-id pub-id-type="doi">10.1515/9783110339406</book-id>Books Archive XMLBA
Attribute:
@book-id-type
Attribute value:
doi
Element value:
{DOI-book}
Example:
<book-id book-id-type="doi">10.1515/9783110339406</book-id>Book-Part IDB
//book-part-meta[not(parent::book-part[@book-part-type='part'])]/book-part-idThe element <book-part-id> holds the DOI of the book-part.
Online DataBO
Attribute:
@pub-id-type
Attribute value:
doi
Element value:
{DOI-book-part}
Example:
<book-part-id pub-id-type="doi">10.1515/9783110339406-017</book-part-id>Book Archive XMLBA
The element <book-part-id> using attribute @book-part-id-type="doi" holds the DOI of the book-part.
Attribute:
@book-part-id-type
Attribute value:
doi
Element value:
{DOI-book-part}
Example:
<book-part-id book-part-id-type="doi">10.1515/9783110339406-017</book-part-id>Object IDB
/book/book-meta/abstract/object-id/book/front-matter/ack/object-id...For book content that should receive a DOI, but a <book-part-meta> that contains the <book-part-id> is not defined (like <ack> or <ref-list>), the element <object-id>
shall be used. It must include the @pub-id-type="doi".
Example:
<object-id pub-id-type="doi">10.1515/9783110339406-003</object-id> Journal-IDsJ
The journal ID holds the journal abbreviations.
Journal Online DataJO
/issue-xml/journal-meta/journal-id/article/front/journal-meta/journal-id| Attribute | Attribute value | Element value |
|---|---|---|
@journal-id-type
|
publisher-id
|
{journal-code-online}
|
journal-code
|
{journal-code}
|
|
doi-code
|
{doi-code}
|
Examples:
<journal-id journal-id-type="journal-code">hsz</journal-id><journal-id journal-id-type="publisher-id">bchm</journal-id><journal-id journal-id-type="doi-code">hsz</journal-id>The dg-journalmap.xml [20] is used to verify the journal abbreviations within the submission checker. This file is created from the journal information listed in our ERP system. The correspondence between the entry within the journal-id and the information within the dg-journalmap.xml is as follows:
| within the Issue and Article-XML file | within dg-journalmap.xml |
|---|---|
<journal-id
journal-id-type="publisher-id">bchm</journal-id>
|
<online_code>bchm</online_code>
|
<journal-id
journal-id-type="journal-code">hsz</journal-id>
|
<kup_code>HSZ</kup_code>
|
<journal-id
journal-id-type="doi-code">hsz</journal-id>
|
<doi_code>hsz</doi_code>
|
Pub Med CentralPMC
/article/front/journal-meta/journal-idFor Pub Med Central the Journal ID must be adjusted as follows:
-
Remove
journal-id/[@journal-id-type="journal-code"] -
Replace
journal-id/[@journal-id-type="doi-code"]withjournal-id/[@journal-id-type="doi"] -
Add
journal-id/[@journal-id-type="pmc"] -
Add
journal-id/[@journal-id-type="nlm-ta"]
| Attribute | Attribute value | Element value |
|---|---|---|
@journal-id-type
|
publisher-id
|
{journal-code}
|
doi
|
{doi-code}
|
|
pmc
|
{pmc-code}
|
|
nlm-ta
|
{nlm-ta-code}
|
Examples:
<journal-id journal-id-type="publisher-id">hsz</journal-id><journal-id journal-id-type="doi">hsz</journal-id><journal-id journal-id-type="pmc">hsz</journal-id><journal-id journal-id-type="nlm-ta">Biol Chem</journal-id>The dg-journalmap.xml [20] is used to verify the journal abbreviations within the submission checker. This file is created from the journal information listed in our ERP system. The correspondence between the entry within the journal-id and the information within the dg-journalmap.xml is as follows:
| within the Article-XML file | within dg-journalmap.xml |
|---|---|
<journal-id
journal-id-type="publisher-id">bchm</journal-id>
|
<kup_code>HSZ</kup_code>
|
<journal-id
journal-id-type="doi">hsz</journal-id>
|
<doi_code>hsz</doi_code>
|
<journal-id
journal-id-type="pmc">hsz</journal-id>
|
<pmc_code>hsz</pmc_code>
|
<journal-id journal-id-type="nlm-ta">Biol
Chem</journal-id>
|
<nlm-ta_code>Biol Chem</nlm-ta_code>
|
Issue IDJ
/issue-xml/issue-meta/issue-idThe element <issue-id> records an identifier that describes an entire issue of the journal.
Attribute:
@pub-id-type
Attribute value:
publisher-id
Value:
{issue-id}
Example:
<issue-id pub-id-type="publisher-id">jbca.2013.32.issue-4</issue-id>Article IDJ
The element <article-id> includes unique identifiers that has been assigned to the article.
| Attribute | Attribute value | Element value |
|---|---|---|
@pub-id-type
|
publisher-id
|
{article-id}
|
doi
|
{DOI-article}
|
Examples:
<article-id pub-id-type="publisher-id">hsz-2015-0068</article-id><article-id pub-id-type="doi">10.1515/hsz-2015-0068</article-id>The element <article-id> has always the attribute @pub-id-type and needs to be included twice within the <article-meta> with the attribute values “publisher-id” and “doi”.
Article CategoriesJ
/article/front/article-meta/article-categoriesThe element <article-categories> is used for assigning articles into related clusters just like categories.
Please note that the element <article-categories>
should be omitted for frontmatter and graphical abstract articles.
Example:
<article-categories>
<subj-group>
<subject>Clinical Chemistry</subject>
<subj-group>
<subject>Research Article</subject>
</subj-group>
</subj-group>
</article-categories>Pub Med CentralPMC
/article/front/article-meta/article-categories/subj-group[@subj-group-type="heading"]For Pub Med Central articles the element <article-catgories> is required. It must to be included only once per article.
Example:
<article-categories>
<subj-group subj-group-type="heading">
<subject>Clinical Chemistry</subject>
<subj-group>
<subject>Research Article</subject>
</subj-group>
</subj-group>
</article-categories>Book Series InformationB
Books Archive XMLBA
/book/collection-meta/collection-idThe element <collection-id> contains the series the book belongs to. The attribute @collection-id-type with the value "doi" is required.
If the book is not part of a series this element should be omitted.
Attributes:
@collection-id-type
Attribute value:
doi
Element value:
{DOI-prefix}/{abbr. of the series}
Example:
<collection-id collection-id-type="doi">10.1515/ifla-b</collection-id>Online DataBO
/book/book-series-meta/book-idThe book series information no longer needs to be tagged for Book Online Data deliveries.
Book CategoriesB
Book Online DataBO
/book/book-meta/book-categoriesThe element <subj-group> holds the classification codes of the book content. At least one <subject>
must be used within this context.
Example:
<book-categories>
<subj-group>
<subject>MA</subject>
<subject>MA-07</subject>
<subject>NA</subject>
<subject>WS-02-04</subject>
</subj-group>
</book-categories>The attribute @subj-group-type="categories" is no longer necessary.
Books Archive XMLBA
/book/book-meta/subj-groupThis element should not be delivered anymore.
Book TitleB
/book/book-meta/book-title-groupThe element <book-title-group> contains the title of the entire book. The element <book-title> is required, the elements <subtitle> and
<trans-title-group> are optional.
If the <trans-title-group> is used, the attribute @xml:lang is required using the according lowercase ISO 639-1 language code [12].
Example:
<book-title-group>
<book-title>Access to Scientific Research</book-title>
<subtitle>Challenges Facing Communications in STM</subtitle>
<trans-title-group xml:lang="de">
<trans-title>Zugang zu wissenschaftlicher Forschung</trans-title>
<trans-subtitle>Herausforderungen der Kommunikation in STM</trans-subtitle>
</trans-title-group>
</book-title-group>TitleB
/book/collection-meta/title-group//book-part/book-part-meta/title-groupThe element <title-group> includes the title information of a book series or a chapter. The element <title> is required, the elements
<subtitle> and <trans-title-group> are optional.
If the <trans-title-group> is used, the attribute @xml:lang is required using the according lowercase ISO 639-1 language code [12].
Example:
<title-group>
<title>Information Outreach and Knowledge Sharing in the United Nations</title>
<subtitle>New Approaches</subtitle>
<trans-title-group xml:lang="de">
<trans-title>Informations- und Wissensaustausch in den Vereinten Nationen</trans-title>
<trans-subtitle>Neue Methoden</trans-subtitle>
</trans-title-group>
</title-group>Journal TitleJ
/issue-xml/journal-meta/journal-title-group/journal-title/article/front/journal-meta/journal-title-group/journal-titleThe element <journal-title> includes the title of the journal in which the article is published.
Element value:
complete title of the journal
Example:
<journal-title-group>
<journal-title>Biological Chemistry</journal-title>
</journal-title-group>ISO 4 Journal Abbreviation
The ISO 4 is an international standard which defines a uniform system for the abbreviation of serial titles (such as journals). The ISSN International Centre maintains the “List of Title Word Abbreviations”, which are standard abbreviations for words commonly found in serial titles
[21]. To tag this information the element <abbrev-journal-title> including the attribute @abbrev-type="iso-4" is used.
Example:
<journal-title-group>
<journal-title>Biological Chemistry</journal-title>
<abbrev-journal-title abbrev-type="iso-4">Biol. Chem.</abbrev-journal-title>
</journal-title-group>Contributors
/book/collection-meta/contrib-group/book/book-meta/contrib-group/book/book-meta/contrib-group//book-part/book-part-meta/contrib-group/article/front/journal-meta/contrib-group/issue-xml/issue-meta/contrib-group/article/front/article-meta/contrib-group/contrib//sec/sec-meta/contrib-groupThe element <contrib-group> contains the contributors of a book series, an entire book, a chapter or an article. The elements <surname> and <given-names>
should be included within each <contrib>. In cases where authors have just one name or where it's unclear which part is the given name, only
<surname> should be used. Use <email> including the attribute @xlink:href to insert the email address of the contributor. @xlink:href is
required and shall start with "mailto:". It must also follow the formal definitions described in RFC 5322 [26] (sections 3.2.3 and 3.4.1) and RFC 5321 [27]. In case a salutation or title information is present, this
must be tagged using <prefix>. To indicate that the contributor was deceased when the article or book has been published, the attribut @deceased="yes"
shall be used.
Each <contrib>
must contain the element <name> or <collab>.
Attribute:
@contrib-type
Attribute values:
assistant, author, contributor, corp_editor, editor, editorial_staff,
founder, series_editor, translator
| Publication Type | Context | XPath | Allowed @contrib-type |
|---|---|---|---|
| Books | Series | /book/collection-meta/contrib-group/contrib |
series_editor, founder, editor, translator, editorial_staff, assistant, advisory_board |
| Book | /book/book-meta/contrib-group/contrib |
founder, author, editor, translator, editorial_staff, assistant, reviser, advisory_board |
|
| Part/Chapter | //book-part/book-part-meta/contrib-group/contrib |
author, translator, reviser, editor |
|
| Journals | Journal | /article/front/journal-meta/contrib-group/contrib |
founder, editor, translator, assistant, advisory_board |
| Issue | /issue-xml/issue-meta/contrib-group/contrib |
guest_editor |
|
| Article | /article/front/article-meta/contrib-group/contrib |
author, translator, guest_editor |
|
| Books/Journals | Section | //sec/sec-meta/contrib-group/contrib |
author, translator |
The attribute @corresp="yes"
must be used for the corresponding author only. If there is a contributors affiliation, this information will be tagged within the element <aff>. To connect the contributor and the affiliation, the
element <xref> including the attributes @rid and @ref-type="aff" is used.
Example:
<contrib-group>
<contrib contrib-type="series_editor">
<name>
<prefix>Prof. Dr.</prefix>
<surname>Michael</surname>
<given-names>Heaney</given-names>
</name>
<email xlink:href="mailto:clemens.heydenreich@xmltest.com">
clemens.heydenreich@xmltest.com
</email>
<xref ref-type="aff" rid="j_hsz-2013-0008_aff_001"/>
<xref ref-type="aff" rid="j_hsz-2013-0008_aff_003"/>
</contrib>
</contrib-group>If the author provides his/her email address, but does not want to publish it along with the publication the @specific-use="company-only"
must be used:
Example:
<email specific-use="company-only" xlink:href="mailto:karen.miller@xmltest.com">karen.miller@xmltest.com</email>Series EditorB
/book/collection-meta/contrib-groupTo capture the series editor of a book, the @contrib-type="series_editor" is used.
Please see Table 1 within section Contributors for details.
EditorB
/book/book-meta/contrib-groupTo capture the editor of a book, the @contrib-type="editor" is used.
Please see Table 1 within section Contributors for details.
Author
/book/book-meta/contrib-group//book-part/book-part-meta/contrib-group/article/front/article-meta/contrib-group/contribTo capture the author of a book, chapter or article the @contrib-type="author" is used.
Please see Table 1 within section Contributors for details.
Name Alternatives
If there are two or more versions of an author name present within the manuscript, they must be tagged using the element <name-alternatives>. Each version
shall contain the attribute @xml:lang using the ISO 639-1 Language codes [12] as well as the attribute @name-style to indicate how to
order/sort the parts of the name [22].
Example:
<contrib contrib-type="author">
<name-alternatives>
<name name-style="western" xml:lang="en">
<surname>Zhang</surname>
<given-names>Y. P.</given-names>
</name>
<name name-style="eastern" xml:lang="ja">
<surname>石橋</surname>
<given-names>忍月</given-names>
</name>
</name-alternatives>
</contrib>Collaborative Group of Authors
To tag a group of contributors credited under a single name, also including an organization credited as a contributor, use the element <collab> within <contrib>.
Examples:
<contrib contrib-type="author">
<collab>on behalf of the <institution>European Federation of Clinical Chemistry and Laboratory Medicine (EFLM)</institution> – <institution>European Society of Pharmacogenomics and Personalised Therapy (ESPT)</institution> Joint Working Group on Personalized Laboratory Medicine (WG-PLM)</collab>
</contrib><contrib contrib-type="author">
<collab>
The Mouse Genome Sequencing Consortium
<contrib-group>
<contrib>
<name>
<surname>Kelly</surname><given-names>Laura A.</given-names>
</name>
</contrib>
<contrib>
<name>
<surname>Randall</surname><given-names>Daniel Lee</given-names>
<suffix>Jr.</suffix>
</name>
</contrib>
</contrib-group>
</collab>
</contrib>On behalf of
If an author or a group of authors have written their work on behalf of an organization or group, this will be captured within <on-behalf-of>
Example:
<contrib-group>
<contrib contrib-type="author">
<name>
<surname>Michael</surname>
<given-names>Heaney</given-names>
</name>
<on-behalf-of>Berlin-Brandenburgische Akademie der Wissenschaften</on-behalf-of>
</contrib>
</contrib-group>ORCIDBAJ
//contrib/contrib-idTo add the ORCID identifier for a contributor the element <contrib-id> with the attribute @contrib-id-type="orcid"
must be used.
Do not use this ID on a collaborative group of authors.
Attribute:
@contrib-id-type
Attribute values:
orcid
Regex:
^https://orcid\.org/\d{4}-\d{4}-\d{4}-(\d{3}X|\d{4})$
Example:
<contrib-id contrib-id-type="orcid">https://orcid.org/0000-0002-7361-560X</contrib-id>You can access more information on the ORCID web page [23].
Author Biography
//contrib/bioThe element <bio> is used to tag biographical data concerning a contributor. The element <fig> containing the author portrait is optional. If it is used, the attribute
@fig-type="contrib" is required. There must be at least one paragraph (<p>) included.
Example:
<bio>
<fig fig-type="contrib">
<graphic xlink:href="graphic/j_hsz-2015-0068_cv_001.jpg"/>
</fig>
<p>Alexey V. Shevelkin received his PhD at the P.K. Anokhin Institute of Normal Physiology. Currently, he is a Postdoctoral Research Fellow at the Pletnikov Laboratory in the Department of Psychiatry and Behavioral Sciences, Johns Hopkins University School of Medicine.</p>
</bio>Affiliation
//contrib-group/affThe element <aff> includes information about the affiliation of an author. The attribute @id is used to link <contrib> entries with the affiliation. The element <country>
includes the corresponding country information. It must contain the attribute @country using the ISO 3166-1 Alpha-2 code [24]. Further detailed tagged information
shall be included by using <institution> and <city>.
Required Information:
@id, institution, city, country/@country
Optional Information:
institution[@content-type="dept"], addr-line, postal-code, state
Example:
<aff id="j_hsz-2013-0008_aff_002">
<institution>Cancer Research UK Cell Signalling Group and Weatherall</institution>,
<institution content-type="dept">Institute of Molecular Medicine</institution>,
<city>Oxford</city>,
<postal-code>OX3 9DS</postal-code>,
<country country="GB">United Kingdom</country>.
</aff>Any affiliation information that is not institution, postal code, city, state or country shall be tagged using
<addr-line>. Punctuation must be preserved.
Private or company only information
If an author does not have an institutional affiliation and therefore no institution information is available, the following tagging may be used:
Example:
<aff id="j_cmam-2016-0011_aff_003"><institution content-type="private"/>
<city>Berlin</city><country country="DE"/></aff>If address information is present, but the author does not want to publish it along with the publication the attribute @specific-use=”company-only”
must be used:
Example:
<aff id="b_9783110365344-003_aff_002" specific-use=”company-only”>
<institution>Cancer Research UK Cell Signalling Group and Weatherall</institution>,
<institution content-type="dept">Institute of Molecular Medicine</institution>,
<city>Oxford</city>,
<postal-code>OX3 9DS</postal-code>,
<country country="GB">United Kingdom</country>.
</aff>You may as well combine @content-type="private" and @specific-use=”company-only” within one affiliation:
Example:
<aff id="b_9783110365344-003_aff_002" specific-use=”company-only” content-type="private">
<addr-line>41 Charles St.</addr-line>,
<city>Oxford</city>,
<postal-code>OX3 9DS</postal-code>,
<country country="GB">United Kingdom</country>.
</aff>Books Online DataBO
Within Books Online Data the element <city> is not required as it is not defined within the Atypon DTD.
Ringgold IDBAJ
//contrib-group/aff/institution-wrapThe Ringgold ID [25] is a unique identifier for organisations in the publishing industry supply chain. If a Ringgold ID is provided, please insert the name of the institution within the element <institution> and
the Ringgold Identifier within the element <institution-id> using the attribute institution-id-type="Ringgold".
Element
|
Attribute
|
Attribute Value
|
|---|---|---|
institution-id
|
@institution-id-type
|
Ringgold
|
institution
|
@content-type
|
university, laboratory, dept, office
|
The elements <institution-id> and <institution> are required when using the attribute @institution-id-type="Ringgold".
Example:
<institution-wrap>
<institution-id institution-id-type="Ringgold">1812</institution-id>
<institution content-type="university">Harvard University</institution>
</institution-wrap>Author Notes
/book/book-meta/author-notes//book-part/book-part-meta/author-notes/article/front/article-meta/author-notesThe element <author-notes> is used to capture additional author information. For example:
-
which of the authors (or other contributors) is the corresponding contributor and to whom information requests should be addressed using the element
<corresp> -
(The "communicated by" information has been moved to section Additional Information.)
Example:
<author-notes>
<corresp>Prof. Dr. W. Mohammed S.A. Gaby, Medizinisches Labor Bremen, Haferwende 12, 28357 Bremen, Germany, gaby@mail.com</corresp>
<p>The authors contributed equally to this work.</p>
</author-notes>
Publication Date
/book/book-meta/pub-date/issue-xml/issue-meta/pub-date/article/front/article-meta/pub-dateThe element <pub-date> holds the publication date of the book, issue or article and can be used once or twice within one document. The attribute @pub-type and the elements <day>,
<month>, <year> are required.
The date must be valid and for the tags <day>, <month> and <year> only digits are allowed:
-
day:
[01-31] -
month:
[01-12] -
year:
\d{4}
The element <year> should not be used as second element within <pub-date>.
Archive XMLBA
For the Archive XML the element @publication-format is used to distinguish between online and print.
Attribute:
@publication-format
Attribute value:
epub, ppub
Example:
<pub-date publication-format="ppub">
<day>01</day>
<month>11</month>
<year>2015</year>
</pub-date>The <pub-date> with the attribute @publication-format is required for each book.
Online DataBOJO
For book and journal Online Data the attribute @pub-type is used to distinguish between online and print.
Attribute:
@pub-type
Attribute value:
epub, ppub
Example:
<pub-date pub-type="ppub">
<day>01</day>
<month>11</month>
<year>2015</year>
</pub-date>The <pub-date> with the attribute @pub-type="epub" is required for each book and article. Please note that the day (<day>1</day>) needs to
be part of the publication date. If there is no specific date available, “1” should be set as default value.
Article-XMLJO
/article/front/article-meta/pub-dateThe <pub-date pub-type="ppub">
must be set for every article that has been published within an print issue. The <pub-date pub-type="issue"> is required for every article
that has been published within an online only issue. <pub-date pub-type="cover-date">
must be included in both cases.
Attribute:
@pub-type
Attribute values:
epub, ppub, issue, cover-date
| Just Accepted/Ahead of Print | Print and Online | Online Only | |||
|---|---|---|---|---|---|
| Article-XML | Article-XML | Issue-XML | Article-XML | Issue-XML | |
| Article Published Online |
epub
|
epub
|
-
|
epub
|
-
|
| Article/Issue Published in Print |
-
|
ppub
|
actual_ppub
|
-
|
-
|
| Issue Cover Date |
-
|
cover-date
|
ppub
|
cover-date
|
epub
|
| Issue Publication |
-
|
-
|
-
|
issue
|
actual_epub
|
The Cover Date of an issue is reflected as <pub-date
pub-type="cover-date"> within the Article-XML and as <pub-date pub-type="epub"> or <pub-date pub-type="ppub">
within the Issue XML.
Issue-XMLJO
/issue-xml/issue-meta/pub-dateWhen used within the <issue-meta> the Print Publication Date (<pub-date pub-type="actual_ppub">) and the Cover Date (<pub-date pub-type="ppub">)
must be included. The Cover Date is the date an issue is planned to be published according to the production calendar. The actual print date is captured within <pub-date pub-type="actual_ppub">
and can be found within our Production Wiki [28].
In case of online only issues or open issues, the cover date needs to be captured within the epub publication date (<pub-date
pub-type="epub">). The actual online publication date will be captured within
<pub-date
pub-type="actual_epub">.
Attribute values:
ppub, actual_ppub, epub, actual_epub
Example:
<pub-date pub-type="ppub">
<day>01</day>
<month>04</month>
<year>2017</year>
</pub-date>
<pub-date pub-type="actual_ppub">
<day>24</day>
<month>04</month>
<year>2017</year>
</pub-date>Please note that the publication date (epub and ppub) must not be changed after the XML-files have been delivered the first time and has been published online.
Pub Med CentralPMC
For PMC articles the <pub-date pub-type="epub">
shall be included for every article. If an article is part of an print issue the print publication date must be added as well using the attributes @date-type="pub" and
@publication-format="print":
Example:
<pub-date pub-type="epub">
<day>12</day>
<month>03</month>
<year>2016</year>
</pub-date>
<pub-date date-type="pub" publication-format="print">
<day>12</day>
<month>03</month>
<year>2016</year>
</pub-date>For online only journals the <pub-date
pub-type="collection">
must replace the print publication date <pub-date date-type="pub"
publication-format="print">:
Example:
<pub-date pub-type="epub">
<day>12</day>
<month>03</month>
<year>2016</year>
</pub-date>
<pub-date pub-type="collection">
<day>12</day>
<month>03</month>
<year>2016</year>
</pub-date>Volume Information
Books Online DataBO
/book/book-meta/volumeThe element <volume> holds the volume number of the book series.
Example:
<volume-number>85</volume-number>Books Archive XMLBA
/book/collection-meta/volume-in-collectionThe element <volume-in-collection> holds the volume number and volume title of the book series.
Example:
<volume-in-collection>
<volume-number>135</volume-number>
<volume-title>Revisionen des Mythos</volume-title>
</volume-in-collection>JournalsJ
/issue-xml/issue-meta/volume/article/front/article-meta/volumeThe element <volume> includes the number of the respective volume the issue belongs to.
Value:
{volume-number}
Example:
<volume>32</volume>Open IssuesJ
In case the article belongs to an open issue the attribute @content-type="open-issue"
must be used.
Example:
<volume content-type="open-issue">32</volume>Just Accepted/Ahead of PrintJ
When used for ahead of print or just accepted articles within the <article-meta> the following information shall be used:
Attribute:
@content-type
Attribute values:
ahead-of-print, just-accepted
Element value:
0
Example:
<volume content-type="ahead-of-print">0</volume>Issue InformationJ
/issue-xml/issue-meta/issue/article/front/article-meta/issueThe element <issue> contains the issue number.
Value:
{issue-number}
Example:
<issue>4-5</issue>Just Accepted/Ahead of PrintJ
For Ahead of Print or Just Accepted Articles, the issue number "0" must be used.
Example:
<issue>0</issue>Pub Med CentralPMC
The issue information must be omitted for journals that only have a volume per year but not several issues.
ISBNB
/book/book-meta/isbnThe element <isbn> holds the ISBN of the book. It must be included one to four times within a document.
Books Online DataBO
The attribute @pub-type is required for each <isbn> entry. For the online data the ISBN must be included at least
once, using the @pub-type="epub".
| ISBN | @pub-type | @content-type | Element value |
|---|---|---|---|
| Print ISBN |
ppub
|
‐
|
{ISBN}
|
| e-Book ISBN (PDF) |
epub
|
‐
|
{eISBN_pdf}
|
| e-Book ISBN (EPUB) |
original_epub
|
‐
|
{eISBN_epub}
|
| Set-ISBN |
set
|
print-online
|
{eISBN_set}
|
Example:
<isbn pub-type="ppub">9783110295207</isbn>
<isbn pub-type="epub">9783110339406</isbn>
<isbn pub-type="original_epub">9783110391468</isbn>
<isbn pub-type="set" content-type="print-online">9783110480221</isbn>Books Archive XMLBA
The attribute @publication-format is required for each ISBN entry.
| ISBN | @publication-format | @content-type | Element value |
|---|---|---|---|
| Print ISBN |
ppub
|
|
{ISBN}
|
| e-Book ISBN (PDF) |
epub
|
|
{eISBN_pdf}
|
| e-Book ISBN (EPUB) |
original_epub
|
|
{eISBN_epub}
|
| Set-ISBN |
set
|
print-online
|
{eISBN_set}
|
Example:
<isbn publication-format="ppub">9783110295207</isbn>
<isbn publication-format="epub">9783110339406</isbn>
<isbn publication-format="original_epub">9783110391468</isbn>
<isbn publication-format="set" content-type="print-online">9783110480221</isbn>ISSN
The element <issn> holds the ISSN of a book series or a journal.
Journal ISSNJ
/issue-xml/journal-meta/issn/article/front/journal-meta/issnTo capture the ISSN of a journal, the element <issn> within <journal-meta>
shall be used.
| Attribute | Attribute value | Element value |
|---|---|---|
@pub-type
|
epub
|
{e-issn}
|
ppup
|
{issn}
|
The attribute @pub-type is required.
Example:
<issn pub-type="epub">1437-4315</issn>
<issn pub-type="ppub">1431-6730</issn>Online Proofing SystemOPS
The Print ISSN (issn[@pub-type="ppub"]) must be omitted.
Book Series ISSNBA
/book/collection-meta/issnTo capture the ISSN of a Book Series, the element <issn> within <collection-meta>
must be used.
| Attribute | Attribute value | Element value |
|---|---|---|
@publication-format
|
epub
|
{e-issn}
|
ppup
|
{issn}
|
The attribute @publication-format is required.
Examples:
<issn publication-format="ppub">0440-7562</issn><issn publication-format="epub">0440-7164</issn>Publisher
/book/book-meta/publisher/article/front/journal-meta/publisherThe element <publisher> holds the publisher information of the book, chapter or article. The allowed values for <publisher-name> and the corresponding
{DOI-prefix}
are specified within the list of predefined publisher names that are listed
within the De Gruyter Variables and ID Guidelines [1].
Example:
<publisher>
<publisher-name>De Gruyter</publisher-name>
</publisher>EditionBOBA
/book/book-meta/editionThe element <edition> holds the edition information of a book title. The attribute @designator
must be used.
Attribute:
@designator
Attribute value:
^[1-9][\d]*$
Example:
<edition designator="3">3rd Edition</edition>Special Issue TitleJ
/issue-xml/issue-meta/issue-title/article/front/article-meta/issue-titleThe element <issue-title> is used to insert a special title of the issue (if present).
Example:
<issue-title>Special Issue: Multilingual communication in binational families: Negotiating languages, identities and everyday tasks</issue-title>If the <issue-title> is present within the Issue-XML/ToC, it should be present within the article XML too.
Article TitleJ
/article/front/article-meta/title-group
<title-group> within <article-meta> contains the article title and related information. The element <article-title> includes the full title of an article or other journal component such like review,
commentary etc.
Any footnote explaining additional information regarding the article such like acknowledgments, funding information or further publication information must not be included. Please consider the elements
<notes> (section Notes), <funding-group> (section Funding Information) or <ack> (section Acknowledgements) in case a
footnote included by the author needs to be replaced.
The element <article-title> is required, the elements <subtitle> and <trans-title-group> are optional. If the <trans-title-group> is used, the attribute
@xml:lang is required using the according lowercase ISO 639-1 language code [12].
Example:
<title-group>
<article-title>On the Influence of XML</article-title>
<subtitle>What happended to SGML?</subtitle>
<trans-title-group xml:lang="de">
<trans-title>Über den Einfluss von XML</trans-title>
<trans-subtitle>Was passierte mit SGML?</trans-subtitle>
</trans-title-group>
</title-group>First/Last Page
//book-part/book-part-meta/fpage//book-part/book-part-meta/lpage/article/front/article-meta/fpage/article/front/article-meta/lpageThe tag <fpage> and <lpage> include the first and last page number of an article, chapter or book. Within these tags the use of the following prefixes is allowed: “e”; “A”; “eA”; “s”; “r”. Please make sure that once a prefix is
used it is included in both tags. The use is case sensitive and there shall be no whitespace between the prefix and the page number. Furthermore the following roman numericals
may be included: i, v, x, l, c, d, m.
Regex:
^((eA|A|e|r|s)?(\d+))|[ivxlcdm]|[u2|u3]+$
For endpaper material front or back (book-app[@book-part-type="endpaper"]), the values u2 and u3 are allowed.
Examples:
<fpage>587</fpage><lpage>606</lpage>This element must not be included within the metadata together with <elocation-id>. Either <fpage> and <lpage> or <elocation-id>
shall be present.
Journals Online DataJO
Please note that these tags must not be included in the <article-meta> tag group for ahead of print, just accepted and open issue articles!
Electronic Location IdentifierJ
/article/front/article-meta/elocation-idThe elocation ID is used to identify articles that do not have printed page numbers. Articles shall include either <fpage> and <lpage> or
<elocation-id>. They must not be included together.
Value:
{elocation-id}
Issues
The attribute @seq
must be used to reflect the sequence of articles within an issue.
Example:
<elocation-id seq="3">20150068</elocation-id>Ahead of Print/Just Accepted
Within article publications (Ahead of Print or Just Accepted) the attribute @seq
shall not be used.
Example:
<elocation-id>20150068</elocation-id>Product InformationJ
/article/front/article-meta/productThe product information includes metadata concerning one product (for example a book) discussed in an article which is usually a book-review. If the
article/@article-type
is "book-review", the element <product>
must be present. It shall contain either <string-name> or <collab> and
should contain all necessary information, such as <source>, <year>, <publisher-name>, <publisher-loc>,
<isbn>, <issn>, <price>. To differentiate between electronic and print ISBNs/ISSNs, the attribute @publication-format (values: ppub,
epub, original_epub) must be used. Punctuation and white space in between elements must be preserved. Formatting, such as bold
or italic
may be used for specific pieces of information within an element (see Formatted Text for further details).
Example:
<product>
<string-name>
<surname>Weissmann</surname>
<given-names>E.</given-names>
</string-name>
<source>Transnational television drama: Relations and mutual influence between the US and UK.</source>
<year>2012</year>
<publisher-name>Palgrave Macmillian</publisher-name>
<publisher-loc>Basingstoke, New York,</publisher-loc>
<isbn publication-format="ppub">1-22-33-45678</isbn>, includes a CD-ROM,
<price>19,95€</price>
</product>Supplementary Material
Supplementary Material is used for description of and pointer to additional data files that contain information directly supportive of the document (for example, audio clip, applet, raw research data).
To add information about the Supplementary Material itself, please see section Supplementary Material Note.
BooksB
//book-part/book-part-meta/supplementary-materialBooks Online DataBO
Supplementary Material within the Books Online Data must include the link to the respective file (@xlink:href) as well as the element <label> to describe the Supplementary
Material file.
Example:
<supplementary-material xlink:href="suppl/9783110339406_sound_files.zip">
<label>Sound files (as ZIP file)</label>
</supplementary-material>Books Archive XMLBA
Supplementary Material within the Books Archive XML must include the link to the respective file (@xlink:href) as well as the element <caption> to describe the
Supplementary Material file.
Example:
<supplementary-material xlink:href="suppl/9783110339406_sound_files.zip">
<caption><p>Sound files (as ZIP file)</p></caption>
</supplementary-material>JournalsJ
/article/front/article-meta/related-articleSupplementary Material files must be linked within the element <related-article>. The element value is required and needs to contain a short
description of the Supplementary Material.
| Attribute | Attribute value |
|---|---|
@xlink:href
|
link to Supplementary Material file |
@related-article-type
|
supplement
|
Example:
<related-article related-article-type="supplement" xlink:href="suppl/snde1799_supplementary_0.zip">Supplementary Material Details</related-article>Code Ocean
When scientific code stored at Code Ocean [32] is to be integrated within an article file, it must be included as follows:
-
as Supplementary Material as described in section Supplementary Material Journals
-
as
related-article[@related-article-type="code-ocean"]using the Code Ocean DOI within@xlink:hrefA description for the Code Ocean material (
text()) as well as the link (@xlink:href) must be present.
Example:
<related-article related-article-type="supplement" xlink:href="suppl/suppl_verbal-detection-error-tradeoff.zip">
Verbal Detection Error Tradeoff (DET). Also available here:
<ext-link ext-link-type="uri" xlink:href="https://doi.org/10.24433/CO.154591c8-9d3f-47eb-b656-3aff245fd5c1">
https://doi.org/10.24433/CO.154591c8-9d3f-47eb-b656-3aff245fd5c1
</ext-link>
</related-article>
<related-article related-article-type="code-ocean" xlink:href="https://doi.org/10.24433/CO.154591c8-9d3f-47eb-b656-3aff245fd5c1">
Detection Error Tradeoff (DET)
</related-article>
History DatesJ
/article/front/article-meta/historyThe element <history> is used for dates related to the processing history of the article.
Attribute:
@date-type
Attribute values:
received, accepted, rev-recd
Example:
<history>
<date date-type="received">
<day>04</day>
<month>11</month>
<year>2012</year>
</date>
<date date-type="accepted">
<day>18</day>
<month>11</month>
<year>2012</year>
</date>
</history>The date must be valid and for the tags <day>, <month> and <year> only digits are allowed:
-
day:
[01-31] -
month:
[01-12] -
year:
\d{4}
The element <year> should not be used as second element within <date>.
Permissions
/book/book-meta/permissions//book-part/book-part-meta/permissions/article/front/article-meta/permissionsThis information is required for each book, chapter and journal article.
Copyright Information
The elements <copyright-statement>, <copyright-year> and <copyright-holder> are required. Please note that there may be other copyright
holder than De Gruyter (publishing partner, institutions, authors etc.). The entries can be found within the De Gruyter Production Wiki [29].
Example:
<permissions>
<copyright-statement>© 2016 Walter de Gruyter GmbH, Berlin/Boston</copyright-statement>
<copyright-year>2016</copyright-year>
<copyright-holder>Walter de Gruyter GmbH, Berlin/Boston</copyright-holder>
</permissions>The elements The element <copyright-statement> and <copyright-year>
must be included.<copyright-statement> must be built as follows:
Element:
<copyright-statement>
Element value:
© {copyright-year} {copyright-holder}
For Open Access titles the <copyright-holder> shall include the phrase "published by" or "publiziert von".
Copyright Cover image
When the copyright of the cover image must be captured, the element <copyright-statement> with the attribute @content-type="cover"
must be used.
Example:
<permissions>
<copyright-statement content-type="cover">© by the author</copyright-statement>
<copyright-statement>© 2020 Walter de Gruyter GmbH, Berlin/Boston</copyright-statement>
<copyright-year>2020</copyright-year>
<copyright-holder>Walter de Gruyter GmbH, Berlin/Boston</copyright-holder>
</permissions>Open Access License
This information shall be integrated within the element <license> whenever a book, chapter or article is free or Open Access. If a book, journal or issue is completely Open Access, the element
<license> still must be included for every chapter and article.
If an article, chapter or book is not Open Access or free the element <license> including the respective child elements shall be omitted.
When a title is published Open Access, the attribute @license-type="open-access"
must be used. Please see the below listed table for required attributes and the corresponding values.
@xlink:href
|
<license-p> (english)
|
<license-p> (german)
|
|---|---|---|
http://creativecommons.org/licenses/by-nc-nd/3.0
|
This work is licensed under the Creative Commons Attribution-NonCommercial-NoDerivatives 3.0 License. | Dieses Werk ist lizensiert unter einer Creative Commons Namensnennung - Nicht-kommerziell - Keine Bearbeitung 3.0 Lizenz. |
https://creativecommons.org/licenses/by-nc-sa/3.0
|
This work is licensed under the Creative Commons Attribution-NonCommercial-ShareAlike 3.0 License. | Dieses Werk ist lizensiert unter einer Creative Commons Namensnennung - Nicht-kommerziell - Weitergabe unter gleichen Bedingungen 3.0 Lizenz. |
https://creativecommons.org/licenses/by-sa/3.0
|
This work is licensed under the Creative Commons Attribution-ShareAlike 3.0 Public License. | Dieses Werk ist lizensiert unter einer Creative Commons Namensnennung - Weitergabe unter gleichen Bedingungen 3.0 Lizenz. |
https://creativecommons.org/licenses/by-nd/3.0
|
This work is licensed under the Creative Commons Attribution-NoDerivs 3.0 Public License. | Dieses Werk ist lizensiert unter einer Creative Commons Namensnennung - Keine Bearbeitung 3.0 Lizenz. |
https://creativecommons.org/licenses/by-nc/3.0
|
This work is licensed under the Creative Commons Attribution-NonCommercial 3.0 Public License. | Dieses Werk ist lizensiert unter einer Creative Commons Namensnennung - Nicht-kommerziell 3.0 Lizenz. |
http://creativecommons.org/licenses/by/3.0
|
This work is licensed under the Creative Commons Attribution 3.0 Public License. | Dieses Werk ist lizensiert unter einer Creative Commons Namensnennung 3.0 Lizenz. |
http://creativecommons.org/licenses/by-nc-nd/4.0
|
This work is licensed under the Creative Commons Attribution-NonCommercial-NoDerivatives 4.0 International License. | Dieses Werk ist lizensiert unter einer Creative Commons Namensnennung - Nicht-kommerziell - Keine Bearbeitung 4.0 International Lizenz. |
https://creativecommons.org/licenses/by-nc-sa/4.0
|
This work is licensed under the Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International License. | Dieses Werk ist lizensiert unter einer Creative Commons Namensnennung - Nicht-kommerziell - Weitergabe unter gleichen Bedingungen 4.0 International Lizenz. |
https://creativecommons.org/licenses/by-sa/4.0
|
This work is licensed under the Creative Commons Attribution-ShareAlike 4.0 |
Dieses Werk ist lizensiert unter einer Creative Commons Namensnennung - Weitergabe unter gleichen Bedingungen 4.0 International Lizenz. |
https://creativecommons.org/licenses/by-nd/4.0
|
This work is licensed under the Creative Commons Attribution-NoDerivs 4.0 |
Dieses Werk ist lizensiert unter einer Creative Commons Namensnennung - Keine Bearbeitung 4.0 International Lizenz. |
https://creativecommons.org/licenses/by-nc/4.0
|
This work is licensed under the Creative Commons Attribution-NonCommercial 4.0 |
Dieses Werk ist lizensiert unter einer Creative Commons Namensnennung - Nicht-kommerziell 4.0 International Lizenz. |
http://creativecommons.org/licenses/by/4.0
|
This work is licensed under the Creative Commons Attribution 4.0 |
Dieses Werk ist lizensiert unter einer Creative Commons Namensnennung 4.0 International Lizenz. |
Example:
<permissions>
<copyright-statement>© 2017 Saskia Schuster, published by Walter de Gruyter GmbH, Berlin/Boston</copyright-statement>
<copyright-year>2017</copyright-year>
<copyright-holder>Saskia Schuster, published by Walter de Gruyter GmbH, Berlin/Boston</copyright-holder>
<license license-type="open-access" xlink:href="http://creativecommons.org/licenses/by-nc-nd/3.0">
<license-p>This work is licensed under the Creative Commons Attribution-NonCommercial-
NoDerivatives 3.0 License.</license-p>
</license>
</permissions>Books Archive XML and JournalsBAJ
Furthermore the attribute @specific-use="rights-object-archive-dnb"
must be added to all elements license[@license-type="open-access"].
Example:
<permissions>
<copyright-statement>© 2017 Saskia Schuster, published by Walter de Gruyter GmbH, Berlin/Boston</copyright-statement>
<copyright-year>2017</copyright-year>
<copyright-holder>Saskia Schuster, published by Walter de Gruyter GmbH, Berlin/Boston</copyright-holder>
<license license-type="open-access" specific-use="rights-object-archive-dnb" xlink:href="http://creativecommons.org/licenses/by-nc-nd/3.0">
<license-p>This work is licensed under the Creative Commons Attribution-NonCommercial-
NoDerivatives 3.0 License.</license-p>
</license>
</permissions> This is no longer required for Book Online deliveries (epub_dgo_{eISBN_pdf}.zip).
Free Access
Content that is published with free access must include the element <ali:free_to_read>. In addition, the namespace declaration @xmlns:ali shall be added (see section Namespaces).
Example:
<permissions>
<copyright-statement>© 2016 by De Gruyter</copyright-statement>
<copyright-year>2016</copyright-year>
<ali:free_to_read/>
</permissions>The following content must be set free and for this include the element <ali:free_to_read> (This only applies to content that is
not Open Access.):
-
/article[@article-type="frontmatter|graphical-abstract"] -
//book-part[@book-part-type="frontmatter|contents"]
Temporary Free AccessBOJ
For declaring articles or book chapters as free access within a certain period of time please use the processing instruction the attributes <?dgonline>@start_date, @end_date within <ali:free_to_read> must be used to The possible attributes reflect
the start and end date of the free access period. It is possible to only include a start or an end date as well as both dates and none of them.@license-start and @license-end
Attributes:
@license-start, @license-end@start_date, @end_date
Attribute value:
start/end date formatted according to ISO 8601 [30]: YYYY-MM-DD
Thh:mm:ssTZD
Example:
<permissions>
<copyright-statement>© 2016 by De Gruyter</copyright-statement>
<copyright-year>2016</copyright-year>
<license license-type="free">
<license-p>This content is free.</license-p>
<?dgonline license-start="2015-06-03T09:00:00-01:00" license-end="2016-06-03T09:00:00-01:00"?>
</license>
<ali:free_to_read start_date="2020-03-01" end_date="2020-07-31"/>
</permissions>Related ArticleBOJ
/article/front/article-meta/related-articleThe element <related-article> includes the link to the matching article PDF, any supplementary material or a link to post publication correction.
PDF fileJ
Journals Online DataJO
The corresponding PDF and XML (only within the ToC, see section Table of Contents) file for each article is linked within the element <related-article> using the attribute @related-article-type="pdf".
| Attribute | Attribute values |
|---|---|
@related-article-type
|
pdf, xml
|
@xlink:href
|
link to the respective PDF, XML file |
Example:
<related-article related-article-type="pdf" xlink:href="hsz-2015-0068.pdf"/>Pub Med CentralPMC
For Pub Med Central deliveries the link to the PDF file needs to be omitted.
Post Publication CorrectionJ
In case a post publication correction has been published, it is linked using the element <related-article> and the attributes @related-article-type and @ext-link-type.
| Attribute | Attribute values |
|---|---|
@id
|
{element-id}
|
@related-article-type
|
corrected-article, correction-forward, retracted-article,
retraction-forward, partial-retraction
|
@ext-link-type
|
doi
|
@xlink:href
|
{DOI}
|
More information can be found within the De Gruyter Post Publication Correction Guidelines [33].
Example:
<related-article id="j_hsz-2015-0068_ppc_001" related-article-type="corrected-article" ext-link-type="doi" xlink:href="10.1515/hsz-2015-0068"/>Translated ArticleJ
To link to a translated version of an article, the element <related-article> including the attribute @related-article-type="translation"
must be used. Furthermore a note using fn-group/fn (see section Additional Information) shall be added to inform
the reader about the translated version.
| Attribute | Attribute values |
|---|---|
@related-article-type
|
translation
|
@ext-link-type
|
doi
|
@xlink:href
|
{DOI}
|
Example:
<related-article related-article-type="translation" ext-link-type="doi" xlink:href="10.1515/almed-2019-0085"/>Alternate FormBO
The element <alternate-form> provides information about an alternative form of the entire book or a single chapter, such as an epub file.
EPUB FileBO
/book/book-meta/alternate-form| Attribute | Attribute value |
|---|---|
@xlink:href
|
Link to EPUB file |
@alternate-form-type
|
epub
|
Please note, that the EPUB file must be included within Book XML file only.
Example:
<alternate-form alternate-form-type="epub" xlink:href="9783110391468.epub"/>Fulltext PDF FileBO
/book/book-meta/alternate-form| Attribute | Attribute value |
|---|---|
@xlink:href
|
Link to fulltext PDF file |
@alternate-form-type
|
pdf
|
Example:
<alternate-form alternate-form-type="pdf" xlink:href="9783110619034.pdf" />PDF/XML FileBO
//book-part/book-part-meta/alternate-formTo link the corresponding chapter PDF or XML (only within the ToC, see section Table of Contents), the attribute @alternate-form-type
must be used.
| Attribute | Attribute value |
|---|---|
@xlink:href
|
link to PDF/XML file |
@alternate-form-type
|
pdf, xml
|
Abstract
/book/book-meta/abstract//book-part/book-part-meta/abstract/article/front/article-meta/abstractThe element <abstract> holds the abstract of a book, chapter or article. The elements <title> and <p> or
<sec>
are required in this context.
Example:
<abstract>
<title>Abstract</title>
<p>This is the abstract text.</p>
</abstract>The title element must not contain a colon (":").
Sections within abstracts
To distinguish between different parts within a section use <sec>. Each section must include a <title> element. If this doesn't exist, do not use
<sec>.
Example:
<abstract>
<title>Abstract</title>
<sec>
<title>Background</title>
<p>Cigarette smoking is a major risk factor for several chronic diseases.
Epidemiological data indicate the use of smokeless tobacco (ST) is associated
with significantly lower risk for smoking-related diseases compared to cigarettes.
Several biomarkers of exposure (BioExp) and effect (BioEff) associated with
smoking and use of moist snuff (ST) were evaluated.</p>
</sec>
<sec>
<title>Methods</title>
<p>A single site, cross-sectional clinical study enrolled three groups of
generally healthy male smokers (SMK), moist snuff consumers (MSC), and non-tobacco
consumers (NTC), and several BioExp and BioEff were evaluated.</p>
</sec>
</abstract>Graphical AbstractJ
/article/front/article-meta/abstract/@abstract-type="graphical"To capture a graphical abstract, the attribute @abstract-type="graphical"
must be used as well as the element <graphic> with a link to the graphical abstract file.
Example:
<abstract abstract-type="graphical">
<title>Graphical Abstract</title>
<p>
<fig fig-type="graphical">
<caption>
<p>Various synthesis methods and electrochemical applications are reviewed.</p>
</caption>
<graphic xlink:href="graphic/hsz-2015-0068-graphabs.jpg"/>
</fig>
</p>
</abstract>The title element must not contain a colon (":").
Translated Abstract
/book/book-meta/trans-abstract//book-part/book-part-meta/trans-abstract/article/front/article-meta/trans-abstractThe element <trans-abstract> holds the abstract that has been translated into a language other than that in which the work was originally published. The elements <title> and <p> or
<sec> are required in this context.
The attribute @xml:lang is required:
Attribute:
@xml:lang
Attribute value: ISO 639-1 Language codes [12] in lower case letters.
Example:
<trans-abstract xml:lang="de">
<title>Zusammenfassung</title>
<p>Dies ist der Text der Zusammenfassung.</p>
</trans-abstract>The title element must not contain a colon (":").
Keywords
/book/book-meta/kwd-group//book-part/book-part-meta/kwd-group/article/front/article-meta/kwd-groupThe element <kwd-group> is used for one set of keywords used to describe a document. The element <title> as well as at least one <kwd> or <nested-kwd> are
required.
Example:
<kwd-group>
<title>Keywords</title>
<kwd>XML</kwd>
<kwd>metadata</kwd>
</kwd-group>For keywords, that are used in another language than the document language, the attribute @xml:lang
must be used:
Attribute:
@xml:lang
Attribute value: ISO 639-1 Language codes [12] in lower case letters.
A <kwd-group> including the attribute @xml:lang
must only be used in combination with a <kwd-group> without the language attribute.
The title element must not contain a colon (":").
Classification Codes
/article/front/article-meta/kwd-group[@kwd-group-type]/book/book-meta/kwd-group[@kwd-group-type]//book-part/book-part-meta/kwd-group[@kwd-group-type]To tag classification codes the attribute @kwd-group-type in combination with the corresponding <title>
must be used.
<title>
|
@kwd-group-type
|
|---|---|
MSC 2010
|
MSC
|
JEL Classification
|
JEL
|
PACS
|
PACS
|
ACM CCS
|
ACM_CCS
|
Example:
<kwd-group kwd-group-type="MSC">
<title>MSC 2010</title>
<kwd>14M30</kwd>
<kwd>14A22</kwd>
<kwd>17B20</kwd>
</kwd-group>The title element must not contain a colon (":").
Nested Classifications
For nested Classifications (like the ACM CCS [34]), the element <nested-kwd> within <kwd-group>
shall be used.
Example:
<kwd-group kwd-group-type="ACM_CCS">
<title>ACM CCS</title>
<nested-kwd>
<kwd>Information systems</kwd>
<nested-kwd>
<kwd>Data management systems</kwd>
<nested-kwd>
<kwd>Database design and models</kwd>
<nested-kwd>
<kwd>Data model extensions</kwd>
<nested-kwd>
<kwd>Uncertainty</kwd>
</nested-kwd>
</nested-kwd>
</nested-kwd>
</nested-kwd>
</nested-kwd>
</kwd-group>JournalsJ
This section has been replaced by a common books and journals related section.
Funding Information
/book/book-meta/funding-group/article/front/article-meta/funding-groupThe element <funding-group> includes information concerning grants, contracts, sponsors, or other funding for the research reported in the article.
<award-group> contains information concerning one award under which the work was supported. The element <funding-source> includes an agency or organization (such as a foundation, corporation, or an educational institution) that
funded the research on which a work was based. Use the attribute @xlink:href to indicate the DOI of the funder.
For values of the element <funding-source> and its attribute @xlink:href the entries within the CrossRef list of the funder names and identifiers [31]
must be used. If an institution is not listed there, please contact us.
The <award-id> contains an identifier that has been assigned to the award, for example, a grant number, a grant reference number, or a contract number.
Example:
<funding-group>
<award-group>
<funding-source xlink:href="http://doi.org/10.13039/501100000848">University Of Edinburgh</funding-source>
<award-id>FFI2010-18214</award-id>
</award-group>
<funding-statement>This work was supported by a research grant from the University Of Edinburgh (FFI2010-18214)</funding-statement>
</funding-group>The elements <funding-source> including the attribute @xlink:href and <award-id> are required in this context.
Book Archive XMLBA
For Book Archive XML deliveries the attribute funding-source/@xlink:href and the element <award-id>
should be included. This is no longer an absolute requirement.
Please note that, for Book Archive XML files, the funding information can also be used for book parts (//book-part-meta/funding-group).
Page Count
Online DataBOJ
/book/book-meta/counts/page-count//book-part/book-part-meta/counts/page-count/article/front/article-meta/counts/page-countThe element <page-count> mentions how many pages the article or book has. The count elements are modeled as empty elements that have no content but carry values on their attributes. The attribute @count is
required.
Attribute:
@count
Attribute value:
^\d*$
Example:
<page-count count="29"/>Book Archive XMLBA
Book Meta
/book/book-meta/counts/book-page-countThe element <book-page-count> mentions how many pages the book has. It is used as empty element that has no content but carries the value on its attribute. The attribute @count is
required.
Attribute:
@count
Attribute value:
^\d*$
Example:
<book-page-count count="120" />Book Part Meta
//book-part/book-part-meta/counts/book-count[@count-type="chapter-page-count"]The element <book-count
count-type="chapter-page-count"> mentions how many pages the chapter has. It is used as empty element that has no content but carries the value on its attribute. The attribute
@count is required.
| Attribute | Attribute value |
|---|---|
@count
|
^\d*$
|
@count-type
|
chapter-page-count
|
Example:
< book-count count="15" count-type="chapter-page-count"/>Additional Information
/article/front/notes/book/book-meta/notes//book-part/book-part-meta/notesThe element <notes> contains additional article information that cannot be represented by any other JATS/BITS metadata tag (like fn-group/fn[fn-type] (see section Additional Information). The
attribute @notes-type is required.
Attribute:
@notes-type
Attribute values:
added-post-electronic-publication, other, software, post-publication-correction, retraction
Examples:
<notes notes-type="added-post-electronic-publication" id="j_snde-2018-1234_notes_001">
<sec>
<title>Correction note</title>
<p>Correction added after online publication February 12, 2015: Mistakenly this article was already published ahead of print under the title of the entire special issue “Adiposopathy in cancer and (cardio)metabolic diseases: an endocrine approach”.</p>
</sec>
</notes><notes notes-type="software" id="j_snde-2018-1234_notes_002">
<p>MATLAB and Simulink are registered trademarks of The MathWorks, Inc. See www.mathworks.com trademarks for a list of additional trademarks. The MathWorks Publisher Logo identifies books that contain MATLAB and Simulink content. Used with permission. The MathWorks does not warrant the accuracy of the text or exercises in this book. This book ́s use or discussion of MATLAB and Simulink software or related products does not constitute endorsement or sponsorship by The MathWorks of a particular use of the MATLAB and Simulink software or related products.</p>
</notes><notes notes-type="post-publication-correction">
<p>The original version of this chapter was revised: [xyz] has been corrected. An Erratum is available at DOI:<related-article related-article-type="correction-forward" ext-link-type="doi" xlink:href="https://doi.org/9783110339406-005">https://doi.org/9783110339406-005</related.article></p>
</notes>Fulltext Elements
Book-PartB
//book-partThis container element includes information about a part of the book, typically called a chapter. In the Book XML file this element is used to create the ToC (see section Table of Contents).
Books Online DataBO
Within the Online data the attribute @book-part-number is used to organize the units of a book.
| Attribute | Attribute value |
|---|---|
@id
|
{book-part-id}
|
@book-part-type
|
book-toc-page-order, chapter, contents, frontmatter, part,
backmatter
|
@book-part-number
|
[/d*]
|
Books Archive XMLBA
Within the Books Archive XML the attribute @seq is used to organize the units of a book.
| Attribute | Attribute value |
|---|---|
@id
|
{book-part-id}
|
@book-part-type
|
chapter, part
|
@seq
|
[/d*]
|
The following book part structures are allowed within Book Archive XML deliveries:
✔ Do
<book-body>
<book-part book-part-type="part">
<book-part-meta/>
<body>
<book-part book-part-type="chapter">
<book-part-meta/>
<body>
<sec/> OR <p/>
</body>
</book-part>
</body>
</book-part>
</book-body><book-body>
<book-part book-part-type="chapter">
<book-part-meta/>
<body>
<sec/> OR <p/>
</body>
</book-part>
</book-body><book-body>
<book-part book-part-type="part">
<book-part-meta/>
<body>
<sec/> OR <p/>
</body>
</book-part>
</book-body>The following structures must not be used:
✘ Don't
<book-body>
<book-part book-part-type="part">
<book-part-meta/>
<body>
<book-part book-part-type="chapter">
<book-part-meta/>
<body>
<book-part book-part-type="chapter">
<book-part-meta/>
<body>
<sec/> OR <p/>
</body>
</book-part>
</body>
</book-part>
</body>
</book-part>
</book-body><book-body>
<book-part book-part-type="chapter">
<book-part-meta/>
<body>
<book-part book-part-type="chapter">
<book-part-meta/>
<body>
<sec/> OR <p/>
</body>
</book-part>
</body>
</book-part>
</book-body><book-body>
<book-part book-part-type="chapter">
<book-part-meta/>
<body>
<book-part book-part-type="part">
<book-part-meta/>
<body>
<sec/> OR <p/>
</body>
</book-part>
</body>
</book-part>
</book-body>Dedication
Book Online DataBO
/book/book-front/notes[@notes-type="dedication"]Dedications that are mentioned at the beginning of a book must be tagged within the <book-front>.
Example:
<notes notes-type="dedication">
<p><italic>For my son Jonas</italic></p>
</notes>Book Archive XMLBA
/book/front-matter/dedicationThe element <dedication> contains text dedicating the book.
Example:
<dedication>
<named-book-part-body>
<p><italic>For my son Jonas</italic></p>
</named-book-part-body>
</dedication>JournalsJ
article/front/notes[@notes-type="dedication"]Dedications within journal articles must be tagged using the element <notes>. The attribute @notes-type="dedication"
shall be added to the <notes> element.
Example:
<notes notes-type="dedication">
<p>We dedicate this paper to our professor, Dr. Robert Jemmings, whose critique of the underlying study identified potential bias in the analysis and strengthened our argument.</p>
</notes>QuotationB
Book Online DataBO
/book/book-front/notes[@notes-type="quotation"]Quotations that are mentioned at the beginning of a book must be tagged within the element <book-front>.
Example:
<notes notes-type="quotation">
<disp-quote>
<p><italic>Worte sind Taten</italic> (‘Words are deeds’)</p>
<attrib>(Wittgenstein, <italic>Culture and Value</italic>)</attrib>
</disp-quote>
</notes>Book Archive XMLBA
/book/front-matter/notes[@notes-type="quotation"]Quotations that are mentioned at the beginning of a book must be tagged using the element <notes> and the attribute @notes-type="quotation".
Example:
<notes notes-type="quotation">
<disp-quote>
<p><italic>Worte sind Taten</italic> (‘Words are deeds’)</p>
<attrib>(Wittgenstein, <italic>Culture and Value</italic>)</attrib>
</disp-quote>
</notes>Index TermsBA
Index terms shall be embedded into the paragraph, where the term appears and a programmatically created index entry should link to using the element <index-term>. Please use
<see> and <see-also> to make "see" and "see also" references. In that case, only the referred term must be used. Do not add "See" or "See
also" within the element text.
Whenever <index-term> elements are present within the XML, the elements index or index-group
must not be used.
Example:
<p>This is a paragraph mentioning the writers Schiller
<index-term index-type="person">
<term>von Schiller, Johann Christoph Friedrich</term>
<see-also>Weimar Classicism</see-also>
</index-term> and Goethe
<index-term index-type="person">
<term>von Goethe, Johann Wolfgang</term>
<see>Goethe</see>
</index-term>.
</p>
Attribute:
@index-type
Attribute values:
subjects, persons, references, abbreviations, locations, terms, general
Nested Index TermsBA
Nested index terms are created by nesting the element <index-term>.
Example:
<p>This is a paragraph with a nested index entry.
<index-term>
<term>primary level index term</term>
<index-term>
<term>secondary term</term>
</index-term></term>
</index-term> as the text continues.
</p>Index Terms Range
In case an index term is not a single target point but should apply to specific range of text elements the attribute @id
shall be added to the <index-term> to mark the start of the range. <index-term-range-end> will tag the end of this range. The attribute @rid
must be added to connect to the starting <index-term>.
Example:
<p>This is a paragraph mentioning the writers Schiller
<index-term index-type="person" id="b_9783110302639-005_index_009">
<term>von Schiller, Johann Christoph Friedrich</term>
</index-term> and tell the story of his life.
...
</p>
...
<p>and here it ends.<index-term-range-end rid="b_9783110302639-005_index_009"/>
</p>Sections
The element <sec> is used to structure content within articles and chapters. The attribute @id
shall be present.
Attribute:
@id
Attribute Value:
{section-id}
Example:
<sec id="b_9783110339406-005_s_001_s_002_s_003">
<label>1.2.3</label>
<title>A Chapter Titel</title>
<p>Here comes the content.</p>
</sec>Use the element whenever a section is structured with a label or title. If that is not present, do not use <sec>.
Books Law XMLBL
For sections within Books Law XML deliveries each <sec>
must contain a label, title or <norm> element (see section Normative text).
Display LevelB
When the display level and hierarchical level are different, the attribute @disp-level indicates the level at which to show a section.
Attribute:
@disp-level
Attribute value:
^[1-9]$
Example:
<sec id="b_9783110339406-005_s_001" disp-level="4">
...
</sec>The section shown above is a first-level section but should be displayed as a forth-level section.
Headings
Section headings are stated within the <sec> element using the tag <title>. In case of numbered titles, the <label> tag must be used to
capture the numbering.
Example:
<sec id="b_9783110339406-005_s_001_s_002_s_003">
<label>1.2.3</label>
<title>A Provisional Hierarchy of the Six Modes</title>
...
</sec>Abbreviations
Abbreviations should be tagged within the text where they appear using the element <abbrev> including the attribute @xlink:title to name the written-out version.
Example:
<abbrev xlink:title="Abbildung(en)">Abb.</abbrev>If there are different abbreviation types within the document the element needs to contain the attribute @content-type.
Example:
<abbrev content‐type="Abbreviated Literature" xlink:title="Acta Sanctorum, begründet von J. Bolland, Antwerpen 1643 ff.">AASS</abbrev>EpigraphB
Epigraphs that are placed at the beginning of a chapter are tagged within the element <disp-quote> as first element within <body>.
Example:
<body>
<disp-quote content-type="epigraph">
<p>„Mithin müßen diese Bilder allgemein und schon für sich verständlich gewesen seyn“.</p>
<attrib>(Wilhelm Grimm, 1821)</attrib>
</disp-quote>
...
</body>Quotation
Quotations can be placed at the beginning or within a chapter/article. They are tagged within the element <disp-quote>. If the element is used for quotations, the attribute @content-type is not
required.
Example:
<disp-quote>
<p>Now is the winter of our discontent.</p>
<attrib>William Shakespeare, Richard III</attrib>
</disp-quote>Footnotes
Footnotes are placed where they are in the text using the element <fn>.
De Gruyter DeliveriesBJO
The attributes @id and @symbol are required.
Example:
<p>This is a normal paragraph with a footnote.<fn id="b_9783110339406-005_fn_002" symbol="2"><p>I am the footnote for a normal paragraph.</p></fn></p>Label
Use the element <label> to specify the footnote regarding a subject or type (if applicable).
Example:
<fn id="b_9783110339406-005_fn_003" symbol="3"><label>Translation:</label><p>I am a special footnote for a normal paragraph.</p></fn>Endnotes
If endnotes do exist together with regular footnotes, they must be distinguished by using the attribute @fn-type="endnote".
Example:
<fn fn-type="endnote" id="b_9781501513152-002_fn_001" symbol="1">
<p>In <italic>Magical Imaginations: Instrumental Aesthetics in the English Renaissance</italic> (Toronto: University of Toronto Press, 2012), Genevieve Juliette Guenther discusses the motif of the poet as magician in the 1590 <italic>Faerie Queene</italic> and <italic>The Tempest</italic> (4).</p>
</fn>Pub Med CentralPMC
The @symbol information must be placed within the element <label>.
Example:
<fn id="b_9783110339406-005_fn_003"><label>3</label><p>I am a special footnote for a normal paragraph.</p></fn>Formatted Paragraphs
To format whole paragraphs, use the attribute @content-type within the element <p>.
Attribute:
@content-type
Attribute values:
center, right, spaced, no_indent
Example:
<p content-type="center">This is some centered text.</p>Paragraphs without a @content-type will be left aligned.
Formatted Text
Apart from the given elements for formatting, like <bold>, <italic>, <underline>, <monospace>, <sc> for small caps,
<sub> for subscript etc., the element <styled-content> can be used including the required attribute @style-type.
Attribute:
@style-type
Attribute values:
spaced, gray_shaded, framed, right
Example:
<styled-content style-type="spaced">some spaced words</styled-content>The attribute @style
must not be used in this context.
Underlines
Underlined text is tagged using the element <underline>. The default is a simple underline. For any other option the attribute @underline-style
may be used.
Attribute:
@underline-style
Attribute values:
double, dotted, dashed
Example:
<underline underline-style="double">important</underline>Images and Media Files
Image and Media Files are tagged using the element <fig>. The attributes @id, @position and @fig-type are required. Image and Media
Files should always have @, except when they have a fixed position in the text (e.g. following a colon), then use @position="anchor".
Figures
Figures that need to be shown in their original size and have a caption are tagged as <fig>.
Example:
<fig id="j_hsz-2015-0068_fig_001" fig-type="figure">
<label>Figure 1</label>
<caption>
<p>I am the caption for Figure 1.</p>
</caption>
<graphic xlink:href="graphic/j_hsz-2015-0068_fig_001.jpg"/>
</fig>
Attribute:
@fig-type
Attribute values:
figure, chart, schema, map, chemical-formula
If there is no distinction been made between figures, the attribute @fig-type="figure"
must be used.
If no label or caption is present, the graphic must not be wrapped within <fig> but instead can be tagged purely as <graphic>
[35], such as:
Example:
<graphic xlink:href="graphic/b_9783110365344-003_fig_002.tiff"/>Otherwise each <fig> element must contain a <label> or <caption> and at least one
<graphic> or one <alternatives> (see section Alternative Graphics) element. Each <graphic> element shall use the
attribute @xlink:href.
Sub GraphicsOPS
Large figures may be split into multiple parts to manipulate or improve the display within the PDF:
Example:
<fig id="j_jib-2017-0002_fig_006" fig-type="figure">
...
<graphic xlink:href="graphic/j_jib-2017-0002_fig_006a.jpg"/>
<graphic xlink:href="graphic/j_jib-2017-0002_fig_006b.jpg"/>
<graphic xlink:href="graphic/j_jib-2017-0002_fig_006c.jpg"/>
<graphic xlink:href="graphic/j_jib-2017-0002_fig_006d.jpg"/>
</fig>Copyright
If the copyright information is present, it should be tagged within the element <permissions>, the elements <copyright-statement>,
<copyright-year>, <copyright-holder> are required.
Example:
<fig>
...
<permissions>
<copyright-statement>© 1997 Cold Spring Harbor Laboratory Press</copyright-statement>
<copyright-year>1997</copyright-year>
<copyright-holder>Cold Spring Harbor Laboratory Press</copyright-holder>
</permissions>
</fig>Alternative Graphics
Occasionally there are multiple versions available for one graphic file. For example if the electronic version must be shown with a watermark. This must be tagged using the element
<alternatives>:
Example:
<fig>
...
<alternatives>
<graphic specific-use="original_epub epub" xlink:href="graphic/b_9783110365344-003_fig_002.png">
<permissions>
<copyright-statement>© 2019 Walter de Gruyter GmbH, Berlin/Boston</copyright-statement>
</permissions>
</graphic>
<graphic specific-use="ppub" xlink:href="graphic/b_9783110365344-003_fig_002.tiff">
<permissions>
<copyright-statement>© 2018 Walter de Gruyter GmbH, Berlin/Boston</copyright-statement>
</permissions>
</graphic>
</alternatives>
</fig>The attribute @specific-use
shall be included.
Attribute:
@specific-use
Attribute values:
ppub, epub, original_epub
Each <alternatives>
must include at least two <graphic> elements.
Inline-graphic
Images that are placed inline and need to be displayed in line height (1,5em) are tagged using the tag <inline-graphic>.
Example:
<p>This paragraph has an inline figure <inline-graphic link:href="graphic/b_9783110339406-005_ingr_001.png"/>.</p>File Format
Figure and Graphic Files within the final XML delivery must be delivered using the following file formats:
| Type | Figures | Inline Graphics | |
|---|---|---|---|
| Raster Graphics | Vector Graphics | ||
| Book Archive XML | EPS/TIFF (JPG/PNG) | EPS (SVG) | PNG |
| Online Data | JPG* | SVG (PNG) | PNG |
* Graphic Files for Online Data deliveries should not extend a width of 1280 Px. The file format mentioned within brackets may be used in exceptional cases only.
Media
Video and audio files are tagged using the element <media> within the element <fig>.
Audio
For creating audio files please stick to the De Gruyter Audio/Video Instructions [36]. Every audio source must be included in two different audio formats: MP3 and AAC (M4A) using the following attributes:
@mimetype
|
@mime-subtype
|
File Extension |
|---|---|---|
audio/mpeg
|
mpeg
|
mp3
|
audio/mp4
|
mp4
|
m4a
|
Example:
<fig id="j_hsz-2015-0068_audio_004" fig-type="audio">
<label>Audio 4</label>
<caption>
<p>gives an audio clip.</p>
</caption>
<media mimetype="audio/mpeg" mime-subtype="mpeg" xlink:href="media/j_hsz-2015-0068_audio_0047.mp3"/>
<media mimetype="audio/mp4" mime-subtype="mp4" xlink:href="media/j_hsz-2015-0068_audio_004.m4a"/>
</fig>Video
For creating video files please stick to the De Gruyter Audio/Video Instructions [36]. Every video source must be returned in two different video formats: H.264 (MP4) and VP8 (WebM) using the following attributes:
@mimetype
|
@mime-subtype
|
File Extension |
|---|---|---|
video/mp4
|
mp4
|
mp4
|
video/webm
|
webm
|
webm
|
Example:
<fig id="j_hsz-2015-0068_video_001" fig-type="video">
<label>Video 1</label>
<caption>
<p>gives a video clip.</p>
</caption>
<media mimetype="video/mp4" mime-subtype="mp4" xlink:href="media/j_hsz-2015-0068_video_001.mp4"/>
<media mimetype="video/webm" mime-subtype="webm" xlink:href="media/j_hsz-2015-0068_video_001.webm"/>
</fig>Still Picture
If for processing or printing purposes a still picture as an alternative is required, it must be captured using <alternatives>. Within the elements
<media mimetype="video/mp4"
mime-subtype="mp4">, <media mimetype="video/webm"
mime-subtype="webm"> and
<graphic
specific-use="print-only"> are required.
Example:
<fig fig-type="video" id="b_9783110365344-003_video_002" position="anchor">
<label>Video 2</label>
<caption><p>gives a video clip.</p></caption>
<alternatives>
<media mime-subtype="mp4" mimetype="video/mp4" xlink:href="media/b_9783110365344-003_video_001.mp4"/>
<media mime-subtype="webm" mimetype="video/webm" xlink:href="media/b_9783110365344-003_video_001.webm"/>
<graphic xlink:href="media/b_9783110365344-003_video_001.jpg" specific-use="print-only"/>
</alternatives>
</fig>Tables
Tables should always have @, except when they have a fixed position in the text (e.g. following a colon), then use @position="anchor". Tables
must always include the attribute @position
. If it contains a caption, a <label>
must be included too.
Each <th> and <td>
shall not contain a <p>
element.
When there are properties that should apply to specific columns in general, (such as @width, @align, @valign), the element <colgroup>
may be used.
Example:
<table-wrap id="b_9783110339406-005_tab_005" orientation="portrait">
<label>Table 5</label>
<caption>
<p>I am the caption for Table 5.</p>
</caption>
<table>
<colgroup>
<col align="center" width="25%"/>
<col align="right" width="50%"/>
<col valign="bottom" width="25%"/>
</colgroup>
<thead>
<tr>
<th>City</th>
<th>Name</th>
<th>Country</th>
</tr>
</thead>
<tbody>
<tr>
<td>Berlin</td>
<td>Bernd</td>
<td>Belgium</td>
</tr>
...
</tbody>
</table>
</table-wrap>Table headers should always be captured using the elements <thead> and <th>.
Horizontal Ruler
The element <hr> may be used to create horizontal lines within <td> or <th>.
Example:
<thead>
<tr>
<th valign="top">Name</th>
<th align="right" valign="top">Year</th>
<th align="right" valign="top">Place</th>
</tr>
<tr>
<th colspan="3">A horizontal Ruler<hr/></th>
</tr>
</thead>Line Breaks
The element <break>
may be used to manipulate or improve the display of tables.
Example:
<thead>
<tr>
<th>Year<break/>1990</th>
<th>Year<break/>2000</th>
<th>Year<break/>2010</th>
<th>Explanation</th>
</tr>
</thead>Table Footnotes
Footnotes within tables shall be tagged using the element <table-wrap-foot>. Usually footnotes are combined within fn-group/fn.
Example:
<table-wrap-foot>
<fn-group>
<fn><p>* Data not available for 1 trial. <sup>a</sup>P<0.05 (random effects model).</p></fn>
</fn-group>
</table-wrap-foot>Attributes within Tables
To emphasize columns, rows or single cells, please use XHTML Style Attribute Module [38] within the attribute @style.
Example:
<td style="color: #7799ff; background-color: #dddddd;">City</td>The following CSS style attributes should be used:
-
color -
background-color
Colors must be expressed by hexadecimal colors (Regex: [0-9A-F]{6}).
Additionally the following attributes may be used to format the table:
| Context | Allowed Attributes |
|---|---|
col, colgroup
|
@width, @align, @valign, @style
|
th, td
|
@align, @valign, @colspan, @rowspan, @style
|
tr
|
@align, @valign, @style
|
Table cell content is aligned top left. The attributes @align and @valign
should be used if the content must be aligned differently.
Pub Med CentralPMC
For PMC deliveries, footnotes (<fn>) within tables must be placed at the end of the table using <table-wrap-foot>. Add a reference to the
<fn> from the original position within the table content using <xref>.
Example:
<table>
<thead>
<tr>
<th>Title</th>
<th>Author</th>
</tr>
</thead>
<tbody>
<tr>
<td>Faust</td>
<td>Goethe<xref ref-type="table-fn" rid="j_cclm-2016-0074_table-fn_001"><sup>1</sup></xref></td>
</tr>
<tr>
<td>Schiller</td>
<td>Die Räuber</td>
</tr>
</tbody>
</table>Online Proofing SystemOPS
Each <th> and <td> shall not contain a <list> element. Additionally, <label>s must be numerical only.
Lists
Lists are tagged using the element <list>, the @list-type attribute must be used to specify the type.
Attribute:
@list-type
Attribute values:
order, bullet, alpha-lower, alpha-upper, roman-lower, roman-upper,
simple, custom
Example:
<list list-type="order">
<title>Cities</title>
<list-item>
<p>Berlin</p>
</list-item>
<list-item>
<p>London</p>
</list-item>
</list> The element <label>
must only be used in combination with @list-type="custom".
Continued Lists
To connect discontinuous lists that form one logical list, the attribute @id within the primary list and @continued-from within the continued list must be used. It
shall only be used in combination with @list-type="order|alpha-lower|alpha-upper|roman-lower|roman-upper".
Example:
<list id="j_hsz-2013-0008_list_003" list-type="order">
...
</list>
<p>...</p>
<list continued-from="j_hsz-2013-0008_list_003" list-type="order">
...
</list>Custom Labels
Lists that use custom labels (such as Step 1, Step 2, Step 3...) must be tagged using the @list-type="custom". They shall include a
<label> to capture the specific numeration.
Example:
<list list-type="custom">
<list-item>
<label>Step 1</label>
<p>Read the instructions.</p>
</list-item>
<list-item>
<label>Step 2</label>
<p>Understand it.</p>
</list-item>
<list-item>
<label>Step 3</label>
<p>Ask questions.</p>
</list-item>
</list>En Dash List
If it is absolutely necessary to keep the en dash within lists, the element <label>
must be used containing the character "–".
Example:
<list list-type="custom">
<list-item>
<label>–</label>
<p>Option One</p>
</list-item>
<list-item>
<label>–</label>
<p>Option Two</p>
</list-item>
</list>Equations and Formula
For mathematical equations and formulas the MathML, Tex Math and graphics equivalents are required for each entry. These ways to display equations/formulas must be combined
in the XML file with the element <alternatives>.
The namespace of MathML must be declared in the <article>/<book> tag with the attribute @xmlns:mml="http://www.w3.org/1998/Math/MathML (see section
Namespaces).
Tag all mathematical formula with <inline-formula>/<disp-formula>. Use them to tag mathematical expressions only, not single characters (such as "ℝ" or "π").
Within the <tex-math> the delimiters that are normally used to switch into and out of math mode must be omitted. Please make sure to validate the TeX sections for each delivery.
Inline Equations
For inline equations the elements <inline-formula> in combination with <inline-graphic>
must be used.
Example:
<inline-formula>
<alternatives>
<inline-graphic xlink:href="graphic/b_9783110339406-005_eq_001.png"/>
<mml:math>
<mml:mrow>
<mml:msup>
<mml:mi>L</mml:mi>
<mml:mi>p</mml:mi>
</mml:msup>
<mml:mspace width="0.166667em"/>
<mml:mrow>
<mml:mo>(</mml:mo>
<mml:mn>1</mml:mn>
<mml:mo><</mml:mo>
<mml:mi>p</mml:mi>
<mml:mo><</mml:mo>
<mml:mi>∞</mml:mi>
<mml:mo>)</mml:mo>
</mml:mrow>
</mml:mrow>
</mml:math>
<tex-math><![CDATA[L^p\,(1<p<\infty )]]></tex-math>
</alternatives>
</inline-formula>Regular white space within MathML element <mtext> is ignored by many renderers. If specific space must be preserved, a No-Break Space shall be used.
Display Equations
For display equations the elements <disp-formula> in combination with <graphic>
must be used. They will be displayed as a block (callout) within the narrative flow.
For <disp-formula> the attribute @id is required.
Example:
<disp-formula id="b_9783110339406-005_eq_002">
<label>(2)</label>
<alternatives>
<graphic xlink:href="graphic/b_9783110339406-005_eq_002.png"/>
<mml:math>
<mml:mstyle displaystyle="true" scriptlevel="0">
<mml:mi mathvariant="normal">Δ</mml:mi>
<mml:mi>x</mml:mi>
<mml:mi mathvariant="normal">Δ</mml:mi>
<mml:mi>p</mml:mi>
<mml:mo>≥</mml:mo>
<mml:mfrac>
<mml:mn>1</mml:mn>
<mml:mn>2</mml:mn>
<mml:/mfrac>
<mml:mi class="MJX-variant">ℏ</mml:mi>
<mml:/mstyle>
<mml:/math>
<tex-math><![CDATA[\displaystyle \Delta x \Delta p \geq \frac{1}{2} \hbar]]></tex-math>
</alternatives>
</disp-formula>Equations with multiple labels
If an equation needs to contain multiple labels to cite different parts of it (see Figure 1, the element <disp-formula-groups>
must be used. The equation should be split into single <disp-formula>.
Example:
<disp-formula-group>
<disp-formula id="b_9783110339406-005_eq_001">
<label>(1)</label>
<alternatives>
<graphic xlink:href="graphic/b_9783110339406-005_eq_001.png"/>
<mml:math>
<mml:mrow>...</mml:mrow>
</mml:math>
<tex-math>...</tex-math>
</alternatives>
</disp-formula>
<disp-formula id="b_9783110339406-005_eq_002">
<label>(2)</label>
<alternatives>
<graphic xlink:href="graphic/b_9783110339406-005_eq_002.png"/>
<mml:math>
<mml:mrow>...</mml:mrow>
</mml:math>
<tex-math>...</tex-math>
</alternatives>
</disp-formula>
</disp-formula-group>
Complex Equations
For equations that are very complex (see Figure 2) and for this reason can not be represented in MathML, the element <mml:math>
may be omitted. They are tagged with <disp-formula @content-type="complex">:
Example:
<disp-formula id="b_9783110339406-005_eq_002" content-type="complex">
<label>(2)</label>
<alternatives>
<graphic xlink:href="graphic/b_9783110339406-005_eq_002.png"/>
<tex-math><![CDATA[...]]></tex-math>
</alternatives>
</disp-formula>
LabelsOPS
When handling labels within the Online Proofing System, please note that only numerical labels (such as 1, 5, 23) must be used. Alphabetical or alphanumerical labels (such as 4a, 4b, II, V) shall be converted.
File Format
Graphical equation alternatives must be delivered using the following file formats:
| Type | |
|---|---|
| Book Archive XML | EPS/SVG (PNG) |
| Online Data | PNG |
The file format mentioned within brackets may be used in exceptional cases. Please get back to your Production Editor before using it.
Pub Med CentralPMC
For PMC deliveries each <mml:math>
must contain an @id. The ID is built from the
{element-id}
extended by _mml. Also, the element <tex-math>
shall be omitted.
Example:
<disp-formula id="b_9783110339406-005_eq_002">
<label>(2)</label>
<alternatives>
<graphic xlink:href="b_9783110339406-005_eq_002.png"/>
<mml:math id="b_9783110339406-005_eq_002_mml">
<mml:mi>ℚ</mml:mi>
</mml:math>
</alternatives>
</disp-formula>Margin Numbers
Margin numbers are tagged using the element <named-content> including the required attributes @content-type="margin-number" and @id.
Example:
<p id="b_9783110339406-005_mn_018"><named-content content-type="margin_number">18</named-content>§ 186 entspricht nahezu wortgleich der Vorgängerregelung.</p>Line Numbers
The elements <milestone-start> and <milestone-end> mark the line, where a line-number should be associated with. The attributes @id and @rationale="line" are
required for <milestone-start>. The element <named-content> including the required attribute
@content-type="line-number" contains the line number itself.
Example:
<p>
<milestone-start id="j_hsz-2015-0068_line_001" rationale="line"/><named-content content-type="line_number">1</named-content>Mithin müßen diese Bilder allgemein<milestone-end/>
<milestone-start id="j_hsz-2015-0068_line_002" rationale="line"/><named-content content-type="line_number">2</named-content>und schon für sich verständlich gewesen seyn.<milestone-end/>
</p>If the line number could be generated (e.g. if whole chapters use line-numbers and there is no reference to a specific line necessary), the line-number should be omitted.
Example:
<p>
<milestone-start id="j_hsz-2015-0068_line_001" rationale="line"/>Mithin müßen diese Bilder allgemein<milestone-end/>
</p>Please do not use this tagging for songs, poems or verses, use <verse-group> instead.
Verse
Songs, poems or verses are tagged within the element <verse-group>, each <verse-line> represents a poem or verse line.
Example:
<verse-group>
<verse-line>Some say the world will end in fire,</verse-line>
<verse-line>Some say in ice.</verse-line>
<attrib>—Robert Frost “Fire and Ice”</attrib>
</verse-group>If line numbers are necessary, this information must to be tagged for each verse line using the element <named-content> including the attribute @content-type="line_number".
Example:
<verse-line><named-content content-type="line_number">3</named-content>Some say the world will end in fire,</verse-line>Formatted Verses
If verses are formatted in a special way by using various indents or specific fonts, they must be embedded as an image using the element <fig> with the attribute
@fig-type="verse"
Example:
<fig id="j_hsz-2015-0068_verse_001" position="anchor" fig-type="verse">
<graphic xlink:href="graphic/j_hsz-2015-0068_verse_001.jpg"/>
</fig>Please note that this should only be used if there are only a few incidences of verses.
Tree Structure
Content that is represented as a tree structure, such as syntactic trees, must be tagged as <fig fig-type="tree">.
Example:
<fig id="j_hsz-2015-0068_tree_001" position="anchor" fig-type="tree">
<graphic xlink:href="graphic/j_hsz-2015-0068_tree_001.jpg"/>
</fig>Please note that this should only be used if there are only a few incidences of tree structures.
Speech
Speeches within the text are tagged using the element <speech>.
Example:
<speech>
<speaker>Speaker 1:</speaker>
<p>I have to say something.</p>
</speech>
<speech>
<speaker>Speaker 2:</speaker>
<p>Me too.</p>
</speech>Preformatted text
This section has been replaced by Transcriptions.
Transcriptions
Transcriptions are a systematic representations of language and are usually displayed in a monospace font to preserve character alignment. This is used to indicate multiple persons speaking at the same time or overlapping each other. Transcriptions
shall be tagged using the element <preformat>. The attribute @preformat-type="transcription" is required.
Example:
<preformat preformat-type="transcription">
00 A: also ich bin [der meinung dass man hier
00 B: [du lässt mich ja [nicht
00 C: [aber
A: zunächst einmal ]
B: mal ganz aus]reden]
C: echt ey ]
00 A: das stimmt doch gar nicht
</preformat>
Attribute:
@preformat-type
Attribute Value:
transcription
Programming CodeBAJ
To tag technical content such as programming language code, pseudo-code, schemas, or a markup fragment, the element <code>
must be used. To distinguish between different languages, the attribute @language
should be used.
Example:
<code language="javascript">function myFunction() {
var x, text;
x = document.getElementById("numb").value;
if (isNaN(x) || x < 1 || x > 10) {
text = "Input not valid";
} else {
text = "Input OK";
}
document.getElementById("demo").innerHTML = text;
}</code>When a label and/or caption is required, the element <code>
must be wrapped within <fig fig-type="code"> including the element <label> and/or <caption>. If these elements are not present, <fig>
must not be used.
Example:
<fig id="j_cmam-2016-0011_code_002" fig-type="code">
<label>Listing: 8</label>
<caption>
<p>This is a code listing of a crazy script.</p>
</caption>
<code language="bash">#!/bin/bash
# script for creating standalone PDFs of depending figures of our article.
# note: due to random score simulations underlying these examples, PDFs will slightly differ by each run.
# note: on first run, if an environment needs to be set-up from scrath, it may take 10 minutes - otherwise: < 1 minute.
mkdir -p /results/tex
mkdir -p /results/pdf
...</code>
</fig>
Books Online DataBO
For Book Online Data the element <preformat> (section Preformatted text) including the attribute @preformat-type="code"
must be used.
Inline Code
Whenever programming code needs to be used within text, the element <monospace>
must be used.
Example:
<p>The syntax of the JavaScript <monospace>for ... in<monospace> loop is as follows:</p>Interlinear gloss
An interlinear gloss is used to help the reader follow the relationship between the source text and its translation, and the structure of the original language [39]. To preserve this relationship, they're tagged using tables.
This table must be placed within <boxed-text>, whenever there's a new division between examples (new numbering), these parts need to be put into separate table and boxed-text elements. (The attribute
@content-type="ling_example" is required in this context.)
Example:
<boxed-text content-type="ling_example" id="b_9783110339406-005_box_001">
<label>(1)</label>
<boxed-text content-type="ling_example">
<label>a.</label>
<table-wrap position="anchor" orientation="portrait">
<table>
<tbody>
<tr>
<td><italic>Red mored</italic></td>
<td><italic>penter</italic></td>
<td><italic>rowa</italic></td>
<td><italic>lulus</italic></td>
<td><italic>tes.</italic></td>
</tr>
<tr>
...
</tr>
</tbody>
</table>
<table-wrap-foot>
<p>‘Those smart students passed the test.’</p>
</table-wrap-foot>
</table-wrap>
</boxed-text>
</boxed-text>These instructions should be used in conjunction with the De Gruyter Style Guide, section “Interlinear type, discourse transcriptions” [40].
Formal statements
Formal statements such as theorems are tagged using the element <statement> including the required attribute @content-type. Within each statement the element
<title> or <label> and at least one <p> element must be present.
Attribute:
@content-type
Attribute values:
theorem, proposition, lemma, assertion, corollary, proof, premise,
example, remark, definition, assumption, result, notation, conclusion, problem,
exercise, algorithm, solution, claim, fact, hint, summary, benefits, mode, description
Example:
<statement content-type="premise">
<title>Premise 1</title>
<p>XML is good.</p>
</statement>Textual Material
Textual Material such as examples, tasks and summaries are tagged within the element <boxed-text> including the required attributes @content-type and @id.
Within this element more complex content is possible by adding multiple sections.
Attribute:
@content-type
Attribute values:
example, learningtarget, takehomemessage, summary, margin, solution,
exercise, question, consider, attention, info, other
When converting boxes defined within our guidelines [40], the following @content-types apply:
| Housestyle Icon |
@content-type
|
|---|---|
|
attention
|
|
info
|
|
exercise
|
|
consider
|
|
question
|
Example:
<boxed-text id="b_9783110339406-005_box_003" content-type="example">
<label>Example 3</label>
<p>This is an example</p>
</boxed-text>Margins
If text parts should not be placed within the normal text flow, but within the margin, the attribute @position="margin"
should be used. This shall only be used within the following contexts:
-
<boxed-text> -
<graphic> -
<media> -
<supplementary-material>
Example:
<boxed-text id="b_9783110365344-003_box_015"
position="margin"> <p>This is a Margin Text.</p> </boxed-text>QuestionsBA
Questions are typically used within textbooks and are normally used in combination with an answer and/or explanations.
Example:
<question id="b_9783110365344-003_question_001" question-response-type="multiple-choice">
<label>1</label>
<p>What must be the case for an argument to succeed with a rational person?</p>
<option correct="no">
<label>A</label>
<p>The premises must be acceptable.</p>
</option>
<option correct="no">
<label>B</label>
<p>The conclusion must be acceptable.</p>
</option>
<option correct="no">
<label>C</label>
<p>The premises must logically support the conclusion.</p>
</option>
<option correct="yes">
<label>D</label>
<p>The premises must be acceptable and they must logically support the conclusion.</p>
</option>
</question>If specified the attribute @question-response-type
may be used to characterize the response. In case of simple textual answers and explanations, the elements <answer> and <explanation>
should be used wrapped within <question-wrap>:
Example:
<question-wrap>
<question id="b_9783110365344-003_question_002">
<p>Is hedonism a religion?</p>
</question>
<answer pointer-to-question="b_9783110365344-003_question_002">
<p>Hedonism is the pursuit of pleasure. It is a philosophical or ethical belief, but
not a religion. In everyday language, hedonism, together with its adjectival
equivalent 'hedonistic,' are often used in a derogatory manner. Hedonism is often
associated with the Ancient Greek philosophical school known as Epicureanism.</p>
</answer>
</question-wrap>
<question-wrap>
<question id="b_9783110365344-003_question_003">
<p>What is the main concern of aesthetics?</p>
</question>
<explanation pointer-to-explained="b_9783110365344-003_question_003"><p>Aesthetics is the
study of beauty. Classical aesthetics tries to find objective measures of beauty. For
example, Aristotle came up with his theory of mimesis, which essentially claims that
the role of art is to mimic nature. His ideas ...</p></explanation>
</question-wrap>Columns/Spaltensatz
Content that has a strict left-right relationship shall be tagged within the element <array> using tables.
Example:
<array>
<tbody>
<tr>
<td>Suborder</td>
<td><sc>Goniatitina</sc> (Hyatt, 1884)</td>
</tr>
<tr>
<td>Superfamily</td>
<td><sc>Pericyclaceae</sc> (Hyatt, 1900)</td>
</tr>
</tbody>
</array>Links
Internal
All internal links within the document (e.g. tables, figures, display formula) must be tagged with the <xref> element and include the appropriate @ref-type.
This is obligatory for all affiliations (@ref-type="aff"), appendices (@ref-type="app"), bibliographic references (@ref-type="bibr"), text boxes (@ref-type="boxed-text"), formulas
(@ref-type="disp-formula"), figures (@ref-type="fig"), footnotes (@ref-type="fn"), lists (@ref-type="list"), sections (@ref-type="sec"), statements
(@ref-type="statement"), tables (@ref-type="table") and table footnotes (@ref-type="table-fn") that are mentioned in the text.
| Attribute | Attribute values |
|---|---|
@ref-type
|
aff, app,
bibr, boxed-text, disp-formula, fig, fn,
list, sec,
statement, table, table-fn
|
@rid
|
{section-id}/{element-id}
of referenced section/element |
As a rule, <xref>
shall always contain the content of the referenced <label>. If punctuation is part of the label, such as "(2)" or "5.", it must be put outside of the element.
Example:
<p>...this has been proofed by <xref ref-type="bibr" rid="j_hsz-2015-0068_ref_023">Smith (1999)</xref>.</p>
<p><xref ref-type="fig" rid="j_hsz-2015-0068_fig_011">Figure 11</xref> shows the developement of... .</p>
<p>As described within section <xref ref-type="sec" rid="j_hsz-2015-0068_s_008_s_001">8.1</xref> the effect regarding... .</p>
<p>This has been shown within equation (<xref ref-type="disp-formula" rid="j_hsz-2015-0068_eq_021">21</xref>).</p>In-text citations must not be combined within one single <xref>. For each citation a new <xref>
shall be used. Furthermore brackets and separators like "," or "-" should be outside the <xref> tag. e.g. "Reference [1-3]" must be tagged as:
Example:
[<xref>1</xref>], [<xref>2</xref>], [<xref>3</xref>]It should not be tagged as: <xref>[1-3]</xref> or [<xref>1-3</xref>]. (Please note: For readability reasons, the required attributes
@ref-type and @id have been omitted.)
Special Cases
To allow our internal systems to handle citations automatically and consistently, the following rules must to be followed for special citation constructions:
-
s-genitive constructions shall be split and added outside the
<xref>element, such as:Example:
...such as <xref ref-type="bibr" rid="j_lingvan-2016-0078_ref_004">Baker</xref>’s (1988) incorporation analysis, ... -
Multiple citations for the same author but different years must be tagged as follows:
Example:
...such as Baker (<xref ref-type="bibr" rid="j_lingvan-2016-0078_ref_004">1985</xref>, <xref ref-type="bibr" rid="j_lingvan-2016-0078_ref_005">2004</xref>, <xref ref-type="bibr" rid="j_lingvan-2016-0078_ref_006">2018</xref>) incorporation analysis, ... -
When a page number is present within the citation only the author names shall be tagged within
<xref>:Example:
...as suggested by <xref ref-type="bibr" rid="j_cogsem-2017-9999_ref_015">Fauconnier and Turner</xref> (2002: 100)… -
Citation of collaboration authors where the collaboration name should be abbreviated must tag the year only:
Example:
NLN, <xref ref-type="bibr" rid="j_ijnes-2017-0001_ref_035">2012</xref>
Legal referencesBL
Links within legal texts usually also contain references to margin numbers or normative texts (norms). For this, additional @ref-type values are allowed:
| Attribute | Attribute values |
|---|---|
@ref-type
|
aff, app,
bibr, boxed-text, disp-formula, fig, fn,
list, sec,
statement, table, table-fn, norm, margin-number
|
@rid
|
{section-id}/{element-id}
of referenced section/element |
Examples:
<p>Bergbauberechtigungen, die vor Inkrafttreten des Bundesberggesetzes erteilt worden sind, werden unter den Voraussetzungen des <xref ref-type="norm" rid="b_9783899498776_n_149">§ 149</xref> mit zahlreichen Maßgaben in das neue Berechtsamssystem überführt <xref ref-type="norm" rid="b_9783899498776_n_151">(§§ 151 ff.)</xref>; für die Aufsuchung und Gewinnung von Bodenschätzen, die Gegenstand dieser Berechtigungen sind, bedarf es keiner neuen Bergbauberechtigung <xref ref-type="norm" rid="b_9783899498776_n_149">(§ 149 Abs. 7).</xref></p><p>Beim Einsatz entsprechender Bewertungstools zur automatisierten Festlegung der jeweils erforderlichen Maßnahmen handelt es sich nicht um Scoring i. S. d. § 28b BDSG, sodass die einschränkenden Voraussetzungen dieser Norm hier keine Anwendung finden (siehe dazu oben <xref ref-type="margin-number" rid="b_9783899498776-002_s_003_s_001_mn_067">Rn 67</xref>).</p>In addition, all general rules (see section Internal links) apply as well.
External
All external links must be tagged with <ext-link> and the appropriate @ext-link-type as well as @xlink:href.
@ext-link-type
|
@xlink:href
|
@xlink:href Regex
|
<ext-link>
|
|---|---|---|---|
uri
|
{url}
|
^(([^:/?#]+):)?(//([^/?#]*))?([^?#]*)(\?([^#]*))?(#(.*))?$
|
Link Name |
doi
|
{DOI-link}
|
^https://doi\.org/10\.\d+/[a-zA-Z0-9\-\._;\(\)/]+$
|
{DOI-link}
|
The attribute @xlink:href
shall capture the full protocol, such as "https://", "http://",... . Please make sure not to insert unnecessary spacing or not allowed characters in link protocols.
Examples:
<ext-link ext-link-type="uri" xlink:href="http://www.degruyter.com">
De Gruyter Online
</ext-link><ext-link ext-link-type="uri" xlink:href="https://jats.nlm.nih.gov/index.html">
https://jats.nlm.nih.gov/index.html
</ext-link><ext-link ext-link-type="doi" xlink:href="https://doi.org/10.1515/aot-2013-0054">
https://doi.org/10.1515/aot-2013-0054
</ext-link>Please note that, due to revised Cross Ref Display Guidelines [41] DOI links must use https://doi.org/ instead of
http://dx.doi.org/ and use the complete link URL.
Page BreaksB
If requested, page breaks may be included using the element <target> to tag the start of a new page. If used, the attributes @id and @target-type
must be present.
| Name | Value | |
|---|---|---|
| Element |
<target>
|
{page-no}
|
| Attribute |
@id
|
page-{page-no}
|
| Attribute |
@target-type
|
next-page
|
Example:
<target id="page-20" target-type="next-page">20</target>Please note that <target> shall not be placed within footnotes, links or references.
Correction StatementJ
Correction Statements are used when a late change needs to be made to an article that is already online ahead of print, but is not yet printed in an issue. This will be included within the XML by adding the attribute
@content-type="added-post-electronic-publication" to the respective paragraph:
Example:
<p>This is the paragraph that has been correct. This is followed by the correction
statement.</p>
<p content-type="added-post-electronic-publication">Correction added on 10 December 2013 after ahead-of-print publication: Minimum distance in the second sentence of paragraph 2, page 5 was updated from 50 m to 70 m.</p>The complete Post Publication Correction Guidelines (with information to Correction Statements, Errata, Corrigenda, Retractions, Duplicate Publications) can be accessed within the Production Wiki [33].
QueriesOPS
Queries need to be inserted within the XML for the proofing stage. To tag this, the processing instruction <?proof-check ?> including the pseudo attributes @query
must be used. Only place the queries inside of editable tags containing PCDATA, such as <kwd>, <p>, or <aff>:
✔ Do
<p>Some text and a question. <?proof-check query="Please check and confirm!"?></p><name>
<surname>M.<?proof-check query="Please provide full name!"?></surname>
<given-names>Heaney</given-names>
</name>Do not insert queries outside of these elements!
✘ Don't
<p>Some text and a question.</p>
<?proof-check query="Please check and confirm!"?>
<p>Some more text.</p><name>
<surname>M.</surname>
<?proof-check query="Please provide full name!"?>
<given-names>Heaney</given-names>
</name>You may find a list of editable and not editable metadata elements within the appendix section Metadata fields within the OPS.
Query information must not be present within the final XML delivery.
Normative textBL
Normative texts or legal norms are tagged using the element <norm> as part of a section. It must contain the element <label> including
the paragraph/article number as well as the <title> holding the title of the article. The abbreviation of the law (such as BBG) may be included using the element <abbrev> (see
section Abbreviations).
The element <norm-p> contains the legislative text, which may be structured by using <sup>.
Example:
<sec id="b_9783899498776-004_s_001_s_001">
<norm id="b_9783899498776_n_001">
<norm-meta>
<abbrev xlink:title="Bundesberggesetz" content-type="norm">BBergG</abbrev>
<label>§ 6</label>
<title>Grundsatz</title>
</norm-meta>
<norm-p>
<sup>1</sup>Wer bergfreie Bodenschätze aufsuchen will, bedarf der Erlaubnis, wer bergfreie Bodenschätze gewinnen will, der Bewilligung oder des Bergwerkseigentums. <sup>2</sup>Diese Berechtigungen können nur natürlichen und juristischen Personen und Personenhandelsgesellschaften erteilt oder verliehen werden.</norm-p>
</norm>
</sec>RecitalsBL
Recitals or margin numbers are used to structure content parts (<p>, <fig>, <table-wrap>) within legal texts. They shall be tagged using the element <margin-number> and
must contain the attribute @id.
Examples:
<sec id="b_9783899498776-004_s_001_s_001_s_001_s_001">
<label>1.</label>
<title>Regelungszweck und Anwendungsbereich</title>
<p><margin-number id="b_9783899498776-004_mn_001">1</margin-number>Aufsuchung und Gewinnung bergfreier Bodenschätze bedürfen nach Satz 1 einer Bergbauberechtigung. Sie unterliegen damit einem umfassenden Erlaubnisvorbehalt.</p>
<p><margin-number id="b_9783899498776-004_mn_002">2</margin-number>Das Erfordernis einer Bergbauberechtigung für bergfreie Bodenschätze hat eine doppelte Funktion: Zum einen wird durch den Erlaubnisvorbehalt das freie Aneignungsrecht für herrenlose Sachen ausgeschlossen, das sich sonst nach sachenrechtlichen Grundsätzen aus der Trennung von Grundeigentum und bergfreien Bodenschätzen.</p>
</sec><fig id="b_9783899498776-002_fig_001" position="float">
<label>Abb. 1</label>
<margin-number id="b_9783899498776-002_s_003_s_002_s_002_s_001_s_003_mn_33">33</margin-number>
<caption>
<p>Kombination von Maßnahmen</p>
</caption>
<graphic xlink:href="graphic/b_9783899498776-002_fig_001.jpg"/>
</fig><table-wrap id="b_9783899498776-002_tab_001" position="float">
<label>Table 1</label>
<margin-number id="b_9783899498776-002_s_003_mn_25">25</margin-number>
<caption>
<p>Auswahl von Maßnahmen</p>
</caption>
<table>...</table>
</table-wrap>Backmatter Elements
The elements <title> or <label>
shall not be used on <back>.
Supplementary Material Note
/article/back/notes[@notes-type="supplement"]/book/book-back/notes[@notes-type="supplement"]//book-part/back/notes[@notes-type="supplement"]The element <notes> with the attribute @notes-type="supplement"
must contain additional information regarding the Supplementary Material, that is attached to the article or chapter.
Instructions how to tag the link to the Supplementary Material file can be found within section Supplementary Material.
| Attribute | Attribute value |
|---|---|
@notes-type
|
supplement
|
@specific-use
|
print-only
|
Example:
<notes notes-type="supplement" id="j_hsz-2015-0068_notes_001" specific-use="print-only">
<sec>
<title>Supplementary Material</title>
<p>The online version of this article offers supplementary material (DOI:<ext-link ext-link-type="doi" xlink:href="https://doi.org/10.1515/hsz-2015-0068">https://doi.org/10.1515/hsz-2015-0068</ext-link>).</p>
</sec>
</notes>Acknowledgements
/article/back/ack/book/front-matter/ack/book/book-back/ackThe element <ack> includes the acknowledgments of an article, book or chapter. If there is funding information mentioned in the acknowledgements please extract and place it within the tag <funding-group>. (See section Funding Information.)
Example:
<ack id="b_9783110339406-005_ack_001">
<title>Acknowledgements</title>
<p>We thank B. Beltchev for purification of Hfq, S. Cusack and A. J. Carpousis for the gift of PAP I, A. Ishihama for Hfq antibodies used in Hfq purification.</p>
</ack>Additional Information
/book/book-back/fn-group/fn//book-part/back/fn-group/fn/article/back/fn-group/fnThis element contains additional information to the article, chapter or book which aren’t part of the narrative flow. In comparison to the <note> element, <fn-group> is used, when the information can be specified clearly
according to the predefined list of @fn-type values within the element <fn>. The attribute @fn-type is required.
Attribute:
@fn-type
Attribute values:
conflict, com, con, financial-disclosure, presented-by, presented-at,
other
Example:
<fn-group>
<fn fn-type="presented-at">
<p>This paper has been presented previously at the International Standards Conference.</p>
</fn>
<fn fn-type="conflict">
<p><bold>Conflicts of interest:</bold>The funding organization(s) played no role in the study design; in the collection, analysis, and interpretation of data; in the writing of the report; or in the decision to submit the report for publication</p>
</fn>
<fn fn-type="com">
<p><bold>Communicated by:</bold> Marianne Grunberg-Manago, Institute of Physico-Chemical Biology, Paris, France</p>
</fn>
<fn id="j_almed-2019-0012_fn_006" fn-type="other">
<p><bold>Article Note:</bold> A translation of this article can be found here:
<ext-link ext-link-type="uri" xlink:href="https://doi.org/10.1515/almed-2019-0009" >https://doi.org/10.1515/almed-2019-0009</ext-link></p>
</fn>
</fn-group>Please see the following table for a mapping between specific information and the corresponding @fn-type:
| Information |
@fn-type
|
|---|---|
| Conflict of Interest, Competing interest |
conflict
|
| Statement of Informed Consent, Statement of Human and Animal Rights, Ethical Approval, Informed consent, translation |
other
|
| Author contributions |
con
|
| Research Funding*, Honorarium |
financial-disclosure
|
| Note on Dissertation** |
dissertation
|
* Funding Information, that includes a funding agency and award identifier, must be tagged using
<funding-group>
** This applies to Book XML deliveries only.
Multiple Headings
If multiple headings are necessary, they shall be captured by using multiple <fn-group>s:
Example:
<fn-group>
<title>Author’s statement</title>
<fn fn-type="conflict" id="j_bnm-2017-0002_s_998">
<p><bold>Conflict of interest:</bold> Authors state no conflict of interest.</p>
</fn>
</fn-group>
<fn-group>
<title>Materials and methods</title>
<fn fn-type="other" id="j_bnm-2017-0002_s_996">
<p><bold>Informed consent:</bold> Informed consent has been obtained from all individuals
included in this study.</p>
</fn>
<fn fn-type="other" id="j_bnm-2017-0002_s_995">
<p><bold>Ethical approval:</bold> The research related to human use has been complied with
all the relevant national regulations, institutional policies and in accordance the tenets
of the Helsinki Declaration, and has been approved by the authors’ institutional
review board or equivalent committee.</p>
</fn>
</fn-group>If there are multiple <fn-group>s present, one of them must contain the element <title>.
Notes
/article/back/notes/book/book-back/notes//book-part/back/notesThe element <notes> contains notes to the article/chapter which aren’t part of the narrative flow but must be placed to the article/chapter (e.g. a prepublication information) and can't be expressed
within fn-group/fn[@fn-type] information (see section Additional Information).
Attribute:
@notes-type
Attribute values:
prepublication,
software
Examples:
<notes notes-type="prepublication" id="b_9783110339406-005_notes_002">
<p>This article has been previously published within the Journal of Standards.<p>
</notes>
<notes notes-type="software" id="j_snde-2018-1234_notes_002">
<sec>
<title>Code and Datasets</title>
<p>The author(s) published code and data associated with this article is on Code Ocean, a computational reproducibility platform. We recommend Code Ocean to SNDE contributors who wish share, discover, and run code in published research articles. (See: <ext-link ext-link-type="uri" xlink:href="https://doi.org/10.24433/CO.154591c8-9d3f-47eb-b656-3aff245fd5c1">https://doi.org/10.24433/CO.154591c8-9d3f-47eb-b656-3aff245fd5c1</ext-link>)</p>
</sec>
</notes>IndexB
Books Online DataBO
An index can be tagged using the element <glossary>. In order to add the DOI information, it must be included into an <sec> element containing the
<object-id>
. The type of the index must be indicated using the attribute
@content-type.
Attribute:
@content-type
Attribute values:
subjects, persons, references, abbreviations,
locations,
terms, general
Example:
<back>
<sec>
<object-id pub-id-type="doi">10.1515/9783110339406-003</object-id>
<glossary content-type="subjects" id="b_9783110339406-005_gloss_001">
<title>Subject Index</title>
<def-list>
<def-item>
<term>index entry</term>
</def-item>
</def-list>
</glossary>
</sec>
</back>If there is more than one index, the element <glossary> can be nested within each other.
Nested indexBO
If an index consists of more than one level, please nest the <def-list> elements within each other.
Example:
<def-list>
<def-item>
<term>Entry</term>
</def-item>
</def-list>
<def-list>
<def-item>
<term>General Entry</term>
</def-item>
<def-list>
<def-item>
<term>Sub-Entry1</term>
</def-item>
</def-list>
<def-list>
<def-item>
<term>Sub-Entry2</term>
</def-item>
</def-list>
</def-list>Books Archive XMLBA
/book/book-back/index-groupIdeally index entries are tagged directly within the text where terms appear (see section Index Terms). In case of valid reasons (please contact the responsible production editor before) this might not be possible. Then the index may be inserted as a list of terms (without the page numbers of the printed book).
Whenever Index Terms (<index-term>) are present within the XML, the elements index or index-group within book-back
must not be used.
The attribute @index-type within <index>
must be used to distinguish between different index types:
Attribute:
@index-type
Attribute values:
subjects, persons, references, abbreviations,
locations, terms, general
For general indices, that include different items (e.g. persons and subject), the @index-type="general"
must be used.
Example:
<index-group>
<index index-type="subjects" id="b_9783110302639_index_001">
<index-title-group>
<title>Subject Index</title>
</index-title-group>
...
<index-div>
<index-entry>
<term>Extensible Markup Language</term>
<see-entry>XML</see-also-entry>
</index-entry>
...
</index-div>
...
<index-div>
<index-entry>
<term>XML</term>
<see-also-entry>Markup Language</see-also-entry>
</index-entry>
...
</index-div
...
</index>
<index index-type="persons" id="b_9783110302639_index_002">
<index-title-group>
<title>Author Index</title>
</index-title-group>
...
</index>
<index-group>Page ReferencesBA
If requested, page references may be included using the element <nav-pointer>.
Example:
<index-entry>
<term>Klosterneuburg, Stiftsbibliothek, Hs. 533, Bl. 3r–4r (ID 11056)</term>
<nav-pointer>137</nav-pointer>
</index-entry>In case multiple page references need to be included, the <nav-pointer> elements must be grouped within <nav-pointer-group>.
Glossary
/book/back/glossary/book/book-back/glossary//book-part/back/glossary/article/back/glossaryLists of terms and definitions are tagged using the element <glossary>. It contains the element <term> and, if applicable, a definition <def>. In order to add the DOI information, it
must be included into an <sec> element containing the
<object-id>
.
Example:
<sec>
<object-id pub-id-type="doi">10.1515/9783110339406-003</object-id>
<glossary>
<title>Glossary</title>
<def-list>
<def-item>
<term>A cappella</term>
<def><p>Vocal music without instrumental accompaniment.</p></def>
</def-item>
<def-item>
<term>Abgesang</term>
<def><p> Second section of the → Barform.</p></def>
</def-item>
<def-item>
<term>Accentus</term>
<def><p>In contrast with → concentus, a style of singing which prizes clear delivery (→ syllabic style, melodic sobriety) over aesthetic beauty.</p></def>
</def-item>
</def-list>
</glossary>
</sec>References
/book/back/ref-list/book/book-back/ref-list//book-part/back/ref-list/article/back/ref-listReferences are required within the element <ref> in two ways: To preserve spacing and punctuation <mixed-citation>
must to be used. Within <element-citation> all detailed tagged information is required and the element does not include untagged text, spacing
or punctuation.
If references are numbered, the <label>
must be used within <ref> directly rather than within <element-citation> or <mixed-citation>.
Example:
<ref-list id="b_9783110339406-005_reflist_001">
<object-id pub-id-type="doi">10.1515/9783110339406-032</object-id>
<title>III. Kommentierte Literaturhinweise</title>
<p>Einführungen und Überblicksdarstellungen zur Sprachphilosophie:</p>
<ref id="b_9783110339406-032_ref_023">
<label>[23]</label>
<mixed-citation>Petitti DB, Crooks VC, Buckwalter JG, Chiu V. Blood pressure levels before dementia. Arch Neurol. 2005 Jan;62(1):112-116. <pub-id pub-id-type="doi">10.1515/cclm-2015-0068</pub-id>
</mixed-citation>
<element-citation publication-type="journal" publication-format="print">
<name><surname>Petitti</surname><given-names>DB</given-names></name>
<name><surname>Crooks</surname><given-names>VC</given-names></name>
<name><surname>Buckwalter</surname><given-names>JG</given-names></name>
<name><surname>Chiu</surname><given-names>V</given-names></name>
<etal/>
<article-title>Blood pressure levels before dementia</article-title>
<source>Arch Neurol</source>
<year>2005</year>
<month>Jan</month>
<volume>62</volume>
<issue>1</issue>
<fpage>112</fpage>
<lpage>116</lpage>
<pub-id pub-id-type="doi">10.1515/cclm-2015-0068</pub-id>
</element-citation>
</ref>
...
</ref-list>Please note, that both reference versions (<mixed-citation> and <element-citation> are required for each <ref>.
For more examples, please visit the PubMed Citation Samples Page [42].
Pub Med CentralPMC
For PMC deliveries the <mixed-citation> alternative must be omitted.
DOIs
If a DOI is present within the reference, it needs to be tagged using the element <pub-id> including the attribute @pub-id-type="doi". This must be included within
<element-citation> as well as <mixed-citation>.
Element Citation
Within <element-citation> inline formatting, such as <italic>, <bold> or quotes must not be used for entire elements. It
may be used to emphasize parts of it.
Example:
<article-title>Generalized inf-sup conditions for <italic>Chebyshev</italic> spectral approximation of the Stokes problem</article-title>Publication Type
The attribute @publication-type is used to distinguish between different types of publication. It must be present for every <element-citation>.
Attribute:
@publication-type
Attribute values:
journal, book, confproc, web, report, thesis, other
Source
The element <source> is required for every reference entry (ref/element-citation). It should hold the title of the
document that contains the material that is being cited. Please find some typical examples for the usage of this element:
When citing an article within a journal the element <source> holds the name of the journal:
<element-citation publication-type="journal" publication-format="print">
<name><surname>Meneton</surname><given-names>P</given-names></name>
<name><surname>Jeunemaitre</surname><given-names>X</given-names></name>
<article-title>Links between dietary salt intake, renal salt handling, blood pressure, and cardiovascular diseases</article-title>
<source>Physiol Rev</source>
<year>2005</year>
<month>Apr</month>
<volume>85</volume>
<issue>2</issue>
<fpage>679</fpage>
<lpage>715</lpage>
</element-citation>
Within book publication citations the element contains the book title:
<element-citation publication-type="book" publication-format="print">
<name><surname>Jenkins</surname><given-names>PF</given-names></name>
<source>Making sense of the chest x-ray: a hands-on guide</source>
<publisher-loc>New York</publisher-loc>
<publisher-name>Oxford University Press</publisher-name>
<year>2005</year>
<size units="page">194 p</size>
</element-citation>For thesis citations, the title of the dissertation is used for <source>:
<element-citation publication-type="thesis">
<name><surname>Liu-Ambrose</surname><given-names>TY</given-names></name>
<source>Studies of fall risk and bone morphology in older women with low bone mass [dissertation]</source>
<publisher-loc>[Vancouver (BC)]</publisher-loc>
<publisher-name>University of British Columbia</publisher-name>
<year>2004</year>
<size units="page">290 p</size>
</element-citation>When the cited material is an online databases, <source> will contain the name of the site/database:
<element-citation publication-type="database" publication-format="web">
<source>Faculty of 1000. Medicine [Internet]</source>
<publisher-loc>London</publisher-loc>
<publisher-name>Medicine Reports Ltd</publisher-name>
<year>c2007 - </year>
<date-in-citation>cited 2007 Feb 1</date-in-citation>
<comment>Available from: <uri>http://www.f1000medicine.com/</uri>.</comment>
</element-citation>For citation of websites it holds the name of the site:
<element-citation publication-type="webpage">
<source>AMA: helping doctors help patients [Internet]</source>
<publisher-loc>Chicago</publisher-loc>
<publisher-name>American Medical Association</publisher-name>
<year>c1995-2007</year>
<date-in-citation>cited 2007 Feb 22</date-in-citation>
<comment>Available from:<uri>http://www.ama-assn.org/</uri>.</comment>
</element-citation>For more examples and assistance on how to use the <source> element, you may visit the PubMed Citation Samples Page [42].
et al.
If not all authors are named, the element <etal/>
must be used. It shall be inserted directly after the last contributor name (<name>).
Initials
If initials are used within author names, the dot must be added to the element itself if the journal style uses it.
<name>
<surname>Smith</surname>
<given-names>Johan M.</given-names>
</name>Comment element
The element <comment>
should only be used in exceptional cases, if a more descriptive element is not available. When it is used, punctuation and whitespace must be preserved.
Links to references
For every reference entry (<ref>) there should be a corresponding link (
<xref>
)
to it.
Online Proofing SystemOPS
Reference lists must not be nested within each other. If there are multiple reference lists, they should be merged.
✔ Do
<ref-list>
<title>References</title>
...
</ref-list>Multiple <ref-list> elements must not be used.
✘ Don't
<ref-list>
<title>References</title>
<ref-list>
<title>Bibliography</title>
...
</ref-list>
<ref-list>
<title>Electronic Sources</title>
...
</ref-list>
</ref-list>Appendix
/book/book-back/app-group or /book/book-back/app//book-part/back/app-group or //book-part/back/app/article/back/app-group or /article/back/appAdditional content regarding an article or chapter must be tagged within the element <app>. A collection of section-level appendices (<app>)
must be grouped within the element <app-group>.
Example:
<app-group>
<title>Appendix</title>
<app id="b_9783110339406-005_app_001">
<label>A</label>
<title>Scientific Evidence and Consumers</title>
…
<sec>
<label>A.1</label>
<title>Consumers</title>
...
</sec>
</app>
<app id="b_9783110339406-005_app_002">
<label>B</label>
<title>Perceptions of Food Irradiation</title>
…
</app>
</app-group>Book Archive XMLBA
/book/book-back/book-app-group or /book/book-back/book-appAdditional content regarding a book must be tagged within the element <book-app>. A collection of section-level appendices (<book-app>)
must be grouped within the element <book-app-group>.
The element <book-part-meta> must be present within the element <book-app> or <book-app-group>.
Example:
<book-app>
<book-part-meta>
<book-part-id book-part-id-type="doi">10.1515/9783110365344-203</book-part-id>
<title-group>
<title>Appendix A</title>
</title-group>
<fpage>521</fpage>
<lpage>532</lpage>
<counts>
<book-count count="12" count-type="chapter-page-count"/>
</counts>
</book-part-meta>
<body>
<sec id="b_9783110365344-203_s_001">
<title>Scientific Evidence and Consumers</title>
...
</sec>
</body>
</book-app>Online Proofing SystemOPS
When using <label>s within the Appendix, the following rule does apply:
-
<label>sthat are used directly within<app>must be alphabetical only (such as "A" or "B"). -
If a section element (
<sec>) is added within<app>, it shall be alpha-numerical (such as "A.1" or "B.2").
Example:
<app>
<label>A</label>
<title>Appendix</title>
...
<sec>
<label>A.1</label>
<title>Appendix Section One</title>
...
</sec>
<sec>
<label>A.2</label>
<title>Appendix Section Two</title>
...
</sec>
</app>Endpaper front/backBA
Some information might be displayed on the endpaper of a book title, in this case, the information should be tagged within the element book-app including the
required attributes book-part-type="endpaper". The attribute @seq indicates the position/sequence of the information.
Example:
<book-app-group>
<book-app book-part-type="endpaper" id="b_9783110643572-005" seq="U2">
<book-part-meta>
<book-part-id book-part-id-type="doi">10.1515/9783110643572-205</book-part-id>
<title-group>
<title>Title of the U2</title>
</title-group>
<fpage>u2</fpage>
<lpage>u2</lpage>
<counts>
<book-count count="1" count-type="chapter-page-count"/>
</counts>
</book-part-meta>
...
</book-app>
<book-app book-part-type="endpaper" id="b_9783110643572-006" seq="U3">
<book-part-meta>
<book-part-id book-part-id-type="doi">10.1515/9783110643572-206</book-part-id>
<title-group>
<title>Title of the U3</title>
</title-group>
<fpage>u3</fpage>
<lpage>u3</lpage>
<counts>
<book-count count="1" count-type="chapter-page-count"/>
</counts>
</book-part-meta>
...
</book-app>
</book-app-group>
Attribute:
@seq
Attribute values:
U2, U3
The values used within @seq must correspond with the fpage, lpage entries.
Delivery packages
Article and chapter PDFs and their matching XML files must be delivered in zip packages. These packages have special naming conventions and structure requirements which are described in this section.
File Naming Conventions
PDF and XML files
Books and Journals OnlineBJO
Each Book, Chapter and Article-XML and their matching PDF file are named according to the respective
{doi-suffix}.
Examples:
hsz-2015-0068.pdfhsz-2015-0068.xml9783110339406-002.pdf9783110339406-002.xml9783110339406.xml9783110339406.pdfBooks Archive XMLBA
The Book-XML file that represents the entire title is named according to the respective Print ISBN
{isbn}.
Example:
9783110295207.xmlPub Med CentralPMC
PDF and XML files for each article within the delivery are named as follows:
{pmc-code}-{article-id}.{ext}
{ext} is pdf|xml.
Examples:
bchm-hsz-2015-0068.xmlbchm-hsz-2015-0068.pdfEPUB file
The Book EPUB file that represents the entire title is named according to the respective EPUB ISBN {isbn}.
Example:
9783110295207.epubMedia Files and Graphics
Books and Journals OnlineBJO
Each media (audio/video) and graphic file must be named according to their
{element-id}
and linked directly within the XML file.
Examples:
j_hsz-2013-0068_fig_011.jpgb_9783110339406-002_fig_003.jpgGraphic files are delivered within the folder "graphics".
Media files are audio and video files and will be delivered within the folder "media". For instructions regarding the file specifications, please see the De Gruyter Audio and Video Guidelines [36].
Pub Med CentralPMC
File names for media and graphic files must be built as follows:
{pmc-code}-{article-id}-{typ}{no}.{ext}
{typ} could be:
-
g= figure graphic -
i= inline graphic -
e= equation
{no} is defined as an alphanumeric identifier.
Examples:
bchm-hsz-2015-0068-g012.pngbchm-hsz-2015-0068-e004.pngSupplementary Material Files
Supplementary Material is attached to a book, chapter or article and contains additional supporting documents or files that are not part of the content of the book or article. These files are stored within the sub folder "suppl".
Books and Journals OnlineBJO
These files are stored within the sub folder "suppl". For instructions regarding Supplementary Material please see the instructions for Supplementary Material [37].
Supplementary Material file names must not contain white spaces, umlauts or any other special characters.
Regex:
^[a-zA-Z0-9\-_\.~]+$
Pub Med CentralPMC
File names for media and graphic files are built as follows:
{pmc-code}-{article-id}-s{no}.{ext}
{no} is defined as an alphanumeric identifier.
Example:
bchm-hsz-2015-0068-s002.zipCover FileJO
The cover file contains the first page of the cover ("U1") without any crop marks. The file name is built as follows:
{issue-id}_cover.pdf
Example:
cmam.2016.16.issue-1_cover.pdfDelivery packages
The zip-file including PDF, XML and graphic/media files must be named according to these instructions:
Books Online DataBO
{book-delivery-id}=epub_dgo_{eISBN_pdf}.zipExample:
epub_dgo_9783110339406.zipBooks Archive XMLBA
{book-delivery-id}=xml_cont_{isbn}.zipExample:
xml_cont_9783110295207.zipFor Book Archive XML deliveries the Print ISBN must be used within the ZIP file name.
Journal Online IssueJO
{issue-delivery-id}={journal-code-online}_{issue-id}_{timestamp}.zipExample:
bchm_bchm.2012.1.issue-2_2013-06-10--18-45-01.zipJournal Online ArticlesJO
{article-delivery-id}={journal-code-online}_{article-id}_{article-delivery-type}_{timestamp}.zipExamples:
bchm_hsz-2012-0006_ja_2013-06-28--10-30-25.zipbchm_hsz-2013-0010_aop_2013-05-16--14-30-25.zipIf you update existing content, the folder and file names contained in the zip shall stay as they are and must not be renamed!
Journal PMC IssuePMC
{issue-delivery-id}={pmc-code}-{volume-number}-{issue-number}.zipExample:
hsz-12-01.zipIn case issues must be revised and resupplied to Pub Med Central a revision indicator (.r1, .r2, .r3) must be added to the ZIP file name:
Example:
hsz-12-01.r1.zipJournal PMC ArticlesPMC
{article-delivery-id}={pmc-code}-{article-id}.zipExample:
bchm-hsz-2012-0006.zipIn case articles must be revised and resupplied to Pub Med Central a revision indicator (.r1, .r2, .r3) must be added to the ZIP file name:
Example:
bchm-hsz-2012-0006.r3.zipFolder structure and content
Books - Online DataBO
epub_dgo_{eISBN_pdf}.zip
|--{eISBN_pdf}
| |--{eISBN_pdf}
| | |--{eISBN_pdf}.xml
| | |--{eISBN_epub}.epub
| | |--{eISBN_pdf}.pdf
| |--{eISBN_pdf}-{chapter-suffix}
| | |--{eISBN_pdf}-{chapter-suffix}.xml
| | |--{eISBN_pdf}-{chapter-suffix}.pdf
| |--{eISBN_pdf}-{chapter-suffix}
| | |--{eISBN_pdf}-{chapter-suffix}.xml
| | |--{eISBN_pdf}-{chapter-suffix}.pdf
| | |--graphic
| | | |--{element-id}.jpg
| | | |--...
| | |--suppl
| | | |--{filename}.{fn-ext}
| | | |--...
| | |--media
| | | |--{element-id}.m4a
| | | |--{element-id}.mp3
| | | |--...The package includes several book parts. The separation into parts shall be one part for each chapter for monographs. Contributions should be separated into parts by sticking to the contribution structure which means that one contribution should be one book part.
Each Book Online Data delivery must contain at least one frontmatter (fm), table of contents (toc), chapter XML file together with the corresponding PDF file as well as one book XML file. Graphic, Media and Supplementary Files are optional.
Books - Archive XMLBA
xml_cont_{isbn}.zip
|--{isbn}.xml
|--graphic
| |--{element-id}.jpg
| |--...
|--media
| |--{element-id}.m4a
| |--{element-id}.mp3
| |--...
|--suppl
| |--{filename}.{fn-ext}
| |--...Each Book Archive XML delivery must contain the Book XML file at the minimum. Graphic, media and Supplementary Files are optional.
For Book Archive XML deliveries the Print ISBN must be used within the ZIP and XML file name.
Journal IssuesJ
Journals OnlineJO
{journal-code-online}_{issue-id}{timestamp}.zip
|--{issue-id}
| |--{article-id}
| | |--{article-id}.xml
| | |--{article-id}.pdf
| | |--graphic
| | | |--figure files
| | |--suppl
| | | |--supplementary files
| | |--media
| | | |--media files
| |--{frontmatter-id}
| | |--{frontmatter-id}.xml
| | |--{frontmatter-id}.pdf
| |--{graphical-abstract-id}
| | |--{graphical-abstract-id}.xml
| | |--{graphical-abstract-id}.pdf
| |--issue-files
| | |--{issue-id}.xml
| | |--{issue-id}_cover.pdfThe number of article-id folders must match with the number of articles within the issue. If there is no graphical abstract please omit the folder
{graphical-abstract-id}
.
Each Online Issue delivery shall to contain at least one article and frontmatter XML file and the corresponding PDF file as well as the Issue XML file. Graphic, Media, Cover and Supplementary files are optional.
Pub Med CentralPMC
For Pub Med Central separate subdirectories for each article inside the package must not be created.
{pmc-code}-{volume-number}-{issue-number}.zip
|--{pmc-code}-{article-id}.pdf
|--{pmc-code}-{article-id}.xml
|--{pmc-code}-{article-id}-{typ}{no}.png
|--...
|--{pmc-code}-{article-id}.pdf
|--{pmc-code}-{article-id}.xml
|--{pmc-code}-{article-id}-{typ}{no}.zip
|--...
The folder issue-files including the XML
{issue-id}.xml
must not be included.
Journal ArticlesJ
Journals OnlineJO
Each article which is published as ahead of print or just accepted must be delivered in a separate zip package. Create one zip file for each article.
{journal-code-online}_{article-id}_{article-delivery-type}_{timestamp}.zip
|--{journal-code-online}.ahead-of-print OR
|--{journal-code-online}.just-accepted
| |--{article-id}
| | |--{article-id}.xml
| | |--{article-id}.pdf
| | |--graphic
| | | |--figure files
| | |--suppl
| | | |--supplementary files
| | |--media
| | | |--media filesEach Ahead of Print or Just Accepted Article delivery must contain only one Article XML and PDF file. Graphic, media and Supplementary files are optional.
Pub Med CentralPMC
For Pub Med Central do not create separate subdirectories for the article inside the package.
{pmc-code}-{article-id}.zip
|--{pmc-code}-{article-id}.pdf
|--{pmc-code}-{article-id}.xml
|--{pmc-code}-{article-id}-{typ}{no}.png
|--...
Links to graphic and media files must be adjusted accordingly.
Supplementary Material
Please always create an additional folder named “suppl” which contains the supplementary material for an article, a book chapter or the whole book. Please place the “suppl” folder in the book-chapter or article folder it belongs to.
These files are allowed for supplementary material:
html | htm | css | ico | js | pdf | png | jpeg | jpg | gif | xls | xlsx |
doc | docx | csv | txt | ppt | flv | fla | mrc | mpg | mpeg | zip | mov | csv |
wmv | rar | pptx | tsv | wma | avi | mp4 | m4v | cif | ogg | webm | oga | weba |
acc | mp3 | epub | wav | odt | ods | odp | dot | dotx | m4a
In case you receive files in a different format than mentioned above please put them in a zip file which combines all supplementary data.
References
- [1] De Gruyter Wiki: Variables and IDs
- [2] Book Interchange Tag Suite (BITS) Version 2.0 Tag Library [February 2016]
- [3] Journal Publishing Tag Library NISO JATS Version 1.1 [December 2015]
- [4] PubMed Central® web page
- [5] Pub Med Central: File Submission Specifications [June 2011]
- [6] Network Working Group: Key words for use in RFCs to Indicate Requirement Levels
- [7] De Gruyter Wiki: Atypon DTDs
- [8] De Gruyter Wiki: Law DTD
- [9] Available Schemas for the Book Interchange Tag Suite (BITS) Version 2.0
- [10] Available Schemas for the Journal Publishing Tag Set Version 1.1
- [11] DTD files for the Journal Publishing Tag Set Version 1.0
- [12] Github: World countries in JSON, CSV and XML and Yaml. countries.xml [Accessed: 2018-05-03]
- [13] W3C: Extensible Markup Language (XML) 1.0 (Fifth Edition). Well-Formed XML Documents [November 2008]
- [14] W3C: Extensible Markup Language (XML) 1.0 (Fifth Edition). Predefined Entities [November 2008]
- [15] A. N. S. Institute, "American National Standard Code for Information Interchange" 1977.
- [16] W3C: Extensible Markup Language (XML) 1.0 (Fifth Edition). Characters [November 2008]
- [17] The Unicode Consortium: Unicode Normalization Forms. [June 2014]
- [18] W3C: Character Model for the World Wide Web: String Matching and Searching.[July 2014]
- [19] W. Richard Ishida: Unicode Bidirectional Algorithm basics. [April 2013]
- [20] De Gruyter Wiki: Submission Checker Control Files
- [21] International Identifier for Serials: Access to the LTWA. 14/09/2017.
- [22] Wikipedia: Personal name. Name order
- [23] ORCID website.
- [24] Github: mledoze/countries.xml
- [25] Ringgold website.
- [26] Network Working Group: Internet Message Format
- [27] Network Working Group: Simple Mail Transfer Protocol
- [28] De Gruyter Wiki: Print Publication Dates
- [29] De Gruyter Wiki: Copyright Information
- [30] Wikipedia: ISO 8601
- [31] CrossRef: List of Funder Names.
- [32] Code Ocean, Inc.. Website [Accessed: 2018-05-24]
- [33] De Gruyter Wiki: Post Publication Correction Guidelines.
- [34] The ACM Computing Classification System (CCS)
- [35] Mulberry Technologies, Inc.: Tagging Figures, Graphics, and Multimedia. In: Journal Publishing Tag Library NISO JATS Version 1.1 [December 2015]
- [36] De Gruyter Wiki: Audio and Video Guidelines.
- [37] De Gruyter Wiki: Supplementary Material.
- [38] W3C: XHTML™ 2.0. XHTML Style Attribute Module [July 2004]
- [39] Wikipedia: Interlinear gloss
- [40] De Gruyter Wiki: Style Guide
- [41] Cross Ref: New CrossRef DOI display guidelines are on the way [September 2016]
- [42] PubMed Central: Sample PubMed Central Citations [May 2008]
Appendix
Standard Terms
| Content | English | German | French | Spanish |
|---|---|---|---|---|
| Abstract | Abstract | Zusammenfassung | Abstrait, Résumé | Resumen |
| accepted | accepted | angenommen | ||
| Acknowledgement | Acknowledgement | Danksagung, Danksagungen | Remerciements | |
| Appendix | Appendix, Appendices | Anhang | ||
| Article Note | Article Note, Note | Artikelnotiz, Notiz, Anmerkung | ||
| Bionotes | Bionotes, About the Author, Author Information | Autoreninformation | ||
| Book Review | Book Review | Buchrezension, Buchbesprechung | ||
| Classification | Classification | Klassifikation | ||
| Communicated by | Communicated by | Betreut von, Übermittelt von | ||
| Concluding Remark | Concluding Remark | Schlussbemerkung | ||
| Contents | Contents | Inhaltsverzeichnis | Índice | |
| Corresponding author | Corresponding author | Korrespondierender Autor, Korrespondenzautor, Kontakt, Kontaktperson | ||
| Cover image | Cover image | Umschlaggestaltung | ||
| Dedicated to xxx | Dedicated to xxx | xxx gewidmet | ||
| Editor in Chief | Editor in Chief, Edited by | Herausgegeben von | ||
| Editors | Editors | In Zusammenarbeit mit, Herausgeber | Editores | |
| Epilogue | Epilogue | Nachwort | ||
| Figure | Figure | Abbildung | Figure | |
| Author contributions | Author contributions | |||
| Research funding | Research funding | |||
| Employment or leadership | Employment or leadership | |||
| Honorarium | Honorarium | |||
| Conflict of Interest | Competing interests, Conflict of interest | |||
| Funding | Funding, Research Funding | Finanzierung | ||
| Graphical Abstract | Graphical Abstract | Grafische Zusammenfassung, Kurzzusammenfassung | ||
| History Dates | History Dates, Publication History Dates | Publikationsdaten | ||
| Index | Index | Verzeichnis | ||
| Issue | Issue | Heft | ||
| Keywords | Keywords, Descriptors | Schlüsselwörter, Schlüsselworte, Schlagwörter, Stichwörter, Deskriptoren | Descripteurs, Mots-clés | |
| List of Abbreviations | List of Abbreviations, Abbreviations | Abkürzungsverzeichnis | ||
| Preface | Preface | Geleitwort, Vorwort | ||
| previously published online | previously published online | vorab online veröffentlicht | ||
| Printing and binding | Printing and binding | Druck und Bindung | ||
| Published by | Published by | publiziert von | ||
| published online | published online | online veröffentlicht | ||
| received | received | erhalten, empfangen | ||
| Nomenclature | Notation, Symbols | Nomenklatur | ||
| Research Article | Research Article | Forschungsbeitrag | ||
| Review | Review | Rezension, Besprechung | Reseña | |
| reviewed by | reviewed by | rezensiert von | Compte rendu par | |
| revised | revised | überarbeitet | ||
| Special Issue | Special Issue | Themenheft | ||
| submitted | submitted | eingereicht | ||
| References | Bibliography, References | Literaturverzeichnis, Bibliographie, Literatur, Literaturangaben | Références | Bibliografía |
| Table | Table | Tabelle | Tableau | |
| Typesetting | Typesetting | Satz, Schriftsatz | ||
| Volume | Volume | Band | Número |
Metadata fields within the OPS
Editable elements
| Element | XPATH |
|---|---|
| Corresponding Author |
/article/article-meta/contrib-group/contrib/@corresp
|
| Surname |
/article/article-meta/contrib-group/contrib/name/surname
|
| Given Name |
/article/article-meta/contrib-group/contrib/name/given-names
|
| Prefix |
/article/article-meta/contrib-group/contrib/name/prefix
|
| Suffix |
/article/article-meta/contrib-group/contrib/name/suffix
|
| Author Portrait |
/article/front/article-meta/contrib-group/contrib/bio/fig[@fig-type="contrib"]
|
| Author Bio |
/article/front/article-meta/contrib-group/contrib/bio
|
| Author Email |
/article/front/article-meta/contrib-group/contrib/email
|
| Author Affiliation |
/article/front/article-meta/contrib-group/aff
|
| Author Notes to Correspondence |
/article/front/article-meta/author-notes/corresp
|
| Author General Notes |
/article/front/article-meta/author-notes
|
| Abstract Text |
/article/front/article-meta/abstract/p or /article/front/article-meta/abstract/sec/p
|
| Graphical Abstract Figure |
/article/front/article-meta/abstract[@abstract-type="graphical"]/p/fig/graphic
|
| Translated Abstract Text |
/article/front/article-meta/trans-abstract/p or /article/front/article-meta/trans-abstract/sec/p
|
| Keywords/Translated Keywords |
/article/front/article-meta/kwd-group[not(@kwd-group-type)]/kwd
|
| Classification Codes |
/article/front/article-meta/kwd-group[@kwd-group-type]/kwd
|
| Funding Source |
/article/front/article-meta/funding-group/award-group/funding-source
|
| Award ID |
/article/front/article-meta/funding-group/award-group/award-id
|
| Funding Statement |
/article/front/article-meta/funding-group/funding-statement
|
| Correction Note Text |
/article/front/notes[@notes-type="added-post-electronic-publication"]
|
| Elements within Element Citation |
/article/back/ref-list/ref/element-citation//*[not(*)]
|
Not editable elements
| Element | XPATH |
|---|---|
| K&P-Code (abbr.) |
/article/front/journal-meta/journal-id[@journal-id-type="publisher-id"]
|
| Journal-Code Online (abbr.) |
/article/front/journal-meta/journal-id[@journal-id-type="journal-code"]
|
| DOI-Code (abbr.) |
/article/front/journal-meta/journal-id[@journal-id-type="doi-code"]
|
| Journal Title |
/article/front/journal-meta/journal-title-group/journal-title
|
| e-ISSN |
/article/front/journal-meta/issn[@pub-type="epub"]
|
| ISSN |
/article/front/journal-meta/issn[@pub-type="ppub"]
|
| Publisher |
/article/front/journal-meta/publisher/publisher-name
|
| Article-ID |
/article/front/article-meta/article-id[@pub-id-type="publisher-id"]
|
| DOI |
/article/front/article-meta/article-id[@pub-id-type="doi"]
|
| Article Print Date |
/article/front/article-meta/pub-date[@pub-type="ppub"]
|
| Article Online Date |
/article/front/article-meta/pub-date[@pub-type="epub"]
|
| Volume |
/article/front/article-meta/volume
|
| Issue |
/article/front/article-meta/issue
|
| Received-Date |
/article/front/article-meta/history/date[@date-type="received"]
|
| Revised-Date |
/article/front/article-meta/history/date[@date-type="rev-recd"]
|
| Accepted-Date |
/article/front/article-meta/history/date[@date-type="accepted"]
|
| Copyright Statement |
/article/front/article-meta/permissions/copyright-statement
|
| Copyright Year |
/article/front/article-meta/permissions/copyright-year
|
| Copyright Holder |
/article/front/article-meta/permissions/copyright-holder
|
| License |
/article/front/article-meta/permissions/license/@license-type
|
| License Text |
/article/front/article-meta/permissions/license/license-p
|
| Supplementary Material |
/article/front/article-meta/related-article[@related-article-type="supplement"]/@xlink:href
|
| Abstract Title |
/article/front/article-meta/abstract[not(@abstract-type="graphical")]/title
|
| Graphical Abstract Title |
/article/front/article-meta/abstract[@abstract-type="graphical"]/title
|
| Translated Abstract Title |
/article/front/article-meta/trans-abstract/title
|
| Keywords Title |
/article/front/article-meta/kwd-group[not(@kwd-group-type
or @xml:lang]/title
|
| Translated Keywords Title |
/article/front/article-meta/kwd-group[@xml:lang]/title
|
| Classification Codes Title |
/article/front/article-meta/kwd-group[@kwd-group-type]/title
|
| Page Count |
/article/front/article-meta/counts/page-count/@count
|
| Subject Group |
/article/front/article-meta/article-categories/subj-group/subject
|
| Article Title |
/article/front/article-meta/title-group/article-title
|
| Article Subtitle |
/article/front/article-meta/title-group/subtitle
|
| Translated Title |
/article/front/article-meta/title-group/trans-title-group/trans-title
|
| Translated Subtitle |
/article/front/article-meta/title-group/trans-title-group/trans-subtitle
|
| Mixed Citation |
/article/back/ref-list/ref/mixed-citation
|
Allowed Unicode Ranges
| from | to | Block | Character Name | Allowed in De Gruyter XML PCDATA |
|---|---|---|---|---|
| U+0000 | U+0008 | Control character | no | |
| U+0009 | U+000A | Control character | Horizontal tab, Line Feed | yes |
| U+000B | U+000C | Control character | Vertical tab, Form feed | no |
| U+000D | U+000D | Control character | Carriage return | yes |
| U+000E | U+001F | Control character | no | |
| U+0020 | U+007F | Basic Latin | yes | |
| U+0080 | U+009F | Latin-1 Supplement | no | |
| U+00A0 | U+00A0 | Latin-1 Supplement | Non-breaking space | yes |
| U+00A1 | U+00FF | Latin-1 Supplement | yes | |
| U+0100 | U+017F | Latin Extended-A | yes | |
| U+0180 | U+024F | Latin Extended-B | yes | |
| U+0250 | U+02AF | IPA Extensions | yes | |
| U+02B0 | U+02FF | Spacing Modifier Letters | yes | |
| U+0300 | U+036F | Combining Diacritical Marks | yes | |
| U+0370 | U+03FF | Greek and Coptic | yes | |
| U+0400 | U+04FF | Cyrillic | yes | |
| U+0500 | U+052F | Cyrillic Supplement | no | |
| U+0530 | U+058F | Armenian | yes | |
| U+0590 | U+05FF | Hebrew | yes | |
| U+0600 | U+06FF | Arabic | yes | |
| U+0700 | U+074F | Syriac | yes | |
| U+0750 | U+077F | Arabic Supplement | yes | |
| U+0780 | U+07BF | Thaana | yes | |
| U+07C0 | U+07FF | NKo | yes | |
| U+0800 | U+083F | Samaritan | no | |
| U+0840 | U+086F | Mandaic | no | |
| U+08A0 | U+08FF | Arabic Extended-A | no | |
| U+0900 | U+097F | Devanagari | yes | |
| U+0980 | U+09FF | Bengali | yes | |
| U+0A00 | U+0A7F | Gurmukhi | yes | |
| U+0A80 | U+0AFF | Gujarati | yes | |
| U+0B00 | U+0B7F | Oriya | yes | |
| U+0B80 | U+0BFF | Tamil | yes | |
| U+0C00 | U+0C7F | Telugu | yes | |
| U+0C80 | U+0CFF | Kannada | yes | |
| U+0D00 | U+0D7F | Malayalam | yes | |
| U+0D80 | U+0DFF | Sinhala | yes | |
| U+0E00 | U+0E7F | Thai | yes | |
| U+0E80 | U+0EFF | Lao | yes | |
| U+0F00 | U+0FCF | Tibetan | yes | |
| U+0FD0 | U+0FDA | Tibetan | no | |
| U+0FDB | U+0FFF | Tibetan | yes | |
| U+1000 | U+109F | Myanmar | no | |
| U+10A0 | U+10FF | Georgian | yes | |
| U+1100 | U+11FF | Hangul Jamo | yes | |
| U+1200 | U+137F | Ethiopic | yes | |
| U+1380 | U+139F | Ethiopic Supplement | yes | |
| U+13A0 | U+13FF | Cherokee | yes | |
| U+1400 | U+167F | Unified Canadian Aboriginal Syllabics | yes | |
| U+1680 | U+169F | Ogham | yes | |
| U+16A0 | U+16FF | Runic | yes | |
| U+1700 | U+171F | Tagalog | no | |
| U+1720 | U+173F | Hanunoo | no | |
| U+1740 | U+175F | Buhid | no | |
| U+1760 | U+177F | Tagbanwa | no | |
| U+1780 | U+17FF | Khmer | yes | |
| U+1800 | U+18AF | Mongolian | yes | |
| U+18B0 | U+18FF | Unified Canadian Aboriginal Syllabics Extended | yes | |
| U+1900 | U+194F | Limbu | no | |
| U+1950 | U+197F | Tai Le | yes | |
| U+1980 | U+19DF | New Tai Lue | yes | |
| U+19E0 | U+19FF | Khmer Symbols | yes | |
| U+1A00 | U+1A1F | Buginese | no | |
| U+1A20 | U+1AAF | Tai Tham | no | |
| U+1AB0 | U+1AFF | Combining Diacritical Marks Extended | no | |
| U+1B00 | U+1B7F | Balinese | no | |
| U+1B80 | U+1BBF | Sundanese | no | |
| U+1BC0 | U+1BFF | Batak | no | |
| U+1C00 | U+1C4F | Lepcha | no | |
| U+1C50 | U+1C7F | Ol Chiki | yes | |
| U+1C80 | U+1C8F | Cyrillic Extended C | yes | |
| U+1CC0 | U+1CCF | Sundanese Supplement | no | |
| U+1CD0 | U+1CFF | Vedic Extensions | no | |
| U+1D00 | U+1D7F | Phonetic Extensions | yes | |
| U+1D80 | U+1DBF | Phonetic Extensions Supplement | yes | |
| U+1DC0 | U+1DCA | Combining Diacritical Marks Supplement | yes | |
| U+1DCB | U+1DFD | Combining Diacritical Marks Supplement | no | |
| U+1DFE | U+1DFF | Combining Diacritical Marks Supplement | yes | |
| U+1E00 | U+1EFF | Latin Extended Additional | yes | |
| U+1F00 | U+1FFF | Greek Extended | yes | |
| U+2000 | U+2027 | General Punctuation | yes | |
| U+2028 | U+202E | General Punctuation | no | |
| U+202F | U+206F | General Punctuation | yes | |
| U+2070 | U+209F | Superscripts and Subscripts | yes | |
| U+20A0 | U+20CF | Currency Symbols | yes | |
| U+20D0 | U+20FF | Combining Diacritical Marks for Symbols | yes | |
| U+2100 | U+214F | Letterlike Symbols | yes | |
| U+2150 | U+218F | Number Forms | yes | |
| U+2190 | U+21FF | Arrows | yes | |
| U+2200 | U+22FF | Mathematical Operators | yes | |
| U+2300 | U+23FF | Miscellaneous Technical | yes | |
| U+2400 | U+243F | Control Pictures | yes | |
| U+2440 | U+245F | Optical Character Recognition | yes | |
| U+2460 | U+24FF | Enclosed Alphanumerics | yes | |
| U+2500 | U+257F | Box Drawing | yes | |
| U+2580 | U+259F | Block Elements | yes | |
| U+25A0 | U+25FF | Geometric Shapes | yes | |
| U+2600 | U+26AF | Miscellaneous Symbols | yes | |
| U+26B0 | U+26FF | Miscellaneous Symbols | no | |
| U+2700 | U+27BF | Dingbats | yes | |
| U+27C0 | U+27EF | Miscellaneous Mathematical Symbols-A | yes | |
| U+27F0 | U+27FF | Supplemental Arrows-A | yes | |
| U+2800 | U+28FF | Braille Patterns | yes | |
| U+2900 | U+297F | Supplemental Arrows-B | yes | |
| U+2980 | U+29FF | Miscellaneous Mathematical Symbols-B | yes | |
| U+2A00 | U+2AFF | Supplemental Mathematical Operators | yes | |
| U+2B00 | U+2BFF | Miscellaneous Symbols and Arrows | no | |
| U+2C00 | U+2C5F | Glagolitic | yes | |
| U+2C60 | U+2C7F | Latin Extended-C | yes | |
| U+2C80 | U+2CF3 | Coptic | yes | |
| U+2CF4 | U+2CF8 | Coptic | no | |
| U+2CF9 | U+2CFF | Coptic | yes | |
| U+2D00 | U+2D2F | Georgian Supplement | no | |
| U+2D30 | U+2D65 | Tifinagh | yes | |
| U+2D66 | U+2D7F | Tifinagh | no | |
| U+2D80 | U+2DDF | Ethiopic Extended | yes | |
| U+2DE0 | U+2DFF | Cyrillic Extended-A | no | |
| U+2E00 | U+2E3B | Supplemental Punctuation | yes | |
| U+2E3C | U+2E7F | Supplemental Punctuation | no | |
| U+2E80 | U+2EFF | CJK Radicals Supplement | yes | |
| U+2F00 | U+2FDF | Kangxi Radicals | yes | |
| U+2FF0 | U+2FFF | Ideographic Description Characters | yes | |
| U+3000 | U+303F | CJK Symbols and Punctuation | yes | |
| U+3040 | U+309F | Hiragana | yes | |
| U+30A0 | U+30FF | Katakana | yes | |
| U+3100 | U+312F | Bopomofo | yes | |
| U+3130 | U+318F | Hangul Compatibility Jamo | yes | |
| U+3190 | U+319F | Kanbun | yes | |
| U+31A0 | U+31BF | Bopomofo Extended | yes | |
| U+31C0 | U+31EF | CJK Strokes | no | |
| U+31F0 | U+31FF | Katakana Phonetic Extensions | yes | |
| U+3200 | U+32FF | Enclosed CJK Letters and Months | no | |
| U+3300 | U+33FF | CJK Compatibility | yes | |
| U+3400 | U+4DBF | CJK Unified Ideographs Extension A | yes | |
| U+4DC0 | U+4DFF | Yijing Hexagram Symbols | yes | |
| U+4E00 | U+9FFF | CJK Unified Ideographs | yes | |
| U+A000 | U+A48F | Yi Syllables | yes | |
| U+A490 | U+A4CF | Yi Radicals | no | |
| U+A4D0 | U+A4FF | Lisu | no | |
| U+A500 | U+A63F | Vai | no | |
| U+A640 | U+A69F | Cyrillic Extended-B | no | |
| U+A6A0 | U+A6FF | Bamum | no | |
| U+A700 | U+A71F | Modifier Tone Letters | no | |
| U+A720 | U+A7B7 | Latin Extended-D | yes | |
| U+A7B8 | U+A7F6 | Latin Extended-D | no | |
| U+A7F7 | U+A7FF | Latin Extended-D | yes | |
| U+A800 | U+A82F | Syloti Nagri | no | |
| U+A830 | U+A83F | Common Indic Number Forms | no | |
| U+A840 | U+A87F | Phags-pa | no | |
| U+A880 | U+A8DF | Saurashtra | no | |
| U+A8E0 | U+A8FF | Devanagari Extended | no | |
| U+A900 | U+A92F | Kayah Li | no | |
| U+A930 | U+A95F | Rejang | no | |
| U+A960 | U+A97F | Hangul Jamo Extended-A | no | |
| U+A980 | U+A9DF | Javanese | no | |
| U+AA00 | U+AA5F | Cham | no | |
| U+AA60 | U+AA7F | Myanmar Extended-A | no | |
| U+AA80 | U+AADF | Tai Viet | no | |
| U+AAE0 | U+AAFF | Meetei Mayek Extensions | no | |
| U+AB00 | U+AB2F | Ethiopic Extended-A | no | |
| U+ABC0 | U+ABFF | Meetei Mayek | no | |
| U+AC00 | U+D7AF | Hangul Syllables | yes | |
| U+D7B0 | U+D7FF | Hangul Jamo Extended-B | no | |
| U+D800 | U+DB7F | High Surrogates | no | |
| U+DB80 | U+DBFF | High Private Use Surrogates | no | |
| U+DC00 | U+DFFF | Low Surrogates | no | |
| U+E000 | U+F8FF | Private Use Area | no | |
| U+F900 | U+FA6A | CJK Compatibility Ideographs | yes | |
| U+FA6B | U+FAFF | CJK Compatibility Ideographs | yes | |
| U+FB00 | U+FB0F | Alphabetic Presentation Forms | no | |
| U+FB10 | U+FB4F | Alphabetic Presentation Forms | yes | |
| U+FB50 | U+FDFF | Arabic Presentation Forms-A | yes | |
| U+FE00 | U+FE0F | Variation Selectors | no | |
| U+FE10 | U+FE1F | Vertical Forms | no | |
| U+FE20 | U+FE2F | Combining Half Marks | no | |
| U+FE30 | U+FE4F | CJK Compatibility Forms | yes | |
| U+FE50 | U+FE6F | Small Form Variants | yes | |
| U+FE70 | U+FEFF | Arabic Presentation Forms-B | yes | |
| U+FF00 | U+FFEF | Halfwidth and fullwidth forms | yes | |
| U+FFF0 | U+FFFF | Specials | no | |
| U+10000 | U+1007F | Linear B Syllabary | no | |
| U+10080 | U+100FF | Linear B Ideograms | no | |
| U+10100 | U+1013F | Aegean Numbers | no | |
| U+10140 | U+1018F | Ancient Greek Numbers | no | |
| U+10190 | U+101CF | Ancient Symbols | no | |
| U+101D0 | U+101FF | Phaistos Disc | no | |
| U+10280 | U+1029F | Lycian | no | |
| U+102A0 | U+102DF | Carian | no | |
| U+10300 | U+10323 | Old Italic | yes | |
| U+10324 | U+1032F | Old Italic | no | |
| U+10330 | U+1034F | Gothic | yes | |
| U+10380 | U+1039F | Ugaritic | no | |
| U+103A0 | U+103DF | Old Persian | no | |
| U+10400 | U+1044F | Deseret | no | |
| U+10450 | U+1047F | Shavian | no | |
| U+10480 | U+104AF | Osmanya | yes | |
| U+10800 | U+1083F | Cypriot Syllabary | no | |
| U+10840 | U+1085F | Imperial Aramaic | no | |
| U+10900 | U+1091F | Phoenician | no | |
| U+10920 | U+1093F | Lydian | no | |
| U+10980 | U+1099F | Meroitic Hieroglyphs | no | |
| U+109A0 | U+109FF | Meroitic Cursive | no | |
| U+10A00 | U+10A5F | Kharoshthi | no | |
| U+10A60 | U+10A7F | Old South Arabian | no | |
| U+10B00 | U+10B3F | Avestan | no | |
| U+10B40 | U+10B5F | Inscriptional Parthian | no | |
| U+10B60 | U+10B7F | Inscriptional Pahlavi | no | |
| U+10C00 | U+10C4F | Old Turkic | yes | |
| U+10E60 | U+10E7F | Rumi Numeral Symbols | no | |
| U+11000 | U+1107F | Brahmi | no | |
| U+11080 | U+110CF | Kaithi | no | |
| U+110D0 | U+110FF | Sora Sompeng | no | |
| U+11100 | U+1114F | Chakma | no | |
| U+11180 | U+111DF | Sharada | no | |
| U+11680 | U+116CF | Takri | no | |
| U+12000 | U+123FF | Cuneiform | no | |
| U+12400 | U+1247F | Cuneiform Numbers and Punctuation | no | |
| U+13000 | U+1342F | Egyptian Hieroglyphs | no | |
| U+16800 | U+16A3F | Bamum Supplement | no | |
| U+16F00 | U+16F9F | Miao | no | |
| U+1B000 | U+1B0FF | Kana Supplement | no | |
| U+1D000 | U+1D0FF | Byzantine Musical Symbols | no | |
| U+1D100 | U+1D1FF | Musical Symbols | no | |
| U+1D200 | U+1D24F | Ancient Greek Musical Notation | no | |
| U+1D300 | U+1D35F | Tai Xuan Jing Symbols | yes | |
| U+1D360 | U+1D37F | Counting Rod Numerals | no | |
| U+1D400 | U+1D7FF | Mathematical Alphanumeric Symbols | yes | |
| U+1EE00 | U+1EEFF | Arabic Mathematical Alphabetic Symbols | no | |
| U+1F000 | U+1F02F | Mahjong Tiles | no | |
| U+1F030 | U+1F09F | Domino Tiles | no | |
| U+1F0A0 | U+1F0FF | Playing Cards | no | |
| U+1F100 | U+1F1FF | Enclosed Alphanumeric Supplement | no | |
| U+1F200 | U+1F2FF | Enclosed Ideographic Supplement | no | |
| U+1F300 | U+1F5FF | Miscellaneous Symbols and Pictographs | no | |
| U+1F600 | U+1F64F | Emoticons (Emoji) | no | |
| U+1F680 | U+1F6FF | Transport and Map Symbols | no | |
| U+1F700 | U+1F77F | Alchemical Symbols | no | |
| U+20000 | U+2A6DF | CJK Unified Ideographs Extension B | yes | |
| U+2A700 | U+2B73F | CJK Unified Ideographs Extension C | no | |
| U+2B740 | U+2B81F | CJK Unified Ideographs Extension D | no | |
| U+2F800 | U+2FA1F | CJK Compatibility Ideographs Supplement | no | |
| U+E0000 | U+E007F | Tags | no | |
| U+E0100 | U+E01EF | Variation Selectors Supplement | no | |
| U+F0000 | U+FFFFF | Supplementary Private Use Area-A | no | |
| U+100000 | U+10FFFF | Supplementary Private Use Area-B | no |