Scope of Application
This document includes all variables and IDs that are needed to create final data for de Gruyter books and journals.
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 or journal 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]
-
Journals [J]
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 [2].
They are underlined throughout the document and its meaning is shown on mouse over.
Book and chapter variablesB
Title ID
The Title ID is an internal identifier to group all editions (Print, E-Book, EPUB) of a book publication.
Variable:
{title-id}
RegEx:
^\d{1,7}$
Example:
514363ISBNB
The ISBN is the International Standard Book Number, which is the international code
for identifying a particular version or printing of a book. Basically De Gruyter uses
a one or two print
ISBNs =
{isbn} and
{isbn_paperback}
as well as two electronic ISBNs – one for the ebook as pdf-version =
{eisbn_pdf}, and one for the epub version of a book =
{eisbn_epub}. In some cases there is a Set ISBN, this normally
represents a set of Print and Online edition.
Variable:
{isbn}, {isbn_paperback}, {eisbn_pdf}, {eisbn_epub}, {eisbn_set}
RegEx:
^(97[89])\d{9}(\d|X)$
Example:
9783110303568Chapter SuffixB
The chapter suffix is used to build unique IDs for each part of the book. Each chapter/book-part receives a specific number which should be a consecutive, unique number. The number must consist of three digits. If the chapter number has less than three digits it will be filled up with zeros.
The chapter-suffix may be used according to the chapter number while front- and backmatter sections could use chapter suffixes starting with "2":
Example:
Book
|-- Title pages: 201
|-- Preface: 202
|-- Acknowledgement: 203
|-- Table of Contents: 204
|-- Introduction: 001
|-- Chapter 1: 002
|-- Chapter 2: 003
|-- ...
|-- References: 016
|-- Index: 017The chapter-suffix may also be assigned according to the appearance within the book:
Example:
Book
|-- Title pages: 001
|-- Preface: 002
|-- Acknowledgement: 003
|-- Table of Contents: 004
|-- Introduction: 005
|-- Chapter 1: 006
|-- Chapter 2: 007
|-- ...
|-- References: 016
|-- Index: 017
Variable:
{chapter-suffix}
Regex:
^[0-9]{3}$
Part Suffix
Parts are used as first level structure for books and do not receive a DOI.
Nethertheless an ID is needed to uniquly identify this level of the book by using the
attribute
@id
.
The Part Suffix must be built
as follows:
Variable:
{part-suffix}
Regex:
^part[0-9]{1,2}$
Example:
part1, part14Volume Number BooksB
This variable contains the respective volume number of the book series.
Variable:
{volume-number-books}
RegEx:
^.+$
Example:
12, 2-3, 1.2Double volume numbers must be
separated with a hyphen (HYPHEN-MINUS).
Journal VariablesJ
Journal CodesJ
For electronic data processing the journal title will be abbreviated with special
journal codes. Three abbreviation codes could apply for a journal:
{journal-code}, {journal-code-online},
{doi-code}.
The {journal-code} will be used in internal systems.
The {journal-code-online} is important for the correct
publication on De Gruyter Online.
The {doi-code}
must be used to create the
DOI suffix.
Variable:
{journal-code},
{journal-code-online}, {doi-code}
Regex:
^[a-z]+$
Example:
probus; prbsArticle System Creation Date YearJ
This variable represents the year, the article has been received.
Variable:
{article-system-creation-date-year}
Regex:
^\d{4}$
Example:
2015Article Counter IDJ
This ID is used within the doi-suffix for journals.
Variable:
{article-counter-ID}
Regex:
^([0-9]{4})$
Example:
0685, 0001Article IDJ
This is a unique ID for an article. It is a combined value which is built as follows:
Variable:
{article-id}={doi-code}-{article-system-creation-date-year}-{article-counter-ID}
Example:
probus-2013-5001Elocation IDJ
This is an ID for an article in case traditional page numbers are not present. It is a combined value which is built as follows:
Variable:
{elocation-id}={article-system-creation-date-year}
{article-counter-ID}
Example:
20135001Article Delivery TypeJ
This is a string which identifies the type of an article delivery (just accepted or ahead of print).
Variable:
{article-delivery-type}
RegEx:
^(ja|aop)$
Issue Related IDsJ
These IDs and variables are used for issue-related information.
cover-date-yearJ
This variable contains the year, the issue was planned to be published.
Variable:
{cover-date-year}
RegEx:
^\d{4}$
Example:
2016Volume NumberJ
The variable {volume-number} contains the respective volume
number of the issue.
Variable:
{volume-number}
RegEx:
^[1-9]\d*(-[1-9]\d*)?$|^0{1}$
Example:
12, 2-3Double volume numbers must
be separated with a hyphen (HYPHEN-MINUS).
Issue NumberJ
The variable {issue-number} contains the respective issue
number.
Variable:
{issue-number}
RegEx:
^[1-9]\d*(-[1-9]\d*)?$|^s[1-9]\d*(-s[1-9]\d*)?$|^0{1}$
Example:
24, 5-6, s8Double issue numbers must
be separated with a hyphen (HYPHEN-MINUS).
Issue IDJ
This is a unique ID for an issue. It is a combined value which is built as follows:
Variable:
{issue-id}={journal-code-online}.{cover-date-year}.{volume-number}.issue-{issue-number}
Example:
prbs.2015.12.issue-2-3Frontmatter IDJ
This is a unique ID for a frontmatter of an issue. It is a combined value which is built as follows:
Variable:
{frontmatter-id}={doi-code}-{cover-date-year}-frontmatter{issue-number}
Example:
probus-2013-frontmatter5Graphical Abstract IDJ
This is a unique ID for a graphical abstract. It is a combined value which is built as follows:
Variable:
{graphical-abstract-id}={doi-code}-{cover-date-year}-graphabs{issue-number}
Example:
probus-2013-graphabs5TimestampJ
The time stamp is a string which must contain the timestamp of when a delivery was created. Please stick to UTC+1 (or CET) when creating the time stamp.
Date Pattern:
YYYY-MM-DD--HH-MM-SS
RegEx:
^\d{4}(-\d\d){2}-(-\d\d){3}$
Example:
2016-01-23--17-11-22ISSNJ
International Standard Serial Number, the international code that uniquely identifies
a serial publication title. De Gruyter uses two types of ISSNs: Print ISSN =
{issn} and e-ISSN = {e-issn}.
Variable:
{issn}, {e-issn}
RegEx:
^\d{4}-\d{3}[\dxX]$
Example:
2152-2812DOI
De Gruyter uses DOIs (digital object identifiers) to uniquely identify book parts and journal articles.
A DOI number consists of two parts – the publisher’s prefix and the suffix. The DOIs in the xml metadata file must be the same as in the article/chapter PDF-file.
DOI BooksB
Variable:
{DOI-book}={DOI-prefix}/{DOI-suffix-book}
Example:
10.1515/9783110303568DOI Book PartsB
Variable:
{DOI-book-part}={DOI-prefix}/{DOI-suffix-book-part}
Example:
10.1515/9783110303568-005DOI ArticlesJ
Variable:
{DOI-article}={DOI-prefix}/{DOI-suffix-articles}
Example:
10.1515/probus-2015-0068DOI Prefix
The prefix of a DOI is a single ID describing the publisher. For De Gruyter products the prefix always is 10.1515. For other publishers the prefix differs (please see section Publisher Names/DOI prefix for the respective publisher prefix and abbreviation).
Variable:
{DOI-prefix}
RegEx:
^10\.\d+$
Values: See section Publisher Names/DOI prefix
DOI Suffix
The DOI suffix differs between different types of publication.
RegEx:
^[a-zA-Z0-9\-\._;\(\)/]+$
BooksB
For books the
{eisbn_pdf}
is used as DOI-suffix.
Variable:
{DOI-suffix-books}={eisbn_pdf}
Example:
9783110303568Book PartsB
For regular chapters the
{eisbn_pdf}-{chapter-suffix}
and for parts the
{eisbn_pdf}-{part-suffix}
must be used as
DOI-suffix.
Variable:
{DOI-suffix-book-part}={eisbn_pdf}-({chapter-suffix}|{part-suffix})
Example:
9783110303568-001, 9783110303568-012, 9783110303568-part4Journal ArticlesJ
For journal articles the
{article-id}
must be used as
doi-suffix.
{DOI-suffix-articles}={article-id}
Example:
probus-2015-0068Publishing Partnerships
When building DOIs for products from publishing partners (e.g. Harvard University Press or Böhlau Verlag) the respective DOI prefixes for each publisher must be used. This is an example for an entire publishing partner book and book-part (Böhlau):
Examples:
10.7788/978341221331210.7788/9783412213312-052Please note that the DOI suffix structure may differ from the De Gruyter standard in content delivered for archive content. An existing DOI must not be changed!
IDs
IDs are mentioned separately because they are used within different elements for the
attribute @id as well as for file namings within XML files. Since
identifiers may not start with a digit, they start with the publication type
{pt}.
The length of an ID
must not exceeed 50
characters.
Publication Type
The publication type differentiates between book and journal publications.
Variable:
{pt}
RegEx:
^[b|j]$
Counter
The variable counter will be used within IDs and should, whenever possible, reflect the label or level of the corresponding element.
Variable:
{counter}
RegEx:
^([0-9]{3}[0-9]?[a-z]?)$
Example:
001, 123, 6885, 045aBook Part IDB
The book-part-id is used within the element <book-part>
to identify the chapter within a book.
{book-part-id}={pt}_{DOI-suffix}Example:
b_9783110302639-005Section Type
This variable is no longer needed. Elements other than
<sec> will use the Element-ID instead.
Section Information
The section information should reflect the level/label of the section.
Variable:
{section-information}=(_s_{counter})+
Example:
s_003_s_004Section ID
The section id is built from the publication type
({pt}), the
{DOI-suffix}
and the section information:
{section-id}={pt}_{DOI-suffix}_{section-information}
Examples:
b_9783110302639-005_s_001_s_002_s_003j_hsz-2013-0008_s_005_s_006For unnumbered sections, please number the id according to their appearance. If there’s a mixture between numbered and unnumbered sections, please assign the number decremental for the unnumbered sections, e.g. "b_9783110302639-005_s_002_s_999".
Element ID
Element IDs are used for specific XML elements within the attribute
@id as well as for file namings. It is built as follows:
{element-id}={pt}_{DOI-suffix}_{element-abbr.}_{counter}Please see the following tables for all id types and their structure:
| Name | Element |
{element-abbr.}
|
Example |
|---|---|---|---|
| Footnote |
<fn>
|
fn
|
b_9783110302639-005_fn_002
|
| Table Footnote |
<fn>
|
tfn
|
b_9783110302639-005_tfn_006
|
| Figure |
<fig>
|
fig
|
j_hsz-2013-0008_fig_011
|
| Inline Graphics |
<inline-graphic>
|
ingr
|
j_hsz-2013-0008_ingr_004
|
| Audio |
<fig>
|
audio
|
b_9783110302639-005_audio_007
|
| Video |
<fig>
|
video
|
j_hsz-2013-0008_video_011
|
| Table |
<table-wrap>
|
tab
|
b_9783110302639-005_tab_005
|
| Reference |
<ref>
|
ref
|
j_hsz-2013-0008_ref_023
|
| Boxed Text |
<boxed-text>
|
box
|
b_9783110302639-005_box_018
|
| Statement |
<statement>
|
stat
|
j_hsz-2013-0008_stat_007
|
| (Paragraph with) margin no. |
<p>, <margin-number>
|
mn
|
b_9783110302639-005_mn_018
|
| Lines with line no. |
<milestone-start>
|
line
|
j_hsz-2013-0008_line_007
|
| Equations |
<disp-formula>
|
eq
|
b_9783110302639-005_eq_002
|
| Inline Equations |
<inline-formula>
|
ineq
|
b_9783110302639-005_ineq_023
|
| List Item |
<list-item>
|
li
|
j_hsz-2013-0008_li_007
|
| Post Publication Correction |
<related-article>
|
ppc
|
j_hsz-2013-0008_ppc_007
|
| Acknowledgement |
<ack>
|
ack
|
b_9783110302639_ack_007
|
| Preface |
<preface>
|
preface
|
b_9783110302639_preface_007
|
| Notes |
<notes>
|
notes
|
j_hsz-2013-0008_notes_007
|
| Dedication |
<dedication>
|
dedic
|
b_9783110302639_dedic_007
|
| References |
<ref-list>
|
reflist
|
j_hsz-2013-0008_reflist_007
|
| Appendix |
<app>
|
app
|
b_9783110302639_app_007
|
| Glossary |
<glossary>
|
gloss
|
b_9783110302639_gloss_007
|
| Affiliation |
<aff>
|
aff
|
j_hsz-2013-0008_aff_007
|
| Index |
<index>
|
index
|
b_9783110302639_index_001
|
| Index Term |
<index-term>
|
index-term
|
b_9783110302639_index-term_006
|
| Programming Code |
<code>
|
code
|
j_cmam-2016-0011_code_002
|
| Normative text |
<norm>
|
n
|
b_9783110302639_n_002
|
For unnumbered elements, please number the id according to their appearance. If there’s a mixture between numbered and unnumbered elements, please assign the number decremental for the unnumbered elements, e.g. "b_9783110302639-005_eq_999".
For book publications you may
also use IDs referring to the entire book, such as Glossary or References. In this
case the {DOI-suffix} might as well be used from the
{DOI-book}:
Example:
b_9783110302639_gloss_007Counting ID
The {counting-id} is used to identify book titles and articles
for the german VG Wort [3] in order to count
electronic access to the content. It
should be build as
follows:
Variable:
{counting-id}=vgzm.{vg-wort-publisher-id}-{DOI-prefix}-{DOI-suffix}
Example:
vgzm.139533-10.1515-9783110709308References
Appendix
Publisher Names/DOI prefix
This is a list of allowed publisher names in combination with the DOI prefix
| publisher | DOI-prefix | Copyright Holder |
|---|---|---|
| Academic Studies Press | 10.1515 | |
| Ambra Verlag | 10.1515 | |
| Amsterdam University Press | 10.1515 | |
| ARC Humanities Press | 10.14361 | |
| Bielefeld University Press | 10.17302 | |
| Birkhäuser | 10.1515 | |
| Böhlau Verlag | 10.7788, 10.7767 | |
| Columbia University Press | 10.7312 | |
| Cornell University Press | 10.7591, 10.1515 | |
| De Gruyter | 10.1515, 10.21078, 10.1016, 10.3183, 10.1111 | |
| De Gruyter Oldenbourg | 10.1515 | |
| De Gruyter Akademie Forschung | 10.1515 | |
| De Gruyter Mouton | 10.1515, 10.5505 | |
| De Gruyter Open | 10.1515, 10.2478, 10.3889, 10.5146, 10.7151, 10.5937, 10.1007, 10.7206, 10.1685, 10.14432, 10.4103, 10.7250, 10.12847, 10.5372, 10.7603, 10.14636, 10.17795, 10.14611, 10.5901, 10.20309, 10.5277, 10.24190, 10.1016, 10.17225, 10.5604, 10.17930, 10.21042, 10.21454, 10.33894 | |
| düsseldorf university press | 10.2478 | |
| DETAIL | 10.11129 | |
| Fordham University Press | 10.1515 | |
| Gorgias Press | 10.31826, 10.1515 | |
| Gütersloher Verlagshaus | 10.14315 | |
| Harvard University Press | 10.4159 | |
| Iberoamericana Vervuert | , 10.31819 | |
| ISEAS–Yusof Ishak Institute Singapore | 10.1355 | |
| Lucius & Lucius | 10.1515 | |
| Mineralogical Society of America | 10.2138 | |
| Mineralogical Society | 10.1180 | |
| Multilingual Matters | 10.21832 | |
| New York University Press | 10.1515, 10.18574 | |
| Oldenbourg Wissenschaftsverlag | 10.1515, 10.1524 | |
| Princeton University Press | 10.1515, 10.23943 | |
| Rutgers University Press | 10.36019 | |
| RWS Verlag | 10.15375 | |
| Sciendo | 10.2478, 10.3889, 10.5146, 10.7151, 10.5937, 10.1515, 10.1007, 10.7206, 10.4103, 10.1685, 10.7250, 10.14432, 10.12847, 10.5372, 10.7603, 10.14636, 10.17795, 10.14611, 10.5901, 10.20309, 10.5277, 10.24190, 10.1016, 10.17225, 10.5604, 10.12914, 10.15611, 10.18559, 10.15388, 10.21454, 10.17930, 10.17738, 10.21042, 10.18778, 10.29316, ​10.30657, ​10.7569, 10.14446, 10.33894, 10.30657, 10.3933, 10.5617, 10.33924, 10.7569, 10.14746, 10.12775, 10.25019, 10.34768, 10.37705, 10.34763 | |
| Sellier – de Gruyter | 10.1515 | |
| sellier european law publishers | 10.1515 | |
| transcript Verlag | 10.14361 | |
| Turkish Society of Biochemistry | 10.5505 | |
| University of California Press | 10.1525 | |
| University of Chicago Press | 10.7208 | |
| University of Hawaii Press | 10.21313, 10.1515 | |
| University of Pennsylvania Press | 10.9783 | |
| University of Toronto Press | 10.3138 | |
| Vandenhoeck & Ruprecht | 10.1515 | |
| Verlag Dr. Otto Schmidt | 10.9785 | |
| Verlag der Zeitschrift für Naturforschung | 10.5560 | |
| Versita | 10.2478 | |
| Vincentz Network | 10.1515 | |
| Wolters Kluwer | 10.1515 | |
| Yale University Press | 10.12987 |