Home - adaptlearning/adapt-contrib-textInput GitHub Wiki

#Text Input

Text Input is a question component bundled with the Adapt framework.

This component asks the learner to answer a question by typing a correct phrase, word, or number.

Visit the page dedicated to Usage and Tips.

##Installation

As one of Adapt's core components, Text Input is included with the installation of the Adapt framework and the installation of the Adapt authoring tool.

• If Text Input has been uninstalled from the Adapt framework, it may be reinstalled. With the Adapt CLI installed, run the following from the command line:
  adapt install adapt-contrib-textInput

• If Text Input has been uninstalled from the Adapt authoring tool, it may be reinstalled using the Plug-in Manager.

##Settings

The settings listed below are the properties that may be configured within the authoring tool. Listed first is the name of the property as it is presented in the authoring tool. It is followed in parentheses by the property as it is used in the Text Input source code. Finally, an explanation is provided to help the course author better utilize the property.

The relationship between Text Input's properties and the way they are presented in the authoring tool’s interface is governed by properties.schema.

Title (title): A reference title for the component. Title is distinct from the Display Title which, if present, appears above the component. If Display Title is rather long, Title provides the opportunity to use a shortened form in tighter spaces, such as in a menu or in the drawer.

Display Title (displayTitle): Optional text that will display as a title above the component. It can be used as a headline. In the authoring tool, Title and Display Title may be linked for easy input. Click the chain icon to toggle linking.

Body (body): Optional text that appears above the component. It can be used in a variety of ways, including as an introduction to the content in the component. HTML is permitted.

Instruction (instruction): This optional text appears above the component. It is frequently used to guide the learner’s interaction with the component.

Classes (_classes): Custom classes predefined in the theme's Less files may be applied to this component. To do this, enter the name of the CSS class. If using more than one class, separate each with a space.

Layout (_layout): This defines the horizontal position of the component in the block that contains it. This property is set when the component is being added to the block. When Add to left or Add to right is selected, another component can occupy the space next to it. If Add is selected, the component spans the width of the containing block.

Attempts (_attempts): This specifies the number of times a learner is allowed to submit an answer.

Display Attempts (_shouldDisplayAttempts): Determines whether or not the text set in Final Attempt Text and Attempts Remaining Text will be displayed. These two attributes are part of the core buttons attribute group.

Randomised Items (_isRandom): Setting this value to true will cause the Items to appear in a random order each time the component is loaded.

Allow Any Case Answers (_allowsAnyCase): This setting determines whether or not the learner's input must match the uppercase and lowercase letters of the supplied answer/s. Set to false if case-sensitivity is required for a correct answer.

Question Weight (_questionWeight): A number which reflects the significance of the question in relation to the other questions in the course. This number is used in calculations of the final score reported to the LMS.

Allow Punctuation (_allowsPunctuation): This setting determines whether the learner's input may include punctuation characters listed below.
) ( ~ _ - = } { : ; * & ^ % £ $ ! # - / , . `

_answers (_answers): An optional two-dimensional array of answers that, if provided, eliminates a required ordering. Used with questions of this model: "List the names of seven continents" where order among the seven responses is irrelevant. May be used in combination with Items in order to provide Prefix, Suffix, and Placeholder, but _answers should not be provided a second time. Example:

    “_answers”: [
       [“Asia”],
       [“Africa”],
       [“North America”,"N America", "N. America"],  
       [“South America”,"S America", "S. America"],
       [Europe],
       [Antartica],
       [Australia]
    ]

Items (_items): Each item represents one text input box for this question and contains values for Answers, Prefix, Suffix, and Placeholder.

Answers (_answers): Text value/s that must be matched by the learner's input. Multiple answers can be created to accommodate, for example, variations in spelling. Example:

    "_answers": [  
        "2",
        "two"
    ]

Prefix (prefix): Text entered in this setting will appear before the input area.

Suffix (suffix): Text entered in this setting will appear after the input area.

Placeholder (placeholder): This text supplies a short hint describing the expected value of the input field.

Feedback (_feedback): If the Tutor extension is enabled, these various texts will be displayed depending on the submitted answer. Feedback contains values for three types of answers: Correct, Incorrect, and Partly Correct.

Correct (correct): Text that will be displayed when the submitted answer is correct.

Incorrect (_incorrect): Texts that will be displayed when the submitted answer is incorrect. It contains values that are displayed under differing conditions: Final and Not Final.

Incorrect Final (final): Text that will be displayed when the submitted answer is incorrect and no more attempts are permitted.

Incorrect Not Final (notFinal): Text that will be displayed when the submitted answer is incorrect while more attempts are permitted.

Partly Correct (_partlyCorrect): Texts that will be displayed when the submitted answer is partially correct. It contains values that are displayed under differing conditions: Final and Not Final.

Partly Correct Final (final): Text that will be displayed when the submitted answer is partly correct and no more attempts are permitted.

Partly Correct Not Final (notFinal): Text that will be displayed when the submitted answer is partly correct while more attempts are permitted.

##Limitations

Accessibility for iOS < v9.1 is broken. Works on iOS 9.1