BFH Shortreport

Download

bfhshortreport.tgz

BFH Short Report Template

A template for short reports, such as lab reports, in the BFH corporate design. It is based on the bfhpub class of bfh-ci and set in two columns with a sans-serif font; title and abstract span the full width.

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

bfhshortreport.tex

The report: preamble and an example body with placeholder text.

sample.bib

Example bibliography database (biblatex format).

.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 (e.g. the module number), \institution, \department, \institute, \version. Title and author also appear in the running head.

  2. Replace the abstract: it is the bold text inside the \twocolumn[...] block, directly after \maketitle.

  3. Replace the \blindtext placeholders. When you no longer need them, remove \usepackage{blindtext}.

  4. Replace sample.bib with your own database, or add your entries to it.

Layout

  • Title and abstract are placed with \twocolumn[...] and therefore span both columns. Keep that block as it is and only change its content.

  • Sections are unnumbered (secnumdepth is 0).

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

  • Font: the whole document uses the sans-serif font (\renewcommand{\familydefault}{\sfdefault}). Remove that line for the serif font.

  • Bibliography starts on a new page in one column (\onecolumn before \printbibliography). Remove \onecolumn to keep it in the columns.

Terminal sessions

\LoadBFHModule{terminal} provides the ubuntu environment for console sessions, as shown in the Methodology section:

\setupLinuxPrompt{student}
\begin{ubuntu}
echo hello `\StartConsole`
hello
\end{ubuntu}

  • \setupLinuxPrompt{<user>} sets the prompt user. The second example in the template shows the long form with host, path, prompt symbol and colour, and prompt changes within one session.

  • Text between backquotes is passed to LaTeX, e.g. `\StartConsole` and prompt changes.

  • The options of the terminal module are described in the bfh-ci manual at latex.ti.bfh.ch.

Boxes and tables

  • Boxes from \LoadBFHModule{boxes}: bfhAlertBox, bfhWarnBox, bfhNoteBox (shown in the template) and bfhRecycleBox, bfhReadBox.

  • bfhTabular typesets a table in the BFH style. Its colours can be changed locally, e.g. inside a table environment: \colorlet{BFH-tablehead}{BFH-MediumBlue!50} and \colorlet{BFH-table}{BFH-MediumBlue!15}.

  • \code{...} prints inline code in typewriter font and quotation marks.

Citations

The template uses biblatex with the alphabetic style (labels such as [Ein05]), sorted by year, name and title (sorting=ynt). The bibliography is processed by biber. latexmk runs it automatically; in an editor, set the bibliography tool to biber, not BibTeX.

Languages

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

French changes the layout of lists in the whole document (see bfh-ci issue #166). To keep the standard lists, uncomment \frenchsetup{StandardLists=true}.

Feedback

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

Preview