Uploaded image for project: 'JW Player'
  1. JW Player
  2. JWPLAYER-31

Offer an attachment picker for the media of the JW Player macro

    XMLWordPrintable

Details

    • Improvement
    • Resolution: Unresolved
    • Major
    • None
    • 2.2.1
    • None
    • Unknown

    Description

      The attachment parameter of the JW Player macro is the media to play: an attached file, like Space.Page@video.mp4, the address of an external video, like a YouTube URL, or the path of a file on the server. The Edit Macro dialog shows it as a plain text field, so the user has to know the syntax of an attachment reference and the name of a file that is already attached, with no way to browse the attachments or upload a new one.

      The parameter is declared in JWPlayer.xml.

      The main problem:

      • An attachment picker alone would not do, since the parameter also accepts URLs and server paths: the field has to let the user pick or upload an attachment, or type a URL.

      Proposal

      • Offer the attachment picker for this parameter while still accepting a typed URL or path. The office macro already does this for its reference, through its officeresourcereference edit template, which lists the files, uploads a new one, restricts them to the expected types and accepts a typed reference.
      • XRENDERING-828 and XWIKI-25568 need the same mix of attachments and URLs, for the image of the box macros and the jars of the script macros, so the field could be shared.

      An empty or missing attachment must also fail with an error that names the file, instead of a velocity error or a player error. JWPLAYER-22 reports the player error of a reference that cannot be played.

      KOs covered

      Macro Criterion Parameter Problem
      jwplayer C4 input-assistance attachment A plain text field for a reference to an attachment, with no picker: the user has to know the syntax Space.Page@video.mp4 and type the name of a file that is already attached. Since the parameter also accepts URLs and server paths, a picker needs design work.
      jwplayer E2 errors attachment attachment="" gives "Failed to execute the [velocity] macro. Cause: [The resolver parameter doesn't contain an Entity Reference of type [ATTACHMENT]]", a technical message that names another macro, and a missing page or file only fails in the player, once loaded, with "Error loading media: File could not be played", which does not say which file is missing. Partly covered, see below.

      Impact found on macro fluidity

      These 2 KOs come from the WYSIWYG usability audit of the macros, under the criteria C4 input-assistance and E2 errors of its usability criteria. The page of the macro, linked in the table, has the full notes.

      The E2 errors KO of jwplayer is only partly covered here, for the media. The same KO also reports other invalid values, covered by the other issues listed on the page of the macro, among them XCOMMONS-3847 for the conversion of the values and XRENDERING-823 for the wording of the error. The width and height formats are covered by XWIKI-25197.

      Attachments

        Issue Links

          Activity

            People

              Unassigned Unassigned
              Lucas C Charpentier Lucas
              Votes:
              0 Vote for this issue
              Watchers:
              1 Start watching this issue

              Dates

                Created:
                Updated: