CMS Plugins

Flex can be installed very easily to existing websites running on popular content management systems. The following plugins are available to get your application deployed to your website with minimal effort!

Wordpress

Wordpress Plugin
  • Compatibility: Wordpress 2.6+
Download Plugin

Current Version: 1.0

Installation Instructions

This plugin is for self-hosted Wordpress sites only. You cannot install plugins to sites hosted on wordpress.org.

  • Download the plugin from this page
  • Log into your Wordpress Admin
  • Click the "Plugins" menu
  • Click "Add New"
  • Click "Upload"
  • Upload the plugin and activate!


Configuration

Once you have installed and activated the plugin, a new menu link will appear in your Wordpress admin titled "BB Flex". Use it to configure your App ID and other plugin settings. You must create a flex store app on Beat Brokerz to get an App ID. Once you have created an app on Beat Brokerz and saved the App ID to your plugin settings page, the flex framework will begin to load automatically on your site.


Shortcode Example

[bbflex widget="widgetname" width="500" height="100" param3="value3"]

The Wordpress plugin includes a shortcode format that you can enable/disable for your site via the plugin settings mentioned above. The shortcode is enabled by default when you install the plugin. You can use shortcodes inline with your content to display individual flex widgets on a page within any given post. Just type the shortcode into your content editor in the place where you want the widget to show.

Shortcode Syntax Breakdown

  • The shortcode is always enclosed on both ends by brackets [ ].
  • The word "bbflex" always follows the first bracket. This lets the plugin know you want to show a flex widget.
  • Every shortcode has a "widget" parameter for which you supply the name of the widget you want to display.
  • Depending on the widget, more configuration parameters may be available, and may or may not be required.
  • A single space separates each parameter, and an equal sign separates the parameter name from the value.
  • Each parameter value should be enclosed in quotation marks.


Widgets

For more information on what widgets are available out of the box with the flex framework, and how to find or create your own, visit the widgets documentation page.

Drupal

7

Drupal

  • Compatibility: Drupal 7.x
Download for Drupal 7

Current Version: 1.0
6

Drupal

  • Compatibility: Drupal 6.x
Download for Drupal 6

Current Version: 1.0

Installation Instructions

You must download the version of this module that corresponds to your version of Drupal.

  • Download the appropriate module

Drupal 7

  • Log into your Drupal site as admin
  • Click the "Modules" menu
  • Click the "Install new module" link

If you don't see the "install new module" link on your modules page, enable the "Update Manager" module first to enable automatic module installation.

  • Upload the module and enable it!
  • Configure your App ID at "admin/config/services/bbflex"

Drupal 6

  • Extract the contents of the zip file
  • Upload via FTP to your sites/all/modules folder
  • Log into your Drupal site as admin
  • Go to your "Modules" administration page and enable it!
  • Configure your App ID at "admin/settings/bbflex"


Configuration

You must save an App ID to your module settings page to begin streaming music on your site.

The drupal module also comes with a custom input filter that enables you to add widgets to your content using simple shortcodes. To enable the input filter (and thus the shortcode ability), you must add it to at least one of your existing input formats in drupal. For drupal 7, visit "/admin/config/content/formats". For drupal 6, visit "/admin/settings/filters".


Shortcode Example

[bbflex:widget="widgetname",width="500",height="100",param3="value3"]

The Drupal module includes a text filter that you can enable/disable for your text formats in Drupal. The shortcode format is NOT enabled by default when you install the plugin. You must edit one or more of your text formats, and enable the "BB Flex Shortcode" filter for each format that you want the shortcode to work with.

For Drupal 6, configure your text formats at: /admin/settings/filters
For Drupal 7, configure your text formats at: /admin/config/content/formats

You can use shortcodes inline with your content to display individual flex widgets on a page within any given post. Just type the shortcode into your content editor in the place where you want the widget to show.

Shortcode Syntax Breakdown

  • The shortcode is always enclosed on both ends by brackets [ ].
  • The word "bbflex" always follows the first bracket This lets the plugin know you want to show a flex widget.
  • A colon ":" immediately follows the word bbflex to separate it from the parameters.
  • A comma separates each parameter/value pair, and an equal sign separates the parameter name from the value.
  • Every shortcode has a "widget" parameter for which you supply the name of the widget you want to display.
  • Depending on the widget, more configuration parameters may be available, and may or may not be required.
  • Each parameter value should be enclosed in quotation marks.

Widgets

For more information on what widgets are available out of the box with the flex framework, and how to find or create your own, visit the widgets documentation page.

Joomla

Wordpress Plugin
  • Compatibility:
Download Joomla Package

Current Version: 1.0

Installation Instructions

  • Download the package from this page
  • Log into your Joomla Admin
  • Click the "Extensions > Extension manager" menu
  • Choose "Install > Upload Package File"
  • Upload & Install the package
  • Enable the plugin from the "Extenstions > Plugin manager" menu


Configuration

Once you have installed and enabled the plugin, you can configure your App ID by clicking the "Beat Brokerz Flex Framework" link on your plugin manager page, and then clicking the "Options" tab.


Shortcode Example

[bbflex:widget="widgetname",width="500",height="100",param3="value3"]

The Joomla extension includes a shortcode format that you can enable/disable for your site via the plugin settings mentioned above. The shortcode format is enabled by default when you install the plugin. You can use shortcodes inline with your content to display individual flex widgets on a page within any given post. Just type the shortcode into your content editor in the place where you want the widget to show.

Shortcode Syntax Breakdown

  • The shortcode is always enclosed on both ends by brackets [ ].
  • The word "bbflex" always follows the first bracket This lets the plugin know you want to show a flex widget.
  • A colon ":" immediately follows the word bbflex to separate it from the parameters.
  • A comma separates each parameter/value pair, and an equal sign separates the parameter name from the value.
  • Every shortcode has a "widget" parameter for which you supply the name of the widget you want to display.
  • Depending on the widget, more configuration parameters may be available, and may or may not be required.
  • Each parameter value should be enclosed in quotation marks.

Widgets

For more information on what widgets are available out of the box with the flex framework, and how to find or create your own, visit the widgets documentation page.