Home Video Tutorials Written Tutorials Template Tutorials
print

Refraction Extensions

Learn all about the exciting RocketTheme exclusive extensions that are included in the Refraction template release. Here you can find instructions for installation and configuration for each of the custom extensions/addons.

Step One: Installing the Extension

Step Two: Publishing the Module/Plugin

RokTwittie

The latest extension from RocketTheme provides a means to showcase various aspects of Twitter, from your tweets to profile information plus much more. The perfect addition to any site geared towards social networking.

How do I configure RokTwittie?

We will take a quick look at the parameters you will find when you install this module. There are 4 columns, parameters, options, demo and description. The parameter column lists each available setting for the module; options lists the available options to choose from; demo lists the options chosen on the demo and description outlines what the module does.

Parameter

Show Title Enabled Position Module Class Suffix Load Built-In CSS Output Caching Cache time (mins) Twitter Login Twitter Password Usernames Show default avatars Enable username statuses Open links in new window Show RSS feed link Show follow updates link Show the bio description Show the URL Show the location Show user updates count Show user followers count Show user following count Show following icons Icons count to show Show view all after icons Enable usernames tweets Show usernames avatars Size in pixel of the avatar Tweets count Open links in new window Show tweets sources Show usernames as prepended text Enable search tweets Search string Show search avatars Size in pixel of the avatar Tweet count Open links in new window Show tweets sources Show usernames as prepended text Inactive users opacity

Options

Yes : No Yes : No list of positions Text Field Yes : No Yes : No Number Field Text Field Text Field Text Field Yes: No Yes: No Yes: No Yes: No Yes: No Yes: No Yes: No Yes: No Yes: No Yes: No Yes: No Yes: No Number Field Yes: No Yes: No Yes: No Number Field Number Field Yes: No Yes: No Yes: No Yes: No Text Field Yes: No Number Field Number Field Yes: No Yes: No Yes: No Number Field

Demo

Yes Yes left leave blank Yes Yes 5 leave blank leave blank rockettheme No Yes Yes Yes Yes No Yes Yes No No No No 10 Yes Yes Yes 22 2 Yes Yes No Yes @rockettheme Yes 22 2 Yes No Yes 0.5

Description

The descriptions for RokTwittie echo the name of the parameter and are self explanatory. However, elaboration of a few key parameters is useful in understanding.

The Twitter Login and Twitter Password options do not need to be filled in order for the module to work. However, Twitter has a maximum of 100 hits in their API so if you have high traffic activity related to the module, you may wish to fill this out. However, entering the username field beneath login and password will allow it to work.

You can load multiple usernames for tweets and searches by separating them by a comma in the various fields.

The options provide you with incredible control over what to display, and are subdivided into sections such as username tweets and search tweets. The frontpage has some of these options disabled but to the left, you should see the module when fully activated.

RokStories

RokStories is a great module to display your articles and accompanying images as a featured item. The module itself is facilitated by Mootools to transition between images and articles seamlessly. Perfect for showcasing featured articles on your site, as seen on the frontpage.

How do I configure RokStories?

We will take a quick look at the parameters you will find when you install this module. There are 4 columns, parameters, options, demo and description. The parameter column lists each available setting for the module; options lists the available options to choose from; demo lists the options chosen on the demo and description outlines what the module does.

Parameter

Show Title Enabled Position Section Category Order # of Articles Thumbnail Width Authors Frontpage Items First Article Thumbs Opacity Nav Interaction Autoplay Autoplay Delay Module Class Suffix

Options

Yes : No Yes : No list of positions list of sections list of categories list of orders Number Field Number Field list of authors Show : Hide Number Field Number Field Click : Hover Yes : No Number Field Text Field

Demo

Yes Yes showcase News RokStories Recently Modified First 4 90 Anyone Show 0 0.3 Hover No 5000 leave blank

Description

Enable/Disable the module header Enable/Disable the module Position of the module Section of content Category of content Ordering of content Number of articles displayed Pixel width of thumbs Choose specific author articles Display frontpage items Article displayed first Transparency (pc) of thumbs Transition trigger type Auto or manual transition Time for transition Suffix applied to the code

RokNewsPager

The module is an article previewer and rotator. It displays content articles, in a summarised form and, using mootools based javascript transition, rotates through a series of pages displaying articles in a contracted list format.

How do I configure RokNewsPager?

We will take a quick look at the parameters you will find when you install this module. There are 4 columns, parameters, options, demo and description. The parameter column lists each available setting for the module; options lists the available options to choose from; demo lists the options chosen on the demo and description outlines what the module does.

Parameter

Show Title Enabled Position Count Max Pages Order Preview Length Author Auto Update Auto Update Delay Frontpage Items Section Category Module Class Suffix

Options

Yes : No Yes : No list of positions Number Field Number Field list of orders Number Field list of authors Yes : No Number Field Show : Hide list of sections list of categories Text Field

Demo

Yes Yes left 3 3 Recently Modified First 65 Anyone No 5000 Show News Top Headlines blue

Description

Enable/Disable the module header Enable/Disable the module Position of the module Number of Articles per page Number of Pages Ordering of content Number of characters displayed Author selector for articles Update news automatically Delay on auto-update Show/Hide frontpage items Section of articles Category of articles Tag for individual styling

RokGZipper

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. A similar method is used for the CSS but is based on path. To exemplify, all the CSS files in template's /css directory are combined into one file, with the module CSS files being combined elsewhere. Compressing all these files means your site can load 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.

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.

RokNewsFlash

RokNewsFlash is a custom mootools module that displays your newsflash tidbits at the top of your site. The RokNewsflash also includes small buttons allowing your visitors to toggle through the different newsflash items you have set up. See it in action on the frontpage.

How do I configure RokNewsFlash?

We will take a quick look at the parameters you will find when you install this module. There are 4 columns, parameters, options, demo and description. The parameter column lists each available setting for the module; options lists the available options to choose from; demo lists the options chosen on the demo and description outlines what the module does.

Parameter

Title Position Access Level Published Module Class Suffix Enable Cache Module Mode Frontpage Item Count Category Section Use Title or Intro Text PreText Label Show Controls Transition Duration Delay Length Preview Length

Options

Yes : No List of position Public : Registered : Special Yes : No Text Field Yes : No Content : Static : Both Show : Hide Number Field List of categories List of sections Title: Intro Text Text Field Yes : No Number Field Number Field Number Field

Demo

No NewsFlash Public Yes leave blank No Content Items Hide 5 Top Headlines News Intro Text Latest: Yes 600 2500 85

Description

Enable/Disable the module header Select the module position Determines who can see the module Enable/Disable the module Allows for individual CSS control Stores the contents with Cache What content types are loaded Show or Hide frontpage items How many items to load Category where content is loaded from Section where content is loaded from Controls what part of content are loaded Text label in the module Enable / Disable the controls Time for switching of content items Time for content to remain static Number of characters to be shown

RokTabs

RokTabs is a fully independent and incredibly flexible standalone version of the popular template feature, RokSlide. That being, a module that displays content in tabs that are scrollable and can rotate automatically. The module itself is installable into Joomla and can be easily utilised on any template, not just Refraction. As its name implies, its a tabbed based module to efficiently showcase your content to your visitors. RokTabs can now load modules inside its tabs, you just need to insert {loadposition name} and it will load the position you defined as *name*

How do I configure RokTabs?

We will take a quick look at the parameters you will find when you install this module. There are 4 columns, parameters, options, demo and description. The parameter column lists each available setting for the module; options lists the available options to choose from; demo lists the options chosen on the demo and description outlines what the module does.

Parameter

Show Title Enabled Position Category Section Order Authors Theme Style Width Max # of Tabs Transition Duration Transition Type Transition Effect Tabs Position Tabs Title Incremental text Hide h6 tags Autoplay Autoplay Delay Module Suffix

Options

Yes : No Yes : No list of positions list of categories list of sections list of orders list of authors Text Field Number Field Number Field Number Field Scrolling : Fading list of transitions Top : Bottom : Hidden list of options Text Field Yes : No Yes : No Number Field Text Field

Demo

Yes Yes user8 RokTabs News Recently Modified First Anyone base 758 0 600 Scrolling Quad.easInOut Top By Content Title Tab Yes No 2000 leave blank

Description

Enable/Disable the module header Enable/Disable the module Position of the module Category of content Section of content Ordering of content A filter for the authors Select a theme/style Width of the module Max number of Tabs Time for transition Type of transition The transition effect Position of the tabs Determine the tab title Set an incremental text Hide h6 titles Rotate automatically Set delay on auto-rotation A module class suffix

RokAjaxSearch

RokAjaxSearch brings fantastic search functionality to Joomla, using the powerful and versatile javascript library, Mootools.

So, what does the module do? The best description is an example, simple type test in the search box in the left column of Refraction and wait ... and a popup shall materialise, showcasing the Joomla search results for you.

How do I configure RokAjaxSearch?

We will take a quick look at the parameters you will find when you install this module. There are 4 columns, parameters, options, demo and description. The parameter column lists each available setting for the module; options lists the available options to choose from; demo lists the options chosen on the demo and description outlines what the module does.

Parameter

Show Title Enabled Position Module Class Suffix Search page URL Advanced Search page URL Inlcude RokAjaxSearch CSS Searchphrase Order Limit Results per page Enable Google Web Search Google Ajax Search API Key Show Pagination Show Estimated Hide div id(s) Link to all results Show Description Include Category/Section Show Read More

Options

Yes : No Yes : No List of position Text Field Text Field Text Field Yes : No Any : All : Exact Phrase List of orders 5-50 3-50 Yes : No Text Field Yes : No Yes : No Text Field Yes : No Yes : No Yes : No Yes : No

Demo

No Yes left leave blank Search Advanced Yes Any Word Newest First 10 3 Yes API Key Yes Yes leave blank Yes Yes Yes Yes

Description

Enable/Disable the module header Enable/Disable the module Choose the module position Add an extra tag to the HTML Link to the search page Link to the Advanced search page Set No to load template specific CSS Search parameters Order of results Number of results Number results per page Search using Google APIs Insert Google API key Show navigation in results Show estimates in results Specify div IDs to be exempt from search Link all search results Show description with results Include category/section in results Show read more

RokNavMenu

RokNavMenu is now an essential ingredient of the RocketTheme templates. It provides various functions which are above and beyond what the mainmenu, and the subsequent template overrides. Therefore, much more sophisticated menus can be constructed providing you with a much greater degree of usability. It is an essential install for the integrated menu systems to operate.

How do I configure RokNavMenu?

We will take a quick look at the parameters you will find when you install this module. There are 4 columns, parameters, options, demo and description. The parameter column lists each available setting for the module; options lists the available options to choose from; demo lists the options chosen on the demo and description outlines what the module does.

Parameter

Show Title Enabled Position Menu Name Limit Levels Start Level End Level Always show submenus Menu Tag ID Menu Class Suffix Module Class Suffix Max Menu Depth Show Menu Icons Menu Icon Link

Options

Yes : No Yes : No List of positions List of menus Yes : No Number Field Number Field Yes : No Text Field Text Field Text Field Number Field Yes : No Yes : No

Demo

No No toolbar mainmenu No 0 0 No leave blank leave blank leave blank 10 No No

Description

Enable/Disable the module header Enable/Disable the module Position of the module Menu that is loaded Limit number of sub-levels Starting menu level Ending menu level Always show submenu items ID added to the menu code Class suffix to the menu Class suffix to the module Max number of menu levels Show menu icons Link menu icons