Custom Modules PDF  | Print |  E-mail
Tuesday, 24 June 2008 09:26

Learn all about the exciting new RocketTheme exclusive modules that are included in the TerranTribune template release. Here you can find instructions for installation and configuration for each of the custom modules.

Step One: Installing the Module

  • Download the terrantribune-extensions-j15.zip archive from the TerranTribune download section of the RocketTheme Joomla! Club. Unzip the archive, inside you will find individual zip files for each of the modules.
  • Login in to your administrator console on your Joomla! website and navigate to the Extensions menu item, and select Install/Uninstall from the dropdown menu.
  • In the Upload Package File section, click the Choose File button and select one of the mod_modulename.zip that was inside of the zip file you downloaded earlier. Next click the Upload File & Install button to install the module.

Step Two: Publishing the Module

  • Now the module is installed it must be published in the appropriate module position and configured to suit our needs. From the top menu, select Extensions then Module Manager.
  • This will take you to the Module Manager which allows you to configure the placement and configuration of all modules in your Joomla! website.
  • Locate the module from the list. Remember there could be a few pages. Once you have found it, you can publish in 2 ways: The first is selecting the cross next to the tile or clicking the title then set Publish to Yes followed by a Save.

RokMiniNews

RokMiniNews is a powerful module to display your articles, perfect for news and media sites. It is highly configurable and is javascript enabled to allow for user interaction. A truly versatile extension.

We will take a quick look at the parameters you will find when you install this module.
  1. Title: Hide
  2. Position: We recommend the newsflash position.
  3. Access level: Public
  4. Published: Yes
  5. Ordering: Determines which appears first, controlled by the creation or modification date of the article
  6. Preview Length: This is the number of characters loaded in the module.
  7. Frontpage items: Show or Hide
  8. Default # of Articles: Select either 0, 5, 10 and 15 as the default option on load.
  9. Section: Choose which Section to pull your stories from.
  10. Module Class Suffix and Cache: Most will leave empty by default.
  11. Extra Module CSS Class: Adds a class to the module to allow for custom styling, such as colour.
  12. Use Custom CSS: The Module can be set to not load the template's styling if you wanted to custom appearance/theme.

Demo Setup

On the demo, you will see we have 6 blocks of content. These are all individual installs of RokMiniNews. To copy and setup this module, follow the steps below:-
  1. Login into the Administrator
  2. Navigate to the Module Manager
  3. Find your install of RokMiniNews in the list
  4. Tick the box to the left of the Module's title in the list
  5. Click the Copy button in the top right of the Module Manager
  6. Now setup the new copied RokMiniNews
  7. Ensure the module is assigned to the same position as its clone to have the javascript move effect (we use newsflash on the demo)

RokNewsRotator

RokNewsRotator is a module that rotates your news item using the powerful of the mootools javascript library. You simply assign a category/section and watch your articles transition

We will take a quick look at the parameters you will find when you install this module.
  1. Title: Hide
  2. Position: We recommend the header position.
  3. Access level: Public
  4. Published: Yes
  5. Module Class Suffix and Cache: Most will leave empty by default.
  6. Module Mode: You have a choice of what type of content to choose from.
  7. Link Titles: Enable this option if you wish the titles to link to your main article.
  8. Link Image: Similar to the above but adds a link to your content image.
  9. Frontpage items: Show or Hide
  10. Count: Enter how many items you would like to show in the module.
  11. Category: Choose which Category to pull your stories from.
  12. Section: Choose which Section to pull your stories from.
  13. Read More Label: Enter any text such as Read On, or Learn More.
  14. Show Controls: This option will enable/disable the controls that appear when you hover over the rotator.
  15. AutoHide Control: This option controls where the controls are permanently active or just appear on hover.
  16. Preview Length: This is the time your article will display for.

All you need to do now is to create some content items which are assigned to the category/section you chose in the module settings. In the content item, you will need to use the following syntax to load the image with the correct styling. The code is content editor HTML mode friendly.

<!--IMAGE image_path IMAGE-->

An example is as follows

<!--IMAGE images/stories/lego/rotator-3.jpg IMAGE-->

Place the image code at the top of your content item and write your content after it.

Ensure that you are either, using HTML mode in your content editor or disabling your content editor entirely. If you wish to disable your WYSIWYG editor, then go to Admin > Site > User Manager > *You* and select No Editor then save.

Demo Setup

If you wish to mimic the setup of the demo, then it is a simple procedure.
  1. Login into the Joomla administrator
  2. Create your content item in your particular category/section
  3. Assign this content item to appear on the frontpage
  4. Navigate to Admin > Extensions > Module Manager > RokNewsRotator
  5. Set the Frontpage items setting to Show
  6. Navigate to Admin > Menu > mainmenu > Home
  7. Set the (leading, intro, columns & links) options to 0
  8. Save
Note that setting no articles to display will result in a XHTML validation error due to an error in the Joomla core coding. Therefore, you may wish to add a placeholder article. To avoid this appearing in the RokNewsRotator module, unsure that you change the creation and modification date to much earlier than the set articles loading in the Module. On the demo, we have 6 articles assigned to the frontpage, the RokNewsRotator loads 5 due to its setting for Count being 5. Therefore, the 6th article doesn't appear in the module.

To ensure that this artificially dated article is the one that appears in the Mainbody area, ensure that in Home > Menu > mainmenu > Home, Order is set to oldest first.

For your content items, use something similar to the following code (this has been extracted from the demo content):-

<!--IMAGE images/stories/rotator/5.jpg IMAGE--><img src="images/stories/world/s-america/1.jpg" alt="Alonso Unsure" width="100" height="100" align="left" style="margin-right: 8px;" />

SÃO PAULO, Brazil (AP) -- Three heavily armed robbers stole two Pablo Picasso prints from an art museum in downtown São Paulo on Thursday, the city's second high profile art theft...

Observe that we have the RokNewsRotator code, image HTML code as well as the content item. The RokNewsRotator code will only appear in the module itself and as its using commenting HTML code to parse the image, it will not appear in your article. Similarly, RokNewsRotator doesn't process HTML code so the image from the content item will not appear in the module. This ensures that you do not have to create a new category/section just for RokNewsRotator as you can easily assign whatever content items you wish with this method and maintain the integrity of the article in both mediums

Last Updated on Saturday, 28 June 2008 11:21