Help+Manual News

Broken YouTube videos in CHM – and how to fix it


With Help+Manual 7 we have introduced web-based videos like YouTube and Vimeo for embedding videos in help files. Especially YouTube worked like a charm in CHM files – until recently.

After a change in the YouTube scripts, the videos – when clicked to play – might trigger a Javascript error. The reason for this error is, that the script expects a “newer” version of MS Internet Explorer, it requires MSIE 9 as the minimum.

The Windows HTML Help viewer internally uses the rendering engine of MS Internet Explorer to display CHM files. By default, it runs with MSIE 7, even if a newer version is installed. To force the CHM viewer to use a newer rendering engine, it can be elevated with a HTML meta tag. We do this with all our CHM templates and skins, and the default elevation for CHM files was MSIE 8 so far. With the recent change in the YouTube scripts, it requires MSIE 9 or higher.

 

A quick and easy fix

To fix the YouTube problem, you need to apply a small change to the skins or HTML templates that you publish your CHM files with. Here is a step-by-step instruction:

  • If you publish CHM with a skin, open the skin file in Help+Manual
  • If you publish without a skin, open the help project in Help+Manual
  • In the Project Explorer, navigate to Configuration > HTML Page Templates > Default
  • Switch to the HTML source code tab
  • Locate the line with “X-UA-Compatible” in the HTML code editor
  • Change it to “IE=9” or “IE=edge
  • Publish your CHM file again

Old:

Modified:

 

This modification will be part of the next update of Help+Manual. However, your customized skins will need a manual tweak though – just follow the steps described above.

Comments are closed.