Add screencasts to Knowledge Base articles
Revision Information
- Revision id: 818
- Created:
- Creator: Chris Ilias
- Comment: update contributors forum links for SUMO 2.1
- Reviewed: Yes
- Reviewed:
- Reviewed by: AnonymousUser
- Is approved? Yes
- Is current revision? No
- Ready for localization: Yes
- Readied for localization:
- Readied for localization by: AnonymousUser
Revision Source
Revision Content
A screencast is a video or animated image of what is displayed on a computer screen to show readers what the instructions in knowledge base articles are telling them.
Table of Contents
Before you create a screencast
- Try to present Firefox in its most familiar form.
- Use as many default settings as possible.
- Use the default Firefox theme.
- Use the default operating system theme.
- Lower the screen resolution or do not capture the entire screen, so it will fit in the browser window.
- Make sure there's enough context to know what the image is of.
- If speaking, make sure you speak clearly.
- Make sure you can export to FLV or ogg/theora.
- Screencasts should only be applied to step-by-step instructions.
Do not create screencasts that are larger than 640x480. Otherwise only a portion of the video will be viewable.
Software
There are many more screen recording products out there. If there is one you would like to recommend, please tell us in the Contributors forum.
Windows
Mac
Linux
- vlc (free)
- recordMyDesktop (free)
Converting to OGG (Windows or Mac)
Ogg/Theora is an open video format that Firefox 3.5 can play without the need for a plugin. Unlike other video formats such as Flash or MPEG, Ogg is unrestricted by software patents and open for further software development. Because Firefox can play Ogg files without a plugin, users with problematic plugins will have better chance of being able to view Ogg screencasts.
Steps (Windows)
- Using BB FlashBack Express, you can export to an uncompressed AVI, which VLC will convert easily.
- Install and run VLC media player.
- Go to the
menu and select . - Click
to select the file to convert. - After you've added a file, click on .
- Under "Settings", select the Video - Theora + Vorbis (OGG) profile.
- Beside "Destination file", click to choose a location and name of the OGG file.
- Click .
Adding screencasts to articles
- Read the Editing articles page first.
- Beside Upload screencast, click
. - A file selector will open, allowing you to select the file from your computer. After you have selected the file in the file selector, and clicked , the file is ready to be uploaded.
- Click
to upload the screencast. A thumbnail of the file should appear in the Insert screencast area.
- You can add both a Flash video and an Ogg video at the same time, and the fallback will work automatically.
- To insert a screencast, click on the Insert Screencast link below the thumbnail, and the corresponding code will appear where the cursor is, in the article content area.