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