@@ -69,13 +69,51 @@ be created directly with sdapsarray.
69
69
choice macro and each question using the question macro.
70
70
71
71
.. environ ::
72
- \b egin{optionarray}[]
72
+ \b egin{optionarray}[kwargs ]
73
73
\e nd{optionarray}
74
74
75
- .. todo :: Uh, document this.
75
+ Identical to :environ: `choicearray ` with the singlechoice keyword arguemnt
76
+ set by default.
76
77
77
78
.. environ ::
78
- \b egin{rangearray}[]
79
+ \b egin{rangearray}[kwargs ]
79
80
\e nd{rangearray}
80
81
81
- .. todo :: Uh, document this.
82
+ :kwarg align: named alignment group, set to a common name to align multiple environments to each other
83
+ :kwarg count: the number of choices in the scale (default: 5)
84
+ :kwarg other: whether to show an alternative answer outside of the scale
85
+ :kwarg layouter: set the sdapsarray layouter (unlikely to be useful in this case)
86
+
87
+ The rangearray environment is used for a scale with lower/upper labels plus
88
+ optionally a further checkmark outside of the range.
89
+
90
+ Each question is added using the :macro: `\\ range ` macro.
91
+
92
+ .. macro :: \range[kwargs]{question}{lower}{upper}{other}
93
+
94
+ :param question: The question text.
95
+ :param lower: The text for the lower end label.
96
+ :param upper: The text for the upper end label.
97
+ :param upper: The text for the alternative choice (only valid if other
98
+ is passed to the environmet.
99
+ :kwarg var: Variable name for this question (to be appended to context).
100
+ :kwarg text: A replacement text for the metadata, if set fragile content is
101
+ permitted inside the `text ` argument.
102
+ :kwarg upper: A replacement text for the metadata, if set fragile content is
103
+ permitted inside the `upper ` argument.
104
+ :kwarg lower: A replacement text for the metadata, if set fragile content is
105
+ permitted inside the `lower ` argument.
106
+ :kwarg other: A replacement text for the metadata, if set fragile content is
107
+ permitted inside the `other ` argument.
108
+
109
+ .. sdaps :: Example of a rangearray environment
110
+
111
+ \b egin{rangearray}[count=7,other]
112
+ \r ange{Question one}{lower}{upper}{other}
113
+ \r ange{Question two}{bad}{good}{unsure}
114
+ \e nd{rangearray}
115
+
116
+ \b egin{rangearray}
117
+ \r ange{Question three}{lower}{upper}
118
+ \r ange{Question four}{bad}{good}
119
+ \e nd{rangearray}
0 commit comments