Skip to content

Metadata Fields

Jump to bottom
The Book of Statistical Proofs edited this page Mar 31, 2020 · 6 revisions

The metadata specification in the header of the template files helps to automatically generate a proof or definition page and makes submission properties machine-readable. It consists of the following five sections.

1. Default properties that may not be changed

In the proof template, these properties read as follows:

layout: proof
mathjax: true

In the definition template, these properties read as follows:

layout: definition
mathjax: true

There is no need to change the values of these properties when writing a proof or definition.

2. Information about the submitter of the proof or definition

This section consists of the following properties:

author: "Joram Soch"
affiliation: "BCCN Berlin"
e_mail: "joram.soch@bccn-berlin.de"
date: 2019-09-27 16:40:00

The field date is required and contains date and time in the ISO date format "YYYY-MM-DD HH:MM:SS". The field author is required, but you may use an alias, pseudonym or GitHub username (see below), if you do not want to share your personal name. The fields affiliation and e_mail are optional, but sharing contact information is highly advisable for questions regarding your submission.

3. Hierarchy information locating a page in the Table of Contents

This section includes taxonomical information, placing a page in the currently accepted page hierarchy:

title: "Template for The Book of Statistical Proofs"
chapter: "Name of the chapter"
section: "Name of the section"
topic: "Name of the topic"
theorem: "Name of the theorem"

In the definition template, the last line reads as follows:

definition: "Name of the definition"

For further information, please see:

4. Sources used when writing down this proof or definition

This section includes bibliogaphical information, used to automatically generate references for providing sources of the submission:

sources:
  - authors: "Author(s) of the source of the proof*"
    year: year when published*
    title: "Title of the source of the proof*"
    in: "Title of monography or name of journal**"
    pages: "volume, issue and/or page information** [* required, ** optional]"
    url: "https://optional.url/to-source/"
    doi: "optional.doi/of.source"

In the definition template, the first three lines read as follows:

sources:
  - authors: "Author(s) of the source of the definition*"
    year: year when published*
    title: "Title of the source of the definition*"

The fields authors, year and title are required. The fields in, pages, url and doi are optional. For further information, please see:

5. Metadata that is displayed at the bottom of a page

This section contains basic proof and definition information, being displayed at the bottom of each submission.

proof_id: "P0"
shortcut: "-temp-"
username: "StatProofBook"

In the definition template, the first line reads as follows:

def_id: "D0"

For further information, please see:

Clone this wiki locally