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.
Please 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 entire document should be wrapped using the questionnaire
environment.
The following macros and environments exist:
questionnaire
: Main environment wrapping everything
info
: Style definition for information block
\addinfo
: Add metadata to the project
\sdapsinfo
: Print the standard instructions for filling out
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 contentchoicequestion
: A multiple choice question with a number of answerschoicegroup
: A list of multiple choice questions layed out in rows (or columns)optionquestion
: A single choice question with a number of answersoptiongroup
: 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 |
---|---|
sdaps_style |
The markings style to use. Either “code128”, “qr” (default: code128) |
checkmode |
|
disable_recognition |
Disable all recognition related page markings. This must not be used when intending to ues the SDAPS program for optical mark recognition. An example use case would be creating a PDF form using the SDAPS LaTeX classes. (default: not set) |
twoside_barcode |
|
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 |
General macros and environments¶
-
\begin{
questionnaire
} [kwargs]
content
\end{questionnaire
}¶ - Keyword Arguments
noinfo – Suppress the generation of the standard information text
This is the main environment. You should have exactly one of these environments containing the entire document.
-
\begin{
info
}
content
\end{info
}¶ A simple environment which places a line on top and below the content.
-
\addinfo
{key} {value}¶ Attach further metadata to the SDAPS project. This may be used for any purpose and the information will also appear on the cover page when generating a report using the main SDAPS program.
-
\sdapsinfo
¶ Print the instruction text that is printed at the top of the page unless the noinfo keyword argument is given to
questionnaire
.Place into a
info
block to get the same visual appearance as the default information text.
-
\sdapspagemark
¶ This macro must be executed once for every page. By default it is placed into the center footer and as such should not be executed unless the footer is modified.
While this command is provided, use it at your own risk. No guarantees are made on how the class uses this macro internally. If you use it, you need to verify the behaviour whenever the class is updated and ensure that everything is functioning appropriately. In particular, this macro must not be executed twice per page.
Question 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 – Spacing added on the left/right of every cell. 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}
-
\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 intosinglechoice
mode by default.\begin{optionquestion}[cols=3,singlechoice]{This is a single choice question} \choiceitem{First choice} \choicemulticolitem{2}{Second choice with a lot of text} \end{optionquestion}
-
\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{
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}[align=mygroupalignment]{A set of mark questions} \markline{First question}{lower}{upper} \markline{Second question}{lower 2}{upper 2} \end{markgroup} \begin{markgroup}[align=mygroupalignment]{Another set of mark questions which is 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}
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.
-
\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).
range – Specify which chekcboxes to show. Needs ot be given an in order list of variables (multichoice) or values (singlechoice) also allowing specifying … for any amount of items.
\begin{choicegroup}{A group of questions} \choice{Choice 1} \choice{Choice 2} \question{Question one} \question{Question two} \end{choicegroup} \begin{choicegroup}[align=something]{Another question} \choice{Some choice 1} \choice{Some choice 2} \question{Question one} \question{Question two} \end{choicegroup} \begin{choicegroup}[align=something]{Another group of questions which is automatically aligned to the previous} \groupaddchoice{1} \groupaddchoice{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} \begin{choicegroup}[layouter=rotated,angle=45,vertical]{A group of questions with a smaller angle} \groupaddchoice{Choice 1} \groupaddchoice{Choice 2} \choiceline{Question one} \choiceline{Question two} \end{choicegroup}
\begin{choicegroup}[colsep=2pt,singlechoice]{Please select a date} \groupaddchoice{1} \groupaddchoice{2} \groupaddchoice{3} \groupaddchoice{4} \groupaddchoice{5} \groupaddchoice{6} \groupaddchoice{7} \groupaddchoice{8} \groupaddchoice{9} \groupaddchoice{10} \groupaddchoice{11} \groupaddchoice{12} \groupaddchoice{13} \groupaddchoice{14} \groupaddchoice{15} \groupaddchoice{16} \groupaddchoice{17} \groupaddchoice{18} \groupaddchoice{19} \groupaddchoice{20} \groupaddchoice{21} \groupaddchoice{22} \groupaddchoice{23} \groupaddchoice{24} \groupaddchoice{25} \groupaddchoice{26} \groupaddchoice{27} \groupaddchoice{28} \groupaddchoice{29} \groupaddchoice{30} \groupaddchoice{31} % Note that the automatically assigned values match the choices. \question{Day} \question[range={...,12}]{Month} \question[range={2,5,...,9,28,...}]{Range} \end{choicegroup}
-
\begin{
optiongroup
} [kwargs] {text}
content
\end{optiongroup
}¶ Alias for
choicegroup
which simply sets it intosinglechoice
mode by default.\begin{optiongroup}{A group of questions} \choice{Choice 1} \choice{Choice 2} \question{Question one} \question{Question two} \end{optiongroup} \begin{optiongroup}[align=something]{Another question} \choice{Some choice 1} \choice{Some choice 2} \question{Question one} \question{Question two} \end{optiongroup} \begin{choicegroup}[align=something,singlechoice]{Another group of questions which is automatically aligned to the previous} \groupaddchoice{1} \groupaddchoice{2} \choiceline{Question one} \choiceline{Question two} \end{choicegroup}
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}
Variables¶
\begin{choicegroup}{A group of questions}
\groupaddchoice[var=alice]{Choice "alice"}
\groupaddchoice[var=eve]{Choice "eve"}
\groupaddchoice{Unnamed choice}
\choiceline[var=adam]{Question "adam"}
\choiceline[var=bob]{Question "bob"}
\choiceline{Unnamed question}
\end{choicegroup}
\begin{choicegroup}[var=flower]{A group of questions with variable "flower"}
\groupaddchoice[var=alice]{Choice "alice"}
\groupaddchoice[var=eve]{Choice "eve"}
\groupaddchoice{Unnamed choice}
\choiceline[var=adam]{Question "adam"}
\choiceline[var=bob]{Question "bob"}
\choiceline{Unnamed question}
\end{choicegroup}
\begin{markgroup}{A group of questions}
\markline[var=alice]{Question "alice"}{lower}{upper}
\markline[var=bob]{Question "bob"}{lower}{upper}
\markline{Unnamed question}{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}
\markline{Unnamed question}{lower}{upper}
\end{markgroup}