Developer's Guide:

Overview: This page describes the jQuizMe's arguments. jQuizMe( quiz, options, lang );

You can view the source for the demos here.

Note: jQuizMe only needs a quiz to run.

Quiz :

jQuizMe( quiz, options, lang );

A quiz is just an array of problems with a quiz type attached to it.

A problem is an object with 4 possible properties.

Note: All problems must have the ques and ans property.

Also, all properties can be string, numbers or html as values.

So here is a simple problem.

{ ques : "2 + 2", ans : "4" } // 2 + 2 = 4

And we can turn it into a quiz, without a quiz type, by placing it into an array.

var basicQuiz = [
    { ques : "2 + 2", ans : "4" }  // Only has one question.
];

Quiz Type:

Note: You can use the short or full name for a quiz type.

Special Note: If tf, multi, or multiList don't have an ansSel property, then the answer selections are formed by using the answers from there own quiz type section.

There are two ways to add a quiz type.

If the quiz is an array, like the previous example , then you must assign the quiz type through the options.

options.quizType = "fill"

The second method is turn the quiz into an object literal, allowing you to have multiple quiz types.

The way to do this is by naming a quiz type as a property of the quiz. Then insert your array of problems into the property.

var basicQuiz = {
    "fill": [
       { ques : "2 + 2", ans : "4" }  // Only has one question.
   ]
};    // basicQuiz is now a fill in the blank quiz with one question.

Examples:

The following format works if you want a quiz with one quiz type.

var quiz = [
	{ 
		ques: "Silver", //question
		ans: "Ag", // answer
		ansInfo : "<br/>More info <a href='http://www.periodictable.com/Elements/079/index.html'>here</a>"  // answer information.
	},
	{
		ques: "Gold.", 
		ans: "Au", 
		ansInfo : "Gold-Au <br/>More info <a href='http://www.periodictable.com/Elements/079/index.html'>here</a>"
	}
];
var options = {
	addToEnd: " has what periodic symbol ?",
	quizType: "fill"  //Or you can write fillInTheBlank instead of fill.
};
// quiz has 2 problems, while the options has set the quiz type to fill in the blank.
$( "#quizArea" ).jQuizMe( quiz, options );

Demo 1

However, if you want a quiz with multiple quiz types, then do the following.

var quizMulti = {
	multiList:[
		{ ques: "opposite / hypotonus", ans: "sin", ansSel : "tan" },
		{ ques: "adjacent / hypotonus", ans: "cos", ansSel: "tan" }
	],
	tf:[
		{ ques: "cos( 30 degrees )", ans: "√3 / 2", ansSel: [ " √2 / 3", "1/4" ] },
		{ ques: "sin( 60 degrees )", ans: "√3 / 2", ansSel: [ "1/2", "√2" ] }	
	],
	fill:[
		{ ques: "1/tan", ans: "cot" },
		{ ques: "1/cos", ans: "sec" }
	]
};
// quizMulti has 6 problems with 3 different quiz types.
$( "#quizArea" ).jQuizMe( quizMulti );

Demo 2

Options :

jQuizMe( quiz, options, lang );

Note: HTML means the value is a string but you can put html in it.

Example:

var quiz = {
	multi:[
		{ ques: "Which is not a javascript keyword.", ans:"local", ansSel:[ "new", "delete" ]}
	]
};
var options = {
	showAns: false,
	review: false
};
$( "#quizArea" ).jQuizMe( quiz, options );

Demo 3

Lang :

jQuizMe( quiz, options, lang );

This following is the default language settings.

_lang = {
			ans:{	// _lang.ans are shown during the display of .q-result, the answer result.
				corrAns: "Correct answer(s):",
				praise: 'Great Job. Right!',
				whyAns: "Info:",
				yourAns: "Your Answer:"
			},
			btn:{	// [ "text", "title" ]
				begin: [ "Begin Quiz" ],
				check: [ "Check" ],
				del: [ "Delete", "Delete quiz" ],
				help: [ "Help", 'Click for help'],
				next: [ "Next" ],
				restart: [ "Restart", "Restart quit over" ],
				details: [ "Details" ],
				review: [ "Review" ],
				showOnlyMissed: [ "", "Click to show only missed questions." ],
				quit: [ "Quit", "Quit quiz" ],
				quitNo: [ "->", "Back" ],
				quitYes: [ '', "Yes" ]
			},
			err:{
				badQType: "Invalid quiz type.",
				badKey: " is an invalid key value.",
				error: "Error",	
				noQType: "No quizTypes.",
				noQues: "Quiz has no questions.",
				notArr: "Must be an array.",
				notObj: "Invalid quiz data structure. Must be an array or object."
			},
			stats:{
				right: "Right",
				rate: "Rate",
				score: "Score",
				wrong: "Wrong",
				total: "Total",
				tried: "Tried"
			},
			quiz:{
				tfFalse: "False",
				tfTrue: "True"
			}
		}

Example:

The following changes the praise for a right answer to "Excellent!".

var lang = { 
	ans : { 
		praise:"Excellent!"
	 }
};
$( "#quizArea" ).jQuizMe( quiz, { quizType: "multi" }, lang );

Demo 4

Please see the language section for translations.