VP-314: Path to template html folder should be configurable by integrator

Description

Currently, the paths to the various templates used by the video player are hard coded in the various subcomponent options, and assume that the integration is at a certain relative path (not coincidentally, the same relativity as our demos). This causes problems if the integrator happens to be placing the videoPlayer code somewhere else, relatively.

We should implement an integrator path prefix option to address this.

Comments

• Anastasia Cheetham commented 2013-06-18T17:01:50.866-0400

  One of our GSOC students found this while working towards integrating the VideoPlayer into ATutor: In his test setup, the template HTML folder was at the same level as the PHP file instantiating the VP, but the built-in path the VP template is "../html/videoPlayer_template.html." Overriding that path specifically loaded the main template, but the language menu template still didn't load. Obviously, integrators could individually override each template path, but they shouldn't have to.

• Anastasia Cheetham commented 2013-06-19T10:19:25.026-0400

  Further investigation: There are only three templates, currently: the main template, the menuButton template and the controllers template. The first two paths can be overridden together in a single options to the main video player:
  ...
  templates: {
  videoPlayer: {
  href: "path/to/videoPlayer/html/videoPlayer_template.html"
  },
  menuButton: {
  href: "path/to/videoPlayer/html//menuButton_template.html"
  }
  }

  The controllers template must be overridden separately, through a demands block:

  fluid.demands("fluid.videoPlayer.controllers", "fluid.videoPlayer", {
  options: {
  templates: {
  controllers: {
  href: "path/to/videoPlayer/html/videoPlayer_controllers_template.html"
  }
  }
  }
  });

  The better way would be to have a single option that integrators can set to specify the relative path to the templates folder. The video player would be responsible for distributing this option to whoever needs it.

• Justin Obara commented 2017-12-22T10:28:41.606-0500

  The video player repository has been archived.