Details
-
Improvement
-
Resolution: Unresolved
-
Major
-
None
-
2.2.1
-
None
-
Unknown
-
Description
The name and description of the JW Player macro name and describe the JavaScript library it uses, not what it adds to the page, a video or audio player, and two parameter descriptions are incomplete or speak of a playlist the user cannot build.
KOs covered
| Macro | Criterion | Parameters | Problem |
|---|---|---|---|
| jwplayer | D1 wording | "JW Player" is the name of the JavaScript library that plays the video, not the word a user types for what the macro does, like video, movie or media player, and the macro is not a product that XWiki defines. Like mathjax, a user who does not know the library cannot guess from the name that it plays a video attached to the page. | |
| jwplayer | D2 summary | "The JW Player is an open-source embeddable media player for web sites, supporting many commonly-used audio and video formats. The player is easy to configure, customize and extend." describes the library, not what the macro adds to the page: it never says that it plays an attachment of a wiki page or an external video, and "easy to configure, customize and extend" says nothing about the macro. | |
| jwplayer | C1 clarity | attachment | The name and the description speak of an attached file, "The reference to the attached media file that should be played", with examples of the page forms, where the parameter also accepts the address of an external video, like a YouTube URL, and the path of a file on the server, which the documentation lists as accepted values and the dialog does not. A user who does not read the documentation does not know that these forms exist. |
| jwplayer | C1 clarity | repeat | The description, "Whether to loop playback of the playlist or not.", speaks of a playlist, while the macro plays one file and the user cannot build a playlist with it: a user who does not know the JW Player library does not know what it means. The name "Repeat" and the true or false values are clear. |
Impact found on macro fluidity
These 4 KOs come from the WYSIWYG usability audit of the macros, under the criteria C1 clarity, D1 wording, D2 summary of its usability criteria. The page of each macro, linked in the table, has the full notes and the steps to reproduce. Fixing them means changing the translations of the macros and, for a name or a category, their definitions.