FMJ Banners Supercharger Documentation

(Work in Progress...)

 

FMJ Banners Supercharger extends the default Joomla Banner system, providing a lot more flexibility and less hassle

 

1. Features

2. Installation

3. Configuration

 

 

 

1. Features

  • SEO (direct) url links - instead of the internal click-registration and 303 redirect, we set the destination-url directly in the href attribute of the banner and calling the 'click-counter' with javascript.
  • Automatic (and optionally manual) target selection. This sets the target attribute to visit the target in the same window or open up a new one.
  • Flexible settings using defaults in the plugin and customizable settings directly in the "Banner Details" tab of each banner's settings.
  • Hassle-free default settings! In most cases, users probably will not need to change any settings, either in the plugin or in the banners.
  • Saves the user bandwidth (especially important in mobile networks), as the response to the plugin's javascript 'click-counter' request disables Joomla's redirect call and returns an empty response.
  • Deals with the case where second call throws errors because your site is on https and the 'click' call is redirected to a non-secure (http) site.
  • Freedom of putting Banners in any banner module, regardless of the module's target setting! While manipulating the anchor code and if 'Banner SEO-Link' is activated, the plugin removes the target settings that are defined in Joomla's Banner modules' settings.
  • Works with jQuery or MooTools! Also, if the time comes to disable MooTools on your site, this plugin will just keep working as before. Future-Proof!
  • Performance optimized code! The plugin avoids unnecessary database calls, as well as unnecessary code execution. For the user this means faster response times as well as saving cpu cycles and energy, which helps the environment.



2. Installation

FMJ-Banners Supercharger is a plugin which is instralled the usual Joomla way.

In your Administration console:

1. Click Extensions -> Manage -> Install (or only Manage)

2. Click "Upload Package FIle", browse for the Extension File and click "Upload & Install". Done.

 

 

 

3. Configuration

 

The easy way (One Click - Using only the defaults):

FMJ Banners Supercharger comes with sensible defaults. The easiest way to get started is to just enable the plugin.

In your Administration console goto "Extensions" -> Plugins and search for "FMJ". This should show any plugins having "FMJ" in their name. Enable the "FMJ-Banners Supercharger" plugin.

That's it! In most cases, this will already do the job. If you test it's functionality hereafter and it doesn't seem to work, just be sure that you clean your cache.

 

The customisation way (changing the defaults or customizing the Superchargers settings on a per-banner level):

To allow maximum customization, all Banner-related settings of the plugin act as default settings and can be overriden on a per-banner level.

All configuration options are explained below:

 

3.1. Plugin Tabs

In this section we will go through the configuratio options available in each tab of the plugin configuration.

 

3.1.1 Plugin

  • Banner SEO-Link:

    Allow the plugin to manipulate the banner's anchor and make it SEO friendly.

    Set it to 'Yes' or 'No' according to what you would like your default to be.(Default: Yes)
    You may also customize this setting in the individual banner settings by either setting it to 'Default' (which inherits this plugin's setting and is the default for individual banner settings) or set it to 'yes' or 'no' in order to customize the setting for each individual banner.

  • Banner Target:

    Choose the default target of the links
    • Auto => plugin decides automatcally, to use either 'Local' or 'External'
    • Local => Will use whatever is defined in 'Local Target Name'
    • External => Local => Will use whatever is defined in 'External Target Name'

     

  • Local Target Name:

    Which Target Name should be used if the Banner Target is 'Local'
    • Default => use plugin setting as default
    • _self => same window (or tab)
    • _parent => parent window (or tab)
    • _top => top window (or tab)
    • _blank => new window (or tab)

     

  • External Target Name:

    Which Target Name should be used if the Banner Target is 'External'?
    • Default => use plugin setting as default
    • _self => same window (or tab)
    • _parent => parent window (or tab)
    • _top => top window (or tab)
    • _blank => new window (or tab)

     

  • Disable content manipulation:

    Caution!!!
    If you need the plugin to NOT make any manipulations temporarily, do NOT disable it! You might loose plugin-related custom settings in your banners, if you save banner entries while the plugin is disabled.

    Instead, use the below 'Disable content manipulation' switch by setting it to 'Yes'. This way, any plugin-related banner settings will still be displayed, caught and saved by the plugin.
    This is more of a testing/debugging switch, to turn off content manipulation without turning off the complete plugin. 

 

3.1.2 Javascript

  • JS Framework to use:

    Specify the Framework to use or 'Auto' to automatically choose one during rendering

    Notes:
    • Auto is default, and will always prefer jQuery over MooTools, if it is being loaded.
    • Unless you are sure, that a specific framework is loaded on every page where there is a banner, you should prefer 'Auto'.

     

  • Declaration of JS Snippet:

    'Inline' embeds the needed JS code into the html file, while 'File' loads it as a JS resource

    'Inline' is the default, because:
    • ... it saves a few bytes
    • ... it has fewer issues when used in conjunction with web site optimizers
    • ... it's a very small snippet, which would have a much bigger impact if loaded separately (If you use a website optimzer, this doesn't really matter much as inline and external resources are generally combined anyway.)

 

3.1.2 Debug

  • Enable Debug Mode:

    Enable Debug Mode for the user group selected below.

    Note: Debug mode overrides the 'Disable Content Manipulation' setting for the debugging users. Users not in the debugging groups specified below, will get the unmodified content.

  • Debug Mode User Groups:

    Select Groups of which Users will be able to use debug-mode, if enabled.