Mercurial > clickerconvert

annotate README @ 78:f230ed9022e0

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Rework questions to new logic for multilne questions
author Andre Heinecke <andre.heinecke@intevation.de>
date Wed, 05 Oct 2016 14:24:53 +0200
parents b574990e90a5
children
rev   line source
8
24d547e7ea09 Add README
Andre Heinecke <andre.heinecke@intevation.de>
parents:
diff changeset
1 ClickerConvert
24d547e7ea09 Add README
Andre Heinecke <andre.heinecke@intevation.de>
parents:
diff changeset
2 ==============
24d547e7ea09 Add README
Andre Heinecke <andre.heinecke@intevation.de>
parents:
diff changeset
3
24d547e7ea09 Add README
Andre Heinecke <andre.heinecke@intevation.de>
parents:
diff changeset
4 Copyright (C) 2016 by ETH Zürich
24d547e7ea09 Add README
Andre Heinecke <andre.heinecke@intevation.de>
parents:
diff changeset
5 Software engineering by Intevation GmbH
24d547e7ea09 Add README
Andre Heinecke <andre.heinecke@intevation.de>
parents:
diff changeset
6
24d547e7ea09 Add README
Andre Heinecke <andre.heinecke@intevation.de>
parents:
diff changeset
7 This file is Free Software under the GNU GPL (v>=2)
24d547e7ea09 Add README
Andre Heinecke <andre.heinecke@intevation.de>
parents:
diff changeset
8 and comes with ABSOLUTELY NO WARRANTY!
24d547e7ea09 Add README
Andre Heinecke <andre.heinecke@intevation.de>
parents:
diff changeset
9 See LICENSE.txt for details.
24d547e7ea09 Add README
Andre Heinecke <andre.heinecke@intevation.de>
parents:
diff changeset
10
24d547e7ea09 Add README
Andre Heinecke <andre.heinecke@intevation.de>
parents:
diff changeset
11
24d547e7ea09 Add README
Andre Heinecke <andre.heinecke@intevation.de>
parents:
diff changeset
12 Introduction
24d547e7ea09 Add README
Andre Heinecke <andre.heinecke@intevation.de>
parents:
diff changeset
13 ------------
24d547e7ea09 Add README
Andre Heinecke <andre.heinecke@intevation.de>
parents:
diff changeset
14
24d547e7ea09 Add README
Andre Heinecke <andre.heinecke@intevation.de>
parents:
diff changeset
15 Clicker convert converts the text output of a classromm response system
24d547e7ea09 Add README
Andre Heinecke <andre.heinecke@intevation.de>
parents:
diff changeset
16 ("clicker") to other doucment formats. Currently only xlsx is supported.
24d547e7ea09 Add README
Andre Heinecke <andre.heinecke@intevation.de>
parents:
diff changeset
17
24d547e7ea09 Add README
Andre Heinecke <andre.heinecke@intevation.de>
parents:
diff changeset
18 The orignal target platforms are Windows NT > 6.1 (Seven and later) and
24d547e7ea09 Add README
Andre Heinecke <andre.heinecke@intevation.de>
parents:
diff changeset
19 GNU/Linux and MacOS.
24d547e7ea09 Add README
Andre Heinecke <andre.heinecke@intevation.de>
parents:
diff changeset
20
24d547e7ea09 Add README
Andre Heinecke <andre.heinecke@intevation.de>
parents:
diff changeset
21 Input File Format
24d547e7ea09 Add README
Andre Heinecke <andre.heinecke@intevation.de>
parents:
diff changeset
22 -----------------
24d547e7ea09 Add README
Andre Heinecke <andre.heinecke@intevation.de>
parents:
diff changeset
23 The input file is a text document with the following expected properties:
24d547e7ea09 Add README
Andre Heinecke <andre.heinecke@intevation.de>
parents:
diff changeset
24
24d547e7ea09 Add README
Andre Heinecke <andre.heinecke@intevation.de>
parents:
diff changeset
25 Questions:
24d547e7ea09 Add README
Andre Heinecke <andre.heinecke@intevation.de>
parents:
diff changeset
26 - A Question is defined by last unquoted string before a line starting
24d547e7ea09 Add README
Andre Heinecke <andre.heinecke@intevation.de>
parents:
diff changeset
27 with "Answer"
24d547e7ea09 Add README
Andre Heinecke <andre.heinecke@intevation.de>
parents:
diff changeset
28 - A multiple choice Answer are all strings that match the pattern
37
b574990e90a5 Update Format spec for additional handling
Andre Heinecke <andre.heinecke@intevation.de>
parents: 8
diff changeset
29 "\"(.*)\",(\\d+)?,(\\d+\\.+\\d+)?" in all lines following a line
8
24d547e7ea09 Add README
Andre Heinecke <andre.heinecke@intevation.de>
parents:
diff changeset
30 "Answer,Votes,Percent" before the next Question.
37
b574990e90a5 Update Format spec for additional handling
Andre Heinecke <andre.heinecke@intevation.de>
parents: 8
diff changeset
31 - A special case is made for lines in a multiple choice block that
b574990e90a5 Update Format spec for additional handling
Andre Heinecke <andre.heinecke@intevation.de>
parents: 8
diff changeset
32 contain multiple comma seperated quoted strings. In that case the
b574990e90a5 Update Format spec for additional handling
Andre Heinecke <andre.heinecke@intevation.de>
parents: 8
diff changeset
33 line is interpreted as each quotet string containing an unfilled
b574990e90a5 Update Format spec for additional handling
Andre Heinecke <andre.heinecke@intevation.de>
parents: 8
diff changeset
34 answer.
8
24d547e7ea09 Add README
Andre Heinecke <andre.heinecke@intevation.de>
parents:
diff changeset
35 - A free text answer is a Quoted string following a Question and
24d547e7ea09 Add README
Andre Heinecke <andre.heinecke@intevation.de>
parents:
diff changeset
36 the single line "Answer".
24d547e7ea09 Add README
Andre Heinecke <andre.heinecke@intevation.de>
parents:
diff changeset
37 All text before the next question is interpreted as free text responses.
24d547e7ea09 Add README
Andre Heinecke <andre.heinecke@intevation.de>
parents:
diff changeset
38 If a Quoted string is inside an Answer it is combined with that Answer.
24d547e7ea09 Add README
Andre Heinecke <andre.heinecke@intevation.de>
parents:
diff changeset
39
24d547e7ea09 Add README
Andre Heinecke <andre.heinecke@intevation.de>
parents:
diff changeset
40 See constants.h for definition.
24d547e7ea09 Add README
Andre Heinecke <andre.heinecke@intevation.de>
parents:
diff changeset
41
24d547e7ea09 Add README
Andre Heinecke <andre.heinecke@intevation.de>
parents:
diff changeset
42 Usage
24d547e7ea09 Add README
Andre Heinecke <andre.heinecke@intevation.de>
parents:
diff changeset
43 -----
24d547e7ea09 Add README
Andre Heinecke <andre.heinecke@intevation.de>
parents:
diff changeset
44
24d547e7ea09 Add README
Andre Heinecke <andre.heinecke@intevation.de>
parents:
diff changeset
45 See clickerconvert --help
24d547e7ea09 Add README
Andre Heinecke <andre.heinecke@intevation.de>
parents:
diff changeset
46
24d547e7ea09 Add README
Andre Heinecke <andre.heinecke@intevation.de>
parents:
diff changeset
47 Installation
24d547e7ea09 Add README
Andre Heinecke <andre.heinecke@intevation.de>
parents:
diff changeset
48 ------------
24d547e7ea09 Add README
Andre Heinecke <andre.heinecke@intevation.de>
parents:
diff changeset
49 See the file INSTALL for build instructions.
24d547e7ea09 Add README
Andre Heinecke <andre.heinecke@intevation.de>
parents:
diff changeset
50
24d547e7ea09 Add README
Andre Heinecke <andre.heinecke@intevation.de>
parents:
diff changeset
51 Binaries may be available on the project homepage.
24d547e7ea09 Add README
Andre Heinecke <andre.heinecke@intevation.de>
parents:
diff changeset
52
24d547e7ea09 Add README
Andre Heinecke <andre.heinecke@intevation.de>
parents:
diff changeset
53
24d547e7ea09 Add README
Andre Heinecke <andre.heinecke@intevation.de>
parents:
diff changeset
54 Documentation
24d547e7ea09 Add README
Andre Heinecke <andre.heinecke@intevation.de>
parents:
diff changeset
55 -------------
24d547e7ea09 Add README
Andre Heinecke <andre.heinecke@intevation.de>
parents:
diff changeset
56 The documentation is written as part of Doxygen comments.
24d547e7ea09 Add README
Andre Heinecke <andre.heinecke@intevation.de>
parents:
diff changeset
57
24d547e7ea09 Add README
Andre Heinecke <andre.heinecke@intevation.de>
parents:
diff changeset
58 Contact
24d547e7ea09 Add README
Andre Heinecke <andre.heinecke@intevation.de>
parents:
diff changeset
59 -------
24d547e7ea09 Add README
Andre Heinecke <andre.heinecke@intevation.de>
parents:
diff changeset
60 For additional information or custom modifications please contact:
24d547e7ea09 Add README
Andre Heinecke <andre.heinecke@intevation.de>
parents:
diff changeset
61
24d547e7ea09 Add README
Andre Heinecke <andre.heinecke@intevation.de>
parents:
diff changeset
62 Intevation GmbH <intevation@intevation.de>
24d547e7ea09 Add README
Andre Heinecke <andre.heinecke@intevation.de>
parents:
diff changeset
63 Neuer Graben 17
24d547e7ea09 Add README
Andre Heinecke <andre.heinecke@intevation.de>
parents:
diff changeset
64 49074 Osnabrück, Germany
24d547e7ea09 Add README
Andre Heinecke <andre.heinecke@intevation.de>
parents:
diff changeset
65
24d547e7ea09 Add README
Andre Heinecke <andre.heinecke@intevation.de>
parents:
diff changeset
66 The public development platform can be found at:
24d547e7ea09 Add README
Andre Heinecke <andre.heinecke@intevation.de>
parents:
diff changeset
67 https://wald.intevation.org/projects/clickerconvert/
This site is hosted by Intevation GmbH (Datenschutzerklärung und Impressum | Privacy Policy and Imprint)