Extension:MwEmbedSupport/MwEmbed

'''Note this documentation is outdated. I will try and update it and move to Extension:MwEmbedSupport''' Mdale 10:04, 13 February 2011 (UTC)

MwEmbed is a core library for JS2 mediaWiki interfaces. It supports localization, script-loader integration & provides a few useful helper functions. Built as a stand alone library it also supports importing "mediaWiki" interfaces into other contexts, such as the video player, add-media-wizard or sequencer in an external site. For more information on stand alone version of mwEmbed see html5 library page on kaltura.org.

= Core mwEmbed.js function overview =

This documentation is mostly copied from the code for easy updates

Configuration Vars
Here are the default configuration variables:

= mwEmbed Object Documentation =

Utility Functions
= MwEmbed File Overview =
 * jsScriptLoader.php The script-loader entry point.
 * mwEmbed.js The javascript entry point. Contains helper functions for javascript class dependency loading, skin setup, conditional invocation of video tag interface rewrite and entry points to firefogg, add-media-wizard, and sequencer interfaces.
 * /remotes/mediaWiki.js a script file to use the mwEmbed tools as a remote script for mediaWiki
 * tests Examples usage and tests of stand alone usage of the mwEmbed library.
 * media a folder with some sample media files
 * Add_Media_Wizard.html a simple inject media into a page sample of add-media-wizard. Usefull if building a simple plugin for blogging software or other CMS.
 * Firefogg_Make_Advanced.html Advanced Encoder example for firefogg. You can see it in action here
 * Firefogg_Make_Simple.html Simple Usage example of firefogg
 * Player_Simple_Video_Tag.html Simple example usage of the mwEmbed player. Showing how it rewrites the &lt;video&gt; tag.
 * Player_Themable.html Sample themeable player via jquery.ui theme engine.
 * Player_Timed_Text.html Timed Text example.
 * Sequence_Editor.html Sample Stand alone sequence editor.
 * jquery
 * jquery.ui-1.7.1 (includes jquery.ui 1.7.1 install)
 * plugins includes a few jquery plugins.
 * jquery-1.3.2.js the jquery library named by version.
 * modules
 * AddMedia Holds all the components for searching and importing of assets. Also know as the add media wizard
 * mw.BaseUploadInterface.js the base library for displaying upload progress and errors. it also handles basic form rewriting
 * mw.Firefogg.js The base firefogg library. Extends the BaseUploadInterface with support for firefogg.
 * mw.FirefoggGUI.js The advanced firefogg interface. Extends the base mvFirefogg library and exposes all firefogg options.
 * mw.RemoteSearchDriver.js The base engine for the add-media-wizard. Contains content provider configuration.
 * searchLibs holds api bindings for the various search providers
 * baseRemoteSearch.js the base class for search providers (provides shared methods among searchLibs)
 * archiveOrgSearch.js bindings for archive.org search
 * flickrSearch.js bindings for flicker image search (just stubs atm)
 * mediaWikiSearch.js bindings for mediaWiki api based search. (used both for searching commons and or the local mediaWiki install)
 * metavidSearch.js bindings for searching the metavid.org archive of use house and senate floor proceedings.
 * ClipEdit Holds tools for image and video manipulation
 * colorpicker A jquery plugin for selecting a color with color weel and all.
 * jCrop A jquery plugin for cropping images.
 * pixastic-editor a jquery.ui photoshop light in-browser image editor.
 * pixastic-lib the core filters for the pixastic editor
 * mvClipEdit.js the driver for editing images and video clips.
 * EmbedPlayer the core libraries for embedding video.
 * binPlayers contains applets used for playback of video
 * cortado
 * cortado.jar the latest cortado.jar from its upstream location: http://theora.org/cortado
 * kaltura-player
 * kdp.swf KDP GPL flash player for h.264 & flv fallback for more info see kaltura dynamic player not used on wikimedia projects
 * flowplayer A simple GPL flash player (for flash fallback of content in mwEmbed not used on wikimedia projects
 * omtk-fx
 * omtkp.swf A simple flash applet for playback of vorbis content included from OMTK source
 * embedPlayer.js The interface driver and base method provider for embedding video
 * nativeEmbed.js The native embedder object. Extends the embedPlayer object with native html5 video embedding.
 * vlcEmbed.js The VLC plugin embeder object. Extends the embedPlayer object with VLC plugin embedding.
 * javaEmbed.js A java embeder that abstracts the cortado applet to work with the embedPlayer object
 * omtkEmbed.js A flash based vorbis audio player, extends the embedPlayer object for audio only playback of vorbis with flash.
 * flashEmbed.js The flash embeder that abstracts a flash player to the embedPlayer object (not used in wikimedia projects)
 * genericEmbed.js A simple object embedder for browsers that register ogg/video support but are not a supported plugin.
 * htmlEmbed.js A embeder for displaying html with embedPlayer controls. This is mostly for sequences that display html based title screens or html based intro text/images.
 * *Sequencer Top level folder for sequencer / playlist components.
 * mw.PlayList.js The base playlist player. It parses a few formats including our reduced feature set SMIL sequencer language and displays the video.
 * mw.Sequencer.js The sequencer library that drives the sequence editor.
 * mw.TimedEffectsEdit.js An early stub for timed Effects editing interface
 * TimedText
 * mw.TextInterface.js A interface for timed text display. Presently support CMML and srt. Also includes a tool for selecting language and click on text seeking.
 * includes
 * languages the language files for localized versions of all the above mentioned components.
 * mwEmbed.i18n.php the core language file. Matches the language file structure of mediaWiki extensions. Placed in this folder to support stand alone localization of the reusable javascript libraries.
 * maintenance the maintenance utilies for syncing language msgs
 * mergeJavascriptMsg.php A simple script for merging javascript msg into the mwEmbed.i8n.php file
 * minify the library for minifying the javascript
 * JSMin.php The JSMin php based javascript minnification library.
 * script-cache holds the cached versions of scripts
 * skins The top level skin folder
 * mvpcf The default skin folder
 * images skin images
 * mv_sequence.css the sequencer skin css file
 * styles.css the player and simple components skin. It works by extending jquery.ui classes and skin structure.