ClickerConvert
==============

Copyright (C) 2016 by ETH Zürich
Software engineering by Intevation GmbH

This file is Free Software under the GNU GPL (v>=2)
and comes with ABSOLUTELY NO WARRANTY!
See LICENSE.txt for details.


Introduction
------------

Clicker convert converts the text output of a classromm response system
("clicker") to other doucment formats. Currently only xlsx is supported.

The orignal target platforms are Windows NT > 6.1 (Seven and later) and
GNU/Linux and MacOS.

Input File Format
-----------------
The input file is a text document with the following expected properties:

Questions:
 - A Question is defined by last unquoted string before a line starting
   with "Answer"
 - A multiple choice Answer are all strings that match the pattern
  "\"(.*)\",(\\d+)?,(\\d+\\.+\\d+)?" in all lines following a line
  "Answer,Votes,Percent" before the next Question.
 - A special case is made for lines in a multiple choice block that
  contain multiple comma seperated quoted strings. In that case the
  line is interpreted as each quotet string containing an unfilled
  answer.
 - A free text answer is a Quoted string following a Question and
 the single line "Answer".
 All text before the next question is interpreted as free text responses.
 If a Quoted string is inside an Answer it is combined with that Answer.

 See constants.h for definition.

Usage
-----

See clickerconvert --help

Installation
------------
See the file INSTALL for build instructions.

Binaries may be available on the project homepage.


Documentation
-------------
The documentation is written as part of Doxygen comments.

Contact
-------
For additional information or custom modifications please contact:

  Intevation GmbH <intevation@intevation.de>
  Neuer Graben 17
  49074 Osnabrück, Germany

The public development platform can be found at:
https://wald.intevation.org/projects/clickerconvert/