BFH Exercise

Download

bfhexercise.tgz

BFH Exercise Template

A template for exercise and lab descriptions in the BFH corporate design, based on the bfhpub class of bfh-ci. It produces a short handout with a title block and the sections Abstract, Objectives, Description and Outcomes.

Installation and compiling are described in the general README of the BFH LaTeX templates; this file covers only what is specific to this template.

Files

File

Purpose

bfhexercise.tex

The exercise: preamble and an example body.

.latexmkrc

latexmk configuration (see the general README).

Getting started

  1. Fill in the title data at the beginning of the document body: \title, \subtitle, \author, \subject, \institution, \department, \institute, \version. Title and subtitle also appear in the running head.

  2. Optionally add a title picture with \titlegraphic*{\includegraphics{...}}. The starred form scales and clips the picture to the title area; the unstarred form keeps the size you give.

  3. Replace the placeholder text in the sections.

Structure and helpers

  • Sections are unnumbered (secnumdepth is 0). Use \section*{...} or \section{...}; the result is the same.

  • Objectives and outcomes are bullet lists in two columns (multicols). Change {2} to set the number of columns.

  • Boxes from \LoadBFHModule{boxes} highlight information. The example uses bfhNoteBox, bfhRecycleBox and bfhReadBox; bfhAlertBox and bfhWarnBox are available as well.

  • Inline code and keys: \code{...} and \key{...} print their argument in typewriter font, in quotation marks, e.g. \key{Ctrl+C}. Escape #, _, %, & as \#, \_, …

  • Table of contents: for longer descriptions, uncomment \tableofcontents.

  • Paragraphs are separated by half a line of space (class option parskip=half-), not by indentation.

Splitting into several files

The preamble sets \input@path to content/. Create that folder for parts of the text and include them with \input{filename}, without the folder name. The folder is not part of the template; the setting does no harm if you don’t use it.

Languages

The document language is English; German (ngerman) and French are loaded as additional languages. To write the exercise in German, use \usepackage[french,english,main=ngerman]{babel}.

French changes the layout of lists in the whole document (see bfh-ci issue #166). To keep the standard lists, uncomment \frenchsetup{StandardLists=true}, or remove french if you don’t need it.

Feedback

Report problems and suggestions via the bfh-ci issue tracker: https://gitlab.ti.bfh.ch/bfh-latex/bfh-ci/-/issues

Preview