From e14045f2852af6d939bd8112db84cce270e9549a Mon Sep 17 00:00:00 2001
From: Jan Wille <jan.wille@stud.hs-hannover.de>
Date: Sun, 28 Apr 2024 15:25:52 +0200
Subject: [PATCH] abstract

---
 chap/whatsLaTeX.tex | 18 +++++++++---------
 example.pdf         |  4 ++--
 example.tex         | 15 ++++++++++++---
 3 files changed, 23 insertions(+), 14 deletions(-)

diff --git a/chap/whatsLaTeX.tex b/chap/whatsLaTeX.tex
index c74a6e7..b841f99 100644
--- a/chap/whatsLaTeX.tex
+++ b/chap/whatsLaTeX.tex
@@ -20,11 +20,11 @@
         other and scroll through them simultaneously.
 
         If you already have a working LaTeX setup, most editors support \emph{SyncTex}, which allows you to jump between source code and PDF file and
-        vice versa. You have to compile yourself, which will create a file called \verb|example.synctex.gz| in your project directory. Now you
-        can \verb|<CTRL>+Click| in the PDF and the corresponding line of source code will be highlighted.
+        vice versa. You have to compile yourself, which will create a file called |example.synctex.gz| in your project directory. Now you
+        can |<CTRL>+Click| in the PDF and the corresponding line of source code will be highlighted.
 
-        The shortcut to jump from the source code into the PDF will depend on your Editor, but for VS Code its
-        \verb|right Click|→\verb|SyncTex from cursor| or \verb|CTRL+ALT+J|.
+        The shortcut to jump from the source code into the PDF will depend on your Editor, but for VS\;Code its
+        |right Click|→|SyncTex from cursor| or |CTRL+ALT+J|.
 
     \section{Requirements to use LaTeX}
         As LaTeX files are just plain text file, you can edit them with any text editor (even windows notepad works, but that's just terrible).
@@ -38,12 +38,12 @@
         As I have already mention above, you also need the LaTeX program. It comes bundled with packages and other additional software inside a
         Tex-distribution. There are two major ones, Texlive and MiKTeX. I recommend MiKTeX, but it essentially doesn't matter which one you choose.
 
-        Once you have the distribution installed, test it by running \verb|pdflatex --version| in any terminal windows and it should return you
+        Once you have the distribution installed, test it by running |pdflatex --version| in any terminal windows and it should return you
         some information about the installed version and setup.
 
     \section{Running LaTeX}
         To create a PDF file from your LaTeX source code, you can always navigate to the project folder in a terminal window and run
-        \verb|pdflatex filename.tex|. However, if you have a decent editor installed, it will provide you with a button and do this for you.
+        |pdflatex filename.tex|. However, if you have a decent editor installed, it will provide you with a button and do this for you.
 
         With these project files you also received a makefile, which demonstrates how to compile this example file successfully from the terminal. The
         README file also has some tips and information for you.
@@ -52,12 +52,12 @@
         will be asked if you want to install them and should than be able to compile this file.
 
     \section{LaTeX commands}
-        Now lets look at the LaTeX command. Every one will begin with a \textbackslash\space followed by a letters only command name, like this:
-        \verb|\command|. Most commands also accept input, which is put after it into curly brackets: \verb|\command{argument||. They can
+        Now lets look at the LaTeX command. Every one will begin with a |\| followed by a letters only command name, like this:
+        |\command|. Most commands also accept input, which is put after it into curly brackets: |\command{argument}|. They can
         accept multiple arguments either in multiple sets of curly brackets or as a comma separated list, depending on the command.
 
         Some commands also accept optional arguments. These are passed inside square brackets between the command name and the curly brackets, like
-        this: \verb|\command[optional]{argument||.
+        this: |\command[optional]{argument}|.
 
     \section{Getting more information}
         So what can you do if you get stuck or just want more information. The simple answer is: Google is your friend. Most questions have already
diff --git a/example.pdf b/example.pdf
index 918d0ce..b00999b 100644
--- a/example.pdf
+++ b/example.pdf
@@ -1,3 +1,3 @@
 version https://git-lfs.github.com/spec/v1
-oid sha256:657506e65b4775b1bbffc3baea4f0a81170755acffaa770dff259b12ee586a70
-size 178995
+oid sha256:4672eef84e4ddc603a56185fa7e97cce96d15c34d53d0229eebef2d960318a71
+size 204508
diff --git a/example.tex b/example.tex
index 61b7104..2820d4a 100644
--- a/example.tex
+++ b/example.tex
@@ -23,11 +23,12 @@
 % ----- package loading -----
 % first thing you do is declare all the packages you need for your document
 % you can also pass options to this packages to configure their behavior
+\usepackage{listings}  % for pretty-printing code snippets
 \usepackage{soul}  % for strickesthough text
 \usepackage{lipsum}  % for dummy text
 
 % for some packages you also call some commands to configure them or your document
-
+\lstMakeShortInline[language={[LaTeX]TeX}]|
 
 % ----- document information -----
 % In your preamble you also list your documents information and metadata. These will be used on the titlepage as well
@@ -74,8 +75,16 @@
     % It will create a new page and a heading for you as well as indenting the whole text block a little.
     % if you have provided keywords, they will also be put at the end of the abstract.
     \begin{abstract}
-        \lipsum[5-6]
-    \end{abstract}
+		If you need an abstract for your document, you can write it wherever you see fit by using the |\begin{abstract}...\end{abstract}|
+		environment, like demonstrated here. It acts as an unnumbered chapter. You can choose if you want it in the TOC using the
+		|abstract=totoc| and |abstract=nottotoc| options of the documentclass.
+
+		If you prefere your abstract to be on a clean page, you can use |\thispagestyle{plain}| to get only a page number or |\thispagestyle{empty}|
+		to get nor header or footer.
+
+		If you use the |\keywords{list, of, keywords}| command in your preamble, the given keywords will also be printed here. You may use
+		|abstract=nokeywords| as a documentclass option to disable this.
+	\end{abstract}
 
     % this command will create the table of contents (TOC).
     \tableofcontents
-- 
GitLab