From e9c410f139c175d231dbf5bb625fa882e8c0c866 Mon Sep 17 00:00:00 2001 From: efradtschuk Date: Sun, 5 Sep 2021 18:33:28 +0200 Subject: [PATCH] minor changes regarding punctuation, upper and lower case, etc. --- content/footnotes.tex | 7 ++++++- content/graphics.tex | 2 +- content/literature.tex | 5 ++++- content/maths.tex | 7 +++++-- content/prospects.tex | 8 +++++--- content/references.tex | 4 +++- content/source-code-listings.tex | 9 ++++++++- 7 files changed, 32 insertions(+), 10 deletions(-) diff --git a/content/footnotes.tex b/content/footnotes.tex index 8f5051a..9f4871c 100644 --- a/content/footnotes.tex +++ b/content/footnotes.tex @@ -1,7 +1,12 @@ \chapter{Footnotes} \label{sec:footnotes} -Whenever we want to include footnotes into our \LaTeX{} document, we can use the command \mintinline{latex}{\footnote{text}}. At the position where we use the command, the correct number will be inserted automatically, and the text within the curly braces will appear in the footer. In combination with the package \mintinline{latex}{hyperref}, URLs within footnotes become clickable\footnote{if we use the command \mintinline{latex}{\url{…}}}. +Whenever we want to include footnotes into our \LaTeX{} document, we can use +the command \mintinline{latex}{\footnote{text}}. At the position where we use +the command, the correct number will be inserted automatically, and the text +within the curly braces will appear in the footer. In combination with the +package \mintinline{latex}{hyperref}, \acro{URL}s within footnotes become +clickable\footnote{if we use the command \mintinline{latex}{\url{…}}}. We can see examples for that in the whole document. The package \mintinline{latex}{footmisc} provides us with additional options for how to display footnotes. They can be passed as optional parameters to the command \mintinline{latex}{\usepackage}: diff --git a/content/graphics.tex b/content/graphics.tex index e833a27..728bbe5 100644 --- a/content/graphics.tex +++ b/content/graphics.tex @@ -4,7 +4,7 @@ Since in \LaTeX{} we work with plain text, we cannot simply embed graphics into our text as we may be used to from other text word processing programs. Instead, we reference external image files by a command. The figure is then embedded and positioned at compile time. -\section{Inserting Graphics} +\section{Inserting graphics} \label{sec:display-graphics} In order to be able to reference graphics, the package \texttt{graphicx} has to be included. For inserting a figure, we can use the following commands: diff --git a/content/literature.tex b/content/literature.tex index d69c132..d1f0547 100644 --- a/content/literature.tex +++ b/content/literature.tex @@ -3,7 +3,10 @@ For typesetting our first theses in \LaTeX{}, the last core functionality to learn is citing literature. Our references are gathered in a bibliography file. -Once we reference one of its entries from our \LaTeX{} document, Bib\TeX{} (a program similar to the standard \acro{PDF}\LaTeX{} compiler) can insert automatically generated citations. +Once we reference one of its entries from our \LaTeX{} document, Bib\TeX{} (a +program similar to the standard \acro{PDF}\LaTeX{} compiler)\todo{either adjust +PdfLaTeX here or in the other locations where it is used, so that it is +consistent } can insert automatically generated citations. It will format them in a bibliography style of our choice. \section{The bibliography file} diff --git a/content/maths.tex b/content/maths.tex index 3cd05cf..900e76e 100644 --- a/content/maths.tex +++ b/content/maths.tex @@ -3,7 +3,9 @@ Mathematical formulas are always set in \emph{math mode}, which, within a paragraph (referred to as \emph{inline}), can be turned on or off with a dollar sign. There is also a \emph{block} environment (cf. \cref{lst:sample-math-environment}). -Important packages for mathematical features are the \texttt{amsmath}, \texttt{amsthm} and \texttt{amssymb} packages of the American Mathematical Society, as well as \texttt{mathtools}. +Important packages for mathematical features are the \texttt{amsmath}, +\texttt{amsthm}, and \texttt{amssymb} packages of the American Mathematical +Society, as well as \texttt{mathtools}. As with many other environments, adding an asterisk turns off the numbering. \example{lst:sample-math-environment}{maths/sample-math-environment}{Exempary math environments} @@ -58,7 +60,8 @@ This can be achieved by prepending each bracket (\mintinline{latex}{(}, \mintinl \section{Lower and upper bounds} The \mintinline{latex}{\limits} command renders lower and upper bounds of integrals above and below the integral sign. -Sums, products and \todo{quite confusing in English}limits do this automatically (c.\,f. \cref{lst:limits}). +Sums, products, and \todo{quite confusing in English}limits do this +automatically (c.\,f. \cref{lst:limits}). For inline formulas, \mintinline{latex}{\limits} are of limited suitability. \example{lst:limits}{maths/limits}{Lower and upper bounds of sums, products, limits and integrals} diff --git a/content/prospects.tex b/content/prospects.tex index 28ac66c..c310866 100644 --- a/content/prospects.tex +++ b/content/prospects.tex @@ -99,7 +99,8 @@ We already have presented a selection of packages. However, there are thousands It comes in very handy whenever one needs the output of external programs in the document, for example, in within the appendix. Just compile the document one more time and the appendix is up-to-date again, if the external program has changed something. \item[Nested graphics] - and the positioning of captions at almost any place are provieded by \texttt{subcaption}.\footnote{\url{https://www.ctan.org/pkg/subcaption}} + and the positioning of captions at almost any place are provided by + \texttt{subcaption}.\footnote{\url{https://www.ctan.org/pkg/subcaption}} We also made extensive use of this package. \item[Tables] can be designed much more flexible than what we have shown here. @@ -119,7 +120,8 @@ with \LaTeX{}. Information on the document class and examples are available at O If required, both refer to additional packages. Whenever you need information on certain packages \acro{\textbf{CTAN}}\footnote{\url{https://ctan.org/}} is your place to go. The official documentation as \acro{PDF} for each package can be found there. -Within this file, the first paragraphs are the most interesting. They are followed by implementation details, that your normally do not need. +Within this file, the first paragraphs are the most interesting. They are +followed by implementation details, that you normally do not need. If the official documentation is too theoretical, and you prefer a more hands-on approach, \textbf{Overleaf}\footnote{\url{https://www.overleaf.com/}} can help you out. Primarily, it is a collaborative online \LaTeX{} editor. However, you can find multiple templates\footnote{\url{https://www.overleaf.com/latex/templates}} for different types of documents (VCs, theses, \textellipsis) there. @@ -131,7 +133,7 @@ For concrete questions, the question-answering platform \textbf{Stackexchange} i Needless to say, you can always contact us with your questions: \begin{compactitem} \item via mail to \href{mailto:fachschaft-wiai.stuve@uni-bamberg.de}{fachschaft-wiai.stuve@uni-bamberg.de}, - \item via phone at +49951\,863\,1219 + \item via phone at +49951\,863\,1219, \item or just come to our bureau at WE5/02.104. \end{compactitem} diff --git a/content/references.tex b/content/references.tex index ff9e951..2c32e8d 100644 --- a/content/references.tex +++ b/content/references.tex @@ -2,7 +2,9 @@ \label{sec:references} If we want to make references, like \enquote{\textellipsis , which you can see in figure 21, \textellipsis}, \LaTeX{} by default provides as with the command \mintinline{latex}{\ref{label}}. No more adapting of the numbering for graphics, tables, etc. needed! -the command expects a unique label as argument, that needs to be assigned to the referenced element. After that, wherever we call the command, the number of our referenced object appears in the text. +The command expects a unique label as argument, that needs to be assigned to +the referenced element. After that, wherever we call the command, the number of +our referenced object appears in the text. \Example{lst:fooboar-learning-latex}{references/ref}{references/ref_crop}{Example for a reference} A smarter package for references is \texttt{cleverref}.\footnote{with only one \enquote{r}!} diff --git a/content/source-code-listings.tex b/content/source-code-listings.tex index 010e4d0..2a22c0e 100644 --- a/content/source-code-listings.tex +++ b/content/source-code-listings.tex @@ -9,7 +9,14 @@ Using \mintinline{latex}{minted} requires a working installation of the programm On some operating systems, Python comes pre-installed, in which case entering the command \mintinline{bash}{python --version} or \mintinline{bash}{python3 --version} in a terminal of your choice\footnote{Opening a terminal on Windows: \faWindows\ + R → Type \enquote{cmd} → Enter} should print out the installed Python version. If Python is yet to be installed, then you can find the installation files on the project website\footnote{Available at \url{https://www.python.org/downloads/}.}. -There are extensive articles that cover all relevant steps to install Python on Windows\footnote{Jason Fitzpatrick, How to Install Python on Windows. How-To Geek. July 11, 2017. Available at \url{https://www.howtogeek.com/197947/how-to-install-python-on-windows/}. Windows users will have to adjust the system path. Forgetting this step has been the number one installation problem in past workshops.}, Linux\footnote{\url{https://docs.python-guide.org/starting/install3/linux/}}, or macOS\footnote{\url{https://docs.python-guide.org/starting/install3/osx/}}. +There are extensive articles that cover all relevant steps to install Python on +Windows,\footnote{Jason Fitzpatrick, How to Install Python on Windows. How-To +Geek. July 11, 2017. Available at +\url{https://www.howtogeek.com/197947/how-to-install-python-on-windows/}. +Windows users will have to adjust the system path. Forgetting this step has +been the number one installation problem in past workshops.} +Linux,\footnote{\url{https://docs.python-guide.org/starting/install3/linux/}} +or macOS.\footnote{\url{https://docs.python-guide.org/starting/install3/osx/}} After a successful installation, you should be able to execute the aforementioned command in a terminal, confirm by pressing Enter, and see approximately the following result: