andre@8: ClickerConvert
andre@8: ==============
andre@8: 
andre@8: Copyright (C) 2016 by ETH Zürich
andre@8: Software engineering by Intevation GmbH
andre@8: 
andre@8: This file is Free Software under the GNU GPL (v>=2)
andre@8: and comes with ABSOLUTELY NO WARRANTY!
andre@8: See LICENSE.txt for details.
andre@8: 
andre@8: 
andre@8: Introduction
andre@8: ------------
andre@8: 
andre@8: Clicker convert converts the text output of a classromm response system
andre@8: ("clicker") to other doucment formats. Currently only xlsx is supported.
andre@8: 
andre@8: The orignal target platforms are Windows NT > 6.1 (Seven and later) and
andre@8: GNU/Linux and MacOS.
andre@8: 
andre@8: Input File Format
andre@8: -----------------
andre@8: The input file is a text document with the following expected properties:
andre@8: 
andre@8: Questions:
andre@8:  - A Question is defined by last unquoted string before a line starting
andre@8:    with "Answer"
andre@8:  - A multiple choice Answer are all strings that match the pattern
andre@37:   "\"(.*)\",(\\d+)?,(\\d+\\.+\\d+)?" in all lines following a line
andre@8:   "Answer,Votes,Percent" before the next Question.
andre@37:  - A special case is made for lines in a multiple choice block that
andre@37:   contain multiple comma seperated quoted strings. In that case the
andre@37:   line is interpreted as each quotet string containing an unfilled
andre@37:   answer.
andre@8:  - A free text answer is a Quoted string following a Question and
andre@8:  the single line "Answer".
andre@8:  All text before the next question is interpreted as free text responses.
andre@8:  If a Quoted string is inside an Answer it is combined with that Answer.
andre@8: 
andre@8:  See constants.h for definition.
andre@8: 
andre@8: Usage
andre@8: -----
andre@8: 
andre@8: See clickerconvert --help
andre@8: 
andre@8: Installation
andre@8: ------------
andre@8: See the file INSTALL for build instructions.
andre@8: 
andre@8: Binaries may be available on the project homepage.
andre@8: 
andre@8: 
andre@8: Documentation
andre@8: -------------
andre@8: The documentation is written as part of Doxygen comments.
andre@8: 
andre@8: Contact
andre@8: -------
andre@8: For additional information or custom modifications please contact:
andre@8: 
andre@8:   Intevation GmbH <intevation@intevation.de>
andre@8:   Neuer Graben 17
andre@8:   49074 Osnabrück, Germany
andre@8: 
andre@8: The public development platform can be found at:
andre@8: https://wald.intevation.org/projects/clickerconvert/