Working with videos

Create videos when showing the user would be more helpful than telling the user, and when a visual presentation would enhance the written description.

Restriction: Do not upload the video directly using Heretto. The files are too big and they slow things down greatly.

Adding an mp4 video file to the documentation

To embed a video into the documentation:

  1. Using Cyberduck, add the mp4 video file to the /video subfolder of the documentation web server. When done, it looks similar to this:

    Directory listing showing /video/admin/Data_Export.mp4 and .png

  2. In your topic, add an <object> element to reference the video.
    <object data="https://docs-assets.medallia.com/video/admin/Data_Export.mp4" 
            outputclass="video"
    />
    • Set the data attribute to the URL to the video file on https://docs-assets.medallia.com/video/…
    • Set the outputclass attribute to video

Adding a file from a video-hosting sites

To embed a video stored on a video-hosting site (such as YouTube, Vimeo, Wistia, and so on):

  1. Learn the embed URL of the video you want to embed.

    Most video-hosting sites make it available from the page displaying the video. For example, to see the embed URL of a video hosted on YouTube, click Share to open the Share dialog.

    Embed URL for a YouTube video

  2. In your topic, add an <object> element to reference the video.
    <object data="https://www.youtube.com/embed/tgbNymZ7vqY" />
    
    • Set the data attribute to the URL to the video file on https://www.youtube.com/embed/tgbNymZ7vqY
Important: Do not set a type or outputclass for platform-hosted videos.

Vimeo files from Medallia Training

To reference a video hosted on Vimeo by Medallia Training, start with the video URL like this:

https://vimeo.com/767326426/3e486eed77

And change it to look like this:

https://player.vimeo.com/video/767326426?h=3e486eed77&amp;app_id=58479
  • Before the first path/number: https://player.vimeo.com/video/
  • The second path/number becomes a parameter: ?h=3e486eed77
  • And append the Training App ID: &amp;app_id=58479

The DITA element looks like this:

<object data="https://player.vimeo.com/video/767326426?h=3e486eed77&amp;app_id=58479"/>