Skip to content

Metadata Fields

The Book of Statistical Proofs edited this page Jan 8, 2020 · 6 revisions

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

1. Default properties that may not be changed:

layout: proof
mathjax: true

2. Information about the submitter of the proof:

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

3. Taxonomy information locating a proof in the Table of Contents:

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"

4. Other theorems this proof depends on (with shortcut, if already in the archive):

dependencies:
  - theorem: "a theorem this proof depends on (with internal reference)"
    shortcut: "-temp-"
  - theorem: "another theorem this proof requires (without reference)"
    shortcut: 

5. Sources used when writing down this proof (author/year/title are required):

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"

6. Metadata that is displayed at the bottom of a proof page:

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

Clone this wiki locally