Skip to content

Commit

Permalink
[add] tooltips add to all options (closes #1), update notifications
Browse files Browse the repository at this point in the history
  • Loading branch information
rvalitov committed Feb 2, 2016
1 parent 7cd0e29 commit b8aca17
Show file tree
Hide file tree
Showing 12 changed files with 298 additions and 2,932 deletions.
4 changes: 4 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,10 @@ Thumbs.db
~*
*.bak

#archives:
*.zip
*.rar

#hidden files:
.*
!/.gitignore
55 changes: 20 additions & 35 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,47 +1,32 @@
![SlideshowEx widget logo](https://raw.githubusercontent.com/rvalitov/widgetkit-slideshow-ex/master/images/slideshowex-logo.jpg)
![SlideshowEx widget logo](https://raw.githubusercontent.com/wiki/rvalitov/widgetkit-slideshow-ex/images/logo.jpg)
# Overview
**SlideshowEx** is an advanced Slideshow widget for [Yootheme Widgetkit2](https://yootheme.com/widgetkit). After installation it becomes available in the Widgets list as a "native" widget and can be used with any [Warp 7 theme](https://yootheme.com/themes).
**SlideshowEx** is an advanced Slideshow widget for [Yootheme Widgetkit2](https://yootheme.com/widgetkit). After installation it becomes available in the Widgets list as a "native" widget and can be used as any other widget.

## Features
Or why it's better than original Slideshow provided by Yootheme?
* **Clickable image** - a link can be attached to the slide's image (media).
* **Clickable overlay** - a link can be attached to whole overlay.
* **Clickable slide** - mixing two features 'Clickable image' and 'Clickable overlay' allows to make the whole slide clickable.
### Basic Features
* **Responsive** - create responsive slideshow.
* **Transition effects** - various transition effects, navigations and animation.
* **Display content on top** - you can display content on top of the slides in an overlay.
* **Backward compatibility** - all other behavior, styling and features of the original [Slideshow widget](http://yootheme.com/demo/widgetkit/joomla/index.php/home/slideshow) are preserved.

# Supported platforms
* The code is based on Widgetkit 2.5.2, however it should work with any Widgetkit 2.4.x and later.
* Joomla 3.4.x or later required
I didn't test it with Wordpress.

# Installation
## Installation Overview
We use "clean" and "neat" approach according to the official Yootheme's manual:
* [Custom widgetkit plugin](http://yootheme.com/widgetkit/documentation/customizing/custom-widget-plugin)
* [Where to store your customizations](https://yootheme.com/widgetkit/documentation/customizing/where-to-store-your-customizations)
### Unique Features
The new features that the SlideshowEx has and that are not available in the original Slideshow widget:

Such approach allows you to:
* keep original Yootheme's Widgetkit source files
* preserve original Yootheme's functionality
* safely do updates to Yootheme's files (download new versions of Widgetkit 2), keeping our new widget (modifications won't be overwritten during update process)
* **Clickable image** - a link can be attached to the slide's image (media), [read more](https://github.com/rvalitov/widgetkit-slideshow-ex/wiki/How-to-make-the-whole-slide-clickable).
* **Clickable overlay** - a link can be attached to whole overlay, [read more](https://github.com/rvalitov/widgetkit-slideshow-ex/wiki/How-to-make-the-whole-slide-clickable).
* **Clickable slide** - mixing two features 'Clickable image' and 'Clickable overlay' allows to make the whole slide clickable, [read more](https://github.com/rvalitov/widgetkit-slideshow-ex/wiki/How-to-make-the-whole-slide-clickable).

## Installation Process
The installation is very simple. You just need to copy the folder _slideshow_ex_ to _/templates/THEME-NAME/widgetkit/widgets/_, so that you will have a folder _/templates/THEME-NAME/widgetkit/widgets/slideshow_ex_. The _THEME-NAME_ is a folder of your [Warp 7 theme](https://yootheme.com/themes), e.g. it can be _yoo_vida_, _yoo_finch_, etc.

# Setup and usage
## Configure the widget
After successful installation you should see the SlideshowEx widget in the widgetkit control panel page, so that you can select it from the list:
![SlideshowEx widget](https://raw.githubusercontent.com/rvalitov/widgetkit-slideshow-ex/master/images/widgets-list.jpeg)
# Supported platforms
* The code is based on Widgetkit 2.5.2 (identical to 2.5.3), however it should work with any Widgetkit 2.4.x and later.
* Joomla 3.4.x or later required

You should configure the widget as usual, e.g. the [Yootheme documentation](http://yootheme.com/demo/widgetkit/joomla/index.php/home/slideshow) can be useful.
Widget should work with Wordpress 4.4.x (according to feedback from users; I can't test it personally, because I don't have the required subscription).

All the advanced features of the SlideshowEx are shown on the following screenshot:
![SlideshowEx widget settings screen](https://raw.githubusercontent.com/rvalitov/widgetkit-slideshow-ex/master/images/slideshowex-settings.jpeg)
If you don't activate any of these features, then the SlideshowEx behaves exactly as the original Slideshow widget from the Widgetkit bundle.
# How to install?
The installation procedure is described [here](https://github.com/rvalitov/widgetkit-slideshow-ex/wiki/How-to-install).

Options and description:
* **Add link to image** - if checked, then the whole image will be clickable. This option is available only if the 'Show media' option is checked. If you use an overlay, probably you will want to activate 'Add link to overlay' option (see below) to make the whole area of the slide clickable.
* **Add link to overlay** - if checked, then the widget makes the whole overlay clickable. This option is available only if the 'Overlay' option is set to anything other than 'None'. Probably you will want to activate this feature both with 'Add link to image' option (see above) to make the whole area of the slide clickable. **Notice:** this feature automatically strips all links (`<a>` tags) from your overlay - it's a required action to avoid a possible collision of `<a>` tags that may happen.
# The manual
Some issues about using the widget are available in the [Wiki area](https://github.com/rvalitov/widgetkit-slideshow-ex/wiki).

# Authors, Contributors and Acknowledgment
* This widget is created by [Ramil Valitov](http://www.valitov.me).
Expand All @@ -56,6 +41,6 @@ Having trouble with SlideshowEx Widget? May be something has already been descri

Being a free project which I do in my spare time, I hope you understand that I can't offer 24/7 support:) You may contact me via e-mail [email protected], I will try to answer to all of them (if such messages imply an answer), however, not immediately, it may take a few days or a week... so, just be patient.

Note, that I can answer only to questions and problems directly related to SlideshowEx widget. Answers to basic questions about the widgetkit nature and simple help about how to use widgets in general or how to use Joomla you can find in appropriate forums:
Note, that I can answer only to questions and problems directly related to this widget. Answers to basic questions about the widgetkit nature and simple help about how to use widgets in general or how to use Joomla you can find in appropriate forums:
* [Joomla](http://forum.joomla.org/)
* [Widgetkits](https://yootheme.com/support)
2,063 changes: 0 additions & 2,063 deletions images/logo.ai

This file was deleted.

Binary file removed images/slideshowex-logo.jpg
Binary file not shown.
Binary file removed images/slideshowex-settings.jpeg
Binary file not shown.
Loading

0 comments on commit b8aca17

Please sign in to comment.