DEPRECATION WARNING
This documentation is not using the current rendering mechanism and is probably outdated. The extension maintainer should switch to the new system. Details on how to use the rendering mechanism can be found here.
EXT: Flash Player Integration (SWF Object)¶
Author: | Kasper Skårhøj |
---|---|
Created: | 2002-11-01T00:32:00 |
Changed: | 2009-01-08T11:39:13.950000000 |
Classification: | yejj_swfobject |
Description: | The keywords help with categorizing and tagging of the manuals. You can combine two or more keywords and add additional keywords yourself. Please use at least one keyword from both lists. If your manual is NOT in english, see next tab "language" ---- forEditors (use this for editors / german "Redakteure") forAdmins (use this for Administrators) forDevelopers (use this for Developers) forBeginners (manuals covering TYPO3 basics) forIntermediates (manuals going into more depth) forAdvanced (covering the most advanced TYPO3 topics) see more: http://wiki.typo3.org/doc_template#tags ---- |
Keywords: | flash player integration, flash integration, flash player, flash, swfobject, swf object, swf, fla |
Author: | Visay Keo, Violeng Mam |
Email: | web@yejj.com |
Info 4: | |
Language: | en |
EXT: Flash Player Integration (SWF Object) - yejj_swfobject
EXT: Flash Player Integration (SWF Object)¶
Extension Key: yejj_swfobject
Language: en
Keywords: flash player integration, flash integration, flash player, flash, swfobject, swf object, swf, fla
Copyright 2000-2008, Visay Keo, Violeng Mam, <web@yejj.com>
This document is published under the Open Content License
available from http://www.opencontent.org/opl.shtml
The content of this document is related to TYPO3
- a GNU/GPL CMS/Framework available from www.typo3.org
Table of Contents¶
EXT: Flash Player Integration (SWF Object) 1
`Copyright 3 <#1.1.Copyright|outline>`_
`Introduction 4 <#1.2.Introduction|outline>`_
`Users manual 6 <#1.3.Users%20manual|outline>`_
`Administration 9 <#1.4.Administration|outline>`_
`Configuration 10 <#1.5.Configuration|outline>`_
`Known problems 12 <#1.6.Known%20problems|outline>`_
`To-Do list 13 <#1.7.To-Do%20list|outline>`_
`ChangeLog 14 <#1.8.ChangeLog|outline>`_
Copyright¶
Credits¶
This extension is a continuation of the work initiated by Richard Bausek from his extension rb_flashobject.
Big thanks go out to Geoff Stearns for his awesome SWFObject JS code.
Thanks to Dominik Stankowski for his great ideas, advice and patient support.
Sponsors¶
Development of this extension was sponsored by Yejj Info Co. Ltd. www.yejj.com
If you would like to sponsor the continuation of this extension, outsource a part of your TYPO3 development to us! We provide ethical TYPO3 outsourcing services to TYPO3 companies. More information can be found on our website.
Introduction¶
What does it do?¶
Extension for embedding Flash movies (.swf) on pages using the SWFObject 2 method with static and dynamic publishing and providing flexible solutions for dynamic and alternative content.
What is SWFObject?¶
SWFObject is an easy-to-use and standards-friendly method to embed Flash content, which utilizes one small JavaScript file.
SWFObject 2:¶
- Offers two optimized Flash Player embed methods; a markup based approach and a method that relies on JavaScript
- Offers a JavaScript API that aims to provide a complete tool set for embedding SWF files and retrieving Flash Player related information [ http://code.google.com/p/swfobject/wiki/api ]
- Utilizes only one small JavaScript file (9.5Kb / GZIPed: 3.8Kb)
- Is the successor of SWFObject 1.5 [ http://blog.deconcept.com/swfobject/ ] and UFO [ http://www.bobbyvandersluis.com/ufo/ ]
- Will eventually replace the Adobe Flash Player Detection Kit [ http://www.adobe.com/products/flashplayer/download/detection_kit/ ]
- Intends to unify all existing Flash Player embed methods and provide a new standard for embedding Adobe Flash Player content
- Is an open source project by Geoff Stearns, Michael Williams, and Bobby van der Sluis, and is formerly known as SWFFix [ http://code.google.com/p/swffix/ ]
Features:¶
- Is more optimized and flexible than any other Flash Player embed method around
- Offers one solution for everybody: It shouldn't matter if you are an HTML, Flash, or JavaScript developer, there should be something in it for everyone
- Breaks the cycle of being locked into vendor specific markup and promotes the use of web standards and alternative content
- Uses unobtrusive JavaScript and JavaScript best practices
- Is easy to use
Users manual¶
Installation¶
Just install the extension using the extension manager.
Quick Start¶
Step 1: Create a Flash movie record¶
- Create a new record using the “create new record” button or via the “new” command in the context menu.
- Choose “Flash Movie” as shown in the picture below.
Now fill out the Flash movie settings (see picture in Screenshot Section).
Step 2: Create a “Flash movie” Content Element¶
Click on the "create new record" link, to add a new content-element. In the next screen click on the wizard link under “Pagecontent”.
At the “New Content Element Wizard” select the icon “Flash Movie” at the bottom of the page.
Now add the previously created “Flash Movie” record to the content element and choose the Publishing Method (Dynamic or Static), and you can check or uncheck the ExpressInstall.
Note:¶
- ExpressInstall is feature for upgrading flash player. No need to go to Macromedia site anymore, no need to download the installer and no need to run the installer on your computer. it can all be done much easier.
- When a user runs swf with the Express Install feature enabled and if he does not have the required version of Flash player, the swf updater from the Macromedia website is loaded into the movie which allows the user to download and install the new flash version.
- Alternative Content: allows you to choose the page content that will display when browsers don't have flash plug-in and it will overwrite the alternative content in the flash movie record.
- After you finish the Flash Movie Settings Tab, you can go to the Attributes tab to add some attributes to your flash movie, but they are all optional.
* Note:¶
For the Flash content id, if you leave it blank, it will have the default value: “ yejjFlashContent_ ” joined with a random string.
The tab Parameters it's also optional, and on this tab you can choose the flash movie quality, display menu in your flash movie, set the background color of the flash movie and some other additional parameters.
For the Flash Variables tab you also can leave it blank if your flash movie doesn't need it.
* Note:¶
Flash Variables or FlashVars is the Flash answer to Query String. It's a way to pass data or variables from html to a Flash movie. The general idea of FlashVars is very similar to a Query String. Variables passed via FlashVars will go into the _root level of the Flash movie.
FAQ¶
None yet.
Configuration¶
- The plugin can be configured and inserted with TypoScript.
- Instead of using Flash Movie Records, flash movie information can be specified via TypoScript. See the Reference section for an example.
Reference¶
plugin.tx_yejjswfobject_pi1: TS setup
altContent¶
Property
altContent
Data type
cObject
Description
Alternative content to be displayed if the flash player requirements are not met.
Alternative content can be specified in three locations: In the plugin, in the movie record and in TypoScript. The plugin flexform value overwrites the TypoScript configuration which itself overwrites the movie record value.
Default
flashMovieUid¶
Property
flashMovieUid
Data type
int
Description
The flash record to be inserted on the page if it was previously created in the database using the list module. Alternatively, the flash record can be specified independently through the property “flash_record”.
Default
flash_record¶
Property
flash_record
Data type
mixed
Description
The flash record to be inserted on the page. Instead of pulling it from the database (cf. flashMovieUid), this property allows to specify the flash record in TypoScript only. See table below for more information.
Default
ts_content¶
Property
ts_content
Data type
mixed
Description
The TS configuration for information specified in the plugin flexform. Used for default configuration of plugins or when plugins are inserted directly by TS. For more information, see table below.
Default
[tsconfig:(tx_yejjswfobject_pi1)]
((generated))¶
Example¶
Here is an example of how to add flash record and configure some flash property.
lib.flash >
lib.flash < plugin.tx_yejjswfobject_pi1
lib.flash {
flashMovieUid = 5
altContent = COA
altContent {
10 = TEXT
10.value = Flash Can not be displayed.
}
}
plugin.tx_yejjswfobject_pi1.flash_record: TS setup
Property
flashmovie
Data type
string
Description
Path of swf file.
Example:
flashmovie = fileadmin/templates/flash/my_flash.swf
Default
Property
width
Data type
int
Description
Set the width of flash movie.
Default
Property
height
Data type
int
Description
Set the height of flash movie.
Default
Property
requiredversion
Data type
int
Description
Set the require version of the flash movie
Default
Property
alternativecontent
Data type
int
Description
Set the alternative content if flash doesn't display.
Gives the possibility to specify alternative content (Content Elements) from tt_contents in connection with the flash_record. Is overruled by alternative content in the altContent section.
Default
[tsconfig:(tx_yejjswfobject_pi1.flash_record)]
Example¶
Here is an example of how to add a flash record by TS.
lib.flash.flash_record {
flashmovie = fileadmin/templates/flash/my_flash.swf
width = 547
height = 34
requiredversion = 8
alternativecontent = 30
}
plugin.tx_yejjswfobject_pi1.ts_content: TS setup
Property
publishMethod
Data type
boolean
Description
Set the publishing method (0 dynamic and 1 for static)
Default
0
Property
expressInstall
Data type
boolean
Description
Set the express install option. If the browser has an older version of Flash player installed than required, the express install swf from the Macromedia website is called which will guide through the update process.
Default
1
Property
flashContentId
Data type
String
Description
Set the id of the flash movie.
Default
Property
attrName
Data type
String
Description
Set the name of the flash movie.
Default
Property
attrClass
Data type
String
Description
Set the class name for the flash movie.
Default
Property
attrAlign
Data type
String
Description
Align the flash movie.
Default
Property
quality
Data type
String
Description
Set quality for the flash movie.
Default
high
Property
bgColor
Data type
String
Description
Defines default background color for all flash movies. The value should be a hex color string (eg. #ffffff).
Default
Property
flashParams
Data type
String
Description
Defines the flash parameters for the flash movie.
Merges with key/values specified in the plugin flexform.
Example:
ts_content {
flashParams (
wmode|transparent
)
}
Default
Property
flashVars
Data type
cObject
Description
Defines the flash variables for the flash movie.
Merges with key/values specified in the plugin flexform.
Example:
ts_content {
flashVars {
xmlFile = TEXT
xmlFile.value = flashpage/content.xml
}
}
Default
[tsconfig:(tx_yejjswfobject_pi1.ts_content)]
Example¶
Here is an example of how to add existing flash record from database and configure some flash property.
lib.flash < plugin.tx_yejjswfobject_pi1
lib.flash.flashMovieUid = 2
lib.flash.altContent = COA
lib.flash.altContent {
10 = TEXT
10.value = Flash alternative content.
}
lib.flash.ts_content {
flashParams (
wmode|transparent
)
flashVars {
xmlFile = TEXT
xmlFile.value = flashpage/content.xml
}
}
Here is an example of how to add a new flash record and configure some flash property.
lib.flash < plugin.tx_yejjswfobject_pi1
lib.flash.flash_record {
flashmovie = fileadmin/flashFile.swf
width = 800
height = 600
requiredversion = 8
alternativecontent = 30
}
[PIDinRootline = 17]
lib.flash.altContent = TEXT
lib.flash.altContent.value = Alternative content for only this page.
[end]
FAQ¶
None yet.
Known problems¶
SWF Object IE6 Crash¶
How do I prevent Internet Explorer from crashing and showing an "Operation Aborted" error when a <base> tag is defined?
Including a closing </base> tag will prevent this bug in Internet Explorer being triggered. Because for HTML 4 compliant pages (a closing base tag is forbidden under HTML 4), you could use Internet Explorer conditional comments to keep your HTML valid and still include a closing base tag for HTML 4 documents:
<base href="http://www.yourdomain.com/"><!--[if IE]></base><![endif]-->
The TYPO3 solution to this problem is to define the baseURL as follows:
config.baseURL = {$global.baseURL}
[browser = msie6]
config.baseURL >
config.headerComment (
This is to allow IE6 to see Flash
-->
<base href="{$global.baseURL}"></base>
<!--
)
[end]
Sources:
To-Do list¶
ChangeLog¶
1.0.0¶
Version
1.0.0
Changes
Initial release
1.0.1¶
Version
1.0.1
Changes
Renamed the extension title from “Yejj Swf Object” to “Flash Player Integration (SWF Object)”.
Created documentation.
1.0.2¶
Version
1.0.2
Changes
Fixed minor problem with expressInstall for dynamic publishing method.
1.0.3¶
Version
1.0.3
Changes
Multi-languages support.
Fixed the bugs which support with multiple swfobjects in one page both for dynamic and static publishing methods.
1.0.4¶
Version
1.0.4
Changes
TypoScript support.
Added documentation for workaround addressing IE6 crash with SWF Object.