diff options
| -rw-r--r-- | doc/new_format.rst | 25 |
1 files changed, 25 insertions, 0 deletions
diff --git a/doc/new_format.rst b/doc/new_format.rst new file mode 100644 index 0000000..42a8cdf --- /dev/null +++ b/doc/new_format.rst @@ -0,0 +1,25 @@ +Writing a New Format for the API +================================ + +Writing a new format plugin for the question API is simple. All that needs to +happen is to insert a string -> function pair into the +``quizdata.formats.FORMATS`` dictionary. The function takes a file-like object +to the data and returns a list of questions. + +The recommended implementation strategy is to make a module named +``_format_[formatname]`` in the ``quizdata`` package and import the +appropriate function in the ``quizdata.formats`` module to add to the +dictionary. + +If parsing is required, the recommended tool is pyparsing, though XML/HTML +would be better served by using a library like BeautifulSoup. + +New Question Types +================== + +New Question types can be implemented as subclasses of the base Question type, +or not. So long as the generic functions dealing with questions are also +extended appropriately. Adding a new type is best left as an exercise to +those reading the code, though it should be simple enough, as the required +behavior of a question object is minimal. (Additional behavior for specific +types of questions should be documented). |