sdapsclassic class

This is the main class which currently should be used to create questionnaires. It builds on top of the other packages and adds new macros and environments which are similar to the ones from the original SDAPS LaTeX class.

Pleaes note that the environments from the sdapslayout package cannot be used directly as using these environments will cause conflicting macro definitions. Instead one can simply use the aliases provided in this class.

The following question types exists for your use:

  • \singlemark: A single range or mark question
  • \singlemarkother: A single range or makr question with an alternative answer in case it isn’t applicable
  • \textbox: A large and optionally scalable textbox for freeform content
  • choicequestion: A multiple choice question with a number of answers
  • choicegroup: A list of multiple choice questions layed out in rows (or columns)
  • optionquestion: A single choice question with a number of answers
  • optiongroup: A list of single choice questions layed out in rows (or columns)
  • markgroup: A list of range or mark questions layed out in rows (or columns)

You should only use \section{} for structuring the document.

Class Options

Argument Description
style The markings style to use. Either “code128”, “qr” (default: code128)
checkmode
The mode for checkbox recognition can be any of:
  • checkcorrect: check to mark, fill to correct (unmark) (default)
  • check: check or fill to mark
  • fill: fill to mark
globalid A global identifier to be printed on the document (as barcode)
globalidlabel The label for the barcode (only code128)
no_print_questionnaire_id Disable printing of questionnaire IDs
print_questionnaire_id Enable printing of questionnaire IDs

Macros

\checkbox *
Arguments:* – If given, a single choice checkbox is shown instead of a multi choice.

Shows an unchecked checkbox for demonstration purposes.

\checkedbox *
Arguments:* – If given, a single choice checkbox is shown instead of a multi choice.

Shows a checked checkbox for demonstration purposes.

\filledbox *
Arguments:* – If given, a single choice checkbox is shown instead of a multi choice.

Shows a filled checkbox for demonstration purposes.

\correctedbox *
Arguments:* – If given, a single choice checkbox is shown instead of a multi choice.

Shows a filled and checked checkbox for demonstration purposes.

\singlemark [kwargs] {question} {lower} {upper}

A simple “mark” question, i.e. a range. The command does not currently allow adding an alternate answer in a way similar to the markgroup or rangearray environments.

Arguments:
  • question – The question text
  • lower – The text for the lower label
  • upper – The text for the upper label
Keyword Arguments:
 

var – The variable for the question (to be appended to context).

\singlemark{A range question}{lower}{upper}
\setcounter{markcheckboxcount}{7}
\singlemark{A range question with 7 answers}{lower}{upper}

\singlemark{A range question}{lower}{upper}
\setcounter{markcheckboxcount}{7}
\singlemark{A range question with 7 answers}{lower}{upper}

Simplest form of a range question

\singlemarkother [kwargs] {question} {lower} {upper} {other}

Similar to \singlemark but also takes an alternative answer.

Arguments:
  • question – The question text
  • lower – The text for the lower label
  • upper – The text for the upper label
  • other – The text for the other label
Keyword Arguments:
 

var – The variable for the question (to be appended to context).

\singlemarkother{A range question}{lower}{upper}{other}
\setcounter{markcheckboxcount}{7}
\singlemarkother{A range question with 7 answers}{lower}{upper}{other}

\singlemarkother{A range question}{lower}{upper}{other}
\setcounter{markcheckboxcount}{7}
\singlemarkother{A range question with 7 answers}{lower}{upper}{other}

A range question with an alternative answer

\textbox * [kwargs] {height} {question}
Arguments:
  • * – If given, the textbox is scalable in height
  • height – The height of the text including a unit. If the * parameter is given, then this is the minimal height only
  • question – The question text, may not contain fragile content
Keyword Arguments:
 
  • text – The question text for the metadata. Fragile content is currently not supported.
  • var – The variable name for this textbox (to be appended to context)

Todo

\textbox should be able to handle an optional keyword argument and then allow the question text to include fragile content.

\textbox*{2cm}{A textbox which is 2cm high, not scaling up to the page size}
\textbox{2cm}{A textbox which is at least 2cm high and can scale up to the page size}
\textbox{10cm}{A textbox which is at least 10cm high sharing the rest of the page with the previous one}

\textbox*{2cm}{A textbox which is 2cm high, not scaling up to the page size}
\textbox{2cm}{A textbox which is at least 2cm high and can scale up to the page size}
\textbox{10cm}{A textbox which is at least 10cm high sharing the rest of the page with the previous one}

A textbox

Note that the SDAPS class supports rather fancy textbox handling including textboxes around other content!

Warning

The following examples are missing code for proper use! They mostly exist to show off the features but are not quite ready for easy consumption.

% Prepare some stuff so that we can access the specialized commands more easily.
\ExplSyntaxOn
\let\sdapshbox\sdaps_textbox_hbox:nnn
\let\sdapshstretch\sdaps_textbox_hstretch:nnnnn
\let\sdapsvbox\sdaps_textbox_vbox:nnnn
\ExplSyntaxOff

\sdapshbox {} {3bp} { This hbox } should have the same baseline. And one can see that a hbox on the left edge
is \sdapshbox{}{3bp}{ nicely aligned } with the edge. And some in a formula: $ f(x) = \frac{1}{c\,\sdapshbox{}{3bp}{box}} \sdapshstretch{}{2mm}{5mm}{40mm}{1} $

See how even the horizontally stretching box in math mode works fine and fills up to the whole width!

Some complex inline content:
  \sdapsvbox {} {0.6\linewidth} {3bp} {
    \begin{tabularx}{\linewidth}{l|l|X}
      adsf  lkasjd lksj flkjsfd & blub & gah \\
      \hline
      asdf & & \\
    \end{tabularx}

    This is a paragraph with more text. This is a paragraph with more text. This is a paragraph with more text.
    This is a paragraph with more text. This is a paragraph with more text. This is a paragraph with more text.
  }

% Prepare some stuff so that we can access the specialized commands more easily.
\ExplSyntaxOn
\let\sdapshbox\sdaps_textbox_hbox:nnn
\let\sdapshstretch\sdaps_textbox_hstretch:nnnnn
\let\sdapsvbox\sdaps_textbox_vbox:nnnn
\ExplSyntaxOff

\sdapshbox {} {3bp} { This hbox } should have the same baseline. And one can see that a hbox on the left edge
is \sdapshbox{}{3bp}{ nicely aligned } with the edge. And some in a formula: $ f(x) = \frac{1}{c\,\sdapshbox{}{3bp}{box}} \sdapshstretch{}{2mm}{5mm}{40mm}{1} $

See how even the horizontally stretching box in math mode works fine and fills up to the whole width!

Some complex inline content:
  \sdapsvbox {} {0.6\linewidth} {3bp} {
    \begin{tabularx}{\linewidth}{l|l|X}
      adsf  lkasjd lksj flkjsfd & blub & gah \\
      \hline
      asdf & & \\
    \end{tabularx}

    This is a paragraph with more text. This is a paragraph with more text. This is a paragraph with more text.
    This is a paragraph with more text. This is a paragraph with more text. This is a paragraph with more text.
  }

Fancy textboxes, for real use additional metadata writing is required!

\addinfo {key} {value}

Adds a bit of metadata. This metadata will for example appear on the cover page of the report.

Arguments:
  • key – The key to set
  • value – The value to set the key to
\addinfo{Key 1}{Value 1}
\addinfo{Key 2}{Value 2}
\addinfo{Key 3}{Value 3}
\addinfo{Key 4}{Value 4}

Almost empty document, look at the metadata to see what this is about.

\addinfo{Key 1}{Value 1}
\addinfo{Key 2}{Value 2}
\addinfo{Key 3}{Value 3}
\addinfo{Key 4}{Value 4}

Almost empty document, look at the metadata to see what this is about.

An example showing the generated metadata

Environments

\begin{choicequestion} [kwargs] {text}
content
\end{choicequestion}
Arguments:

text – Text of the choice question. Fragile content is currently not supported.

Keyword Arguments:
 
  • cols – Number of columns
  • colsep – Distance between columns. This defaults to 6pt.
  • rowsep – Extra distance between rows. This defaults to 0pt.
  • var – Variable name for this question (to be appended to context).
  • text – Replacement text for metadata
  • type – the question type “multichoice” or “singlechoice”
  • multichoice – switch to multichoice “Choice” question mode
  • singlechoice – switch to singlechoice “Option” question mode

The content should only contain \choiceitem, \choicemulticolitem and \choiceitemtext.

\begin{choicequestion}[cols=3]{This is a choice question}
  \choiceitem{First choice}
  \choicemulticolitem{2}{Second choice with a lot of text}
  \choiceitemtext{1.2cm}{3}{Other:}
\end{choicequestion}

\begin{choicequestion}[cols=3]{This is a choice question}
  \choiceitem{First choice}
  \choicemulticolitem{2}{Second choice with a lot of text}
  \choiceitemtext{1.2cm}{3}{Other:}
\end{choicequestion}

A choicequestion

\choiceitem [kwargs] {text}

A possible choice in a choicequestion. Will span exactly one column.

Arguments:

text – The text for the choice. Fragile content is currently not supported.

Keyword Arguments:
 
  • var – Variable name for this answer for multichoice (to be appended to context).
  • val – Value for this answer for singlechoice.
  • text – Replacement text for metadata.
\choicemulticolitem [kwargs] {cols} {text}

A possible choice in a choicequestion. Will span exactly cols columns.

Arguments:
  • cols – The number of columns to span.
  • text – The text for the choice. Fragile content is currently not supported.
Keyword Arguments:
 
  • var – Variable name for this answer for multichoice (to be appended to context).
  • val – Value for this answer for singlechoice.
  • text – Replacement text for metadata.
\choiceitemtext [kwargs] {height} {cols} {text}

A possible freeform choice in a choicequestion. The text field will be of height height and it will span exactly cols columns.

The text item can currently only be used in multichoice environments.

Arguments:
  • cols – The number of columns to span.
  • text – The text for the choice. Fragile content is currently not supported.
Keyword Arguments:
 
  • var – Variable name for this question (to be appended to context).
  • text – Replacement text for metadata.
\begin{optionquestion} [kwargs] {text}
content
\end{optionquestion}

Alias for choicequestion which simply sets it into singlechoice mode by default.

\begin{info}
content
\end{info}

A simple block to typeset important information differently.

\begin{info}
  Just a block to write some information in, will have a line above and below.
\end{info}

\begin{info}
  Just a block to write some information in, will have a line above and below.
\end{info}

An info block

\begin{markgroup} [kwargs] {text}
content
\end{markgroup}
Arguments:
  • text – Common question for all subquestions. Fragile content is currently not supported
  • kwags – Same as rangearray
\begin{markgroup}{A set of mark questions}
  \markline{First question}{lower}{upper}
  \markline{Second question}{lower 2}{upper 2}
\end{markgroup}

\begin{markgroup}{Another set of mark questions which is automatically aligned to the first}
  \markline{First question}{a}{c}
  \markline{Second question}{b}{d}
\end{markgroup}

\begin{markgroup}[other]{Another further set of questions with an alternative answer}
  \markline{First question}{lower}{upper}{other}
  \markline{Second question}{a}{b}{c}
\end{markgroup}

\begin{markgroup}{A set of mark questions}
  \markline{First question}{lower}{upper}
  \markline{Second question}{lower 2}{upper 2}
\end{markgroup}

\begin{markgroup}{Another set of mark questions which is automatically aligned to the first}
  \markline{First question}{a}{c}
  \markline{Second question}{b}{d}
\end{markgroup}

\begin{markgroup}[other]{Another further set of questions with an alternative answer}
  \markline{First question}{lower}{upper}{other}
  \markline{Second question}{a}{b}{c}
\end{markgroup}

A group of range questions (used to be called mark)

Todo

The spacing in the “other” case is not sane, we need a larger default spacing in general.

\begin{choicegroup} [kwargs] {text}
content
\end{choicegroup}
Arguments:
  • text – Common question for all subquestions. Fragile content is currently not supported
  • kwags – Same as choicearray

Note

The choicegroup environment is an alias for the choicearray environment. At this point the only difference is that the choicegroup environment correctly prints the header and that it creates the \groupaddchoice and \choiceline aliases.

\choice [kwargs] {text}

A possible choice inside inside the group.

Arguments:

text – The choices (header) text.

Keyword Arguments:
 
  • text – A replacement text for the metadata, if set fragile content is permitted inside the text argument.
  • var – Variable name for this answer for multichoice (to be appended to context).
  • val – Value for this answer for singlechoice.
\groupaddchoice [kwargs] {text}

Alias for \choice for compatibility.

\question [kwargs] {text}

A single question inside the group. All choices need to be defined earlier using \choice.

Arguments:

text – Question text.

Keyword Arguments:
 
  • text – A replacement text for the metadata, if set fragile content is permitted inside the text argument.
  • var – Variable name for this question (to be appended to context).
\choiceline [kwargs] {text}

Alias for \question for compatibility.

\begin{choicegroup}{A group of questions}
  \choice{Choice 1}
  \choice{Choice 2}
  \question{Question one}
  \question{Question two}
\end{choicegroup}

\begin{choicegroup}{Another group of questions which is automatically aligned to the first}
  \groupaddchoice{1}
  \groupaddchoice{2}
  \choiceline{Question one}
  \choiceline{Question two}
\end{choicegroup}

\begin{choicegroup}{A group of questions}
  \choice{Choice 1}
  \choice{Choice 2}
  \question{Question one}
  \question{Question two}
\end{choicegroup}

\begin{choicegroup}{Another group of questions which is automatically aligned to the first}
  \groupaddchoice{1}
  \groupaddchoice{2}
  \choiceline{Question one}
  \choiceline{Question two}
\end{choicegroup}

Example of a choicegroup environment

\begin{choicegroup}[layouter=rotated,vertical]{A group of questions}
  \groupaddchoice{Choice 1}
  \groupaddchoice{Choice 2}
  \choiceline{Question one}
  \choiceline{Question two}
\end{choicegroup}

\begin{choicegroup}[layouter=rotated,vertical]{A group of questions}
  \groupaddchoice{Choice 1}
  \groupaddchoice{Choice 2}
  \choiceline{Question one}
  \choiceline{Question two}
\end{choicegroup}

Example of a vertical choicegroup environment also showing the "rotated" header layouter

\begin{optiongroup} [kwargs] {text}
content
\end{optiongroup}

Alias for choicegroup which simply sets it into singlechoice mode by default.

Complex typesetting and images

SDAPS allows replacing the text which is exported for the metadata (i.e. what will show up in the report). This can make sense for convenience reasons, if shortened answers are sufficient for e.g. the report, but it also allows inserting complicated LaTeX expressions into the document without having to fear any issues.

Apart from the advantage of having a better string in the report or similar you also get the advantage that more TeX commands can be used in the document. Usually environments like verbatim or array would not work inside an SDAPS environment, but they will work if a replacement text is specified.

\begin{choicegroup}[layouter=rotated]{A group of questions}
  \groupaddchoice[text=choice 1]{$\left( \begin{array}{cc} a & b \\ c & d \end{array} \right) + \log{\alpha}$}
  \groupaddchoice[text=choice 2]{Choice 2 -- \LaTeX}
  \choiceline[text=question 1]{\verb^Inline verbatim^}
  \choiceline[text=question 2]{
    \begin{tabularx}{0.5\linewidth}{llX}
      cell 1 & cell 2 & tabularx over half the page width fit used as the question text. This cell is the X column filling the rest of the half page.
    \end{tabularx}%
  }
  \choiceline[text=question 3]{
\begin{verbatim}Even such things as verbatim environments work.
However, verbatim does have some weird spacing issues (which can be partially
solved by wrapping it into a vbox or similar).
\end{verbatim}
  }
  \choiceline{Question 4 ends up unmodified in the metadata}
\end{choicegroup}

\begin{choicegroup}[layouter=rotated]{A group of questions}
  \groupaddchoice[text=choice 1]{$\left( \begin{array}{cc} a & b \\ c & d \end{array} \right) + \log{\alpha}$}
  \groupaddchoice[text=choice 2]{Choice 2 -- \LaTeX}
  \choiceline[text=question 1]{\verb^Inline verbatim^}
  \choiceline[text=question 2]{
    \begin{tabularx}{0.5\linewidth}{llX}
      cell 1 & cell 2 & tabularx over half the page width fit used as the question text. This cell is the X column filling the rest of the half page.
    \end{tabularx}%
  }
  \choiceline[text=question 3]{
\begin{verbatim}Even such things as verbatim environments work.
However, verbatim does have some weird spacing issues (which can be partially
solved by wrapping it into a vbox or similar).
\end{verbatim}
  }
  \choiceline{Question 4 ends up unmodified in the metadata}
\end{choicegroup}

Example of using fragile content together with metadata text replacement

Variables

\begin{choicegroup}[var=flower]{A group of questions with variable "flower"}
  \groupaddchoice[var=alice]{Choice "alice"}
  \groupaddchoice[var=eve]{Choice "eve"}
  \choiceline[var=adam]{Question "adam"}
  \choiceline[var=bob]{Question "bob"}
\end{choicegroup}

\begin{choicegroup}[var=flower]{A group of questions with variable "flower"}
  \groupaddchoice[var=alice]{Choice "alice"}
  \groupaddchoice[var=eve]{Choice "eve"}
  \choiceline[var=adam]{Question "adam"}
  \choiceline[var=bob]{Question "bob"}
\end{choicegroup}

A choicegroup example using variables. Notice that the boxes in the metadata have variables named e.g. "flower_adam_alice"

Todo

This is still somewhat broken. If the parameter is missing somewhere then it will not be filled in with a proper value automatically!

\begin{markgroup}[var=car]{A group of questions with variable "car"}
  \markline[var=alice]{Question "alice"}{lower}{upper}
  \markline[var=bob]{Question "bob"}{lower}{upper}
\end{markgroup}

\begin{markgroup}[var=car]{A group of questions with variable "car"}
  \markline[var=alice]{Question "alice"}{lower}{upper}
  \markline[var=bob]{Question "bob"}{lower}{upper}
\end{markgroup}

A markgroup example using variables. The variable is e.g. "car_alice" and the boxes have a value assigned to them. The "_dummy" is an implementation detail and should be ignored.

Todo

Check that the _dummy should be there, pretty sure this is correct.