Listings

We have multiple examples of LaTeX source code in the script. As a default setting, we use the package listings for displaying them.

• However, the package minted generates more appealing listings.
• Minted requires additional configuration, like the installation of the programming language Python 3 and the package Pygments
• The following slides explain how to use minted for this LaTeX project

Change the listings mode

In order to compile the script using minted, the listings mode has to be changed.

• Create a new file in the root directory of the project archive, named listings-mode.tex
• Insert the following command into the newly created file

\newcommand\listingsmode{minted}

• Compile main.tex again by pressing ⏩

Origin

• Donald Knuth, 1977–1986: typesetting system TeXτεχ → /tɛç, tɛx, tɛk/ for The Art of Computer Programming
• Leslie Lamport, from 1980s: software package LaTeX made TeX easier to use

Procedure of this workshop

Goal: you are going to build your own little
LaTeX manual based on our LaTeX script.

• learning by doing
• understanding how LaTeX works
• details can be looked up later

WYSIWhat?

What You See Is What You Get

• Formatting with immediate visual feedback

Image source: xkcd

Comments

After a percent sign, the rest of the line is ignored by the compiler. It is called a comment and does not appear in the resulting document.

% profile start
Name: Donald Knuth \\
Geburtsdatum: \\ % TODO: insert
Geburtsort: Milwaukee, Wisconsin
% profile end

Shortcuts: Ctrl + T and Ctrl + U

Preamble & document environment

👁 Every LaTeX document is composed of

• a preamble: global settings (document class, encoding, language, page format, additional packages, …) and
• a document environment: content of the document.

\documentclass{article}
\usepackage[utf8]{inputenc}
\usepackage[T1]{fontenc}
\usepackage{babel}

\begin{document}
Hello world!
\end{document}

Languages — an example

\today
\selectlanguage{ngerman}
\today
\selectlanguage{swedish}
\today
\selectlanguage{russian}
\today
\selectlanguage{greek}
\today
\selectlanguage{english}
\today

Continuous Text

Continous text can be written directly ↲
in the source code. ↲
Simple line breaks ↲
are ignored, ↲
just as     multiple space characters. ↲
↲
An empty line creates a new paragraph ↲
which has an indentation by default. ↲
Manual line breaks can be forced ↲
using two backslashes, but this use ↲
is strongly discouraged \\ ↲
within continuous text.

Reserved characters

Some characters do things in LaTeX:

# $ % ^ & _ { } ~ \

50% is one half.

Solution: prefix with ‘\’:

50\% is one half.

Does not work for ‘\\’, we will see a solution for this later.

Sections and chapters

Texts are structured by beeing subdivided in sections and chapters. Always available:

\section{Level 1}
\subsection{Level 2}
\subsubsection{Level 3}
\paragraph{Level 4}
\subparagraph{Level 5}

Additionally, for some document classes:

\chapter{Chapter}
\part{Part}

Sections and chapters

With an asterisk, there is no numbering and no entry in the table of contents:

\section*{No entry in table of contents}

You can also provide an alternative title for the table of contents:

\section[Entry in table of contents]
{Actual chapter heading}

Front matter

\documentclass{article}
\usepackage{babel}
\title{The World of Truffles}
\author{Fooboar Rüssel \\ Fachschaft
WIAI\thanks{WIe AIn Profi},
Otto-Friedrich-Universität Bamberg}
\date{\today}
\begin{document}
\maketitle
\section{Truffle hunt}
\subsection{Hunt with a pig}
\subsection{Hunt without a pig}
Why would you do that?
\section{Truffle recipes}
My favorite recipe
\end{document}

Table of contents

\documentclass{article}
\usepackage{babel}
\begin{document}
\tableofcontents
\section{Truffle hunt}
The first section.
\subsection{Hunt with a pig}
A subsection.
\subsection{Hunt without a pig}
Another subsection.
\subsubsection[But why?]
              {Why would you do that?}
Sub-subsection.
\section{Truffle recipes}
My favorite recipe
\end{document}

Goal

Create a bigger LaTeX project and …

• prevent LaTeX documents from growing monstrously 👹
• keep the overview over the project structure

Main file 👑

• contains basic structure and front matter
• includes separate sections with
  \input{path/to/file}

\documentclass{article}
\usepackage{babel}
\usepackage[utf8]{inputenc}
\usepackage[T1]{fontenc}
\title{A Title}
\begin{document}
    \maketitle
    \tableofcontents
    \input{section1.tex}
    \input{section2.tex}
\end{document}

File with a section

• contains no preamble
• contains no \begin{document} or \end{document}

\section{This is section 1}
A paragraph about the content 
of section 1.

% …

\section{This is section 2}
A paragraph about the content 
of section 2.

% …

Specifying file paths 👣

• important for \input{}, but later also for other media types
• file and folder structure = tree structure 🌳

Specifying file paths 👣

Absolute paths

• path from the root directory to a file
• the direcories are separated by special characters:
  • under UNIX: /
  • under Windows: \

Specifying file paths 👣

Relative paths

• path from somewhere in the tree to a certain file
• shorter + less typing! ☺
• with \input{}, you can specify the path relative to the main file

Specifying paths 👣

Relative paths

Relative path from main.tex to part1.tex in subfolder

./sections/part1.tex

Specifying paths 👣

Relative paths

Relative path from main.tex in its own subfolder to part1.tex in another subfolder

../sections/part1.tex

Two dots ‘..’ represent the parent folder of the current folder (in this case: latex, parent of main).

Outsourcing the preamble

What do you think happens when we outsource the preamble into its own subfile?

Will the document compile?

Yes, it will!
A simple way of keeping the main file even more organised.

Spaces

• normal space dividing words: space bar
• non-breaking space: ~
• thin space: \,
• many other widths available

Thin spaces are used in abbreviations
and before units, e.\,g., 10\,s.
Normal-width non-breaking spaces can help
keep honorary titles and names on one
line: Dr.~Fooboar.

English and French spacing

In English, LaTeX uses the old-fashioned English spacing, i. e., double sentence spacing.

If you want to be more modern, you can use \frenchspacing above your first paragraph. \nonfrenchspacing goes back to default.

If you actually use English spacing, LaTeX will still try and put normal word spacing after abbreviations. However, you should check the results and intervene where needed by

• forcing normal spaces: .\␣
• manually ending sentences: \@.␣

Hyphens and dashes

Hyphenation

Most of the time, LaTeX hyphenates words correctly, if the correct language is configured. Sometimes, however, manual intervention is necessary. The different kinds of hyphens that LaTeX offers are described in our script.

Quotes

The csquotes package provides, amongst others, the command \enquote.

\enquote{A \enquote{nested}
quote.}

When included with autostyle=true, foreign-language quotes use the according quotation marks:

\foreignquote{ngerman}{Ein deutsches
Zitat.}

Emphases

The easiest way of emphasising in continuous text is the semantic command \emph{} that can also be nested:

\emph{If you have a whole bunch of 
important text with some \emph{even more 
important Text} hidden inside it, 
you can use nested emphases.}

Optical highlighting

specifies exactly how to format the text:

Nesting emphases

Possible if the font contains the exact font style:

\textbf{Very
    \textit{Important
        \textsc{Stuff}
    }
}

Font size

Preset font sizes

{\<fontsize> some text}

Font sizes relative to normalsize:

{\tiny         If}
{\footnotesize you}
{\small        can}
{\normalsize   read}
{\large        this,}
{\Large        you}
{\LARGE        don’t}
{\huge         need}
{\Huge         glasses.}

Font size

Manual configuration possible

\fontsize{<fontsize>}{<lineheight>}
\selectfont

This is text in normal font size.

\fontsize{1cm}{0.9cm}\selectfont
This is a ginormous passage.

\normalsize
Back to normal.

URLs

The hyperref package provides an \url{} command that reproduces URLs

• letter by letter
• using line breaks without hyphens
• using a font with well-distinguishable characters
• as a clickable link in the PDF

\url{https://www.latex-project.org/}

Ragged alignment

By default, LaTeX sets text in full justification, but it is possible to activate ragged alignment.

\raggedright … \raggedleft …
\centering …

Alternatively, we can use dedicated environments:

\begin{flushleft}  Text \end{flushleft}
\begin{flushright} Text \end{flushright}
\begin{center}     Text \end{center}

Proper ragged alignment is even more difficult than good justification, so better avoid it.

Indentation and spacing

• paragraphs are usually indicated by first-line indentation (\parindent)
• we can decide to use paragraph spacing (\parskip) instead (!)
• both parameters are customisable:

\setlength{\parindent}{0pt}
\setlength{\parskip}{1em
    plus  .5em % permitted stretch
    minus .5em % permitted compression
}

• \noindent allows us to disable first-line indentation for a given paragraph

Unordered lists 📜

\begin{itemize}
    \item lasagna noodles
    \item crushed tomatoes, % …
    \item oregano, basil, % …
    \item mozzarella cheese
    \item flour
    \item milk
\end{itemize}

We mark each bullet point with \item. This pattern is the same for all kinds of enumerations.

Ordered and definition lists

\begin{enumerate}
  \item cook onions over medium % …
  \item add crushed tomatoes, carrots % …
  \item add herbs and spices % …
  % \item …
\end{enumerate}

\begin{description}
  \item [Béchamel sauce] Béchamel % …
  \item [Lasagne] Lasagne (singular % …
\end{description}

Compact lists

The package paralist offers enumerations with less line spacing.

\section{Ingredients}
\begin{compactitem}
  % \item …
\end{compactitem}
\section{Preparation}
\begin{compactenum}
  % \item …
\end{compactenum}
\section{Glossary}
\begin{compactdesc}
  % \item …
\end{compactdesc}

In-line enumerations

Another feature provided by paralist enables us to integrate enumerations into paragraphs.

The following herbs are % …
\begin{inparaitem}
    \item lovage
    \item parsley
    \item chives
\end{inparaitem}

Of course, there is an accompanying list type called inparaenum for ordered lists.

Nested lists

\begin{compactitem}
  % …
  \item vegetables \begin{compactitem}
    \item crushed tomatoes
    \item carrots
    \item peas
    \item onions
  \end{compactitem}
  \item herbs \begin{compactenum}
    \item oregano
    \item basil
    \item rosemary
  \end{compactenum}
  % …
\end{compactitem}

List styles

The list style type can be set using the optional parameter label. To accomplish this, we need to include the package enumitem first.

% Roman numerals
\begin{enumerate}[label=\roman*]
% …
% Arabic numerals
\begin{enumerate}[label=\arabic*]
% …
% Alphabetical
\begin{enumerate}[label=\alph*]
% …

Formula environments 🧮

$2 \sqrt{\frac{\pi^2}{3} \cdot c_2}$

Mathematical formulas are only accepted in the so-called math mode. In-line formulas must therefor be guarded by two dollar signs. We can also use the equation block environment:

\begin{equation}
  2 \sqrt{\frac{\pi^2}{3} \cdot c_2}
\end{equation}

Packages: amsmath, amsthm, amssymb, mathtools

Depicting boundaries

The bounds of an integral can be enforced to appear above and below the integral symbol using the \limits command. This is the standard behaviour for sums, products and limits.

\sum_{i=1}^{n^2}(x+2)
\prod_{j=1}^{100}(3 \cdot x)
\lim_{x \rightarrow \infty}(14x^3 - 12)
\int\limits_{-12}^{4}(14x^3 - 12)

Don’t use \limits inline.

Aligning a group of equations

The align environment permits us to align equations at certain positions like the ‘ = ’ character.

\begin{align}
  13 \cdot (4a - 3)^2 &= 13 … \\
      &= 208a^2 - 312a + 117
\end{align}

• The equations will be aligned with respect to the ampersands (‘&’).
• We can mark a new line using ‘\\’.
• align and equation will not be numbered if we add an asterisk after their names (e. g. \begin{align*} and \end{align*}).

Column definitions

\begin{tabular}{lrcl}
    % table content
\end{tabular}

Vertical separator lines and double horizontal lines are frowned upon by typographers and should be avoided.

Table content

\begin{tabular}{lll}
    \toprule
    Column 1 & Column 2 & Column 3 \\
    \midrule
    Content a & Content b & Content c \\
    Content e & Content f & Content g \\
    Content i & Content j & Content k \\
    \bottomrule
\end{tabular}

• Columns are separated by ’&’.
• Rows are ended by ‘\\’.
• \toprule, \midrule and \bottomrule structure the table.

An advanced example

\begin{table}[h]
    \begin{tabular}{llr}
        \toprule
        Structure & \multicolumn{2}{l}{Access time complexity} \\ \cmidrule(r){2-3}
        & Average & Worst \\
        \midrule
        Stack & $\mathcal{O}(n)$ & $\mathcal{O}(n)$ \\
        Binary tree & $\mathcal{O}(log(n))$ & $\mathcal{O}(n)$ \\
        AVL tree & $\mathcal{O}(log(n))$ & $\mathcal{O}(log(n))$ \\
        \bottomrule
    \end{tabular}
\end{table}

🔗 Booktabs documentation

Installation 🖥️

minted requires the Python programming language. As soon as Python is installed, we can download the corresponding Python package Pygments using a command prompt:

pip install Pygments

Add the LaTeX packages for minted or listings and we are good to go:

\usepackage{minted}
\usepackage{listings}

In-situ listings

Within a dedicated environment:

\section*{Haskell Magic}
Squares of all even % …
\begin{minted}{haskell}
[x^2 | x <- [1..200], even x]
\end{minted}

Directly inline:

\section*{An HTML Example}
A headline is denoted the following way:
\mint{html}|<h2>LaTeX at University</h2>|

External source code

We can avoid redundancy by including source code directly from its source file.

\section*{Simple Java Application}
\inputminted{java}{Test.java}

public class Test {
    public static void main(/*…*/) {
        System.out.println(/*…*/);
    }
}

In-situ listings

Within a dedicated environment:

\section*{Haskell Magic}
Squares of all even % …
\begin{lstlisting}[language=Haskell]
[x^2 | x <- [1..200], even x]
\end{lstlisting}

The listings package does not provide an inline command.

External source code

Conveniently, also listings offers an import command:

\section*{Simple Java Application}
\lstinputlisting[language=Java]{Test.java}

public class Test {
    public static void main(/*…*/) {
        System.out.println(/*…*/);
    }
}

Footnotes 📎

\usepackage{hyperref}

Footnotes are automatically numbered consecutively, independent of sections.

(Here, hyperref is used for the \url command, it is not necessary for footnotes per se.)

The wild boar (\textit{Sus scrofa}), also 
known as the wild swine, common wild pig, 
or simply wild pig, is a suid native to 
much of Eurasia and North Africa, and has 
been introduced to the Americas and Oceania.
\footnote{\url{https://en.wikipedia.org/
wiki/Wild_boar}}

Configuring footnotes

The footmisc package provides additional options for the presentation of footnotes that can be activated by adding parameters to the \usepackage command.

% Reset the counter on each page:
\usepackage[perpage]{footmisc}

% Display footnotes in-line:
\usepackage[para]{footmisc}

% Use symbols instead of numbers:
\usepackage[symbol]{footmisc}

Cross-references

Manually (just don’t!)

As you can see in figure 23, …

Using the \ref command:

\begin{figure}[H]
    \includegraphics % …
    \caption{Our mascot Fooboar}
    \label{img:fooboar}
\end{figure}

As you can see in figure 
\ref{img:fooboar}, …

Cross-references

Using the cleveref package (with one ‘r’!):

\begin{figure}[H]
    \includegraphics % …
    \caption{Our mascot Fooboar}
    \label{img:fooboar}
\end{figure}

Fooboar is a young and highly engaged
boar (see \cref{img:fooboar}).

The \cref command automatically inserts suitable prefixes.

A few more things

• It is recommended that you include the package hyperref before cleveref.
• \cref can take multiple references at once, separated by commas.

\section{An introduction}
\label{sec:section1}
% …
Reference be made to 
\cref{sec:section1,sec:section2,
sec:section3,sec:section5}.

Creating an index

\usepackage{makeidx}
\makeindex
\begin{document}
\maketitle
\section{What is LaTeX\index{LaTeX}?}
LaTeX\index{LaTeX} is a typesetting
system\index{Typesetting system}.
\newpage \section{TeX\index{TeX} vs.
LaTeX\index{LaTeX}} It is based on
TeX\index{TeX}, an invention by 
Donald Knuth\index{Knuth, Donald}.
As TeX\index{TeX} is way more complex
syntactically than LaTeX\index{LaTeX},
LaTeX\index{LaTeX} is much more 
popular.
\printindex

Designing presentation slides

For slides, there is the beamer document class, as well as numerous templates and themes.

\documentclass{beamer}
\usetheme{Frankfurt}
\usecolortheme{seahorse}
\usepackage[utf8]{inputenc}

\begin{document}
\begin{frame} 
    \frametitle{Lemon sorbet}
    \framesubtitle{Incarnation of good?}
    \begin{definition}
        A lemon sorbet is a
        semi-frozen \textbf{dessert}
        on \textit{lemon} base.
    \end{definition}
\end{frame}
\end{document}

Drawing images

TikZ (“TikZ ist kein Zeichenprogramm” — “TikZ is no drawing software”) is a powerful package for drawing vector graphics.

% …
\tikzstyle{every node}=[draw=black,thick,anchor=west]
\tikzstyle{selected}=[draw=red,fill=red!30]
\tikzstyle{dir}=[fill=gray!50]
\tikzstyle{relativeTo}=[fill=blue!70]
\begin{tikzpicture}[%
grow via
three points={one child at (0.5,-0.7) and
two children at
(0.5,-0.7) and (0.5,-1.4)},
edge from
parent path={(\tikzparentnode.south)
 |- (\tikzchildnode.west)}]
\node {/ or C:}
child { node {home}
  child { node {knut}
    child { node {pictures}}
    child { node {docs}
      child { node [dir] {latex}
        child { node [relativeTo] {main.tex}
        child { node [selected] {part1.tex}
      }
    }
  }
};
\end{tikzpicture}

Linguistics

The qtree package can render constituent-based parse trees:

\Tree [.S [.NP LaTeX ]
[.VP [.V is ] [.NP fun ] ] ]

Mathematical proofs

Logical tableaux can be renderd using the prftree package.

\begin{displaymath}
\prftree[l,r]{}{[comp$\_{ns}$]}
{
  \prftree[l,r]{}{[comp$\_{ns}$]}
  {
    \prftree[l,r]{}{[ass$\_{ns}$]}
    {
      -
    }
    {
      (\texttt{m:=a}, \sigma\_{\bot,\bot})
      \rightarrow \sigma\_{48,\bot}
    }
  }
  {
    \prftree[l,r]{}{[ass$\_{ns}$]}
    {
      -
    }
    {
      (\texttt{n:=b}, \sigma\_{48,\bot})
      \rightarrow \sigma\_{48,18}
    }
  }
  {
    (\texttt{m:=a; n:=b}, \sigma\_{\bot,\bot})
    \rightarrow \sigma\_{48,18}
  }
}
{
  \prftree[l,r]{}{}
  {
    \dots
  }
  {
    \textbf{[1]}\ (\texttt{LOOP}, \sigma\_{48,18})
    \rightarrow \sigma\_{6,6}
  }
}
{
  (\texttt{m:=a; n:=b; LOOP}, \sigma\_{\bot,\bot})
  \rightarrow \sigma\_{6,6}
}
\end{displaymath}