Install as usual using the Joomla! installer.
The module can automatically find articles with images, so there is no need to add any code to the articles themselves.
You can set the parameters for the module using the Joomla! module manager. The module uses sensible defaults, so to get you started you may only need to pick the articles that you wish to display. The parameters are shown below.
The number of articles to display in the module.
The order in which the articles are displayed. The choices are:-
The authoring of the articles allowed. The choices are:-
If the fourth option is selected, the module will display articles by the profiled user whenever a user profile is viewed; otherwise articles by anyone will be displayed.
Choose from which Joomla component you wish the articles to be taken. The default is the Joomla core component, however the module can also read content from the K2 component if this option is selected instead.
Choose whether front page articles are included in module.
The section(s) from which the articles are selected. This can be blank to include all sections, or be a comma-separated list for more than one. This applies when the Joomla content component is used as the content source only.
The category(s) from which the articles are selected. This can be blank to include all categories, or be a comma-separated list for more than one. This applies when the Joomla content component is used as the content source only.
The IDs of the articles that you want to select. This can be blank, or a comma-separated list. If the section and category IDs are blank, then you can choose articles from all sections of the content. This applies when the Joomla content component is used as the content source only.
Image Field Size - Choose the size of K2 image field to use, the default is extra small. If you are using images embedded in the article instead then use the image options below to choose the thumbnail size.
The category(s) from which the articles are selected. Use control-click to select more than one category.
The articles that you want to select. Use control-click to select more than one item.
This determines whether the module counts characters or sentences when determining the length of the extract to display. If characters are used the extract length will be rounded to the nearest whitespace character, if sentences are used the extract will use characters up until the next terminating punctuation (!? or .).
If set to 'yes', each article includes a clickable 'read more' link.
The text to display for the 'read more' link. This can include html tags such as the <img> tag so that icons can be used instead of text.
If 'yes' is selected, the slideshow will automatically start on page load.
Select 'yes' to display the image thumbnails. These are not loaded until the main images have already downloaded, so displaying thumbnails will not require any extra downloading, since they will be loaded directly from the browser cache.
The orientation for the thumbnail strip. The choices available are horizontal or vertical.
The type of scroller. There are two types available, 'click' and 'mouseover'. A click scroller includes arrow buttons which when click will scroll the thumbnails, a mouseover scroller will scroll the thumbnails automatically when the mouse is hoverered over the ends of the scroller.
Choose whether or not to display thumbnail captions.
The caption height in pixels
The main image width and height in pixels, and the thumbnail size.
Use image width or height when determining the size of images that don't fit into the image container due to differing proportions. If 'width' is selected, then the main images will be scaled so that their width is the same width as the image container. If 'height' is selected, then the height will be matched to the image container. In each case, any excess of the image will be cut off.
The best thing is to experiment with this setting, and see what is most acceptable for your site.
Set this to yes to resize images. Use this if your images are bigger than the size displayed in the slideshow, or if you want to compress images. The original images will not be changed, the resized images will be written to a cache folder within the module.
In subsequent displays of the module the cached images will be used, to improve performance.
Image quality is a value ranging between 0 (worst quality) to 100 (best quality). If your images are good quality to start with then you may be able to reduce the quality down to about 75 without bad effects, and the resulting compression can reduce the file size quite a bit, and will speed loading the slideshow. If your images are already compressed though the results will probably not be good.
Add text here that you wish to display at the head and foot of the module.