Direkt zum Hauptinhalt

Fields to be used in templates

This section contains a list of all fields you can currently use in templates.

Notation: List<Person> = a list of values with the type Person,

Project Metadata

Prefix: metadata.
(e.g. metadata.title prints the book title)

Field
 Type (string/number/list/type/bool)
 Optional (true/false)
 Description
title
 string
 false
 Project title
subtitle
 string
 true
 Project subtitle
authors
 List<Person>
 false (but may be empty)
 List of all authors, either added to the project or to one of the (sub)sections
editors
 List<Person>
 false (but may be empty)
 List of all editors, either added to the project or to one of the (sub)sections
web_url
 string
 true
 URL to a web version of this project (e.g. blog symposium)
identifiers
 List<Identifier>
 true
 List of identifiers, e.g. ISBNs, DOIs, etc.
published string
 true
 publish date as string in dd.mm.YYYY format
languages
 List<Language>
 true
 project language(s)
number_of_pages
 number
 true
 currently not used
short_abstract
 string
 true
 short abstract / content summary
long_abstract
 string
 true
 long abstract / content summary
keywords
 List<Keyword>
 true
 List of keywords with optional gnd identifier
ddc
 string
 true DDC class
license
 License
 true

License of the publication - either Creative Commons or a custom license.

 

Variants:

  • CC0
  • CC_BY_4
  • CC_BY_SA_4
  • CC_BY_ND_4
  • CC_BY_NC_4
  • CC_BY_NC_SA_4
  • CC_BY_NC_ND_4
  • other (contains a string)
series
 string
 true
 Series this publication belongs to
volume
 string
 true
 Volume this publication belongs to
edition
 string
 true
 Edition of this publication
publisher
 string
 true
 Publisher of this publication

Person

Field
 Type (string/number/list/type/bool)
 Optional (true/false)
 Description
id
 string
 true
 internal unique id
first_names
 string
 true
 one or more first names
last_names
 string
 false
 one or more last names
orcid
 Identifier
 true
 ORCID (Open Researcher and Contributor ID)
gnd
 Identifier
 true
 GND (Gemeinsame Normdatei)
bios
 List<Biography>
 true
 list of biographies for this person, with specified language
ror
 Identifier true
 ROR (Research Organization Registry ID)

Identifier

Field
 Type (string/number/list/type/bool)
 Optional (true/false)
 Description
id
 string
 true
 internal unique id
name
 string
 false
 custom name of the identifier (e.g. "ebook ISBN)
value
 string
 false
 value of the identifier (e.g. the ISBN)
identifier_type
 IdentifierType
 false
 Identifier Type - one of these variants:
  • DOI
  • ISBN
  • ISSN
  • URL
  • URN
  • ORCID
  • ROR
  • GND
  • Other (contains a string)

Language

One of these variants:

  • DE
  • EN

Biography

Field
 Type (string/number/list/type/bool)
 Optional (true/false)
 Description
content
 string
 false
 the biography
lang
 Language
 true
 language of the biography

Keyword

Field
 Type (string/number/list/type/bool)
 Optional (true/false)
 Description
title
 string
 false the keyword
gnd
 Identifier
 true
 GND belonging to this keyword

Project Settings

Prefix: settings.
(e.g. settings.cover_image_path)

Note: settings is an optional field

Field
 Type (string/number/list/type/bool)
 Optional (true/false)
 Description
toc_enabled
 bool
 false
 Whetether a table of contents should be shown
csl_style
 string
 true name of the enabled csl (citation style language)
csl_language_code
 string
 true
 used language code for csl
metadata_page_additional_html
 string
 true
 Information to be shown on the metadata/imprint page
cover_image_path
 string
 true
 filename of the cover image. You can include the image with <img src="uploads/{{settings.cover_image_path}}">
backcover_image_path
 string
 true
 filename of the backcover image. You can include the image with <img src="uploads/{{settings.backcover_image_path}}">

Sections (Project Contents)Contents

sections is a List of Sections.

Example to print all section titles:

{{#each sections}}
<h1>{{metadata.title}}</h1>
{{/each}}

Section

Field
Type (string/number/list/type/bool)
Optional (true/false)
Description
id string false unique section id sub_sections List<Section> false (but can be empty) a (nested) list of sections children List<ContentBlock> false (but can be empty) content blocks of this section metadata SectionMetadata false Metadata of this section visible_in_toc bool false whetether this section should be shown in the toc 
endnotes List<Endnote> false (but can be empty) list of endnotes used in this section

ContentBlock

Field
Type (string/number/list/type/bool)
Optional (true/false)
Description
id string false unique content block id block_type BlockType false

BlockType variants:

    Paragraph Heading Raw List Quote Image html string false

    content of this block as html

    SectionMetadata

    Field
    Type (string/number/list/type/bool)
    Optional (true/false)
    Description
    title string false title of this section toc_title_override string true optional version of the title for the table of contents subtitle string true subtitle of this section toc_subtitle_override string true optional version of the subtitle for the table of contents authors List<Person> false (but can be empty) authors of this section editors List<Person> false (but can be empty) editors of this section web_url string true url to web version of this section (e.g. blog post) identifiers List<Identifier> false (but can be empty) identifiers of this section (e.g. chapter doi) published string true date the section was published lang Language false language of this section

    Endnote

    Field
    Type (string/number/list/type/bool)
    Optional (true/false)
    Description
    num number false number of the endnote in this section id string false unique id of the endnote content string false formatted endnote as html
    nach oben