EmbedFlashPlugin

Page contents

• Example
• General syntax
• Flash attributes
• More examples
  • Image folder
  • Yahoo Maps in Flash
• Settings
• Installation Instructions
• Plugin Info

Embed Adobe Flash files in TWiki topics

Example

%EMBEDFLASH{"%ATTACHURL%/sample.swf" width="550" height="400"}%

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

General syntax

%EMBEDFLASH{"filepath" <optional attributes> }%

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).

Argument	Comment	Example	Default value
Required attributes
filepath	Filepath of the movie; should have suffix .swf	mypath/flashmovie.swf
General attributes
width	Width of Flash movie in pixels, or a percentage. 100% means one hundred percent of the available width on the page.	"50%" or "500px"	"100%"
height	Height of Flash movie in pixels, or a percentage. 100% means one hundred percent of the available height on the page.	"50%" or "500px"	"100%"
bgcolor	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 (plugin) version needed to view movie	"8"	"9"
Advanced attributes
align	Default centers the movie in the browser window and crops edges if the browser window is smaller than the movie. l (left), r (right), t (top), and b (bottom) align the movie along the corresponding edge of the browser window and crop the remaining three sides as needed.	"l", "r", "t", "b"	""
salign	l, r, t, and b align the movie along the left, right, top or bottom edge, respectively, of the browser window and crop the remaining three sides as needed. tl and tr align the movie to the top left and top right corner, respectively, of the browser window and crop the bottom and remaining right or left side as needed. bl and br align the movie to the bottom left and bottom right corner, respectively, of the browser window and crop the top and remaining right or left side as needed.	"l", "t", "r", "b", "tl", "tr", "bl", "br"	""
scale	Scaling of Flash movie.	"noborder", "exactfit", "noscale", "showall"	""
quality	Playback quality.	"best", "high", "medium", "low", "autohigh", "autolow"	"high"
menu	Should right-click on Flash movie show a (default) menu? Note that with the Flash 7 player the menu cannot be removed.	"true" or "false"	"true"
id	ID of Flash movie; for general use not necessary to specify.	"movie2"	the filename without suffix, eg. flashmovie
wmode	Sets the Window Mode property of the Flash movie for transparency, layering, and positioning in the browser. window - movie plays in its own rectangular window on a web page. opaque - the movie hides everything on the page behind it. transparent - the background of the HTML page shows through all transparent portions of the movie, this may slow animation performance.	"window", "opaque" or "transparent"	""
play	Specifies whether the movie begins playing immediately on loading in the browser.	"true" or "false"	"true"
loop	Specifies whether the movie repeats indefinitely or stops when it reaches the last frame.	"true" or "false"	"true"
allowscriptaccess	Controls the ability to perform outbound scripting from within a Flash SWF. When allowScriptAccess is never, outbound scripting always fails. When allowScriptAccess is always, outbound scripting always succeeds. If allowScriptAccess is sameDomain (it is supported in SWFs from Flash Player 8), outbound scripting is allowed only if the SWF file resides in the same domain as the hosting web page.	"sameDomain", "always" or "never"	"sameDomain"
fullscreen	Enabled scriptable fullscreen mode. An overlay dialog box will appear when the movie enters full-screen mode, instructing the user how to exit and return to normal mode. The dialog box appears for a few seconds and then fades out.	"true" or "false"	"false"
base	Specifies the base directory or URL used to resolve all relative path statements in the Flash Player movie. This attribute is helpful when your Flash Player movies are kept in a different directory from your other files.	any directory URL, or empty string ""	"%ATTACHURL%/"
swliveconnect	Specifies whether the browser should start Java when loading the Flash Player for the first time.	"true" or "false"	""
flashvars	Variables to be passed to the Flash movie. Multiple variables are separated by &.	flashvars="x=50&y=100&url=%ATTACHURL%/picture.jpg"	""

Note that this plugin writes object and embed tags using Javascript to prevent annoying popup windows.
More information on Flash OBJECT and EMBED tag attributes (Adobe TechNote).

More examples

Image folder

The images are placed in separate folders. The Flash movie is also in its own folder. Adjust the filepath and base attribute to the Flash file:

%EMBEDFLASH{
"%ATTACHURL%/swf/ThumbController.swf"
width="430"
height="370"
base="%ATTACHURL%/swf/"
}%

Yahoo Maps in Flash

%EMBEDFLASH{
"http://developer.yahoo.com/maps/flash/V3.5/asGS.01.swf" 
base="http://developer.yahoo.com/maps/flash/V3.5/"
width="600px"
height="400px"
}%

Settings

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

• One line description, is shown in the TextFormattingRules topic:
  • Set SHORTDESCRIPTION = Embed Adobe Flash files in TWiki topics

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

Installation Instructions

Note: You do not need to install anything on the browser to use this plugin. The following instructions are for the administrator who installs the plugin on the server where TWiki is running.

• Run configure for automated install, or do manual install:
• Download the ZIP file from the Plugin web (see below)
• Unzip EmbedFlashPlugin.zip in your twiki installation directory. Content:

  File:	Description:
  data/TWiki/EmbedFlashPlugin.txt
  lib/TWiki/Plugins/EmbedFlashPlugin.pm
  pub/TWiki/EmbedFlashPlugin/sample.fla
  pub/TWiki/EmbedFlashPlugin/sample.swf
  pub/TWiki/EmbedFlashPlugin/img/thumbs/Agave.jpg
  pub/TWiki/EmbedFlashPlugin/img/thumbs/Clown-Fish.jpg
  pub/TWiki/EmbedFlashPlugin/img/thumbs/Daisies.jpg
  pub/TWiki/EmbedFlashPlugin/img/thumbs/Dandelion-Seeds.jpg
  pub/TWiki/EmbedFlashPlugin/img/thumbs/Dandelion.jpg
  pub/TWiki/EmbedFlashPlugin/img/thumbs/Faux-Fur.jpg
  pub/TWiki/EmbedFlashPlugin/img/big/Agave.jpg
  pub/TWiki/EmbedFlashPlugin/img/big/Clown-Fish.jpg
  pub/TWiki/EmbedFlashPlugin/img/big/Daisies.jpg
  pub/TWiki/EmbedFlashPlugin/img/big/Dandelion-Seeds.jpg
  pub/TWiki/EmbedFlashPlugin/img/big/Dandelion.jpg
  pub/TWiki/EmbedFlashPlugin/img/big/Faux-Fur.jpg
  pub/TWiki/EmbedFlashPlugin/swf/ThumbController.swf

• Visit configure in your TWiki installation, and enable the plugin in the {Plugins} section.

Plugin Info

Plugin Author:	TWiki:Main.ArthurClemens
Copyright:	© 2003-2008 TWiki:Main.ArthurClemens © 2007-2011 TWiki:TWiki.TWikiContributor
License:	GPL (GNU General Public License)
Plugin Version:	2011-01-11
Change History:
2011-01-11:	TWikibug:Item6530: Fix for IE issue; doc improvements; changing TWIKIWEB to SYSTEMWEB -- TWiki:Main.BenEsacove
24 Mar 2008:	Version 1.2 - Added flashvar attributes.
25 Feb 2008:	Version 1.1 - Added attributes. Write HTML embed/object tags with Javascript to prevent popup windows. If no javascript is available the noscript tag is used.
02 Nov 2006:	Version 1.01 - Updated Flash sample, small changes to documentation.
28 Dec 2003:	Version 1.0
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

Related Topics: TWikiPreferences, TWikiPlugins