Markdown Survey Format

As described here, you can use a variant of the markdown format to create surveys.

This page describes the details of the syntax. To get started quickly, you can download some example markdown surveys.

Markdown specifies links using the following format:

[link text](link reference)

Kaizen Surveys Markdown format uses the link format with special ‘link text’ (and the link reference is left blank).

Am example of specifiying a link to google in markdown would be [Google](http://www.google.com)

Question Format

[Q:XXX YYY]()

Where XXX is any valid question type.

Answer Format

[A YYY]()

Note that YYY is the name associated with the answer. It need NOT be specified for both the question and answer (either or both is fine).

Note that not all questions require an answer field.

Supported Question Types

All questions must start with Q:XXX where XXX is the question type

Text Based Questions

Question Type (XXX) Description
String Basic Text Question
Text Longer Text Question where answer can be multiple lines long.
String-History1 Text question with a history. Previous answers are available as possible choices.
String-History Text question with a history, but also allows multiple answers.
String-Multi Text question that allows multiple answers.

Number Based Questions

Question Type (XXX) Description
Integer Question expects a counting number (integer) answer. Can specify min/max.
Integer-Spinner Same as Integer, but displays a spinner. Requires you to specify min/max.
Decimal Expects a number (including decimals)
Rating Star rating. Can specifiy min/max (defaults 0 and 5)

Date/Time Based Questions

Question Type (XXX) Description
Datetime Date and Time (spinners)
Date Date (spinner)
Time Time (spinner)

Multiple Choice Questions

Question Type (XXX) Description
Select1 Multiple choice
Select Multiple select. Can choose multiple answers.
Select1-Spinner Same as Select1 but with a spinner.

Other Questions

Question Type (XXX) Description
Note This Question type expects no answer. Just displays information.
Geopoint Record current location.
Image Get image from camera or import existing image/photo.
Flashcard Creates a flashcard question with question and answer provided.

A more complete description of what these question types do is found in the survey wizard (editor) within the Kaizen Surveys app. They are also described here.

Equivalent Examples for a Number Question

All three of the following would create a question that expects a number answer that is stored as ‘Height’.

[Q:Decimal Height]() What is your height?
[Q:Decimal Height]()

What is your height?
[Q:Decimal]()

What is your height?

[A Height]()
Markdown Tip

Blank lines matter in markdown. A common mistake is to forgetting to include blank lines where appropriate.

In the above examples, the blank lines indicated are required in order to properly separate the content.

Also, don't forget to include the () after your link text [????]() as it is required to be picked up as a markdown link.

Example for a Text Question

Note that this example uses the markdown image reference format within the question text.

[Q:Text Comments]()

![](http://upload.wikimedia.org/wikipedia/commons/thumb/5/5f/HubbleDeepField.800px.jpg/245px-HubbleDeepField.800px.jpg)

Take a few minutes to look at this photo and then describe what you see.

*Please do NOT use the internet or a reference to help you :)*

Example for a Multiple Choice Question

Note that this example uses the markdown image reference format within the question text.

[Q:Select1]()

![](http://upload.wikimedia.org/wikipedia/commons/thumb/5/5f/HubbleDeepField.800px.jpg/245px-HubbleDeepField.800px.jpg)

Choose the best description for this image.

[A Astro Photo]()

* Dog
* Salad
* Planet
* Supernova
* Thousands of galaxies

Advanced example for a Multiple Choice and History Question.

This example illustrates using the ‘useradd’ option on a select1 question as well as the ‘filteranswer’ option on a history question.

[Q:Select1]() { useradd=true }

What best describes your current mood?

[A Mood]()

* Happy
* Sad
* Mad

[Q:String-History Reasons]() { filteranswer='Mood'}

Try to identify as many possible reasons you are aware of right now that might be contributing to this mood.

In the above example, the ‘useradd’ option allows the user to add a NEW choice in the multiple choice question.

The ‘filteranswer’ option on the String-History question will show previous answers as possible choices to this question. However, only answers given previously for the currently selected Mood will be shown.

Example for a Flashcard Question

Note that this example uses the markdown image reference format within the question and answer text.

[Q:Flashcard]()

![](http://upload.wikimedia.org/wikipedia/commons/thumb/5/5f/HubbleDeepField.800px.jpg/245px-HubbleDeepField.800px.jpg)

What is this a picture of?

[A]()

Hubble Deep Field image.

More info about this image is [available here](http://commons.wikimedia.org/wiki/File:HubbleDeepField.800px.jpg).

Simplified Markdown Survey Format

An additional method of specifying questions is to use #Q and #A as alternatives to the link references described above.

Simplified Markdown Limitation

In the current version of Kaizen Surveys, the simplified Markdown format described here only supports Flashcard type questions.

Simplified Markdown Limitation

Note that the ENTIRE markdown file must either use the standard (link) notation or the simplified notation described here. You cannot mix both in the same file.

Example for a Flashcard Question

#Q What is this a picture of?

![](http://upload.wikimedia.org/wikipedia/commons/thumb/5/5f/HubbleDeepField.800px.jpg/245px-HubbleDeepField.800px.jpg)

#A Hubble Deep Field image.

More info about this image is [available here](http://commons.wikimedia.org/wiki/File:HubbleDeepField.800px.jpg).