Currently Being Moderated

YouTube Macro

VERSION 8

Created on: Jul 19, 2007 9:30 AM by Aaron Johnson - Last Modified:  Sep 4, 2008 5:24 PM by tim.neuwerth

This macro makes it easy to display YouTube movies in documents, blog posts, and threads. Here's an example of how it's used:

 

 

 

Technologies

The simple example code here illustrates how you can use a plugin to display media in Clearspace content.

 

What's Included

  • build.xml -- Ant build file.

  • plugin.xml -- Plugin descriptor required by Clearspace.

  • src/com.jivesoftware.clearspace.plugins.youtube.YouTubeMacro.java -- Macro class that gets the media and generates HTML needed to display it.

 

Building and Deploying the Code

The Ant build.xml file at the root of the plugin includes a build.plugins target you can use to compile the code and package it into a JAR file. There's also a deploy.plugins target that copies the JAR into the <jiveHome>/plugins directory that accompanies your Clearspace distribution. Paths into your test Clearspace distribution assume that this plugin project is in the standalone Clearspace distribution at: <root>/plugins/plugins/<plugin_name>. Be sure to update the targets if you're testing another way, such as with the Clearspace WAR distribution.

 

Be sure to read the notes below about dependencies. The JAR files you'll need are included as part of Clearspace.

 

Running the Samples

  1. Build and deploy the code.

  2. Open Clearspace and create a wiki document. Add whatever text you like, but be sure to add the youtube macro using the syntax described above.

  3. Preview or publish the document to see its output.

 

You should see the media displayed and ready to play.

 

 

Dependencies

In addition to requiring Java 1.5, this code requires a few of the libraries you'll find in the WEB-INF/lib directory of your Clearspace installation, listed below.

 

  • clearspace-<version>.jar

 

If you'd rather deploy the plugin manually, you can do that in one of two ways:

 

  • Just copy the plugin JAR file into the <jiveHome>/plugins directory. Your running Clearspace instance will deploy it automatically.

  • Open the admin console and navigate to System > Settings > Plugins, then browse for your plugin JAR file.

 

Clearspace 1.X Plugin Files

 

Clearspace 2

  • The youtube macro is now included by default in Clearspace 2

Average User Rating
(2 ratings)




andrefonseca andrefonseca  says:

Hi Folks,

 

Are there ways to specify attributes ?

 

Thanks,

 

Andre

Download Plugin for

Plugin Info

More Like This

  • Retrieving data ...