Versions Guide

This guide will help you set up CoalaWeb Versions quickly and easily taking full advantage of all its features. When you install a CoalaWeb extension all the parts of the system will be installed at the same time making installing, upgrading and uninstalling a breeze.

Overview

CoalaWeb Versions gives Joomla administrators the power to display their minimum supported versions plus retrieve and display current versions in any Joomla content item. It comes packed with options making it very flexible.

When installing all the parts of the system will be installed at the same time making installing, upgrading and uninstalling a breeze.

Updates

The CoalaWeb Versions extension integrates with the inbuilt Joomla Update system so both Core and Pro users can keep their extension up to date. For Core users when you see updates listed in the Joomla update manager feel free to select it and update.

For Pro subscribers you will need to make sure you still have a valid subscription and that you have entered your Download ID into the System - CW Gears plugin. [Figure-1]

Not sure where to find your Download ID? Click HERE for more info.

Inside the CW Gears plugin options your will find a tab titled Updates and under it a Download ID input field. I recommend you copy and paste your Download ID into this field to reduce the risk of a typo and also to check for no spaces at the end. [Figure-1a]

The CW Gears plugin will take care of the Download ID for any CoalaWeb extensions that doesn't come with a component.

Where can I find my Download ID?

To see your Download ID you will need to log into coalaweb.com and then go to:

Members -> My Subscriptions

You will then see the ID displayed in the module titled Download ID. [Figure-1b]

TIP: To stop any typos I recommend copying and pasting the download ID and also to check for no spaces at the end.

Instructions

Core and Pro

To retrieve and display the current Joomla version use the plugin code {cwversions joomla-current} or for your currently supported Joomla version as defined in the plugin options use {cwversions joomla} in any of your joomla content items such as articles and or custom modules.

Pro Only

Pro subscribers also get the following plugin code options:

Basic

Display minimum PHP version {cwversions php}
Display minimum MySQL {cwversions mysql}
Display minimum Browser {cwversions browser}

Custom

Display custom options with custom plus number {cwversions custom1}

Advanced

Pro subscribers also get what I consider advanced options to display the current version of a locally installed extension or via it's update XML file.

Display currently installed version use it's element name {cwversions element coalawebversions}
Display version based on update XML file use xml {cwversions xml http://cdn.coalaweb.com/updates/cw-versions-pro.xml}

TIP: If you are using the plugin code in a custom module make sure that the Prepare Content option found under the module's Options tab is set to Yes.

Options

To make it easier to follow I have broken up this section into two parts.

Main

In the Main Options tab there is a Joomla input field for both Core and Pro users which will display when using the plugin code joomla. For Pro subscribers there is also PHP, MySQL and Browser input fields. Keep in mind whatever you put in these fields will be displayed when using their corresponding plugin code. [Figure 2]

Examples

Joomla 3.6+
PHP 5.4+
MySQL 5.1+
Modern Browser (IE >= 9)

Custom [Pro]

In the Custom Options tab there are three custom input fields which will display when using the plugin code custom plus it's corresonding number for example {cwversions custom1}. Keep in mind whatever you put in these fields will be displayed. [Figure 2a]

Need More Help

Do you have a question that wasn't covered by this GUIDE? Then it's time to drop by the Forum

Written by Steven Palmer Wednesday, 28 June 2017 Posted in Extensions, Versions