Question Score content type to review

Forums: 

Hi, 

Could you please review this content type that I have develped. 

Question Score is a versatile assessment tool that allows you to create list-based questionnaires with weighted responses. Unlike standard quizzes that focus on "right" or "wrong" answers, this plugin calculates a total score based on the intensity or frequency of a user's selections (e.g., YesSometimes, or No). 

  Key Features:

  • Customizable Labels: Tailor the three response options to suit your context  (e.g., Always/Often/Never or Agree/Neutral/Disagree).
  • Weighted Scoring: Assign specific point values to each response option to weight the final result.
  • Dynamic Feedback: Define "Score Bands" (ranges) to trigger specific feedback messages once the user completes the questionnaire.
  • Quick Setup: Use the "Quick Insert" feature to paste a list of questions at once, making it easy to convert existing paper-based surveys into interactive digital activities.
  • Accessible Design: Built with accessibility in mind, featuring screen-reader support, keyboard navigation, and responsive layouts for mobile devices.

  This plugin is ideal for self-assessments, personality indicators, risk evaluations, or any scenario where a cumulative score determines a  personalized recommendation or outcome.

Developed by Chris Richter at Ricoshae. 

Thanks,

Chris 

otacke's picture

Hi Chris!

You may want to check your content type yourself first with "How to review H5P content types" as your guide.

Had a quick look and observed this:

  1. Your content file is invalid - did you build it by hand??? Your library folder is lacking the version number.
  2. Some of the parameter fields are not encoded properly such that e.g. an apostrophe is rendered as '
  3. Now that H5P supports theming, you may want to support that, too.
  4. Using <hx> tags is somewhat problematic, because you never know in what context H5P content is rendered, so the headline hierachy may be wrong. You set <h2>, but what if the content is displayed deeper in the hierarchy under an <h4>, for instance?
  5. Setting 800px max-width in CSS feels odd.
  6. clip is deprecated
  7. CSS may benefit from combining classes that are used frequently + custom CSS properties for common colors, etc.
  8. Having a hidden "Skip to results" is not seen in any other H5P content type. And it might make more sense to add it to the DOM just once and hide it when not needed instead of rebuilding it every time the user calculates the score.
  9. H5P core injects a "Title" field already. You add another one. Confusing for authors, and you could simple use the value from the core editor field. It's in the 3rd constructor argument that you don't use.
  10. Building all the HTML with strings is very heavy on the eye and makes it hard to interpret. Thought about using a templating library? Or building the elements programatically?
  11. JQuery is used, but at some point, H5P Group will get rid of it. Better not to rely on it except for where H5P still requires it.
  12. Using the contentid for prefixing ids will break if your content type is ever used as subcontent. The ids will then be identical across subcontent instances.
  13. For "quick insert", there's a dedicated H5P editor widget for lists, cmp. e.g. Question Set. Might make sense to use that instead for consistency.
  14. Hardcoded strings, not translatable.
  15. Comments should rather tell you "Why", not "What". "What" should be clear from code.
  16. Grid might make more sense than linked flex boxes
  17. Flex feels overused in general where it's not really required.
  18. Aren't the h5p-question-score-option-mobile-label fields redundant to what the aria label(s) already convey(s)?
  19. Your radio inputs have focus and focus-visible at the same time.
  20. ES5, yeah, well.
  21. Not following the coding style guide.

Cheers,
Oliver

p.s.: I am not a member of the H5P core team and not affiliated with H5P Group, so I do not decide on anything here.

Hi Oliver, 

Thank you so much for the detailed feedback. This is exaclty  what I was looking for.

Some of the issues you mentioned I had notice like the encoding issue, the title double up and I was wondering about JQuery. 

I willl get to work and see what I can do to clean everything up and make it conform with the H5P requirements. 

Really appreciate your response and your time. 

Thank you, 

Chris

otacke's picture

You're welcome. Hope that document that I linked to helps as well.