feat: add referencing for resq and hyp environments

To use the automated facilities provided by the `cleveref` package, we
need to add respective names for the `resq` and `hyp` environments for
research questions and hypotheses.

CHANGELOG.md

@@ -7,6 +7,11 @@ and this project adheres to
 
 ## [Unreleased]
 
+### Added
+- Fix the referencing with cleveref's `\cref` etc. for the `resq` (research
+  questions) and `hyp` (hypotheses) environments
+  (see [#8](https://github.com/se2p/se2thesis/issues/8))
+
 ## [v3.3.1] – 2024–02–23
 
 ### Changed

examples/se2thesis-master-thesis-example.tex

@@ -44,6 +44,10 @@
 \institute{Chair of Example}
 \location{Passau}
 
+\usepackage[capitalise]{cleveref}
+%\crefname{resq}{research question}{research questions}
+\Crefname{resq}{Research Question}{Research Questions}
+
 \begin{document}
 
 \frontmatter
@@ -72,13 +76,18 @@
 
 \section{Further Examples}
 
-We could reference the \TeX{} book~\autocite{Knu86}.
+We could reference the \TeX{} book~\autocite{Knu86}.  And we want to reference
+\cref{rq:1} and \cref{hyp:1} here.
 
-\begin{resq}
+\begin{resq}\label{rq:1}
     What is \(41 + 1\)?
 \end{resq}
 
-\begin{summary}{Research Question 1}
+\begin{hyp}\label{hyp:1}
+  We hypothesise that the answer to \cref{rq:1} is 42!
+\end{hyp}
+
+\begin{summary}{\Cref{rq:1}}
    It's 42, obviously!
 \end{summary}
 

se2packages.dtx

@@ -881,6 +881,8 @@
     \AddToHook { begindocument/before }
       {
         \RequirePackage[capitalise]{cleveref}
+        \Crefname{resq}{Research Question}{Research Questions}
+        \Crefname{hyp}{Hypothesis}{Hypotheses}
       }
   }
 %    \end{macrocode}