### “Premium Featured Posts Slider” Documentation by “Web factory Ltd” v1.15

# “Premium Featured Posts Slider” WordPress plugin

Created: 2012-02-28, revision 4
By: Web factory Ltd
Support: via CodeCanyon

Thank you very much for purchasing our WordPress plugin. If you have any questions that are beyond the scope of this help file, please feel free to email us via our user page contact form. Have a good one!

## Table of Contents

1. Online documentation, examples and help
2. Installation
3. Usage
4. Configuration
5. PSD files
6. FAQ
7. Sources and Credits

### B) Installation - top

### Installation

1. Download the plugin ZIP file.
2. Open your WP admin and go to Plugins -> Add New -> Upload. Browse for the ZIP file premium-featured-posts-slider-plugin.zip on your computer and hit “Install Now”.
3. Activate the plugin.

### Placing the Slider in your theme

1. In WP admin, open Appearance - Premium Featured Posts Slider
2. All predefined options will be fine for now except "width". You have to set the width to fit your theme. It depends where you want to put the slider but the number is probably going to be around 600px. We don't recommend using "100%" as the width. Save settings.
3. If you have a widget area in header, or anywhere else you would like to put the slider just create a text widget and put the [fps] shortcode in it.
4. If you can't use the shortcode open header.php and put `<?php the_featured_posts_slider(); ?>` under your menu or on any other appropriate place depending on your theme's layout.

### Upgrade

1. Deactivate and delete plugin in your WP admin -> Plugins.
2. Use the Add New -> Upload function to upload the new ZIP file.
3. Activate the plugin.

### C) Usage - top

After positioning the FPS in your theme, using it very easy. Be sure to select a featured image for each of your posts because otherwise FPS won't know what image to associate with it. If you're displaying the latest content there's no need to manually select featured posts. The slider will simply show the last n posts. If you're displaying featured posts be sure to mark all content as featured that should be displayed in FPS.
All options are easily configurable via the options GUI and have inline help.

### D) Configuration - top

### Global FPS options

Global FPS options are configured in WP Admin – Appearance – Premium Featured Posts Slider.

Option name | Description | Default
Width | Slider container width - this option has to be configured. Set the value according to your theme layout. Any CSS parsable value is accepted. We don't recommend using "100%". | 600px
Slider Content | You can feature content that's been manually selected or use the latest content. This option has full support for custom post types and custom taxonomies. | latest posts
Number of Slides | Number of posts shown in slider. If the number of "featured" posts is greater than "number of slides" the later will take precedence. | 5

Thumbnail Size

List of thumbnail sizes your theme supports. Select the size that best fits your site's layout and selected FPS layout. FPS registers it's own additional thumbnail size which can be customized. Thumbnail size can be chosen on a per-post basis while editing individual posts.
Once the size is changed you have to re-build or re-upload the images. We suggest using Image Sizes Manager.

medium

Layout

FPS comes with 6 predefined layouts:

- Layout 1 - Large image with title on image bottom
- Layout 2 - Thumbnail with content on right
- Layout 3 - Medium image with content on right
- Layout 4 - Large image with title above image
- Layout 5 - Thumbnail with content on left
- Layout 6 - Medium image with content on left

If none fit your needs you can define your own using variables described later in this doc.

layout 2

Auto Generate Previous and Next Buttons | If checked previous and next buttons will be placed on left and right edges of the slider. | enabled
Auto Generate Pagination Buttons | Choose from two pagination types below the slider: circles and thumbnails; or disable pagination. | circles
Autoplay | Time between each automatic slide switch. | 5 seconds
Transition Effect | Effect used for transitioning between slides - slide or fade. | slide
Transition Effect Speed | Duration of transition effect/animation in milliseconds. | 350 milliseconds
Stop on Hover | If checked autoplay will be stopped once user hovers over the slider. | enabled
Randomize | Randomize slides order. By default they are orderd by publishing date, descending. | disabled
Include CSS | If you wrote your own CSS for slides or copy/pasted our CSS code into some other file then disable this option, otherwise leave it enabled. | enabled
Include jQuery | If your theme doesn't already have jQuery included enable this option to have FPS include it. | disabled
Include Slides JS | If your theme already has Slides JS included uncheck this option. | enabled
Shortcode Name | Write only the shortcode name, without brackets. If the shortcode name you want is already taken you'll be notified after saving. | fps
Additional Image Size | Width, height and cropping option for FPS custom image size. Please note: changes to image size are not "retroactive" meaning they will only affect newly uploaded images. Use Image Sizes Manager to re-build images. | 330x330px, cropped
Pagination Thumbnail Image Size | Width and height option for FPS navigation thumbnail image size. Please note: changes to image size are not "retroactive" meaning they will only affect newly uploaded images. Use Image Sizes Manager to re-build images. | 50x50px
Show Slider | If you want FPS shown only on certain pages but you placed FPS code in ie header.php set this option to enable conditional display on selected pages. | always display FPS

### Per-post FPS options

Per-post (page / custom post type) options are configured while editing and creating new content. Three variables can be set:

- featured - yes / no
- layout - use FPS globally configured layout, one of 6 predefined or the custom one
- thumbnail - use FPS globally configured thumbnail, or any other size available in your theme

### Selecting featured content

In post / page / custom post type list (table) you'll see a new column "Featured". By checking / unckecking the checkbox for a selected post you'll mark it as featured / not featured.

### List of variables available for use in custom layout code

When writing custom layout code you can use the following variables. The code itself is plain HTML. Please note that the code you enter is the code for a single slide not the whole slider. To get some ideas how to write code look at the code of 6 predefined layouts.

- {id} - post ID; ie: 34
- {permalink} - post permalink URL; ie: http://www.myweb.com/my-pos/
- {title} - post title; ie: My Nice Title
- {excerpt} - post excerpt with "the_excerpt" filter applied. If there\'s no excerpt an empty string is returned.
- {content-full} - complete post content with "the_content" filter applied.
- {content} - post content before the "<!--more-->" separator with "the_content" filter applied.
- {author} - post author "display name"; ie: John Doe
- {author-link} - URL to author\'s archive page; ie: http://www.myweb.com/author/john/
- {date} - post "published" date. Formatted using "date format" from Options - General; ie: 2011/02/22
- {time} - post "published" time. Formatted using "time format" from Options - General; ie: 8:22 am
- {comments-count} - total comments count; ie: 25
- {categories} - comma separated list of category links
- {tags} - comma separated list of tag links
- {thumbnail} - thumbnail <IMG> HTML element complete with src, width, height and default WP CSS classes.
- {thumbnail-src} - thumbnail file URL
- {thumbnail-width} - thumbnail width in pixels; ie: 330.
- {thumbnail-height} - thumbnail height in pixels; ie: 330.
- {slider-width} - slider width you entered in FPS options; ie: 700px.

### Using theme PHP functions

FPS features two theme functions:

- the_featured_posts_slider() - echoes complete slider content
- get_the_featured_posts_slider() - returns complete slider content in a string

Both functions have no parameters so in most cases to implement FPS in your theme use:

    <?php the_featured_posts_slider(); ?>

### Using the shortcode

FPS shortcode ([fps]) is basically just a wrapper for the_featured_posts_slider() function. You can use it in text widgets to enable FPS. If you have a widget area in site's header implementing FPS is merely a matter of using the shortcode in a text widget.
If your site's front-page is a static page you can of course put the shortcode in that page.

### E) PSD files - top

FPS comes with two PSD files: fps-arrows.psd and fps-pagination.psd. First one contains the left and right navigation buttons, and the second one active and non-active pagination bullets that are usually placed below the slider.

### F) FAQ - top

### It's not working!

- Do you have wp_footer() function call in theme's footer? No? Add it!
- Do you have jQuery included in your theme? No? Enable "Include jQuery" option in FPS settings.
- Do you have any posts selected as "featured"? No? Well then there are just no posts to show :)
- Did you place the FPS function call or shortcode in your theme? No? You have to do it - see the installation
- Did you set the slider width in options? It's mandatory, you have to configure it.

### My slider is all mangled up / CSS is broken

FPS will not custom style your slides! It uses default WordPress CSS classes which your theme should already have defined such as post and entry title. It's alsoimportant that you choose the right image size to fit the current layout.
Each slider has "fps-slide" class so you can easly target any elements with your CSS or write inline styles using the custom layout editor.
If you still can't get it to work please contact us. We'll gladly help you!

### I changed the image size in options but the size is still the same!?

Changes to image size are not “retroactive” meaning they will only affect newly uploaded images. Use Image Sizes Manager to resize the old images.

### Can I place multiple Slider on the same page?

No! There can only be one slider per screen at a time. You can place multiple sliders on different places ie: on homepage it shows below the header,on category pages it's in the middle ... But, only one per screen!

### Will this plugin slow my site down?

No it won't. FPS has a minimal footprint and uses only one standard WP query to fetch featured posts. Everything else is a bit of JS and CSS.

### G) Sources and Credits - top

No external PHP related assets were used in this script's code.

Other copyrighted assets used:

- jQuery
  http://www.jquery.com
  Licenced under MIT and GNU GPL version 2
- Slides, A Slideshow Plugin for jQuery
  copyright Nathan Searles
  www.slidesjs.com
  Licensed under the Apache License, Version 2.0

Once again, thank you so much for purchasing this WordPress plugin. As stated at the beginning, we'd be glad to help you if you have any questions relating to this theme. We'll do our best to assist. If you have a more general question relating to the themes on ThemeForest, you might consider visiting the forums and asking your question in the "Item Discussion" section.

Web factory Ltd.

Go To Table of Contents