h5p / h5p-documentation-tool

H5P Documentation Tool

Documentation tool for educational assessment.

License

(The MIT License)

Copyright (c) 2015 Joubel AS

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

h5p-documentation-tool's Issues

Export of documentation tool forces French spellcheck in Word

We've come across an issue when we export student submissions from the Documentation tool. Students are asked to write up their reflections in the Documentation tool and download these and send them in.

The problem is, when this exported file is opened in Word it loads up a template (which I believe is exportTemplate.docx) which has French spellchecker activated. This then underlines all the words as if they are spelt wrong.

When the spellcheck language is changed to English, it changes back immediately. We can't save it with English spellcheck. I think this is due to it using French template?

Export text also prints out html tags

Hello,

If you have document export page the docx file output with "export text" will dipslay all the html-tags that you have used to stylize your text on a standard pages "Description of inputfield"-field are displayed in the docx-file f.ex Tell me

Possible bug in document export

HTML entities like   used in description fields are exported as text into the word-document. This entity is treated as a space in the h5p-resource and in the document preview. But when you open the document these codes appear as text.
The same HTML entity (  ) used in title-fields doesn't have this behaviour. Those appear as a space in both the h5p-resource and the exported document.
Below you can find printscreens form an example.
The h5p-resource example is also uploaded on h5p.org and can be viewed with this url: https://h5p.org/node/1252514

printscreens - h5p-resourrce with document export page:

printscreens - document preview:

printscreens - exported document in word-editor:

Accessibility issue

Documentation Tool

We are the KOMPETENZZENTRUM DIGITALE BARRIEREFREIHEIT.NRW, a digital accessibility evaluation and testing facility at the Technical University of Dortmund, Germany. We have scientifically evaluated the accessibility of various H5P elements, including the Documentation Tool.

We have identified some Accessibility fails, we would like to share our findings and some recommendations.

1. Issue: Inability to delete a question or objective when using voice control due to the absence of a displayed number.

• Suggestions: Make the button for deleting a question or objective focusable for voice control users, providing a clear visual indication of the item's index or number for identification and deletion.

2. Issue:
   Language Tool is an assistive tool to support people with dislexia to write. This tool does not detect spelling and grammar errors when entering questions and objectives.

• Suggestions: Investigate the integration of the Language Tool to recognize and highlight spelling and grammar errors in the input fields for questions and objectives, improving the overall quality of the content.

3. Issue: The page repeatedly scrolls away when navigating with the keyboard, requiring users to repeatedly scroll back to the title.

• Suggestions: Enhance the focus management and scrolling behavior to ensure that the page remains in a consistent position during keyboard navigation, preventing unnecessary scrolling.

4. Issue: Users desire a "Finish" button to save a completed document.

• Suggestions: Implement a "Finish" button to provide users with a clear option to save a completed document, improving usability and user control over the submission process.

5. Issue: The buttons for rating tasks/objectives and for navigating are sometimes positioned far from the rest of the tool, requiring horizontal scrolling.

• Suggestions: Optimize the layout and positioning of the buttons to reduce the need for horizontal scrolling, ensuring they are easily accessible and within close proximity to the relevant content.

6. Issue: Insufficient explanation of the document submission process upon submission.

• Suggestions: Provide clear and concise information or feedback indicating where the document will be sent upon submission, ensuring users have a clear understanding of the destination.

7. Issue: When zoomed in to 200%, the texts for "Select all" and "Export" are not visible when creating a new document. Additionally, the tooltip is not resized.

• Suggestions: Ensure that all elements, including texts and tooltips, are properly resized and visible when zoomed in to 200% or any higher magnification levels.

8. Issue: The buttons for rating objectives overlap the text of the objective when zoomed in to 400%.

• Suggestions: Increase the spacing and provide sufficient margins to prevent overlapping of buttons and text when zoomed in to 400%, ensuring all elements are visually separated and accessible.

9. Issue: Insufficient clarification of icons on the "Select all" and "Export" buttons.

• Suggestions: Include tooltips or aria-labels to provide explicit explanations of the icons used on the "Select all" and "Export" buttons, ensuring that users with visual impairments can understand their functionality.

Conclusion:

Addressing the identified issues and implementing the suggested improvements will significantly enhance the overall accessibility and user experience of the H5P element. By making these enhancements, you will ensure that all users, including those with disabilities, can fully engage with and benefit from the content and functionalities of the H5P element. It is recommended to prioritize these accessibility improvements to ensure compliance with web accessibility guidelines.
Please feel free to reach out if you have any questions or require further assistance in implementing these accessibility enhancements.

Always registers score as 0

The Documentation tool always sets the score to 0/0. When this is integrated into Drupal via Opigno, this results in Opigno setting a 0 score regardless of what is set for the activity. The behaviour I'd expect would be Opigno setting the score to whatever is set for the activity (i.e. just to record that it's been completed).

Haven't really worked with xapi much, but would it be possible to just not call setScoredResult at all?

self.triggerAnsweredEvents();
        /*
         * There's no score attached to Documentation Tool, but
         * it may be used in Column which needs a score that's not null.
         */
        var completedEvent = self.createXAPIEventTemplate('completed');
        completedEvent.setScoredResult(0, 0);
        self.trigger(completedEvent);
      });

Wrong es-mx language name

I had made some mistake with the mexican spanish language es-mx
It seems to have 0 translated strings in page
https://localization.h5p.org/es-mx/H5P.H5P.DocumentationTool

Can you please tell me what the problem is
Thanks in advance

Download/Export button doesn't show up in Chrome browser on iPad

When using the documentation tool in an iPad (mobile) browser in Chrome, the button to export the document doesn't appear for a user to click on. When looking at the code displaying the site, the button isn't even generated.

Desktop browser:

iPad browser:

Possible bug in upgrade script

When updating library versions on H5P-resources, some libraries experience more or less known errors. Documentation Tool has the most severe error where both of these errors seem to occur:

1. The H5P title is overwritten with data from the next input field (seems like a known and willing change)
2. The existing data within H5P "Metadata" is dropped

I have testet uploading an H5P with an older version to H5P.org and the result is as seen above: https://h5p.org/node/1247114
For more screenshots showing the before and after, please visit cerpus/Edlib#455

Affected libraries
These are the ones documented so far:

Single Choice: error 1 (title is overwritten)
Dialog Cards: error 1 and 2 (title is overwritten + metadata is emptied)
Documentation Tool: error 1 and 2 (title is overwritten + metadata is emptied)
Find the hotspot: error 1 (title is overwritten)
True/false: error 1 (title is overwritten)
Column: error 1 (title is overwritten)

Skjermopptak.2022-01-12.kl.13.23.36.mov

Using invalid xAPI interaction type

The value 'compound' used in

h5p-documentation-tool/documentation-tool.js

Line 603 in 2dc8aec

definition.interactionType = 'compound';

is not among the allowed values for interaction types, cmp. https://github.com/adlnet/xAPI-Spec/blob/master/xAPI-Data.md#interaction-types The xAPI validator at https://lrs.adlnet.gov/statementvalidator declares xAPI statements using that value as invalid. While this may be fine for H5P itself, it may cause trouble in a LRS or other systems evaluating the xAPI statements.

The value seems to be relevant for the H5P report module though, see: h5p/h5p-php-report#11

Images for all pages

Dear H5P-Team,

thanks for this wonderful tool. It is really fill the gap for science, especially with the assignments and later assesements. We also use this for text and figure analysis.
Would it be possible to include images (or even better multimedia) to all pages?
Currently this is restricted to Standard Pages and not available for Goals Page and Goals Assessment Page.

Thanks for your efforts

Documentation tool doesn't scale the iframe right in Moodle

Hello

documentation tool seems to scale its displayed page length according how long the first page is. This is clearly a bug, since if you have short first page and long second page you cannot see navigation buttons at all at the bottoms of the page.

This bug seesm to appear somewhere between versions Documentation Tool (1.4.0) -> Documentation Tool (1.5.2) since in version 1.4.0 the bug doesn't exist. Tested with Moodle 3.3 & mod_hvp 1.5 & Documentation Tool (1.5.2).

Steps to recreate:

1. Create H5P-activity in Moodle
2. Select documentation tool
3. Add a standard page as first page select

• library type "text"
• type first page to title and text-fields.

4. Add second Second page and

• as library type select "text input field editor element"
• give it description "question 1"
• select "input field size" 10 lines.

5. Repeat this two more times so you have 3 questions on this page.

6. save and display

7. Notice that on the second page you can see only first two questions, question 3 isn't seen and neither is no navigation buttons.

If you open this tab to separate browser window and resize it the question 3 comes in the view but not before this.

---

Creating the H5P-activity;

Below you can see that question "tell me 3" isn't displayed at all on the second long page and neither is navigation buttons

Only after resizing the window "tell me 3" and navigation buttons are displayed

Stil no possibility to save the entered content

Could you please check the pull request?

Problems with characters like Å, Ü in navigation menu

Element titles containing character like Å and Ü are missing the upper part of the character when shown in the navigation menu in the resource.
see example in the attached printscreen.

Perhaps are the used settings in this part from the stylesheet "navigation-menu.css" causing this problem:
.h5p-documentation-tool .h5p-navigation-menu .h5p-navigation-menu-entry span { position: relative; top: -2px; }