Club Free

Joomla Extensions

FREE

RokGZipperLatest Version: 1.8

RokGZipper

Powerful CSS and Javascript Compression System RokGZipper is a plugin whose primary aim is to improve the performance and speed of your site. It does this by compressing your CSS (stylesheets) and JavaScript files. For javascript files, it compresses them altogether (via GZip) and places them in the cache folder.

It differentiates between the pages so if you have a particular combination of scripts on one page, and a different combination on another, two files will be created and loaded independently, allowing your site to load much faster.

Note: This plugin is experimental and should be used at your own risk. You should not use the plugin during development stage and should only activate it on a finalised site.

Also, Gzip must be installed on your server and enabled in PHP in order to function.

What does this mean in the real world?

To see how this effects a template in the a real world scenario, we'll examine the front-page of the SolarSentinel demo site from a very average 768kb DSL connection. We used the Net panel in Firebug for Firefox to get our data.

CSS Files

First we'll see how the site loads the CSS without RokGZipper enabled:
RokGzipper

As you can see because the SolarSentinel template allows for maximum flexibility with almost unlimited combinations of header/body/footer/backgrounds etc, there are multiple CSS files loaded as well as some of the CSS files needed for the modules used. Let's turn on RokGZipper and see what we get now:

RokGzipper

As you can clearly see the 11 original requests have been reduced to 4 requests. The 104KB of CSS files has been reduced to just 18KB (17% of the original size!), and the original 1.44 seconds it took to download the CSS files has been reduced to just 359ms (400% faster!). A drastic improvement!

Javascript Files

Now to see the effects on the JavaScript side. SolarSentinel is an extremely feature-packed template, and we've tried to show off as much as possible on the front page of the demo. This makes it an excellent example to really see the power of RokGZipper in action. First without RokGZipper enabled:

RokGzipper

Once again, there's a lot of JavaScript there to power all the features and functionality we are showing off on the front page. This of course is a somewhat extreme case, and you probably would not have this much functionality turned on at any one time. Let's enable RokGZipper and see what we get:

RokGzipper

The end result is even more dramatic than with the CSS. Those original 17 requests for the JavaScript elements have been reduced to just 1 request. The 164KB has been reduced to just 46KB (28% of the original size), and the 4.85 seconds it took before has been reduced to just 639ms (760% faster!).

Of course RokGZipper is particular useful with SolarSentinel due to the large amounts of CSS and JavaScript Files, but RokGZipper can be applied to any template that implements addScript() and addStyleSheet() functions and should improve your browsing experience significantly. However, if the files are loaded through HTML, you will need to change that to PHP declarations as outlined at this page.

How do I configure RokGZipper?

The plugin itself has one parameter, as found in Extensions → Plugin Manager → System - RokGZipper. This option is Cache Time in Secs which delineates the amount of time the cache will remain unchanged before it is flushed for a new file. The value is set in seconds.
Note: You need to publish the plugin for it to work.

Installation - Joomla 1.5


Downloading the Extension Files

  • RokGzipper Plugin (plg_rokgzipper.zip) This file is the plugin package you will use to install RokGzipper into Joomla.

Using the Joomla Installer

From the Menu in your Joomla Administrator, go to Extensions → Install/Uninstall.

Next, browse for your plg_rokgzipper.zip file you downloaded and then click Upload File & Install.


installation

Accessing the Plugin Page

Next, go to Extensions → Plugin Manager. In the list, you will find System - RokGzipper. Click the name in order to enter RokGzipper's Plugin Manager where you can set the options. You will want to set the plugin to Enabled for it to start.


installation

Changelog

This is a changelog for the RokGzipper plugin, alpha, beta and release candidate versions.

Legend:

* -> Security Fix
# -> Bug Fix
+ -> Addition
^ -> Change
- -> Removed
! -> Note

----------- 1.8 Release (30-Jan-2010)-----------

30-Jan-2010 Andy Miller
# Fixed handling of single files when JS folder is unwritable

----------- 1.7 Release (01-Jan-2010)-----------

01-Jan-2010 Brian Towles
+ add support to ignore gantry files that are already gzipped

----------- 1.6 Release (30-Nov-2009)-----------

30-Nov-2009 Brian Towles
+ Added css whitespace and comment stripping
# Fixed cleanup of query strings from css files

----------- 1.5 Release (31-Oct-2009)-----------

31-Oct-2009 Brian Towles
# Fixed reversal of CSS issue

----------- 1.4 Release (29-Oct-2009)-----------

29-Oct-2009 Brian Towles
# Fixed backwards computability with regexp

----------- 1.3 Release (07-Sep-2009)-----------

7-Sep-2009 Brian Towles
# Fixed ignore issue caused by extra DS

4-Sep-2009 Brian Towles
^ Moved from Document link/script to scanning body for all links/scripts
+ Added ignore of file option
+ Added cache file contents comments option
+ Added writable directory checks and comment warnings.

----------- 1.2 Release -----------

# Removed path from comments

----------- 1.1 Release -----------

# Minor bug fixes
 
----------- 1.0 Release -----------

+ Initial Release