wpStickies

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 "wpstickies-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 "wpstickies-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 "wpStickies" folder extracted from "wpstickies-x.x.x.installable.zip" file.
5. Navigate to the Plugins page on your WordPress admin area and click the Activate button below wpStickies WP.

Auto-update

Since wpStickies WP 2.0.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 wpStickies 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 tags 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 plugin settings, there are probably new options to control these changes.

How wpStickies works?

Unlike other plugins, wpStickies doesn't require anything from you to use it. Other plugins may want you to insert some code or the image itself to your page. wpStickies doesn't follow these kind of requirements, there aren't any shortcodes or widgets or anything that you may used to becuase it is fully automatic.

To insert a sticky on your page, you just have to open your front-end page and find the image you want to work with and simply just drag an area over it or click at a point to create a spot. That's it, it works like magic.

Which images are wpStickies enabled?

wpStickies works on images inserted with the WordPress post/page editor automatically. If you want to use wpStickies on other images, you have to specify a new selector or apply on them the "wpstickies" class with the WP editor advanced image options. For more information, please read the "About selectors" section of this documentation. If we can help you with anything, please do not hesitate to contact us.

Troubleshooting

In some very rare cases your WordPress installation may use different structure to display images and it may cause some issues. Don't worry, the plugin will work for you the same and those issues can be fixed easily. Just send us an email from our CodeCanyon profile page and we will reply with the necessary information as soon as possible.

What are the selectors?

The selectors are patterns for selecting elements that you want to work with. wpStickies works on images inserted with the WP post/page editor automatically. This is also achieved with selectors. Specifying a new selector will allow you to apply wpStickies on your custom images or even HTML elements with background. You can also use selectors to prevent wpStickies applying on your images you don't want to.

How selectors works?

To understand how the selectors works, you need some web development experience, especially with the HTML DOM structure. The most basic selectors are using namespaces, the HTML element names. For example, in HTML, you can insert an image with the <img> element. In selectors, you can use the "img" selector to apply wpStickies on every images. You can reference elements with a specific class name with a dot at the beginning of your selector. For example: ".wpstickies". To reference an element with an ID, you can use the hash mark: "#customid". These are the basics of the selectors.

You can pile up these selectors for more accourate results. For example, if you want to apply wpStickies on images, which are inside HTML elements with class name "entry", you can use the following: ".entry img". If you have a main content area that holds all your content and has an ID "content", you can extend our example selector for a more accurate results: "#content .entry img".

So, how can I find all the selectors?

We are using the selector engine of jQuery, so you can find all the available selectors on this page.

How can I prevent wpStickies applying on images I don't want?

Of course, you can do this with selectors. jQuery supports a very special selector for this, you can find all the details here.

What if I don't understand any of this?

That's okay, this help entry is made for users with some web development experience. If you have any questions or you want to modify the behavior of wpStickis that involves selectors, you can email us from our CodeCanyon profile page.

Provide plugin access to non-admin users

If you want to share your tags administration with other (non-admin) users, you can find the relevant options under Plugin Settings -> General -> Permissions. There are several predefined options, but you can also select "Custom" to enter a custom capability. See the Codex for more informations about roles and capabilities. Please note, these settings are only responsible for accessing wpStickies' admin pages.

Non-admin users can only manage your tags by default. If you tick the "Allow changing plugin settings" option they will also be able to alter any plugin setting, which includes permission settings as well. Be aware the risks when you enable this option.

Allow non-admin users to add/modify tags

You can find mostly the same options described in the previous entry to control who can add/modify tags on your images. These settings can be found under Plugin Settings -> Permissions, where you can edit permissions for adding and modifying tags separately.

Since your permission preferences might also include non-trusted users, we've created a pending list where you can review all the changes made before they goes public. Options related to the pending list are also separated based on adding/modifying tags, so you can choose the right action to be performed after certain events. For example, you can re-valuate edited tags, or just completely ignore the pending list if only trusted users can make changes.

Do I have to accept my own tags?

No, every action you take is immediate if you're an administrator. For other users it depends on the permission preferences set in plugin's settings.

About the "wpStickies admins" group

The plugin creates you a new user role called "wpStickies admins" after installation. The members of this group has basic capabilities, much like subscribers. The only difference is that they can add/modify tags if you choose it in your permission settings.

Restore removed tags

Rejecting a pending sticky or removing any of them won't delete it immediately. These stickies will still be available under Stickies -> Restore. Later you can decide to restore or delete them permanently, but they are invisible and acting like deleted in the meantime.

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 wpStickies-en_US.po file from your "/wp-content/plugins/wpStickies/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: wpStickies-fr_FR.po and wpStickies-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/wpStickies/locales/" folder. WordPress should use them immediately if you named your files properly.

Creating multilingual tags with qTranslate

qTranslate is the most easiest way to use multilingual contents in wpStickies. 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. wpStickies supports shortcodes and other special syntaxes in its language strings and spot fields, so you can enter something like this to make multilingual tags:

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

Translating with the WPML plugin

My Media

Under the My Media sub-page you can see and filter all your uploaded images to tag them with wpStickies. It offers a convenient way to quickly and easily tag images without visiting the corresponding front-end pages where they belong to. This media editor can also be used to tag images used in certain posts and pages, and the plugin will provide you a quick access link on the right sidebar when you are editing them.

CSS editor

Since version 2.1.0, wpStickies has a CSS editor where you can enter custom CSS code to further change the plugin's appearance beyond the provided styling options.

Please note, the CSS editor requires some CSS knowledge. Entering invalid CSS code could break the appearance of your site badly.

Troubleshooting options

The Troubleshooting section in the plugin settings 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.

Why wpStickies breaks linking on images?

Since you have to perform mouse actions (e.g. clicking, dragging) on images to add tags, wpStickies needs to suppress regular events like opening the linked content in a new tab in order to provide an uninterrupted experience with using the plugin. However, with selectors or the per images settings you can disable wpStickies on certain images to restore their original behavior.

wpStickies does not work after moving my site

wpStickies identify images by their URL. If you've moved your site to another domain, you may have to enable the "Use relative URLs" option in the plugin settings. This way wpStickies will try to find your images locally on the new installation, but it could also break tagging on images loaded from external servers.

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