Configuration Details#

Page level#

class ssbuilder.builder.make_question_page(question_id, figure_type='NormalCurveSlider', figure_values=None, page_title='Normal Curve Question', question_text='Move the slider', confirm_message='Confirm my answer', skip_message='Prefer not to answer', button_text='Submit', out_html_file=None, out_rel_path=None, logging_vars=None, confirm_var_name=None, var_name_suffix=True, pretty_url=False, pass_through_vars=['id'], out_url=None, next_question_url=None, debug=False, full_html=True, footer_type='confirm_submit', instructions_type='log', forward_type=None)#

generate html file

Parameters:

  • question_id (string {required}) – name for the question internally

  • figure_type (string) – string name of valid plot type in ssbuilder

  • figure_values (dictionary) – parameters to pass to plotting function

  • page_title (string) – what to show in the tab title default = ‘Normal Curve Question’,

  • question_text (string, markdown formatted) – the text of the questions

  • confirm_message (text) – prompt for confirmation

  • skip_message (text) – prompt for skipping

  • button_text (string) – text on button

  • out_html_file (string) – name fo the html file, that will be in the url for the participant if not passed will add “.html” to the questionid

  • out_rel_path (string or file buffer) – where to write the files.

  • logging_vars (dictionary) – dictionary of names for the variable types the specific question requires

  • confirm_var_name (string {'confirm'}) – name for the variable, if not passed will be question_id + ‘confirm’ +question_id

  • var_name_suffix (boolean {True}) – if true, add question_id to the passed values for all _var_names. Default is True, can be changed to False if you specify the variable names directly

  • pass_through_vars (list of strings ['id']) – list of variables to pass through from previous to next

  • next_question_url (string) – question id or url for the qualtrics question

  • pretty_url (boolean {False}) – if True make pages like /IndentiCurve/name/ instead of /IdentiCurve/name.html

  • full_html (boolean {True}) – generate a full html page or if False, generate only a segment of the page (eg for combining or embedding)

  • footer_type (string {'confirm_submit','next' }) – type of footer to use ‘confirm_submit’ or ‘next’

  • -------

Notes

variables with _var_name + “id” will be passed to qualtrics

Building from config#

ssbuilder.generate_from_configuration#

alias of <Command generate-from-configuration>