mmSlideShow v1.

0
Instruction Manual
Copyright 2009 mmPlugins
www.mmPlugins.com

Table of Contents
Installation ........................................................................................................... 3
How To Upgrade To A Newer Release ................................................................... 3
Module Parameters .............................................................................................. 4
Module Class Suffix .......................................................................................................................................... 4
Directory .............................................................................................................................................................. 4
Skin ......................................................................................................................................................................... 4
Select Colour....................................................................................................................................................... 4
Include CSS .......................................................................................................................................................... 4
Slideshow Width ............................................................................................................................................... 4
Slideshow Height .............................................................................................................................................. 4
Auto-resize images........................................................................................................................................... 4

Advanced Parameters ........................................................................................... 5

Show Play/Pause .............................................................................................................................................. 5
Show Previous/Next........................................................................................................................................ 5
Show Thumbnails............................................................................................................................................. 5
Thumbnail Width.............................................................................................................................................. 5
Thumbnail Height............................................................................................................................................. 5
Number of Thumbnails .................................................................................................................................. 5

Other parameters ................................................................................................. 6

Animation Type................................................................................................................................................. 6
Animation Direction ........................................................................................................................................ 6
Animation Transition...................................................................................................................................... 6
Animation Ease.................................................................................................................................................. 6
Animation Duration......................................................................................................................................... 6
Control Animation Transition ..................................................................................................................... 6
Control Animation Ease ................................................................................................................................. 6
Control Animation Duration ........................................................................................................................ 6
Rotation Type..................................................................................................................................................... 6
Rotation Interval............................................................................................................................................... 6

What are skins ...................................................................................................... 7

How To Customise CSS.......................................................................................... 7
How To Customise The Default Template .............................................................. 7

Installation
mmSlideShow technically consists of two extensions, a module and a plug-in. You
will have to install both for mmSlideShow to work. I doesn't matter in which order
you install them. Simply go to "Extensions > Install/Uninstall" and install the
packages you have downloaded from mmPlugins.com.
1. The Plugin
in order to show content inside your slideshow (images etc) you need to make sure
that the content plugin has been enabled. To do this, go to Extensions / Plugin
Manager and locate Content mmSlideshow in the list and enable it.
2. The Module
once the plugin has been enabled youre ready to start configuring mmSlideShow. To
do this, go to Extensions / Module Manager and locate mmSlideShow in the list.

Important Note (Legacy Mode):

if you are running Joomla in Legacy Mode youll have to download a
complementary file for this to work. This file can be found in your account where
you downloaded mmSlideShow.

How To Upgrade To A Newer Release

The mmSlideShow installation package utilizes Joomla's upgrade mechanism. No
uninstallation is necessary unless explicitly stated on mmPlugins.com for the release
you are trying to install. Simply follow the installation instructions as if the
extensions are installed for the first time.
We do always advice to make a full backup of the database and the entire Joomla
directory on the file system before installation or uninstallation of any Joomla
component, plugin or module. Especially if your site is live.

Module Parameters
Module Class Suffix
A suffix to be applied to the css class of the module. This allows for individual
module styling.

Directory
Select the folder to where you have uploaded your images to be used in the
slideshow.

Skin
mmSlideShow comes with pre-made skins ready to use. Simply select the skin you
want to use for your website.

Select Colour
Selects the colour that you want to use with your selected skin.

Include CSS
Turns the CSS on or off. If set to NO, no stylesheet is embedded by mmSlideShow.
Choose this option if you are writing CSS yourself as part of your Joomla template.
You can also create your own skins by starting with a copy of one of the existing
skins.

Slideshow Width
Sets the width of the slideshow in pixels.

Slideshow Height
Sets the height of the slideshow in pixels.

Auto-resize images
By default mmSlideShow resizes images to the specified dimensions with the help of
the mmSlideShow plugin. When set to NO, the plugin only resizes images for the
thumbnails.

Advanced Parameters
Show Play/Pause
When set to YES the play/pause button is visible.
When set to NO the play/pause button is hidden.

Show Previous/Next
When set to YES the previous and Next arrows are visible
When set to NO the arrows are hidden

Show Thumbnails
Turns the thumbnails On or Off.

Thumbnail Width
Sets the width of the thumbnails in pixels

Thumbnail Height
Sets the height of the thumbnails in pixels

Number of Thumbnails
Sets the number of thumbnails

Other parameters
Animation Type
Choose between three types of animations, Fade, Scroll or Fade & Scroll.

Animation Direction
Sets the direction of the animation.
Note: only applies if you have set the Animation Type to Scroll.

Animation Transition
Transitions are a list of preferred effects for the slide animation.

Animation Ease
Transitions Ease set the fade in and Fade out transition for the slide animation.

Animation Duration
Transition Duration is the time for which you want the effect to be displayed in Milli
Seconds.

Control Animation Transition

Control Animation Ease
Control Animation Duration
Rotation Type
Rotation Interval

What are skins

mmSlideShow skins consist of CSS files and images. Each skin contains a unique
design that is applied to mmSlideShow. Each skin that ships with mmSlideShow also
contains a range of color schemes to make it easier to match the design of any site.
Please note that we advice you to not edit the default skins. Please read on to learn
about the best ways to make mmSlideShow your own.

How To Customise CSS

Whenever you want customize a piece of software you might want to update in the
future it is better not to directly modify any of the files that will be overwritten when
upgrading to a newer version. To support good development practice, the
mmSlideShow module has a parameter labeled "Include CSS". Make sure to set this
to no when you decide to customize the CSS so that your own CSS code does not
conflict with the original CSS code.
The next step is to copy the content of the CSS file of the skin of your choice to the
CSS file of your Joomla template. You could also create a new CSS file of course and
include it in the tag in your Joomla template's index.php file. No you can modify the
CSS as much as you need without having to worry about the next upgrade to
override any of the changes you made.
Alternatively you can create your own skin. The easiest way to create your own skin
is to copy one of the skins that ship with mmSlideShow and modify that to suit your
needs.

How To Customise The Default Template

mmPlugins always tries to follow the conventions set out by Joomla. By doing so it
becomes very simple to override a template with your own copy. If your site would
be using a template called "foo", create a file in the following location:
/templates/foo/mod_mmslideshow/default.php Now simply copy the contents of
the file:
"/modules/mod_mmslideshow/tmpl/default.php" to the file you just created.
Now the file living in your template directory is automatically used instead of the
original file. Now you can modify the new template flle all you like without having to
worry about your changes being overridden the next time you upgrade.