Documentation

Installation

• Download the package
• Extract it to the “plugins” folder of your wordpress
• In the Admin Panes go to “Plugins” and activate it

Upgrade

• Replace all the files on post highlights folder
• Deactivate and reactivate the plugin

Usage

Place the following code where you want the highlights to appear on your theme:

<?php
if (function_exists("insert_post_highlights"))
    insert_post_highlights();
?>

For example, if you want to display the highlights only in the home page you can add the following code to the index.php file of your theme (alternatively you can add the above code snippet to the home.php file of your theme):

<?php
if (is_home()) {
    if (function_exists("insert_post_highlights")) {
        insert_post_highlights();
    }
}
?>

Highlighting a post

To highlight a post go to the Edit Posts page and check the checkbox under the Highlight column. Choose one of the post images to be used and optionally enter a headline for the highlight.

To make your life easier when managing your highlights, you can filter your posts list clicking on the “only highlighted” checkbox and clicking onF ilter.

Here is how it looks:

Hghlighting a post

Plugin options

Post Highlights settings page

Go to Post Highlights > Settings to change some options. You can change the theme (see section below), configure the delay time, maximum number of posts to display, navigation arrows color and size.

If you want, you can say “I want Post Highlights to automatically create and use an image with these dimensions” and specify a height and width. If this options is checked, Post Highlights will create a copy of every image you upload to your site with these dimensions and then use it to show it to the world.

If this option is not checked, Post Highlights will use the full size image.

In all cases, if the image size is bigger than the plot area, it will be croped, and if its bigger, it will repeat like a pattern.

Defining Permissions

Post Highlights permissions page

In Post Highlights > Permissions you can give permission to users to highlight posts.

Post Highlight Themes

If you want to know how to create your own theme, check out this page.

If you have created a theme please write to post-highlights at hacklab.com.br and we can publish your theme here on this site.

Any doubts or suggestions?

Check out the support page.