WeatherSlider WP

Installation via WP plugin installer

1. Extract the archive file on your machine that you've downloaded from CodeCanyon.
2. Navigate to Plugins -> Add new page on your WordPress admin area.
3. Select the Upload button on the top and choose the "weathersliderwp-x.x.x.installable.zip" file that you've extracted from the downloaded archive, then hit the Install Now button.
4. WordPress may ask you to enter your FTP login credentials. Click on Proceed when you finished.
5. The plugin is now installed, click on the Activate Plugin button.

Installation via FTP

1. Extract the archive file on your machine that you've downloaded from CodeCanyon.
2. Find the "weathersliderwp-x.x.x.installable.zip" file in the extracted contents and unpack that archive as well.
3. Open your favorite FTP application and connect to your server. Navigate to the "/wp-content/plugins/" folder.
4. Copy over the "WeatherSlider" folder extracted from "weathersliderwp-x.x.x.installable.zip" file.
5. Navigate to the Plugins page on your WordPress admin area and click the Activate button below WeatherSlider WP.

Auto-update

Since WeatherSlider WP 2.3.0 we are supporting automatic updates. The auto-update feature requires a valid item purchase code; you can find it by navigating to your CodeCanyon downloads page and downloading your License Certificate for the corresponding item. Your Item Purchase code is in the downloaded text file. Please enter this code at the WeatherSlider WP main plugin page under the "News & Updates" section.

Manual update

Once you've downloaded the most recent version from your CodeCanyon downloads page you can deactivate and remove the old version, then install the new one. Your sliders and settings are in the database, removing the plugin won't touch them. The new version always has backwards compatibility, so you don't have to worry about anything.

Changes during updates

Depending on the default settings, you may have to enable or disable some settings related with the new features. If you experience any unwanted behavior change after an update, it is always a good idea to check the settings of your sliders, there are probably new options to control these changes.

Setting up your API key

Before you can use the plugin, WeatherSlider requires a World Weather Online API key. You can get it for free and it only takes a couple of seconds. Please click on the following URL and register for your own API key: http://developer.worldweatheronline.com/signup.aspx.

If you are done with the registration and received your key, please navigate to the WeatherSlider settings page and enter the key to the "WWO API key" text field and save your settings.

What is caching?

Caching is a technique that helps avoiding API overuse and can significantly speed up loading of the weather information. Enable this option if you've a site with great traffic, or if you've received a warning from WorldWeatherOnline about overusing your free API.

How do I enable caching?

In some cases, you may need to make writable the cache folder in your "/wp-content/plugins/WeatherSlider/" directory. The plugin will let you know if a certain action from your part is required. See the Codex for more info.

Also, you can set the cache refresh interval, this setting controls how often the plugin should get the latest weather data in minutes. By adjusting this settings you can achieve even more effective results in API usage.

Managing sliders

You can add new sliders with the 'Add New' button at the top of the plugin's main admin page. After you've added a slider it will be listed in the list below. There are buttons at the end of each row, which enabling you to duplicate or remove sliders.

Inserting WeatherSlider with shortcode

You can place your WeatherSlider sliders into posts and pages with their shortcodes. Once you've created a slider, its shortcode will appear in the list of your sliders.

Inserting WeatherSlider with widget

WeatherSlider WP supports widgets, so you can place your WeatherSliders in your front-end page just by a drag 'n' drop. To do that, navigate to the Appearance menu on your left sidebar and select "Widgets". Grab the WeatherSlider WP Widget and drop it into one of your widget areas.

Please note that some themes may not support a widget area what you need. In this case, you can create a new widget area by editing your template files. See the official documentation about widgetizing your theme.

Calling WeatherSlider from your theme files

Because WeatherSlider can be an integral part of your site, you may want to place it into your theme files. There is a PHP function with filtering options that you can call for example from the header.php file of your theme to insert the slider on certain pages. Here is the function definition:

weatherslider ( mixed $sliderID [, string $pages] )

The $sliderID parameter can be found on the plugin page in the slider list view at the first table column.

The $pages parameter is a comma separated list of pages either by name or the ID of the pages. If you are unsure about your page names or IDs, look at their URL, it is the last component.

There is a special page name, the "homepage", with you can filter WeatherSlider WP to display the slider on your home page only.

The follwing examples are all valid, you can use either of these, you can even mix them on your own needs:

<?php weatherslider(1); ?> // Displays the first slider on every page
<?php weatherslider(1, 'homepage'); ?> // Displays the first slider only on your home page
<?php weatherslider(1, 'my-custom-post-title'); ?> // Displays the first slider on a custom page by name
<?php weatherslider(2, '1369'); ?> // Diplays the second slider on a custom page by ID
<?php weatherslider('paris', 'category-name'); ?> // Displays the slider with the slug 'paris' on a custom page by a category name
<?php weatherslider(3, 'homepage,about-us,1234'); ?> // Displays the third slider on multiple pages

Using the Geolocation feature

The Geolocation feature enables your visitors to see weather information for their own location. Just add the special location name "GEOLOCATION" (without quotation marks) to your list of locations, the plugin will handle the rest for you.

Supported slider dimensions

You can specify any size to the slider you want between 240x200 and 1300x600 pixels. These two limitations required to maintain the quality of the graphics elements.

Custom styling

By editing the weatherslider.css in your "/wp-content/plugins/WeatherSlider/css/" you can set custom style settings to your WeatherSliders. This requires some basic CSS knowledge.

How to translet the admin user interface?

1. Download PoEdit

   There are several apps available to help you with translating .PO files. PoEdit is a popular one, and it's available on every major platform. You can download it from here.

2. Start translating

   Open the default WeatherSlider-en_US.po file from your "/wp-content/plugins/WeatherSlider/locales/" folder. When you save your work PoEdit will generate you a .MO file which will be needed to apply your work.

3. Name your files properly

   WordPress recognizes your localization by a special formatting of file names. You will need to include the right language and country codes so it can identify what language is your work made for.

   For example, a French localization would have the file names: WeatherSlider-fr_FR.po and WeatherSlider-fr_FR.mo. You must follow this syntax, including the dash, underscore, and lower- or uppercase letters.

4. Apply your localization

   Copy your newly created .PO and .MO files into the "/wp-content/plugins/WeatherSlider/locales/" folder. WordPress should use them immediately if you named your files properly.

Creating multilingual sliders with qTranslate

qTranslate is the most easiest way to create multilingual sliders in WeatherSlider. It is a free and simple plugin that supports a shortcode-like syntax to enter text in multiple languages, so it can display the proper one for your visitors. WeatherSlider supports shortcodes and other special syntaxes in its language strings, so you can enter something like this to create a multilingual slider:

[:en]English text[:de]German text

Translating with the WPML plugin

About the Troubleshooting & Advanced Settings section

The "Troubleshooting & Advanced Settings" box contains options to improve the plugin's performance when it's possible and to avoid common incompatibility issues with other themes and plugins.

Please note, changing these settings incorrectly could break some features of your site, and it is not recommended for users without experience.

Is my location supported?

You can test your location and weather data on WorldWeatherOnline's website.

WeatherSlider keeps saying "getting weather"

Please, make sure about the following things:

• You are using the most-recent version of the plugin
• You get your own API key for the new WWO API
• Your API key is valid and works without problems. You can test it on WWO's developer page.
• Check your account standing by logging in on WWO's developer page.
• You entered your API key properly, without any whitespaces or extra characters.

Please note, caching plugins on your WP installation could prevent showing real-time changes, and you might need to empty your caches to verify whether your actions have solved the problem or not.

Multiple widgets on the same page does not work

This is a limitation in the World Weather Online API, it doesn't allow parallel requests at the same time. Caching may help improving cases related to this limitation, but only WWO's premium API solves the problem entirely.

I have exceeded my API usage limit. What should I do?

WeatherSlider WP has caching functionality. It makes your widgets load faster and helps to decrease your API usage considerably. Adjusting the update intervals can be even more effective. Caching is highly recommended in most cases, see the "Setting up caching" section for more details.

I'm receiving security notifications on my HTTPS site

Since version 2.6.2 you can enable the "Use HTTPS" option in the plugin settings, so WeatherSlider will retrieve the weather information over a secure connection.

If you get stuck...

Before contacting us, please make sure that you:

• read this documentation carefully
• and browsed the FAQ of the item.

If you didn't find answer to your problem, please ask your question on the item discussion page or send us a private message from our Codecanyon profile page (Search for the "Email kreatura" box on the bottom right - in this case we will reply via email). We can answer your support questions only in these ways (please do not send us email directly).

IMPORTANT! For the fast troubleshooting, please send us detailed informations about the issue and make sure that you don't forget to send us your site url where you are using / want to use the item. Please note, that we cannot troubleshoot from screencast videos or screenshots.

Please take some time until we respond (usually in 24 - 48 hours).

Useful pages