QXmlMoodle

Abstract:
=========

QXmlMoodle is a open-source library host on github (https://github.com/roddevu/QXmlMoodle). This library permit you to import and export the Moodle quiz in XML.
The following document is provide to help future developer to understand how the project work and theses specificities.
In order to have the highest visibility all the project and even the documentation are in English. But it's a French project made only by French people for the moment ;)

Quick usage:
============

If you don't want to "put your hand in the code", follow this 3 steps to use QXmlMoodle in your project:
1. Add this two jar to your project:
    a XOM 1.2.7 (or higher) findable here: http://www.cafeconleche.org/XOM/xom-1.2.7.jar
    b QXmlMoodle 1.0: https://github.com/roddevu/QXmlMoodle/blob/master/qxmlmoodle.jar
2. Look javadoc and samples
3. Enjoy :)

Project:
========

With QXmlMoodle developers can:  import, change, create, export a moodle quiz in an XML valid document. 

Furthermore a powerful XML debugger is included! Indeed, for each exceptions and warning QXmlMoodle provide you all the necessary to correct them: line, xml marker and a short description. Sometimes you will also have a proposition of correction! 

All you have to do is load a document, using the load method of Quiz class, and call getErrors() or getWarnings() method to get the list of error(s) and warning(s).

Very easy to use, isn't it?
	
Strict compliant:
=================

QXmlMoodle is fully PMD and CheckStyle compliant!
 
To participate to this project, your code need to raise 0 warning after a CheckStyle and a PMD scan! PMD information warnings are tolerate, but please avoid them.

Usage:
======

To use the actual version of QXmlMoodle, you need to add XOM 1.2.7 (or higher) to your project. You can download it jar here: http://www.cafeconleche.org/XOM/xom-1.2.7.jar.

QXmlMoodle provide a class that covers all needs: question list, error list, warning list.

* To create a quiz: 
    - simply instantiate the "class fr.qxmlmoodle.Quiz"
* To import a Moodle quiz:
    - call the method: load(file_url : string)
    - return true if no important error have been encounter, return false otherwise
* To manipulate the quiz:
    - adding a question
    - get the question list
    - change a question
    - etc.
* To test your quiz:
    - use getErrors() to retrieve the error list
    - use getWarnings() to retrieve warning list
* To export your quiz, you have two methods:
    - use exportToString() : string
    - use save(file_url : string) : boolean
	
QXmlMoodle support (for the moment) 9 type of questions. It represent all the questions type available in the actual Moodle quiz format.

Each sort of question have its methods, for example in a Type Matching question you can manage the sub questions with: addSubQuestion() and getSubQuestions().

You can find more information in the Javadoc, here: https://github.com/roddevu/QXmlMoodle/tree/master/JavaDoc