[[PageOutline(2-5,Contents,pullout)]]

= Embed Flash content

== Description

This plugin provides a macro ![[Embed(...)]] for embedding flash content into wiki pages.

== Bugs/Feature Requests

Existing bugs and feature requests for FlashEmbedMacro are 
[report:9?COMPONENT=FlashEmbedMacro here].

If you have any issues, create a 
[http://trac-hacks.org/newticket?component=FlashEmbedMacro&owner=rudyryk new ticket].

[[TicketQuery(component=FlashEmbedMacro&group=type,format=progress)]]

== Download

Download the zipped source from [download:flashembedmacro here].

== Source

You can check out FlashEmbedMacro from [http://trac-hacks.org/svn/flashembedmacro here] using Subversion, or [source:flashembedmacro browse the source] with Trac.

== Installation

From a bash command prompt:
{{{#!sh
unzip flashembedmacro-r10922.zip
cd flashembedmacro/0.11
python setup.py bdist_egg
cp dist/TracFlashEmbedMacro-0.95RC1-py2.4.egg /your-trac-project/plugins/
apachectl graceful
}}}

== Usage and Examples

Macro produces html code for embedding flash content from certain service, by its 'key' and content id. It also can embed simple SWF by its URL.

Available keys:
 * ''youtube'': video from !YouTube http://youtube.com
 * ''vimeo'': video from Vimeo http://vimeo.com
 * ''swf'': SWF by URL or attachment link
 * ''flv'': insert [http://www.longtailvideo.com/players/jw-flv-player/ JW Player] with flv file, you '''must''' provide extra ''purl'' parameter.

Optional parameters:
 * ''w'' and ''h'': width and height of embedded flash object

=== Enable in the trac.ini file

For a global installation, you need to ensure the following is added to the `[components]` section of your `trac.ini` file:

{{{#!ini
[components]
tracflashembed.macros.embedmacro = enabled
tracflashembedmacro = enabled
}}}

=== Embed !YouTube or Vimeo

Examples:
{{{
[[Embed(youtube=emYqURahUKI)]]
[[Embed(vimeo=3840952,w=400,h=300)]]
}}}

=== Embed SWF by url

Examples:
{{{
[[Embed(swf=http://trac-hacks.org/raw-attachment/wiki/FlashEmbedMacro/flowers.swf,w=500,h=400)]]
[[Embed(swf=/raw-attachment/wiki/FlashEmbedMacro/flowers.swf,w=500,h=400)]]
}}}

=== Embed SWF from attachment

Examples:
{{{
[[Embed(swf=flowers.swf,w=500,h=400)]]
[[Embed(swf=attachment:flowers.swf,w=500,h=400)]]
}}}

If ''swf'' parameter starts with '!http://', '!https://' or '/', it's treated as URL. Otherwise it is processed as an attachment.

The 'attachment:' prefix is optional, so the examples above are equivalent.

If it doesn't play, check this setting in the `trac.ini` file:

{{{#!ini
[attachment]
render_unsafe_content = true
}}}

=== Embed FLV video

Note, that you will need [http://www.longtailvideo.com/players/jw-flv-player/ JW Player] hosted somewhere.

{{{
[[Embed(flv=video.flv,purl=/jwplayer.swf,w=500,h=400)]]
}}}

The url for ''flv'' file is handled same as ''swf''.

== Recent Changes

[[ChangeLog(flashembedmacro, 3)]]

== Author/Contributors

'''Author:''' [wiki:rudyryk] [[BR]]
'''Maintainer:''' [[Maintainer]] [[BR]]
'''Contributors:'''