Word Import
Surveys can be created first in Microsoft Word and later imported into Lighthouse Studio (by clicking File > New Study from Word...). See the documentation below for how to format your Word document properly.
A sample Word document can be found in the Samples folder located in the user's Documents\Sawtooth Software\Lighthouse Studio folder.
Questions:
|
Additional Items:
|
This documentation describes the format required to import a Word document into Lighthouse Studio. Here is an example of how to specify a select question in Word:
[QUESTION: Q1] [TYPE: SELECT | RADIO | RANDOMIZE] Please select your favorite color:
|
The text above defines a single Select question named "Q1". The text inside of brackets, for example "QUESTION" or "TYPE", is a tag. Tags are used to specify different settings. The "QUESTION" tag specifies the beginning of a new question. Some tags can contain values. In the example above the value for "QUESTION" is "Q1", the name of the question. Tags do not need a value. For example the tag "RANDOMIZE" has no value. Just including this tag will cause the response options to be randomized.
Multiple tags can be combined within one set of brackets if they are separated by the "|" character. For example:
[TYPE: SELECT] [RADIO] [RANDOMIZE] |
can also be written like this:
[TYPE: SELECT | RADIO | RANDOMIZE]
|
Tags are case-insensitive.
Select questions can be created by setting the TYPE tag to SELECT. They have the following optional tags:
RADIO, CHECKBOX, or DROPDOWN |
Specifies the Select format. RADIO is the default. |
MINIMUM |
Specifies the minimum number of checks allowed (applies to CHECKBOX). Requires a value. |
MAXIMUM |
Specifies the maximum number of checks allowed (applies to CHECKBOX). Requires a value. |
RANDOMIZE |
Randomize the response options. |
REQUIRED |
Specifies that the question must be answered. |
NOT REQUIRED |
Specifies that the question does not need to be answered. |
Example:
[QUESTION: Q1] [TYPE: SELECT | CHECKBOX] [RANDOMIZE] [MINIMUM: 2 | MAXIMUM: 4] Please select two or more of your favorite options.
|
Grid questions can be created by setting the TYPE tag to GRID. They can contain the following tags:
RADIO, NUMERIC, or OPEN-END |
Specifies the grid format. RADIO is the default. |
ROW LIST |
This tag comes before the bulleted or numbered list that defines each row label. This tag is required. |
COLUMN LIST |
This tag comes before the bulleted or numbered list that defines each column label. This tag is required. |
RANDOMIZE ROWS |
This tag will cause the grid rows to be randomized. |
RANDOMIZE COLUMNS |
This tag will cause the grid columns to be randomized. |
MINIMUM |
Specifies the minimum number of checks allowed per row or column if used with the CHECKBOX format. Specifies the minimum number that can be entered if using the NUMERIC format. Used to specify the minimum number of characters if using the OPEN-END format. Requires a value. |
MAXIMUM |
Specifies the maximum number of checks allowed per row or column if used with the CHECKBOX format. Specifies the maximum number that can be entered if using the NUMERIC format. Used to specify the maximum number of characters if using the OPEN-END format. Requires a value. |
DON'T KNOW |
Specifies the "Don't Know / Refuse" value for the NUMERIC format. Requires a value. |
DECIMALS |
If included allows decimal numbers to be entered. Applies to the NUMERIC format. |
SINGLE LINE |
Specifies that OPEN-END input should be a single line. |
MULTIPLE LINE |
Specifies that OPEN-END input should have multiple lines. |
REQUIRED |
Specifies that the question must be answered. Applies to grids with the RADIO, NUMERIC, or OPEN-END format. |
NOT REQUIRED |
Specifies that the question does not need to be answered. Applies to grids with the RADIO, NUMERIC, or OPEN-END format. |
Example:
[QUESTION: Q1] [TYPE: GRID | CHECKBOX] [DIRECTION: COLUMNS] [MINIMUM: 1 | MAXIMUM: 2] Indicate the number of items in each column. [ROW LIST]
|
Numeric questions can be created by setting the TYPE tag to NUMERIC. They have the following optional tags:
MINIMUM |
Specifies the minimum number allowed. Requires a value. |
MAXIMUM |
Specifies the maximum number allowed. Requires a value. |
DON'T KNOW |
Specifies the "Don't Know / Refuse" value. Requires a value. |
DECIMALS |
If included allows decimal numbers to be entered. |
REQUIRED |
Specifies that the question must be answered. |
NOT REQUIRED |
Specifies that the question does not need to be answered. |
Example:
[QUESTION: Q1] [TYPE: NUMERIC] [MINIMUM: 0 | MAXIMUM: 24] About how many hours a day do you perform this activity? |
Open-end questions can be created by setting the TYPE tag to OPEN-END. They have the following optional tags:
MINIMUM |
Specifies the minimum number of characters allowed. Requires a value. |
MAXIMUM |
Specifies the maximum number of characters allowed. Requires a value. |
MULTIPLE LINES |
Include to indicate that the input box contains multiple lines. |
SINGLE LINE |
Include to indicate that the input box displays as a single line. |
REQUIRED |
Specifies that the question must be answered. |
NOT REQUIRED |
Specifies that the question does not need to be answered. |
Example:
[QUESTION: Q1] [TYPE: OPEN-END] [MINIMUM: 1 | MAXIMUM: 30] [SINGLE LINE] What is your name? |
Ranking questions can be created by setting the TYPE tag to RANKING. They have the following optional tags:
DRAG TO CONTAINER, SORT VERTICALLY, SORT HORIZONTALLY, NUMERIC, DROPDOWN |
Specifies the format of the ranking question. |
PARTIAL |
Specifies a subset of items to rank. Applies to DRAG TO CONTAINER, SORT VERTICALLY, and SORT HORIZONTALLY. Requires a value. |
RANDOMIZE |
Randomizes the response options. |
REQUIRED |
Specifies that the question must be answered. |
NOT REQUIRED |
Specifies that the question does not need to be answered. |
Example:
[QUESTION: Q1] [TYPE: RANKING | SORT VERTICALLY] [RANDOMIZE] Please rank the following brands...
|
Semantic Differential questions can be created by setting the TYPE tag to SEMANTIC DIFF. They have the following tags:
SLIDER, RADIO |
Specifies the format. SLIDER is the default. |
LEFT LIST |
This tag comes before the bulleted or numbered list that defines the left-side list. This tag is required. |
RIGHT LIST |
This tag comes before the bulleted or numbered list that defines the right-side list. This tag is required. |
SCALE LIST |
This tag comes before the bulleted or numbered list that defines the scale list. |
LEFT VALUE |
Specifies the left side value of the scale. If this is used then the SCALE LIST is not used for values. |
RIGHT VALUE |
Specifies the right side value of the scale. If this is used then the SCALE LIST is not used for values. |
RANDOMIZE ROWS |
Randomizes the rows. |
RANDOMIZE COLUMNS |
Randomizes the columns. |
RANDOMIZE ITEMS |
Randomizes individual items. |
REQUIRED |
Specifies that the question must be answered. |
NOT REQUIRED |
Specifies that the question does not need to be answered. |
Example:
[QUESTION: Q1] [TYPE: SEMANTIC DIFF] [RANDOMIZE ROWS] Please tell us what you think about Anderson grocery stores. [LEFT LIST]
[SCALE LIST]
|
Constant sum questions can be created by setting the TYPE tag to CONSTANT SUM. They have the following optional tags:
TOTAL |
Specifies the total amount that must be entered. Requires a value. |
DECIMALS |
If included allows decimal numbers to be entered. |
RANDOMIZE |
Randomizes the response options. |
REQUIRED |
Specifies that the question must be answered. |
NOT REQUIRED |
Specifies that the question does not need to be answered. |
Example:
[QUESTION: Q1] [TYPE: CONSTANT SUM] [TOTAL: 24] Approximately how many hours per day do you perform each of these activities:
|
Select questions can be created by setting the TYPE tag to TEXT.
Example:
[QUESTION: Intro] [TYPE: TEXT] Welcome to the survey. We appreciate your feedback. |
Terminate questions can be created by setting the TYPE tag to TERMINATE. They have the following optional tags:
QUALIFIED, DISQUALIFIED |
Specifies the termination status. The default is QUALIFIED. |
LINK |
Specifies a link (e.g. https://www.sawtoothsoftware.com) to follow after termination. Requires a value. If a link is specified no question text should be entered as the survey will follow the link instead of displaying text. |
Example:
[QUESTION: THANKYOU] [TYPE: TERMINATE] Thank you for your feedback. We really appreciate it. |
Question text can be defined by placing text beneath the following tags:
•HEADER 1
•HEADER 2
•QUESTION TEXT
•FOOTER
If none of these tags are specified HEADER 1 will be used.
Example:
[QUESTION: Q1] [TYPE: SELECT | RADIO] [HEADER 1] Q1 [HEADER 2] Please select your favorite color: [List]
|
Multiple paragraphs can be imported as a single text field. Any text that is bolded, italicized, or underlined in Word are given the appropriate HTML tags in Lighthouse Studio.
To remove any formatting from a section of text use the CODE and END CODE tags. See: HTML, JavaScript, CSS
A bulleted list may be entered into question text, however a question text tag (e.g. HEADER 1, HEADER 2, etc.) is required above it. Otherwise the bulleted list might be interpreted as question response options.
Response options or list items are defined by either a numbered or bulleted list within the document. Here is an example:
[QUESTION: Q1] [TYPE: SELECT] Please select your favorite color:
|
The bulleted list in the example above specifies the response options for the select question. If a numbered or bulleted list follows a question text tag, such as "HEADER 1", then it is assumed that the list should be part of the question text and not a way of specifying response options. To define response options explicitly for a question, use the LIST tag.
Lists optionally can have names assigned to them. This allows the list to be reused in the survey. When reusing a list, you can just use the list tag with the name; you don't have to respecify all of the list items. Here is an example:
[QUESTION: Q1] [TYPE: SELECT] Please select your favorite color: [LIST: colorList]
[TYPE: SELECT] Please select your least favorite color: [LIST: colorList] |
"Other Specify" list items are defined by including the OTHER tag after the item text. Exclusive items (e.g. "None of the above") are specified with the EXCLUSIVE tag. For example:
[QUESTION: Q1] [TYPE: SELECT | CHECKBOX] Please select all your favorite colors: [LIST: colorList]
|
Here is an example of skip logic:
[QUESTION: Q1] [TYPE: SELECT] Please select your favorite color:
|
At the bottom of the example above you will see the tag "SKIP TO" followed by the destination question. Next the tag "IF" is followed by the skip logic.
In addition to question names these special destinations are supported:
•Next Question
•End of Block
•Next Loop Iteration
•End of Loop
"PRE-SKIP" can also be used.
To always skip to a destination do not include "IF" or any logic. For example:
[SKIP TO: Q15]
|
Tags that begin and end with a hyphen are ignored and can be used as comments or notes within the document. For example:
[--- Start the demographic questions here ---]
|
Everything in the example above will not imported into Lighthouse Studio.
To specify a page break include the PAGE BREAK tag.
Example:
[PAGE BREAK]
|
If you would like to exclude the content at the top or bottom of your document you can use the START SURVEY and END SURVEY tags. All content above START SURVEY and after END SURVEY will be ignored. These tags are optional. If they are not included it will be assumed that the whole document contains proper Lighthouse Studio Word Import syntax.
Example:
Dietary Preferences Survey Author: John Smith Client: Sawtooth Software [START SURVEY] [QUESTION: Q1] ... [END SURVEY] 123 Main St. 555-1234 (ext. 567) example@email.com |
If your survey text contains a bracket ("[" or "]") you will need to include two brackets to differentiate it from a tag. Here is an example of how you would specify brackets in your survey text:
[[This text will be imported with single brackets surrounding it]]
|
The text above would look like this after it was imported:
[This text will be imported with single brackets surrounding it]
HTML, JavaScript, CSS etc. can be entered into the Word document. We recommend surrounding any custom code by the CODE and END CODE tags. These tags will prevent Word Import from adding any unintended formatting to the code.
Example:
[HEADER 1] About how many hours a day do you perform this activity? [CODE] <script> ... </script> [END CODE] |
