Update first chapters section

This commit is contained in:
Knoch 2023-04-28 12:28:33 +02:00
parent a029095b65
commit bb2db7a0dc
3 changed files with 24 additions and 16 deletions

View File

@ -10,45 +10,54 @@ The material contained in this repository introduces the most fundamental LaTeX
* formatting paragraphs
* lists
* maths and formulas
* source code listings (`listings` with an optional `minted` part)
* graphics
* tables
* footnotes
* references
* literature management
* source code listings (`listings` with an optional `minted` part)
Most chapters contain exercises to practically apply the aspects that are introduced by the text.
## Getting started
### For beginners
A PDF version of the script can be found [in the “releases” section](https://github.com/fs-wiai/latex-script/releases). It will give you an overview of how to approach any, but especially this LaTeX project. For this, have a look at the “First steps with LaTeX” section.
This project contains three different documents:
1. a **script** containing all of the chapters we cover in the workshop (`main-script`),
2. an **exercise script** with practical tasks to apply what you have learned (`main-exercises`), and
3. a **solution script** that you can refer to for your self-study (`main-solutions`).
A PDF version of all of these documents can be found [in the “releases” section](https://github.com/fs-wiai/latex-script/releases). You may use the script to delve into the realms of LaTeX on your own. It will give you an overview of how to approach any, but especially this LaTeX project. To get your hands dirty, have a look at the exercise script, especially the “First steps with LaTeX” section.
**Optionally**, the `minted` package can be used for source code listings. This requires some additional configuration (including the installation of [Python3](https://www.python.org/)). Please refer to the chapter on “Source code listings” in the aforementioned PDF file.
### Command line usage
The project can be compiled by running a LaTeX compiler on `main.tex`. A simple command would be:
Each document in this project can be compiled by running a LaTeX compiler on `main-script.tex` (or any of the other two main files, respectively). A simple command would be:
```sh
$ pdflatex main.tex
$ pdflatex main-script.tex
```
Run the command twice to generate the table of contents and other registers. Once the literature tasks are being worked on, compilation requires an additional call to BibTeX:
```sh
$ pdflatex main.tex
$ bibtex main.aux
$ pdflatex main.tex
$ pdflatex main.tex
$ pdflatex main-script.tex
$ bibtex main-script.aux
$ pdflatex main-script.tex
$ pdflatex main-script.tex
```
If you decide to use the optional `minted` package (see section above), don't forget to add the `--shell-escape` flag:
If you decide to use the optional `minted` package (see section above), don't forget to add the `--shell-escape` flag:
```sh
$ pdflatex --shell-escape main.tex
```
Read more about the potentially dangerous implications of this flag in the script.
## Project Structure
```

View File

@ -2,15 +2,11 @@
\definecolor{latexblue}{rgb}{0.9,0.925,0.95}
\pagecolor{latexblue}
\todo{Refactor text for new exercise script.}
\chapter*{First steps with \LaTeX}
\addcontentsline{toc}{section}{First steps with \LaTeX}
This script serves as a short \LaTeX{} reference and as exercise material for the Fachschaft \acro{WIAI} \LaTeX{} workshop.
All of the source files and the latest version of this script can be found on Github.\footnote{\url{https://github.com/fs-wiai/latex-script/releases}}
The following instructions will equip you with the programs necessary to create documents with \LaTeX{}---they will be explained in the following chapters.
This document\footnote{Find the latest version of this document on Github: \url{https://github.com/fs-wiai/latex-script/releases}} contains exercises to practically apply learnings from the Fachschaft \acro{WIAI}'s \LaTeX{} workshop.
The following instructions will equip you with the programs necessary to create documents with \LaTeX{}---they are explained in the workshop and the main script.
Please, make sure to install the \emph{compiler first} and the \emph{editor afterwards}\textit{.}
\section*{Compiler}
@ -30,7 +26,7 @@ However, for beginners, we recommend using \TeX{}studio,\footnote{You find the l
\section*{Compiling for the first time}
Open up the file \file{main-exercises.tex} in \TeX{}studio.
It can be found in our project directory.
By pressing \includegraphics[width=.8em]{graphics/faForward.png}, it is converted into a a file called \file{main.pdf}.
By pressing \includegraphics[width=.8em]{graphics/faForward.png}, it is converted into a a file called \file{main-exercises.pdf}.
You should be able to find the latter by looking at the project directory in your file explorer.
If your installation is not working yet, \TeX{}studio will show you an error message.
Feel free to contact us in this case.\footnote{Find us at \url{https://www.uni-bamberg.de/wiai/fs}.}

View File

@ -49,6 +49,9 @@
% Literature
\usepackage{natbib}
% Line wraps in monospace font
\usepackage[htt]{hyphenat}
% Tracking changes
\usepackage{changes}
\definechangesauthor[color=blue, name={Christian}]{C}