Description
JoomlaXTC's Image Gallery plugin is the easiest way to include image galleries on Joomla! or K2 content. It is easy to setup to let you add nice thumbnails and great-looking image slideshows in no time.
Installation
Installation is done as with any standard Joomla extension following these steps:
- Download the plugin zip file to your PC.
- Use the standard Joomla Extension Manager to install the file.
Configuration
Before using the plugin, it must be configured first by going to the Extensions / Plug-In manager menu option and clicking on the plugin name to edit the parameters. The parameters are organized in groups for easy identification. For better results, make sure the plugin is in a Disabled state at first and while you configure it to prevent any bad data or other disruption to your website frontend. Enable the plugin once you are done setting the parameters.
Plugin options are split in two main tabs described below:
Plugin Options
| Field | Description |
|---|---|
| Gallery Content Tag | Sets the tag name to look for. Default value is 'gallery' so content tag would be: {gallery}parameters{/gallery} |
| Thumbnail Width | Set the width of thumbnails (in pixels). |
| Thumbnail Height | Set the height of thumbnails (in pixels). |
| Thumbnail type | Select method to build thumbnails. |
| Single | When enabled, only the first thumbnail will be shown in the content item. Disable to show all thumbnails. |
| Padding | Space between image wrapper and content. |
| Margin | Space between viewport and image wrapper. |
| Opacity | When enabled, transparency of content is changed for elastic transitions. |
| Cyclic | When true, galleries will be cyclic, allowing you to keep pressing next/back buttons. |
| Autoscale | If enabled, image is scaled to fit in browser window. |
| Center on scroll | When enabled, image is centered while scrolling. |
| Hide on overlay click | Toggle if clicking the overlay should close image. |
| Hide on content click | Toggle if clicking the content should close image. |
| Enable overlay | Toggle overlay shadow. |
| Overlay opacity | Opacity of the overlay (from 0 to 1) |
| Overlay color | Color of the overlay. |
| Show info area | Toggle Title/description display area. |
| Show title | Toggle title text if available. |
| Show description | Toggle description text if available. |
| Numbering | Toggle image numbering on titles. |
| Title position | The position of title. |
| Start transition | The initial transition type. |
| Exit transition | The final transition type. |
| Start speed | Speed of initial transition (in milliseconds). |
| Exit speed | Speed of final transition (in milliseconds). |
| Change speed | Speed of image change (in milliseconds). |
| Fade speed | Speed of image fade (in milliseconds). |
| Show Close button | Enable or disable close button. |
| Show navigation buttons | Enable or disable navigation buttons. |
Advanced Options
| Field | Description |
|---|---|
| Use PNG thumbnails | When enabled, all thumbnails will be store in PNG format with transparent background. |
| Thumbnail background color | Background color for thumbnails. Default: FFFFFF |
| jQuery load | Choose jQuery load method (this option is not available on Joomla! 3.0). |
| Preload Mootools | Preloading Mootools helps resolve jQuery/Mootools conflicts. |
| Mouse wheel navigation | Enable or disable mouse wheel navigation. |
| CSS load | Load plugin CSS. Disable if you want to use CSS from some other place. |
Adding galleries to content articles
To add a gallery of images to a Joomla! article or K2 item, just upload one or more image file to a folder in the media/ or images/ folders of your website. For example, you may want to upload image1.jpg, image2.jpg and image3.jpg to a folder called media/mygallery.
Once the images are stored, you can include the gallery in your article by using a special tag within the article contents. This allow you to position the gallery on any place with the document. To display the images in the example above, the tag will look like this:
{gallery}mygallery{/gallery}
The Image Plugin will look for files in a folder called mygallery on the media or images folders and will construct the necessary code to display them as part of your article.
Custom titles and descriptions
You can add custom titles and descriptions to your images in two different forms:
Text files per image
For each image file in the folder, add one or two extra files with the title and description you want. These two files must share the exact file name as the image, for example: if your image file is named "myphoto.jpeg", the title and description files must be named as follows:
myphoto_title.txt
myphoto_description.txt
Each file should contain the title or description text you wish to show.
Single label file
Place a "labels.txt" file in the same folder as the images, and edit the file to include the file name, title and description of each image. Each value must be placed on a single row per image and separated by a pipe (|) character. For example, if you have an image file named "myphoto.jpeg", the file should contain a text line like this:
myphoto.jpeg|My photo title|This is the description text of my photo.
Remember to place all information on a single row per image.
Label files support multiple languages, to do this just add one or more label files and name them according to Joomla's language convention:
en-GB.labels.txt
es-ES.labels.txt
fr-FR.labels.txt
Using K2 galleries
JoomlaXTC's Image Gallery plugin supports most K2 galleries transparently. In this case, it is recommended to disable K2's SIG gallery plugin and let Image Gallery do the job.
With this plugin, you can also include K2 galleries on Joomla! content simply by adding a tag pointing to a K2 gallery ID, for example:
{gallery}3{/gallery}
This will display images from K2 gallery identified with ID 3 on your Joomla article.
Copyright 2016 Monev Software LLC www.joomlaxtc.com
