EmbedFlashPlugin

To embed a Macromedia Flash (.swf) file.

Example

%EMBEDFLASH{filename="http://www.redbourn.org.uk/twiki/pub/TWiki/EmbedFlashPlugin/sample.swf" width="320" height="240"}%

If this plugin is installed you will see a Flash movie here:

%EMBEDFLASH{filename="http://www.redbourn.org.uk/twiki/pub/TWiki/EmbedFlashPlugin/sample.swf" width="320" height="240"}%

General syntax

%EMBEDFLASH{filename="string" width="percentage or number" height="percentage or number" background="hex string" version="number" align="string" scale="string" quality="string" menu="true or false" id="string" align="string"}%

Minimum syntax:

%EMBEDFLASH{filename="string" width="percentage or number" height="percentage or number"}%

(other attributes are inserted automatically).

Flash attributes

Pass Flash movie attributes within the %EMBEDFLASH{...}% accolades (all values within quotes). When a particular parameter is not specified, the default value will be used (see table below).

More information on Flash OBJECT and EMBED tag attributes: http://www.macromedia.com/support/flash/ts/documents/tag_attributes.htm.

Argument	Comment	Example	Default value
Required attributes
`filename`	Filename of the movie; should have suffix .swf	`flashmovie.swf`	`none`
General attributes
`width`	Width of Flash movie in pixels, or a percentage. 100% means one hundred percent of the available width on the page.	`320`	`100%`
`height`	Height of Flash movie in pixels, or a percentage. 100% means one hundred percent of the available height on the page.	`50%`	`100%`
`background`	Background color of Flash movie in hex string. When omitted, no background color will be specified and the background color of the Flash movie will be used.	`#cccccc`	`""`
`version`	Flash Player version needed to view movie: version 5, 6 or 7	`5`	`6`
Advanced attributes
`align`	HTML alignment. Possible values: "" (default), left, right, top, bottom.	`right`	`""`
`scale`	Scaling of Flash movie. Possible values: "" (default), noborder, exactfit, noscale.	`noscale`	`""`
`quality`	Playback quality (default Flash setting is "high"). Possible values: best, high, medium, low, autohigh, autolow.	`best`	`high`
`menu`	Should right-click on Flash movie show a (default) menu? Possible values: true, false. Note that with the Flash 7 player the menu cannot be removed.	`true`	`false`
`id`	ID of Flash movie; for general use not necessary to specify.	`movie2`	the filename without suffix, eg. `flashmovie`

Global Settings

Plugin settings are stored as preferences variables. To reference a plugin setting write %<plugin>_<setting>%, for example, %EMBEDFLASHPLUGIN_SHORTDESCRIPTION%

One line description, shown in the Text Formatting Rules topic:
Set SHORTDESCRIPTION = Embeds a Macromedia Flash file

Debug plugin: (See output in data/debug.txt)
Set DEBUG = 0

Plugin Installation Instructions

Note: You need to install a Macromedia Flash plugin on the browser to see the Flash content. The following instructions are for the administrator who installs the plugin on the server where TWiki is running.

Download the ZIP file from the Plugin web (see below)

Unzip EmbedFlashPlugin.zip in your twiki installation directory.
Contents:

File:	Description:
`data/TWiki/EmbedFlashPlugin.txt`	Plugin topic
`lib/TWiki/Plugins/EmbedFlashPlugin.pm`	Plugin Perl module
`pub/TWiki/EmbedFlashPlugin/sample.swf`	Sample Flash movie

(Dakar) Visit configure in your TWiki installation, and enable the plugin in the {Plugins} section.
Test if the plugin is correctly installed: you should see a Flash movie at the top of this page.

Plugin Info

Plugin Author:	Arthur Clemens^?
Plugin Version:	28 Dec 2003 (V1.000)
Change History:
28 Dec 2003:	Initial version
CPAN Dependencies:	none
Other Dependencies:	none
Perl Version:	5.005
Plugin Home:	http://TWiki.org/cgi-bin/view/Plugins/EmbedFlashPlugin
Feedback:	http://TWiki.org/cgi-bin/view/Plugins/EmbedFlashPluginDev