OBJECT
html tag to embed arbitrary content into a wiki page, with a particular bent towards media: Common media formats are detected and some "agnostic best-guess" html is used (derived from that recommended by the plugin providers). However, any content at all can be embedded using the object tag: java, pdf, other html, svg, even images (although there is of course no reason to do so). The plugin uses generic syntax when it cannot detect the type of file being embedded.
The plugin stores a range of default values (defined here on this page) which allow you to specify a bare minimum of info in your markup and still get acceptable results (see Basic Usage below). These defaults can of course be overridden on a use-by-use basis.
A USEEMBED
flag should be left to "true" - I thought I could be clever before I fully understood the minefield that is browser plugin syntax.
It also supports TWiki:Plugins.EmbedPlugin's EMBED
syntax to enable it to supersede that plugin:
%OBJECT{"SomeMovie.mov"}%
This will detect that the embedded file is a QuickTime and use "media-like" syntax (and pass the correct CLASSID
to IE - why it can't work out which plugin to use is a little beyond me). However, unlike an IMG tag, plugins do not autosize to their content, and the movie would display at the default size. You could use media of only one size site-wide and specify the dimensions as defaults, but realistically the minimum markup you need to embed things into your wiki pages is:
%OBJECT{"SomeMovie.swf" width="320" height="180"}%
%OBJECT{src="SomeMovie.wmv" width="320" height="180" controller="FALSE" play="TRUE" useembed="TRUE" myparam1="3.1419" myparam2="edinburgh"}%
Once you start passing a ton of parameters, you aren't gaining much by using the plugin, and you may actually be reducing the portability of your code, so it may be best to do your own HTML.
cowtype="Jersey"
, that is passed on to the browser, both as a <PARAM>
tag and inside the optional <EMBED>
tag.
A few parameters are defined and get handled a little differently (they may be "translated" to a particular browser plugins syntax)
Parameter![]() |
Value | Description | Notes |
---|---|---|---|
controller | text boolean ("TRUE" or "FALSE") | whether to display controls | automatically added |
height | std web measure (px, %, em) | height of box holding content | |
play | text boolean | whether to auto-play the content | automatically added for QT and Flash |
src | URI | the content to embed ("src=" is optional) | |
useembed | text boolean | whether to include a non-standard (but widely recommended) EMBED tag |
|
width | std web measure (px, %, em) | with of box holding content |
youtube.com
it will automatically use flash
Originally, the plugin used (almost) the exact recommended HTML on a type-by-type basis, but I've abandoned this in favour of "one markup fits all" because you don't know which plugin will be handling what - the various ISO formats (MPEG1,2,4, MP3) will be taken by whatever plugin was installed last, and QuickTime now handles Windows Media on Macintosh systems (at Microsoft's recommendation!).
While most of the HTML is as generic as possible, the CLASSID
value and some other mime-type information is unique to a particular file-type, and for Flash, QuickTime and Windows Media the Microsoft-sanctioned values are sent. I understand MSIE has to have this info or it totally burns ...
I haven't bothered with Real. If there's huge demand, it wouldn't be hard to add - but it may also be handled quite well by the generic media syntax already.
The sytax recommendations are found:
PARAM
tags is also put in the EMBED
tag (and any special EMBED
only parameters go first).
In other words, all parameters recommended by the plugin maker are sent, plus more, and in any old order.
This is an interesting article on getting "pure" OBJECT tags to both a) validate and b) work with browsers:
http://alistapart.com/articles/byebyeembedUSEEMBED
. I assumed that you could just leave EMBED
out, but that will break on everything but IE, as the other browsers (a little churlishly) ingore the entire tag if it has MS's custom params in it.
templates/objectplugin_mov.tmpl
, which contains the classid's, codebase etc.
%TMPL:DEF{objectHeader_mov}%classid="clsid:02BF25D5-8C17-4B23-BC80-D3488ABDDC6B" codebase="http://www.apple.com/qtactivex/qtplugin.cab" %TMPL:END% %TMPL:DEF{embedTag_mov}%TYPE="video/quicktime" PLUGINSPAGE="http://www.apple.com/quicktime/download/" %TMPL:END% %TMPL:DEF{controlerHeight_mov}%16%TMPL:END%To add other types add your own template using the same naming scheme (
objectplugin_ext.tmpl
).
%<plugin>_<setting>%
, for example, %INTERWIKIPLUGIN_SHORTDESCRIPTION%
configure
interface (Go to Plugins->Find More Extensions) .zip
or .tgz
archives
perl <module>_installer
)
configure
and enable the module, if it is a plugin.
,v
files in your existing install (take care not to lock the files when you check in)
Plugin Authors: | TWiki:Main.PiersGoodhew![]() ![]() |
Copyright: | © 2006 TWiki:Main.PiersGoodhew![]() © 2008 TWiki:Main.SvenDowideit ![]() © 2006-2010, TWiki:TWiki.TWikiContributor ![]() |
License: | GPL (Gnu General Public License)![]() |
Plugin Version: | 19389 (2010-08-29) |
Change History: | |
2010-08-28: | TWikibug:Item6530![]() |
20 Oct 2008 | modernize with TWiki:Plugins.BuildContrib![]() ![]() |
16 Oct 2006 | initial version |
Dependencies: | None |
Plugin Home: | http://twiki.org/cgi-bin/view/Plugins/ObjectPlugin![]() |
Feedback: | http://twiki.org/cgi-bin/view/Plugins/ObjectPluginDev![]() |
Appraisal: | http://twiki.org/cgi-bin/view/Plugins/ObjectPluginAppraisal![]() |