Chribel Summary Quarto

A quarto template, which can be used to write course summaries. It uses pdflatex!

Note

Chribel means doodle or scribbe in Swiss German. It has no meaning whatsoever, just sounds silly :)

Warning

This is not a definitive version of the template and still has a bunch of stuff which requires special attention. If time is sufficient I might turn some of the $\LaTeX$ components into Quarto properties.

Installing LaTeX

As it is a pdf document, it requires LaTeX. A smaller version of LaTeX called TinyTex can be installed via the documentation page Quarto - Installing TeX or via following command:

quarto install tinytex --update-path

--update-path is used, so other tools can also use this latex distribution!

Creating a New Document

To create a new document using this format, use the use quarto command in the terminal.

quarto use template joelvonrotz/chribel-summary-quarto

This will create a new directory with an example document that uses this format. Keep the file template_document.qmd and delete the others.

Using with an Existing Document

To add this format to an existing document:

quarto add joelvonrotz/chribel-summary-quarto

Then, add the format to your document options (variants shown below):

format: chribel-summary-quarto-pdf

format:
  chribel-summary-quarto-pdf:
    ... # for additional options

Note

As this template is based on the pdf-format, all the same options can be used. See Quarto: PDF Options

Warning

There might be some unwanted files added to it, such as template.png. Delete all the unwanted files!

Using in a project

To use the template for a project, run either commands from the previous chapter.

Method: `quarto add ...`

Create a _quarto.yml file and insert the minimum options. Following is with the example main_document.qmd

project:
  type: chribel-summary-quarto
  render:
    - main_document.qmd

Add other options from the Options chapter below or from the template documents.

Method: `quarto use ...`

Remove everything except _extentions-folder, _quarto.yml. Create a new main document such as main_document.qmd or summary_main.qmd and edit the render target in the _quarto.yml file. Following is with the example main_document.qmd

project:
  type: chribel-summary-quarto
  render:
    - main_document.qmd
...

Options

The template comes with a couple of options, of which some you might need to change, depending on your language and other stuff.

A lot of the options are the same as the ones from the Quarto PDF options.

Title & Subtitle

title: "Silly title for silly writing"
subtitle: "Course for silly writing"

Authors, Supervisors and Experts

Compared to the academic template, only one author is given. So if more people worked on the summary, just extend the field with the names.

author: "Author 1, Author 2 & Author 3"

Language

Two Quarto options are used for configuring the language.

lang: en-GB
babel-lang: ukenglish

Header and Footer

Header and footer are set using the LaTeX package fancyhdr. In the YAML header in the main document or _quarto.yml, the options are configured using following format:

fancyhdr:
  header:
    right:  "\\texttt{fancyhdr.header.right}"
    center: "\\texttt{fancyhdr.header.center}"
    left:   "\\texttt{fancyhdr.header.left}"
  footer:
    right:  "\\texttt{fancyhdr.footer.right}"
    center: "\\texttt{fancyhdr.footer.center}"
    left:   "\\texttt{fancyhdr.footer.left}"

An example would be:

fancyhdr:
  header:
    right: "\\nouppercase{\\rightmark}" # add current section title
    center: ""
    left: "Ass Kicking FS24"
  footer:
    right: "Cool Author 3000"
    center: "\\thepage\\ / \\pageref{LastPage}"
    left: "\\today"

Date Format

Changing the date format is a bit finicky, but it is possible. Following example sets the date format to 'DD.MM.YYYY'.

\usepackage[datesep=.]{datetime2}
\DTMsetdatestyle{ddmmyyyy}

or in the project YAML or document frontmatter

format:
  chribel-academic-quarto-pdf:
    include-in-header:
    - text: "\\usepackage[datesep=.]{datetime2}"
    - text: "\\DTMsetdatestyle{ddmmyyyy}"

Important

\today needs to be replaced with \DTMtoday in the document.

Github Link

If you want to link the source or the document itself, you can use the source option

source:
  github: "url/to/document.pdf"

Font-Family

By default no fonts are set (the default LaTeX font is used). To change this, fonts from the LaTeX font catalogue are added to the option chirbel-fontfamily. An entry must have a name option and may have a options (used for scaling for example).

chribel-fontfamily:
- name: 
  options:
- name: 
- name:
  options:

Important

Depending on the font, it needs to be loaded first before others to only adapt specific styles. This is simply done by adding this font first into the list. See the following example.

An example with a specific loading sequence to get the template_document.qmd style:

chribel-fontfamily:
  - name: AlegreyaSans      # used for section headings, title page
  - name: cmbright          # used for paragraph and math
  - name: inconsolata
    options: "scaled=0.95"  # for code blocks

Example Document/Project

There are two examples, which render to .pdf-documents.

[template_document.qmd]: document using the YAML frontmatter
[template_project.qmd]: project using the document options from _quarto.yml.

Defaults Values

The following yaml lines contain the default values (which are set in _extension.yml). To edit (some of) these values, just add the new value into the document front matter or into the _quarto.yml if you use the project structure.

keep-tex: true
pdf-engine: pdflatex
documentclass: article

geometry:
  - "top=18mm"
  - "bottom=15mm"
  - "left=5mm"
  - "right=5mm"
papersize: a4
fontenc: T1
fontsize: 10pt
pagenumbering: none

include-before-body: # NOT OVERRIDABLE, ONLY EXTENDABLE
  - config/before-content.tex
include-in-header: # NOT OVERRIDABLE, ONLY EXTENDABLE
  - config/preamble.tex
template-partials: # NOT OVERRIDABLE, ONLY EXTENDABLE
  - partials/before-body.tex
  - partials/before-title.tex

toc: true
toc-depth: 3
number-sections: false

fig-pos: H
fig-align: center

code-block-bg: "#f7f7f7"
code-line-numbers: false
highlight-style: github

joelvonrotz/chribel-summary-quarto