forked from sr258/h5p-advanced-blanks
-
Notifications
You must be signed in to change notification settings - Fork 3
/
Copy pathTODO
175 lines (165 loc) · 12 KB
/
TODO
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
High priority:
==============
Bugfixes:
☐ library.json: remove "preloadedCss": [ ] (also in Ractive)
✔ mode selection allows "-" selector (+ option below) @done(18-06-29 18:13)
☐ hide "option restriction setting" when not appropriate (showWhen doesn't work for selectAlternatives for some reason)
possibly bug in H5P core library
✘ line-height doesn't work in selection mode @cancelled(18-08-03 23:28)
✔ snippets are always in their own paragraph (because they are html elements and receive a paragraph around them) @done(18-06-02 20:36)
✘ you can press "Check" in Selection mode even if nothing has been selected so far @cancelled(18-06-02 20:38)
General todo:
☐ change structure of directories so that it's enough to simply build the library to get it running
☐ create 1.0.1 release package
☐ make ! clickable
☐ make ! clickable when showing solutions (currently disabled)
✔ make "retry" behavior consistent to other content types + check if it needs it's own option @done(18-08-04 16:38)
✔ App.onScoreChanged --> setting feedback when fully done @done(18-08-04 16:54)
✔ resume with state + auto-check behavior @done(18-08-04 16:54)
✔ blanks: has checked blanks, shows buttons + all feedback @done(18-08-04 16:54)
✔ auto-check-mode: all filled out: show feedback text + buttons (solutions, try again) @done(18-08-04 16:54)
✔ add 'general feedback' functionality for auto-check (or is this consistent with other content types?) @done(18-08-04 16:54)
✔ auto-check + complete cloze + change text of blank --> state should go back to 'entering' @done(18-08-05 12:17)
✔ write German translation of semantics @done(18-08-21 21:04)
✔ test German localization @done(18-09-07 17:53)
✔ set default values in code @done(18-09-07 17:45)
✔ make example content types @done(18-09-07 18:26)
✔ check necessity of content updates @done(18-09-08 11:13)
☐ test all options (for regression testing)
☐ check if "show solutions requires input" is handled in the same way as in other content types
✔ check why confirm dialogs don't work in h5p-cli server test setting --> H5P.ConfirmationDialog is undefined even though it should exist... this is an issue with the h5p-cli server, not this content type @done(18-09-02 18:21)
☐ write tests for:
✔ select mode: alternatives @done(18-09-02 18:12)
✔ select mode: others + no restriction @done(18-09-02 18:17)
✔ select mode: others + restrictions @done(18-09-02 18:17)
✔ disable image zoom @done(18-09-02 18:21)
☐ highlights
☐ check behavior of content type when used in...
☐ Course Presentation
how to add it? Doesn't really work.
☐ Interactive Video
☐ Column
☐ ractive elements aren't added to dom!
✔ Question Set @done(18-08-04 16:35)
✔ restore state with all correct answers --> shows retry & doesn't allow changes in answers + getAnswerGiven is incorrect @done(18-08-04 16:35)
✔ what we need: fill in answers, but don't check them + getAnswerGiven must be true @done(18-08-04 16:35)
✔ "override check button" --> doesn't work as expected @done(18-08-04 14:47)
✔ disabled --> should not show check button & give no feedback @done(18-08-04 14:44)
✔ bug: doesn't proceed to next step @done(18-08-04 14:44)
✔ check state storage mechanism: is the current state fully saved & restored? @done(18-08-03 23:30)
✔ make sure semantics naming is consistent with other H5P libraries @done(18-07-07 17:59)
✔ very long selection / textareas are clipped if they go out of bounds @done(18-06-02 20:58)
Firefox 57:
Safari iOS 11 on iPhone and iPad:
✘ typing mode: error indicator overlaps with text @cancelled(18-06-29 17:02) not reproducable
- typing mode: when there's a popup, the reference element should be focused (still needed?)
✔ typing mode: the color of correctly solved gaps are wrong (the text is much too light) @done(18-06-29 17:02)
✔ typing mode: the alignment of the (in)correct symbol is broken: it's too far up (minor issue) @done(18-06-29 17:02)
- typing mode: the cursor is visible on top of popups if they overlap (happens a lot)
Chrome / Samsung Internet on Android (Samsung Galaxy S7):
- typing mode: part of the cursor is visible on top of popups if they overlap (happens a lot, not as ugly as on iOS)
- clipping of popups (small amount, no content clipped) in certain cases
- highlight of text + textarea directly below --> no space between them
- popup and textarea / select should be focused when popup is shown
Edge 41 + Internet Explorer 10/11:
- highlight blink animation doesn't work
- select mode: when selecting an option, all options in the list are displayed with the in/correct style (displayed only for a short time)
only Edge 41:
- hover over correct symbol: textbox select cursor displayed (instead of none)
- big left margin for select boxes
- typing mode: hint button aligned to the bottom
only Internet Explorer 10/11:
- select mode: UI override of select boxes doesn't work: displays chevron (a problem if there is a hint, because it is on top of the in/correct symbol)
- select mode: correct answer: text too light (dark gray), not an issue in typing mode
- typing mode: textbox calculation too small
Medium priority:
================
☐ add "not-filled out" warning
☐ focus check button (Question.focusButton) when cloze is filled out entirely
✔ better tip icon @done(18-06-29 17:57)
✔ implement feedback ranges @done(18-08-03 16:44)
✔ implement Question type contract (https://h5p.org/documentation/developers/contracts) @done(18-08-03 23:19)
✔ getAnswerGiven() @done(18-08-03 16:24)
✔ getScore() @done(18-08-03 16:24)
✔ getMaxScore() @done(18-08-03 16:24)
✔ showSolutions() @done(18-08-03 16:24)
✔ resetTask() @done(18-08-03 16:24)
✔ getXAPIData() @done(18-08-03 23:19)
✔ fully implement xAPI @done(18-08-03 23:28)
✔ answered + answer serialization (= check all pressed) --> stores all answers @done(18-08-03 23:19)
✔ implement getXAPIData contract (for report rendering engines) @done(18-08-03 23:19)
Low priority:
=============
☐ give smart UI hints: Esc + Enter button, Tab when not used
☐ It would be useful to have a text pasting option that accepts regular blanks.
This is rather complicated as the "widgets" attribute is not implemented for groups, only for lists. The easiest way might be to extend
the H5P core for groups to have the "widgets" attribute! (this would be done by changing the inheritance structure of the group editor widget to
derive from SemanticStructure and by finding out what the default editor widget for group would be)
☐ take over accessibility from h5p-blanks
☐ auto-growing text-fields
☐ hover over image --> no tooltip (bug in h5p library?)
☐ feedback popup is too large --> auto-size
Far future:
===========
☐ It would be useful to have an inbuilt language intelligence that can deal with typical issues:
☐ wrongly used apostrophes: ´` instead of '
☐ auto-alternatives for short forms (with option to disable it); requires intelligent checking of what is before the gap to avoid weird short forms like "Chris's done that before."
☐ auto-feedback for irregular verbs and typical misspellings
☐ autogeneration of incorrect answers for tenses which the content creator can select + generic auto-feedback texts defined by the user.
☐ autogeneration of incorrect answers for plural / singular
(re)consider if needed:
=======================
☐ react to resize event + send them when appropriate
☐ new setting: allow further editing after 'check' / disallow
☐ sanatise all user entered strings
☐ replace ractive with jquery views
☐ add highlight for hints
☐ hide tip icon if blank was answered correctly
☐ show "check" button in auto-answer mode when last gap is being filled (to avoid confusion of what to do at the end; user might not be aware of the concept of "losing focus")
☐ auto-check in select mode: does this work with keyboard select?
☐ if correct answer is: "Correct 1" and user enters "Correct " it is not considered a spelling mistake
done log:
=========
✔ fix feedback popup positioning @done(18-01-14 11:54)
✔ feedback popup sometimes is shifted to the wrong position if buttons become visible (reason is that its position is set as relative to the bottom, which changes after the popup was positioned) @done(18-01-14 11:54)
✔ resizing of screen -> no repositioning @done(18-01-14 11:54)
✔ check if resize events are called and handled correctly @done(18-01-14 11:54)
✔ clicking hint --> cloze is always marked as retry
✔ check mode --> spelling mistake: no marking of box
✔ dropdown icon is on top of other icons
✔ blank should revert to "neutral" state when it was wrong and is opened
✔ bug: empty selection --> line is too high
✔ no "check" button after it was pressed and there were errors (because the changed error blank aren't reset to neutral)
✔ select mode --> marking of correct / error not working
✘ show +1 / -1 score calculator
✔ simplify highlight markup in semantics (for incorrectAnswers)
✔ popup for (i) icon when notifying of surpressed popups?
✔ Alternative markup should be / instead of ; to align the content with the normal h5p content type. @done(17-12-27 21:52)
✔ It would be useful to have HTML markup in feedback texts. @done(17-12-31 11:47)
✔ The 'case sensitive' option should be off by default. @done(17-12-30 14:07)
✔ Answer mode should become a regular option. @done(17-12-30 14:07)
✔ Line height should not be 1.0. The touching boxes look bad. @done(17-12-31 11:20)
✔ was not/wasn't --> only was not is accepted as solution (it's not an issue with alternatives, though. It's must be about the apostrophe.) @done(17-12-27 21:52)
✔ trim whitespaces of user input
✘ select box / input box not long enough for long input --> overlap with symbols @cancelled(17-12-31 11:51)
✘ requires an estimate of width by text length (should be implemented in an isolated way) @cancelled(17-12-31 11:51)
✔ hide message surpression indicator when clicking retry
✔ empty feedback --> crash @done(17-12-30 14:13)
✔ select mode: random choice of other answers @done(17-12-30 16:16)
✔ remove duplicate choices @done(17-12-30 16:22)
✔ don't show typing mistake error message in select mode @done(17-12-30 18:17)
✔ beautify editor screen @done(18-01-13 17:52)
✔ make parts as collapsible (with groups) @done(18-01-13 17:27)
✔ unify headings (through importance) @done(18-01-13 16:40)
✔ add "important" blocks to explain how the content type works @done(18-01-13 17:47)
✔ add "@mistake" hint for "Spelling mistake warning" label @done(18-01-13 16:38)
✔ snippets are obligatory --> make optional @done(18-01-13 16:37)
✔ put Ractive into library @done(18-01-01 14:51)
✔ reimplement snippets @done(17-12-31 16:07)
✔ consider auto-growing boxes and block alignment to avoid "combing" on small screens @done(18-01-19 17:48)
✔ selection boxes have a strange border on the right (probably an artifact of -moz-appearance: button; which doesn't work, see firefox_select.png + firefox_select_2.png) @done(18-01-19 17:24)
✔ typing mode: auto-capitalization of gaps @done(18-01-10 21:17)
✔ select & typing mode: overlap of text with symbols in selection boxes with hints and incorrect answer (overlap1.png) @done(18-01-13 16:22)
✔ hover over hint button: textbox select cursor instead of "hand" cursor displayed (in select mode) @done(18-01-10 21:07)
✔ typing mode: the textbox displays a "clear" button it is not correctly aligned to the right because of the space for the incorrect / correct symbol; can this be hidden? the h5p blanks content type doesn't have this issue) @done(18-01-10 21:07)
✔ select mode: think of better way of showing feedback than reopening the drop down menu @done(18-01-19 18:26)