Embedding video in a DITA topic

Last Updated : Oct 29, 2014 |
In DITA, you can embed a video in a DITA topic and have that video be available in your HTML output. There are a couple of ways that you can embed a video in a topic:
  • If the video demonstrates how to perform a particular action documented in a task topic, you can embed the video with the example element at the end of the task.
  • If you to create a separate topic just for the video, you can create a concept topic with a title that explains what the video depicts and an example element with the video information embedded.
Note:
Videos in PDF outputs is not supported. If the topic in which you embed a video is used in both PDF and HTML outputs, you need to apply the proper profiling and filtering to ensure that the video is filtered out of the PDF output.
Prolog information
Metadata
Keywords:
These steps provide values for using a video created using Captivate software. If you want to embed a video created with a different tool, please contact an IA.
Before you begin
If the topic is included in both HTML and PDF outputs, work with an IA to set up the appropriate filter for your project.
  1. Copy the topic TopicWithSampleEmbeddedVideo.dita from the Samples\topics\Topic with Embedded Video directory to your working directory.
  2. In Arbortext Editor, open both the topic TopicWithSampleEmbeddedVideo.dita and the topic into which you want to embed the video.
  3. Copy the example element from TopicWithSampleEmbeddedVideo.dita to your topic and then close TopicWithSampleEmbeddedVideo.dita.
  4. In the example element, position the cursor after the param element and press Ctrl + D.
  5. In the Modify Attributes dialog box, modify the value field to the name of your video. If you are going to put the video in a subfolder in your HTML output, include the folder name too.
    For example, if your video is named AddingUser.swf and you'll be copying it into a Tutorials subfolder with your HTML output, enter Tutorials/AddingUser.swf in the value field.
  6. Produce the HTML output.
  7. Export the output.
  8. Extract the files from the zip and copy the tutorial into the HTML output directory.
  9. Open the HTML topic containing the video and test that the video launches properly.