Add cleveref for better references + infos in the README

README.md

@@ -19,8 +19,12 @@ While layout changes are generally not a problem, please try to leave the title
 
 ## Common Mistakes & Hints for a Good Thesis
 
+### Referencing
+- When referring to something, it should be clear what exactly you are referring to. *cleveref* (`\cref{label here}` in the middle of sentences and `\Cref{label here}` at the beginning of a sentence) make it easy.
+- For a figure or table, write `Figure 1`, with a capital letter `F` - even in the middle of a sentence.
+- Equations are identified by parenthesis (round "brackets", e.g. `(2.1)`) and optionally a label prefix `Eq.` / `Equation` (*cleveref* includes it).
+
 ### Graphics
-- When referring to a figure, write `Figure 1`, with a capital letter `F` - even in the middle of a sentence. `\autoref{LABEL HERE}` can help you.
 - When including drawings, plots, etc., include them as vector graphic (`eps`, `pdf`, ...) if at all possible (and reasonable).
     - Exporting a PDF from draw.io is not more complicated than exporting a raster image, but the result looks much better and stays sharp when zoomed in.
     - If possible with your plotting toolkit, you can also export your graphic as drawing commands for e.g. *pgf* - then with correct configuration the type face and font size will also match with the rest of the text. *Matplotlib* can do that, see its documentation [here](https://matplotlib.org/stable/users/explain/text/pgf.html). Note: This is typically more work and not strictly necessary.

scrskoma.cls

@@ -318,7 +318,7 @@
 
 
 %-------------------------------------------------------------------------------
-%   Bibliography
+%   External & Internal References
 %-------------------------------------------------------------------------------
 
 % BibLaTeX is responsible for all the bibliography stuff
@@ -333,6 +333,9 @@
 ]{biblatex}
 
 
+% \cref, \Cref for smarter references
+\RequirePackage[capitalise]{cleveref}
+
 %-------------------------------------------------------------------------------
 %   Glossary and Acronyms
 %-------------------------------------------------------------------------------

writeup.tex

@@ -47,11 +47,23 @@
 
     % Sample chapters to demonstrate formatting
     \chapter{Introduction}
+    \label{sec:intro}
     And so it begins\ldots{} Even though it is often easiest to write this
     chapter at a later point in time\ldots{}
 
     \chapter{Theory}
-    When writing formulas, please keep \cite{Blankenburg2017Normengerechte} in mind.
+    This sentence shows you how referencing \cref{sec:intro} in the middle of a sentence should be done.
+    \Cref{sec:intro} shows how a reference at the beginning of a sentence should look like.
+
+    The Frequency $f$ and the wavelength $\lambda$ are related via the speed of light $c$ by
+    \begin{equation}
+        c = \lambda f \,.
+        \label{eq:clambdaf}
+    \end{equation}
+    Please note that previous sentence was properly ended in \cref{eq:clambdaf} with a period.
+    \Cref{eq:clambdaf} makes it clear what the difference between \texttt{\textbackslash{}cref} and \texttt{\textbackslash{}Cref} is.
+    Finally, when writing formulas, please keep \cite{Blankenburg2017Normengerechte} in mind.
+
 
     \blinddocument{}
     \Blinddocument{}