Commit 05c20d73 authored by Klaus Stein's avatar Klaus Stein
Browse files

Improve documentation

parent 056fc5ee
...@@ -2,6 +2,9 @@ ...@@ -2,6 +2,9 @@
"mybib" "mybib"
(lambda () (lambda ()
(LaTeX-add-bibitems (LaTeX-add-bibitems
"Blum97")) "Oetiker_et_al:2001"
"Blum97")
(LaTeX-add-environments
'("declaration" LaTeX-env-args ["argument"] 0)))
:bibtex) :bibtex)
...@@ -358,11 +358,64 @@ provides you with everyting you need. ...@@ -358,11 +358,64 @@ provides you with everyting you need.
\section{Math Mode} \section{Math Mode}
\label{sec:math-mode} \label{sec:math-mode}
\TeX\ and \LaTeX\ are famous for their math typesetting
capabilities. Unfortunately they are often used in bad ways.
You can either inline short equations like \(k+1\) or refer to some
variable \(x\) we use in the larger equation
\[
x = \sum_{k=1}^{42}\frac{k}{k+1}.
\]
Whenever you are referring to some variable or other math construct in
the text \emph{always} do it in math mode. On the first sight
\emph{italics} and \emph{math mode} look similar, but they are not. Compare:
\begin{center*}
\begin{tabular}{ll@{\hspace{3em}}ll}
\verb|\textit{italics}|&\textit{italics}&\verb|\textit{math mode}|&\textit{math mode}\\
\verb|\(italics\)|&\(italics\)&\verb|\(math mode\)|&\(math mode\)
\end{tabular}
\end{center*}
In an equation \(xy\) means multiplication of the variables \(x\) and
\(y\) (in school we would have written \(x\cdot y\) or \(x\times
y\)). Therefore in math mode each letter is written by itself, kerning
is not applied, ligatures are broken up, spaces are ignored.
If you have expressions that involve operators (or function names)
consisting of more than letter they normally are typeset in roman type
(an upright fashion).
\begin{equation}
\label{eq:limexample}
\lim_{n\rightarrow0}\left\{\frac{n}{\sqrt{n}}\right\}
\end{equation}
or
\begin{equation}
\label{eq:minexample}
\min_{x\in[0,\pi]}\left\{\frac{\sin x + \cos x}{2-\log x}\right\}
\end{equation}
The common ones are predefined.
We recommend to use the \cmd{amsmath} package whenever you do
something slightly more complicated as it provides lots of helpers
e.\.g. to define your own operators like \(\cogsys\):
\begin{equation}
\label{eq:cogsys}
\cogsys_{\text{thesis}}(\text{me}) =
\frac{\text{effort}+\text{frustration}}{\text{procrastination}}
\end{equation}
and also provides a \verb|\text| command to typeset proper text in
formulars that auto-scales as you can see. Please \emph{never ever}
just write text in math mode.
As you can see equations are numbered so that one can refer to
an equation, e.\,g. in equation~\label{eq:limexample} we show how
large \{ and \} are typeset.
\section{Typography} \section{Typography}
\label{sec:typography} \label{sec:typography}
\begin{itemize}\Note{This will become several subsections} \begin{itemize}\Note{This will become several subsections}
\item widows und orphans \item widows und orphans
\item paragraphs (empty lines)
\item „…“ “…” ``…'' {\selectlanguage{ngerman}"`…"'} \item „…“ “…” ``…'' {\selectlanguage{ngerman}"`…"'}
\item Microtypography (spacings etc) (e.\,g., a~good thing, …) \item Microtypography (spacings etc) (e.\,g., a~good thing, …)
\item hyphenation \item hyphenation
......
...@@ -20,6 +20,18 @@ request to the\Note{Do we have a function email address we can give ...@@ -20,6 +20,18 @@ request to the\Note{Do we have a function email address we can give
\section{\LaTeX\ Introductions and HowTos} \section{\LaTeX\ Introductions and HowTos}
\label{sec:latex-literature} \label{sec:latex-literature}
There is a huge number of \LaTeX\ tutorials on the Internet, CTAN%
\footnote{The \href{https://www.ctan.org/}{Comprehensive TeX Archive
Network}} provides (among the vast amount of packages) a whole
\fhref{https://www.ctan.org/topic/tut-latex}{list of tutorials} (of
variable quality) in various languages. The
\citehreft{Oetiker_et_al:2001} aka “\LaTeXe\ in 139~minutes”
\parencite{Oetiker_et_al:2001} is the oldest still maintained one.
\begin{TODO}
Add some useful introductions.
\end{TODO}
\section{Other Sources on How To Write (a Thesis)} \section{Other Sources on How To Write (a Thesis)}
\label{sec:writing-literature} \label{sec:writing-literature}
......
...@@ -21,6 +21,21 @@ ...@@ -21,6 +21,21 @@
\begingroup\color{black!70!green}}{% \begingroup\color{black!70!green}}{%
\endgroup} \endgroup}
\newenvironment{center*}{\par
\smallskip\begingroup\centering}{\par\endgroup\medskip}
\DeclareCiteCommand{\citetitlehref}{}{%
\href{\thefield{url}}{\thefield{title}}%
}{}{}
\newcommand{\citehreft}[1]{%
\enquote{\citetitlehref{#1}}\,\footnote{\citeurl{#1}}
% \enquote{\fhref{\citefield{#1}{url}}{\citefield{#1}{title}}}%
}
\DeclareMathOperator{\cogsys}{cogsys}
%%% Local Variables: %%% Local Variables:
%%% mode: latex %%% mode: latex
%%% TeX-master: "thesisdoc" %%% TeX-master: "thesisdoc"
......
@techreport{Oetiker_et_al:2001,
title={The Not So Short introduction to \LaTeXe},
subtitle={ or LATEX 2$\varepsilon$ in 139 minutes},
author={Oetiker, Tobias and Partl, Hubert and Hyna, Irene and Schlegl, Elisabeth},
url={http://mirrors.ctan.org/info/lshort/english/lshort.pdf},
year={2021}
}
@article{Blum97, @article{Blum97,
author = {A.L. Blum and M. Furst}, author = {A.L. Blum and M. Furst},
title = {Fast planning through planning graph analysis}, title = {Fast planning through planning graph analysis},
......
...@@ -88,6 +88,13 @@ ...@@ -88,6 +88,13 @@
\usepackage{tikz} \usepackage{tikz}
\usetikzlibrary{mindmap,trees} \usetikzlibrary{mindmap,trees}
% We use biblatex with apastyle
\usepackage{csquotes}
\usepackage[style=apa, backref=true, natbib]{biblatex}
\bibliography{mybib} % According to the name of your bib file
% For the online version enable hyperlinks % For the online version enable hyperlinks
\usepackage[% \usepackage[%
% use colors instead of boxes for links % use colors instead of boxes for links
...@@ -101,13 +108,9 @@ ...@@ -101,13 +108,9 @@
]{hyperref} ]{hyperref}
% We use biblatex with apastyle
\usepackage{csquotes}
\usepackage[style=apa, backref=true, natbib]{biblatex}
\bibliography{mybib} % According to the name of your bib file
% our extra command definitions % our extra command definitions
\input{cmd-defs} \usepackage{cmd-defs}
% …and some commands we only need during writing. % …and some commands we only need during writing.
% We will comment the following line fo the final version % We will comment the following line fo the final version
......
No preview for this file type
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment