Skip to content

Template Files

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

The easiest way to write a proof or definition for "The Book of Statistical Proofs" is to duplicate the proof template or definition template file, go through and edit them from top to bottom. Essentially, each of these proof templates consists of two sections.

Proof Template

The first section (currently up to line 28) consists of proof metadata and is written in YAML. When you edit this section, fill in as many fields of the metadata specification as you can, because this will ease cross-referencing in the archive and make proof properties machine-readable.

---
layout: proof
mathjax: true

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

title: "Proof Template"
chapter: "Name of the chapter"
section: "Name of the section"
topic: "Name of the topic"
theorem: "Name of the theorem"

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"

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

The second section (currently starting from line 31) consists of the proof itself and is written in Markdown and LaTeX. When you edit this section, observe our advice for using LaTeX, e.g. be sure to use $...$ for in-line math, $$...$$ for stand-alone equations and give a label to each equation.

**Theorem:** Let there be [something](/D/-temp-). Then

$$ \label{eq:Theorem}
\textbf{an equation belonging to the theorem}
$$

if $\textbf{some conditions}$ are fulfilled.


**Proof:** Given [something](/D/-temp-), it holds that

$$ \label{eq:Proof}
\textbf{an equation belonging to the proof}
$$

which completes the proof of \eqref{eq:Theorem}.

Definition Template

The first section (currently up to line 28) consists of definition metadata and is written in YAML. When you edit this section, fill in as many fields of the metadata specification as you can, because this will ease cross-referencing in the archive and make definition properties machine-readable.

---
layout: definition
mathjax: true

author: "Joram Soch"
affiliation: "BCCN Berlin"
e_mail: "joram.soch@bccn-berlin.de"
date: 2020-01-22 07:50:00

title: "Definition Template"
chapter: "Name of the chapter"
section: "Name of the section"
topic: "Name of the topic"
definition: "Name of the definition"

sources:
  - authors: "Author(s) of the source of the definition*"
    year: year when published*
    title: "Title of the source of the definition*"
    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"

def_id: "D0"
shortcut: "-temp-"
username: "StatProofBook"
---

The second section (currently starting from line 31) consists of the definition itself and is written in Markdown and LaTeX. When you edit this section, observe our advice for using LaTeX, e.g. be sure to use $...$ for in-line math, $$...$$ for stand-alone equations and give a label to each equation.

**Definition:** An entity is called something, if

$$ \label{eq:Definition}
\textbf{an equation belonging to the definition}
$$

where $\textbf{some variables}$ are clarified.
Clone this wiki locally