Joomla Documentation

Welcome to the product documentation section. Here you will find installation guides, quick-references and more information for our Joomla! extensions and templates.

Image Wall

The JoomlaXTC Image Wall module is the easiest way to present attractive image galleries on your website: the animation effects, layout capabilities and the option of using your own custom designs provide incredible yet easy-to-use flexibility to showcase your images.

Installation

Install the module using the regular Joomla! extension installer.

Configuration

The module can be customized using the standard Joomla! Module Manager.

Parameters are divided in two main sections: The Module Parameters section defines what images will be shown and how they should be presented. The Advanced Parameters allows you to configure the special effects and animations, if any were used. These parameters won't affect the images but can affect their display form.

To access these parameters go to the module manager and select the Image Wall Module.

Module Parameters

Module parametersUse these parameters to customize the standard presentation of the module

SELECTION PARAMETERS - Use these parameters to select what images to show:

Image folder pathEnter the directory path where images are stored, relative to your website file path. For example: "images" or "images/yourimagefolder" or "media/images/publicgallery". Trailing slash characters are not needed.
Filename filterAn optional string to be used as filename filter. This case-sensitive parameter will restrict the image search to only those who have the string as part of their file name.
Sort fieldImages will be placed on the layout following this sort criteria.
Sort orderThis parameter specifies the sorting order for the sort field.
DISPLAY PARAMETERS - Use these parameters to customize the layout of the module box. The layout consists of a grid made up with one or more pages of pictures organized in rows and/or columns.

ColumnsNumber of columns to show.
RowsNumber of rows to show.
PagesNumber of pages to show. Transition effects are enabled between page changes.
Display StyleSpecial effects applied to the layout. Window modes work with one page only, all others require multiple pages of content to perform transitions between them.
Window WidthWidth (in pixels) of the window frame when using a Window special effect.
Window HeightHeight (in pixels) of the window frame when using a Window special effect.
Transition pausePause time between page transitions in milliseconds. A value of -1 disables automatic transitions. Default value is: 4000.
Transition durationPage transition effect duration in milliseconds (default: 1500).
Slide orientationThe initial order to perform page slide transition animations.
Transition typeChoose from different Mootools animation styles.
Button StyleButton graphic set to use when buttons tags are enabled.
TemplateTo select one of our predesigned template. NOTE: Select -None selected- if want to use Module HTML template and Main Content HTML template fields.
Module HTML template HTML/CSS code to display the overall module box. You can embed any of the following tags:
{leftbutton}Draws a "Left/Back/Previous" button.
{mainarea}This tag draws the main layout area block, including the special effects.
{morearea}This tag draws a secondary area with more images.
{pages}Displays a numbered page list for quick browsing.
{rightbutton}Draws a "Right/Forward/Next" button.
Main Content HTML template HTML/CSS code to display each item. You can embed any of the following tags to display article information:
{filename}Displays the image file name.
{image}Displays the original image.
{image_url}THis tag contains the original image URL, useful if you have specific n eeds for it.
{thumbnail}Displays the thumbnail image.
{thumbnail_url}The URL of the thumbnail image.
{size}The original image file size.
{adate}Timestamp of last access to the original image file (this value is provided by the operating system of your web server).
{mdate}Timestamp of last modification to the original image file (this value is provided by the operating system of your web server).
{cdate}Timestamp of last change to the original image file. Comparable to creation timestamp (this value is provided by the operating system of your web server).
{width}The Width of the image (in pixels).
{height}The Height of the image (in pixels).
{thumbwidth}The Width parameter value defined for thumbnail images (in pixels).
{thumbheight}The Height parameter value defined for thumbnail images (in pixels).
{title}Use this tag to set an optional title string for the image. If used, the title string must be stored in a text file on the same folder as the image, for example: if the image filename is image.jpg, the title file must be: image_title.txt
{description}Use this tag to set an optional description text of the image. If used, the description string must be stored in a text file on the same folder as the image, for example: if the image filename is image.jpg, the description file must be: image_description.txt
Thumbnail widthMaximum width for thumbnail images (in pixels).
Thumbnail heightMaximum height for thumbnail images (in pixels).
Keep aspect ratioThis parameter controls how cache thumbnail images will be generated. A value of Centered will center a scaled-down version of the original image in a transparent background sized according to the two previous parameters. Otherwise, the image will be scaled-down until it fits in an area of the same size as the two previous parameters.
Date formatFor timestamp fields, this parameter specifies the date format to display the values. Refer to PHP's Date() function for a list of available values.
Size formatThe Size tag value can be shown in different formats, use this parameter to specify your preferred choice.
Enable modal pop-upThis enables Joomla's Modal function for use in HTML anchor tags with class="modal" applied to them, opening the target URL in a modal pop-up window.
'MORE' AREA CONFIGURATION - Use these parameters to customize the 'more' area block in the module.
'More' Content HTML templateHTML/CSS code to display each image. You can embed any of the supported tags to display image information.
More imageOffer links to more images.
More ColumnsNumber of image to show horizontally. If number of images is higher, multiple rows will be shown.
Clone from main?Enabling this will make the images in the more section be the same as in the main section.
Thumbnail widthMaximum width for thumbnail images (in pixels).
Thumbnail heightMaximum height for thumbnail images (in pixels).
Module Class SuffixA suffix to be applied to the CSS class of the module.
A word on thumbnails: The module creates the necessary thumbnails on-the-fly and uses Joomla's cache folder to store them. This provides excellent performance and greately reduces the workload on your web server. If you need to recreate the thumbnails after modifying any parameter, simply delete the thumbnail files from the cache folder. You will recognize the files by the prefix "IW" followed by the module ID number, a unique filename and the thumbnail size.
Advanced Parameters

Module advanced parameters These parameters control the behavior of special animation effects, please read the next section for more information about content effects and how to apply them.

Z layerDefine the z-index layer to use for the special effect content.

Tooltip / Pop-Up FX Settings - Use these parameters to customize the Tooltip and Pop-Up effects:

In OpacityThe opacity of the tooltip/pop-up when the mouse enters the trigger zone. A value of 0 will make the display transparent while a value of 1 will make it opaque, values range from 0 to 1 in decimal increments.
Out OpacityThe opacity of the tooltip/pop-up when the mouse leaves the trigger zone. A value of 0 will make the display transparent while a value of 1 will make it opaque, values range from 0 to 1 in decimal increments.
In Animation VerticalThe distance the tooltip/pop-up will move vertically (in pixels) when the mouse enters the trigger zone.
Out Animation VerticalThe distance the tooltip/pop-up will move vertically (in pixels) when the mouse leaves the trigger zone.
In Animation HorizontalThe distance the tooltip/pop-up will move horizontally (in pixels) when the mouse enters the trigger zone.
Out Animation HorizontalThe distance the tooltip/pop-up will move horizontally (in pixels) when the mouse leaves the trigger zone.
Fade-in DurationThe duration of the "In" animation when the mouse pointer enters the trigger zone (in milliseconds).
Fade-Out durationThe duration of the "Out" animation when mouse pointer leaves the trigger zone (in milliseconds).
PauseThe time the tooltip/pop-up will be shown between the "In" animation and the "Out" animation (in milliseconds).
Tooltip animation modeSelect one of the many Moo functions to perform animations.
Tooltip / Popup ease modeThe transition type. All transitions, except for "linear" transition, can be combined with a "Transition Ease".
Centered PopupSet this to "Yes" if you want pop-up effect displays to appear centered in the browser window.

Slide FX Settings
- These parameters control the "Slide" content effect:

Sliding Panels SettingsChoose an animation style from the list.
Note: The following Settings are used ONLY when Slide Panels Settings is set to CUSTOM:
Slide Panel X inThe distance (in pixels) from the left trigger zone border that the slide panel will go to when the mouse enters the trigger zone.
Slide Panel X outThe distance (in pixels) from the left trigger zone border that the slide panel will go to when the mouse leaves the trigger zone.
Slide Panel Y inThe distance (in pixels) from the top trigger zone border that the slide panel will go to when the mouse enters the trigger zone.
Slide Panel Y outThe distance (in pixels) from the top trigger zone border that the slide panel will go to when the mouse leaves the trigger zone.
Slide animation modeSelect one of the many Moo functions to animate the slide effects.
Slide ease modeChoose how to apply the animation effect. This setting is not used when "Slide Animation Mode" is set to Linear.
Frames per SecondThe frames per second used to animate the effect. Note: Using a high value in a heavy site could decrease the video performance. Combine this setting with "Frame Duration" to get a smooth effect.
Fame DurationThe time (in milliseconds) the duration will last.

Hover FX Settings
- These Parameters Control the Hover Effect:

Hover Effect in ColorThe background color that will fade in when mouse enter the element with class="js_hover".
Hover Effect Out ColorThe background color that will fade out when mouse leaves the element with class="js_hover".
Adding Tile and Description Text

Each photo can have a title and description displayed with the tags {title} and {description}. In order to create a title and description simply create a .txt file with the same name as the image with _title or _description after the photo file name such as: photo1_title.txt and photo1_description.txt and then upload these to your images gallery folder!


Special effects

Besides the page transition effects, you can also include additional effects that apply to the content of each item. By adding certain CSS tags to your HTML code and organizing the layout of content, these effects allow you to build fully customizable tooltips, pop-ups and slide effects. Since all the content data tags are available on these effects as well, you can elaborate the display of your content as much as you want!

Keep in mind however, that with great power comes great responsibility: the HTML of both zones is still part of the HTML code of your page; if your HTML/CSS code has a bug, it may affect how other parts of your site look and work.

Content effects are activated by the user's mouse pointer but with subtle differences. How you can implement each effect and how they are activated is explained below:

Tooltips

A Tooltip will appear automatically when the mouse pointer hovers over a specific "trigger zone", this example code explains better how to use the necessary tags:

Code Sample

Sample Effect

<div class="jxtctooltip">
This is the tooltip trigger zone
    <div class="tip">
        This is the tooltip content
    </div>
</div>
This is the tooltip trigger zone
This is the tooltip content

Upon display, this code will show the "This is the tooltip trigger zone" legend by itself, but if you move the mouse pointer over it, a tooltip will come up displaying the "This is the tooltip content" legend. Each zone is wrapped within a tag, you must use the CSS tags "jxtctooltip" and "tip" as shown to make the effect work.

Pop-ups

A pop-up will appear when the user clicks on the "trigger zone", the Pop-up zone has its own Close and Drag buttons. This example code shows the necessary CSS tags in use:

Code Sample

Sample Effect

<div class="popuphover">
This is the pop-up trigger zone
    <div class="pop">
        This is the pop-up content
    </div>
</div>
This is the pop-up trigger zone
This is the pop-up content

The trigger zone is made with the contents of the div with class "popuphover", and the pop-up content is hidden in the div with class "pop", it will be shown when the user clicks on the trigger zone.

Slides

Slides are useful to display content in different layers, for example imagine a picture with a footnote that expands to show a full description. Different than Tooltips or Pop-ups, Slides do not use a trigger zone, they react to mouse pointer over their own zones. This is an example code:

Code Sample

Sample Effect

<div class="slidebox">
This is the content zone
    <div class="slidepanel">
        This is the slide content zone
    </div>
</div>
This is the content zone
This is the slide content zone

Again, the container zone inside the div with CSS class "slidebox" will be shown first, and the contents of the slide on div "slidepanel" will be shown when the mouse hovers its zone.

Hover

The Hover is useful when you want to focus on specific zone of the content, for example a "clickable" zone that looks similar to other content, an image or name that want to highlight. Similar to Slides, they react to mouse pointer over their own zones and does not need a trigger zone. This is an example code:

Code Sample

Sample Effect

This is the content zone
<div class="js_hover">
    The content with highlight
</div>
This is the rest of content zone
This is the content zone
The content with highlight
This is the rest of content zone

Once the mouse is over the js_hover zone the color will change automatically. As you can see this is the easier effect but provide you the power to catch the attention of your visitors.

Styling

As previously explained, the content is rendered in a grid fashion with one or more rows and columns and one or more pages, each page represents a single grid. Each cell in a grid contains the template code for one item with the placeholder tags translated to their corresponding data element such as titles, descriptions, images, etc.

In order to ease the visual styling of the grids, there are certain common CSS classes added to the HTML code for your convenience. You can put hard-coded CSS styling in the XTS template fields directly, but you may find using your template's CSS file a better option.

If you can't or don't want to alter your main CSS file, you can put any CSS code needed in the module's own file: css/wall.css. This file is located inside the module folder.

This is a brief explanation on how the HTML and classes are applied:

Each page in the module output is made with an HTML tag; the first table has CSS class firstpage, any inner pages have class centerpage and the last page has class lastpage. If there is only one page then it has class singlepage.

Each row within a table also has similar classes added to it: firstrow for the top row in the table, centerrow for any middle rows and lastrow for the bottom row of content. In the event that only a single row is used, it will have class singlerow assigned to it. These clases are repeated for as many tables (pages) are in the module output.

Likewise, columns also have similar tags: the left-most column has firstcol, the right-most column has lastcol and any middle column has centercol. Single columns have, you guessed it, singlecol. These classes are also applied on all pages shown.

Buttons also have extra CSS classes: prevbutton and nextbutton apply to the tags for each page change button. Page number buttons have tags as well: firstbutton, middlebutton, lastbutton and centerbutton.

You can have a common set of CSS styling code for these tags in your template's CSS file to maintain a consistent appearance on any modules being shown, or you can use them in combination with the module CSS class parameter to define specific styling for a particular module.

With these many options, the styling possibilities are unlimited! You are in total control of how the content will be shown in your site, just let the module handle the content gathering for you.

Copyright 2011 Monev Software LLC www.joomlaxtc.com

Security Notice

JoomlaXTC does not sell it's products on 3rd party sites.  Any website offering JoomlaXTC products for sale are not licensed versions and should be considered a scam.

Never download our products from file sharing websites like rapidshare, torrents or warez forums.

We have received reports of malicious versions of our software containing viruses, extra code, and even once installed, delete your database, steal sensitive information such as passwords, and credit card information. 

There is only one place to get the full and safe licensed versions of our software and you're looking at it!   Enjoy.

Joomla! is Free Software released under the GNU/GPL License. Joomla is a trademark of Open Source Matters and the name is used under a limited license from Open Source Matters in the United States and other countries. joomlaxtc.com / Monev Software LLC is not affiliated with or endorsed by Open Source Matters or the Joomla! Project.