latex-wochenende/slides/chapter-13.en.md
2021-05-28 21:13:44 +02:00

210 lines
4.5 KiB
Markdown
Raw Permalink Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

@slide(layout=chapter-slide)
@title
References and footnotes
@slide(layout=content-and-preview)
@title
Footnotes <span class="emoji">📎</span>
@content
``` {.hljs .lang-tex}
\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.)
``` {.hljs .lang-tex}
The wild boar (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}}
```
@preview
![](svg/chapter-13/footnote-example-crop.svg)
@slide(layout=content-and-preview)
@title
Configuring footnotes
@content
The `footmisc` package provides additional options for the presentation of footnotes that can be activated by adding parameters to the `\usepackage` command.
``` {.hljs .lang-tex}
% Reset the counter on each page:
\usepackage[perpage]{footmisc}
% Display footnotes in-line:
\usepackage[para]{footmisc}
% Use symbols instead of numbers:
\usepackage[symbol]{footmisc}
```
@preview
![](svg/chapter-13/footmisc-en-crop.svg){.thin-padding}
@slide(layout=content-and-preview)
@title
Cross-references
@content
Manually (just dont!)
``` {.hljs .lang-tex}
As you can see in figure 23, …
```
Using the `\ref` command:
``` {.hljs .lang-tex}
\begin{figure}[H]
\includegraphics % …
\caption{Our mascot Fooboar}
\label{img:fooboar}
\end{figure}
As you can see in figure
\ref{img:fooboar}, …
```
@preview
![](svg/chapter-13/ref-example-crop.svg)
@slide(layout=content-only)
@title
Assigning labels
@content
Both cross-reference commands work with **sections, figures, tables, listings, and equations,** as long as you use correct labels.
Labels have to be **unambiguous.** For clarity, certain prefixes are common, and some packages use them to derive information.
<table>
<tr>
<td>`fig:` Figures</td>
<td>`tbl:` Tables</td>
</tr>
<tr>
<td>`sec:` Sections</td>
<td>`subsec:` Subsections</td>
</tr>
<tr>
<td>`ch:` Chapters</td>
<td>`itm:` Enumeration items</td>
</tr>
<tr>
<td>`eq:` Equations</td>
<td>`lst:` Source code listings</td>
</tr>
</table>
@slide(layout=content-and-preview)
@title
Cross-references
@content
Using the `cleveref` package (with *one* r!):
``` {.hljs .lang-tex}
\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.
@preview
![](svg/chapter-13/cref-example-crop.svg)
@slide(layout=content-only)
@title
Things to consider
@content
* Terms inserted by `\cref` use the language specified with the document class (or `babel`):
``` {.hljs .lang-tex}
\documentclass[english]{article}
```
* Apart from sections, referenced elements need captions (`\caption{…}`), and the **captions have to be placed before the label.**
* For sectioning commands, the label is inserted directly after the section command.
``` {.hljs .lang-tex}
\section{Notes}\label{sec:notes}
```
@slide(layout=content-and-preview)
@title
A few more things
@content
* It is recommended that you include the package `hyperref` before `cleveref`.
* `\cref` can take multiple references at once, separated by commas.
``` {.hljs .lang-tex}
\section{An introduction}
\label{sec:section1}
% …
Reference be made to
\cref{sec:section1,sec:section2,
sec:section3,sec:section5}.
```
@preview
![](svg/chapter-13/cref-multiple-example-crop.svg)
@slide(layout=task)
@task-number
13
@title
Inserting footnotes
@content
* Make the text *Stand März 2021* in file `exercises/footnotes/footnotes.tex` appear as a **footnote**.
* Additionally, insert a **clickable URL** that leads to the download page for the Java Development Kit (`https://www.oracle.com/java/technologies/javase-downloads.html`).
@slide(layout=task)
@task-number
14
@title
Inserting references
@content
* In file `exercises/references/references.tex`, replace *in der Abbildung* and *Das nachstehende Quelltext-Listing* by **references** to the figure and to the source code listing.
* Use the command `\cref` for the references.
* Make sure to add **labels** to the elements that you want to create a reference for.
* To do so, wrap the source code listing in a `listing` **environment**.
* Additionally, add a **caption** to the source code listing.