R

Required Managed Learner Questionnaire Format [Home Page]


The following are the building blocks required for the creation of questionnaire source files. One may use the template document [see end of list below] found in the htdocs/qst directory of the Managed Learner software package to commence with the creation of new questionnaires.

      1.     Comment Line Label
      2.     Name Of Sponsoring Organization
      3.     Title Of Questionnaire
      4.     Name Of Author
      5.     Version Of Questionnaire
      6.     Questionnaire Start And Expiry Dates
      8.     Questionnaire Default Email Address
      9.     Description Block
     10.    Section Definition
     11.    Subsection Definition
     12.    Information Block Declaration
     13.    Standard Question Block Declaration
     13.    Multiple Choice Question Block Declaration
     13.    Select Option Question Block Declaration
     13.    Match Option Question Block Declaration
     14.    Dependency Declarations
     15.    End Of Questionnaire Declaration
     16.    Changing The Control Delimiter
     17.    HTML Line Label
              APPENDIX - Questionnaire Template



Comment Line Label   [Back to Top]


This declaration takes is for one line only and must start with the four characters 'rem:'

You may not list comments within the data regions of Description, Question or Information blocks.

Example:

rem: This is a comment line



Sponsoring Organization   [Back to Top]


This declaration takes place on one line only as follows:

~COMPANY~...enter name of company here....~

The data field may be up to 40 characters in length.

This declaration must occur prior to first section declaration.

Example:

~COMPANY~CGE Informatica~



Title Of Questionnaire   [Back to Top]


This declaration takes place on one line only as follows:

~TITLE~...enter title of questionnaire here....~

The data field may be up to 40 characters in length.

This declaration must occur prior to first section declaration.

Example:

~TITLE~WORLD POLITICS~



Author Of Questionnaire   [Back to Top]


This declaration takes place on one line only as follows:

~AUTHOR~...enter name of author here....~

The data field may be up to 40 characters in length.

This declaration must occur prior to first section declaration.

Example:

~AUTHOR~William Brinkley~



Version Of Questionnaire   [Back to Top]


This declaration takes place on one line only as follows:

~VERSION~...enter version of questionnaire here....~

Version of questionnaire can be any decimal number.

This declaration must occur prior to first section declaration.

Example:

~VERSION~1.22~

Note: minor version changes e.g. from version 1.5 to 1.6 can be done while the questionnaire is in use. However, changes from one minor version to its next increment should really be marginal. No student will appreciate being presented with a noticeably different questionnaire on the successive occasion that he logs in. The system can tolerate removing of questions and addition of questions as long as you update the version.

Major questionnaire version changes e.g. version 1.x to 2.0 should be done when you have a new batch of students attempting the questionnaire - never midstream. Of course you may work on the assembly of a new major version of questionnaire during a period of time and release it at the opportune time.
Questionnaire Start & Expiry Dates   [Back to Top]


This declaration takes place on one line only as follows:

~START&END~YYYYMMDD~YYYYMMDD~

with the first YYYYMMDD being the first day the questionnaire can be used,

with the second YYYYMMDD being the final day the questionnaire can be used.

This declaration must occur prior to first section declaration.

Example:

~START&END~20001201~20201231~



Questionnaire Default Email Address   [Back to Top]


In the event that a section does not have a feedback email address specified, then in that case feedback originating from a question in that section will be forwarded to this default email address.

This declaration must occur prior to first section declaration.

The email data field may be up to 40 characters in length.

Example:

~EMAIL~feedback@yourcompany.com~



Description Block   [Back to Top]


This field has information about the questionnaire.

As can be seen from below, to declare a description block, you need to enter 'DESCRIPTION' between control delimiters '~'. Subsequent lines are meant to hold information regarding this questionnaire. The final information line must terminate with a '|' character.

This declaration must occur prior to first section declaration.

You are permitted to enter up to 200 lines of information.

Example:

~DESCRIPTION~
.....line 1 of information......
.....line 2 of information......
.....line 3 of information......
.................................................
.................................................
.................................................|



Questionnaire Section Declaration   [Back to Top]


This declaration takes place on one line only as follows:

~SECTION~xx~...enter section name here....~[I]~[E[0,1]emailaddress]~

xx - is the section number and can be from 00 to 19.

The section name field may be up to 40 characters in length.

The 'I' segment may be used if you wish to have this section labeled as 'ignored' on first invocation by a user. Of course the user can later remove this label if s/he wishes.

The segment starting with 'E' carries the section feedback email address. A '0' following the 'E' indicates that the feedback need only go to this address specified. If a '1' followed the 'E' then the feedback would also go to the default feedback address listed at the top of the questionnaire.

The size of the email address may be up to 40 characters in length.


Examples:

~SECTION~01~GEOGRAPHY~

~SECTION~01~GEOGRAPHY~I~

~SECTION~01~GEOGRAPHY~E0feedback@yourcompany.com~

~SECTION~01~GEOGRAPHY~I~E1feedback@yourcompany.com~



Questionnaire Subsection Declaration   [Back to Top]


This declaration takes place on one line only as follows:

~SUBSECTION~...enter subsection name here....~

The data field may be up to 40 characters in length.

Example:

~SUBSECTION~WORLD WAR I~



Information Block Declaration   [Back to Top]


An information block occupies two or more lines. The first line is used to declare that the block is an information block. The subsequent lines hold the information, and may not exceed 200 lines. An information block has the following format:

~QIxxx~|
...line 1 of info in block
..........line 2 ....................
.........................................
.........................................
..........line n ....................|


xxx - refers to question number which can be from 0 to 999.

Note that the control lines end with a block delimiter '|'.
Note also that the information section ends with delimiter also.



Standard Question Block Declaration   [Back to Top]


A question block occupies at least three lines, and has three parts. The first part declares that block is a question block. The second part holds the question section of the block. The third part holds the answer or in the case of a multiple choice question, the potential answer. The total number of question and answer lines may not exceed 200 lines.


Standard Question Type Definition

~QQxxx~|
.... line 1 of question .....
.............................................
.............................................
.... line n of question .....|
.... line 1 of answer ......
.............................................
.............................................
.... line m of answer ....|

QQ - indicates that question is of standard type.

xxx - refers to question number which can be from 0 to 999.

Example:

~QQ21~|
In what year did WWII begin?|
1939|



Multiple Choice Question Type Definition   [Back to Top]


~QMxxx~|
.... line 1 of question .....
.............................................
.............................................
.............................................
.... line n of question .....|
.... line 1 of answer ......
^.....[correct answer].........
.............................................
^.....[correct answer].........
.... line n of answer .....|


QM - indicates that question is of multiple choice type.

xxx - refers to question number which can be from 0 to 999.

'^' character at beginning of line indicates to system that answer exists on that line, and therefore this or these lines will be highlighted when the user prompts for the answer. If answer extends beyond one line then all lines containing answer must begin with '^' character.

Note1: each line of answer must be no more than 500 characters in length. If it exceeds this number the questionnaire check software will signal an error. Lines which start with '^' character may be of length 76 in total.

Example:

~QM31~|
In what year did WWII begin?|
1917
1933
^1939
1945|



Select Option Question Type Definition   [Back to Top]


~QSxxx~|
.... line 1 of question .....
.............................................
.............................................
.............................................
.... line n of question .....|
.... line 1 of answer ......
..... preamble to potential answers [[x1//((x2))//x3]].
..... preamble ... [[x4//x5//((x6))] post-amble....
.... line n of answer .....|


QS - indicates that question is of select option type.

xxx - refers to question number which can be from 0 to 999.

[[x//((y))//z]] - the segment wherein the answer options lie. The part in brackets is the correct answer.

Note1: each line of answer must be no more than 500 characters in length. If it exceeds this number the questionnaire check software will signal an error.

Example:

~QS31~|
Select correct answers from brackets below.|
..... the quick brown fox jumps over the laxy [[cat//((dog))//horse]].
..... the quick brown [[hare//tortoise//((fox))] jumps over the
..... laxy [[cat//((dog))//horse]] .
|



Match Option Question Type Definition   [Back to Top]


~QOxxx~|
.... line 1 of question .....
.............................................
.............................................
.............................................
.... line n of question .....|
.... line 1 of answer ......
......[[answer1]].........
.............................................
......[[answer2]].........
.... line n of answer .....|


QO - indicates that question is of match option type.

xxx - refers to question number which can be from 0 to 999.

[[answer]] - the answer segment. The answer is not displayed on initial presentation. It is displayed when a request to display answer is made.

Note1: each line of answer must be no more than 500 characters in length. If it exceeds this number the questionnaire check software will signal an error.

Note2: do not insert any html control information within the [[ and ]] delimiters.

Example:

~QO31~|
Decide on correct answer for each of options below.|
[[1917]] was the year in which WWI started.
[[1939]] was the year in which WWII started.
[[1991]] was the year in which the first Gulf War [Iraq,Kuwait] started.
|



Dependency Declarations   [Back to Top]


The appearance of questions and information blocks may be made dependant on the completion of attempts of previous or future questions. To make a question or information blocks dependant on other questions, one needs to merely insert additional information in the control section of a question or information block.

Dependency Declarations

A dependency is one where the appearance of a question or information block is dependant on the successful completion of a previous or future question. Here is an example of question 31, being dependant on question 30 being answered. Note that only the control section of the question block is displayed.

~QQ31~D30~|

The 'D' character in the second token indicates dependency.

One can have more than one dependency per question or information block and a total number not exceeding 6. Dependencies may be on prior or subsequent questions all of which must exist within same section.

Example:

~QQ31~D29~D30~|

Here question 31 only appears if both questions 29 AND 30 have been answered successfully. A logical 'AND' relation exists with all positive dependencies, whereas an 'OR' relation exists with negative dependencies as is described below. However, an 'AND' relation exists between the results of positive and negative dependencies to result in a final determination if the question will appear or not.



End Of Questionnaire Declaration   [Back to Top]


This declaration takes is for one line only and uses the section definition line

~SECTION~xx~END~

xx - is the a number that is one more than the number of the previous section declared and can be

any number from 01 to 20.


Example:

~SECTION~11~END~



Changing The Control Delimiter   [Back to Top]


This declaration takes place on one line only as follows:

~SEPARATOR~...enter new delimiter character here....~

The default delimiter on startup is the '~' character.

Changing the control delimiter is useful when you want to use the delimiter character as data. Changing the delimiter to some other character permits you to use that previous delimiter character as a normal character.

Example:

~SEPARATOR~-~

-TITLE-HISTORY~GEOGRAPHY-

-SEPARATOR-~-


* Note: Do not forget to change to standard delimiter when you are done.



HTML Line Label   [Back to Top]


This declaration is for one line only and must start with the five characters 'html:'

This declaration may be used in a limited way in question and information blocks.

Any source files mentioned in html lines must be placed in htdocs/qst/[qstname] directory.

Example:

html: <font color=red>


Note1: No syntax check is done of the html content in the line. No line break is added at the end of the line.

Note2: html declarations are permitted in information blocks and standard question blocks [in both question and answer segments].

Note3: html declarations are permitted in the question segment of multiple choice, select option and match option question segments, but not in their answer segments. In the file createnewq.ini.php you can define certain characteristics [such as font, color, boldness] for the answer blocks of these same type of questions.

Note4: You may change certain color characteristics of the labels [Questionnaire, Section, Subsection] that appear in a question block header by changing the appropriate variables in the createnewq.ini.php file.


Special HTML Characters:     [& " < >]

Certain characters have special significance in HTML. If you want them to be properly represented on your page you must list them appropriately with their HTML equivalent.

Here are the main examples:


                   '"'           '&quot;'

                   '&'           '&amp;'

                   '<'           '&lt;'

                   '>'           '&gt;'

                   ' '           '&nbsp;'


For instance '</font>' is HTML control information.

If you wanted it to show up on the screen you would write it as '&lt;/font&gt;'




APPENDIX - Questionnaire Template   [Back to Top]


~COMPANY~My Company~
~TITLE~The World~
~AUTHOR~Anonymous~
~VERSION~1.3~
~START&END~20000101~20051230~
~EMAIL~genfdbk@mycompany.com~
~DESCRIPTION~
This is a basic questionnaire template. |

rem:---------------------------------------------------------------------------------------------------------
~SECTION~00~Geography~
~SUBSECTION~Oceans~

rem:---------------------------------------------------------------------------------------------------------
rem: The following is a information block with no dependencies.

~QI0~|
The 3 major oceans of the world are:
Pacific
Atlantic
Indian|

rem:---------------------------------------------------------------------------------------------------------
rem: The following is a question with no dependencies.

~QQ1~|
Name the major oceans of the world?|
Pacific
Atlantic
Indian|

rem:---------------------------------------------------------------------------------------------------------
rem: The following information block only appears if info block 0 and question
rem: 1 have been declared as understood.


~QQ2~D0~D1~|
Which is the largest ocean?|
Pacific.|

~SECTION~01~History~
~SUBSECTION~World Leaders~

rem:---------------------------------------------------------------------------------------------------------
rem: This is illustration of a multiple-choice question


~QM10~|
Who said 'Icht bien ein Berliner'?|
Churchill
^Kennedy
Stalin
Roosevelt|


rem:---------------------------------------------------------------------------------------------------------
~SECTION~02~END~
rem:---------------------------------------------------------------------------------------------------------



[[end of document]]
Copyright © 2002-2016 Chandra G. Ellaurie PEng.   - www.mlnr.org