Mercurial > clickerconvert
annotate README @ 38:5354cbda7188
Fix HTML Layout. Support multiple formats at once. More handling.
This commit is a bad mix of multiple changes. It addresses:
- HTML Width is now relative and should fix some pdf creation problems.
- Format is now taken from the extension of the file names provided.
- Multiple file names are accepted at once.
- Parser now handles missing values in Multiple choice answers
- Parser now handles unfilled multiple choice values
| author | Andre Heinecke <andre.heinecke@intevation.de> |
|---|---|
| date | Fri, 15 Apr 2016 15:19:04 +0200 |
| parents | b574990e90a5 |
| children |
| rev | line source |
|---|---|
| 8 | 1 ClickerConvert |
| 2 ============== | |
| 3 | |
| 4 Copyright (C) 2016 by ETH Zürich | |
| 5 Software engineering by Intevation GmbH | |
| 6 | |
| 7 This file is Free Software under the GNU GPL (v>=2) | |
| 8 and comes with ABSOLUTELY NO WARRANTY! | |
| 9 See LICENSE.txt for details. | |
| 10 | |
| 11 | |
| 12 Introduction | |
| 13 ------------ | |
| 14 | |
| 15 Clicker convert converts the text output of a classromm response system | |
| 16 ("clicker") to other doucment formats. Currently only xlsx is supported. | |
| 17 | |
| 18 The orignal target platforms are Windows NT > 6.1 (Seven and later) and | |
| 19 GNU/Linux and MacOS. | |
| 20 | |
| 21 Input File Format | |
| 22 ----------------- | |
| 23 The input file is a text document with the following expected properties: | |
| 24 | |
| 25 Questions: | |
| 26 - A Question is defined by last unquoted string before a line starting | |
| 27 with "Answer" | |
| 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 | 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 | 35 - A free text answer is a Quoted string following a Question and |
| 36 the single line "Answer". | |
| 37 All text before the next question is interpreted as free text responses. | |
| 38 If a Quoted string is inside an Answer it is combined with that Answer. | |
| 39 | |
| 40 See constants.h for definition. | |
| 41 | |
| 42 Usage | |
| 43 ----- | |
| 44 | |
| 45 See clickerconvert --help | |
| 46 | |
| 47 Installation | |
| 48 ------------ | |
| 49 See the file INSTALL for build instructions. | |
| 50 | |
| 51 Binaries may be available on the project homepage. | |
| 52 | |
| 53 | |
| 54 Documentation | |
| 55 ------------- | |
| 56 The documentation is written as part of Doxygen comments. | |
| 57 | |
| 58 Contact | |
| 59 ------- | |
| 60 For additional information or custom modifications please contact: | |
| 61 | |
| 62 Intevation GmbH <intevation@intevation.de> | |
| 63 Neuer Graben 17 | |
| 64 49074 Osnabrück, Germany | |
| 65 | |
| 66 The public development platform can be found at: | |
| 67 https://wald.intevation.org/projects/clickerconvert/ |