Back to top

YITH Newsletter Popup Documentation

Thank you so much for using our plugin.

YITH Newsletter popup - Wordpress plugin

This document covers the installation and use of this plugin and reveals answers to common problems and issues - I encourage you to read this document if you are experiencing any difficulties.

Get started!


 

Getting started

To install this plugin you must have a working version of WordPress already installed. For informations about how to install the WordPress platform, please see the WordPress Codex - http://codex.wordpress.org/Installing_WordPress

Installation

Upload via ftp:

First, unzip the zip archive you downloaded on your computer. Upload the folder to your server via ftp to the   /plugins/ directory on your Wordpress installation. (wp-content > plugins)

Upload via Wordpress admin:

Go to your Wordpress admin, and in the Plugins-panel, choose Add New. Click Upload in the below the title "Install Plugins". Upload the plugin zip.

Installing WordPress  http://codex.wordpress.org/Installing_WordPress

Activation

Once you have uploaded the plugin, activate your plugin in Plugins > Installed plugins.

Go in Appearance > Newsletter Popup and be sure that Enable the newsletter popup is ticked.

Settings

In Appearance > Newsletter Popup page you will find the settings of the plugin. Also the options are splitted in more tabs, to find them easily.

General

General Settings
Enable Newsletter Popup Enables the plugin
Cookie Variable Here you can set a name for your cookie that will help you to show the popup to all your visitors even the ones that disabled it. It is useful if you are launching a new promo. Don't abuse of it.
Popup Title The title displayed on top of the popup
Popup Image If you want, you can set here an image to be shown on the left side of the popup.
Popup Message The message displayed. You can also use HTML code.
Hide forever button Text to be shown and used as an hide forever button on popup's left.
Custom style Insert here your custom CSS style.
Typography
Title font of message Choose the font type, size and color for the titles inside the message text.
Paragraph font of message Choose the font type, size and color for the subtitle message text.
Hiding buttons fonts Choose the font type, size and color for the hiding button fonts.
Background Settings
Choose a color to be used as background Choose the background color of the popup.

Newsletter

All options to configure the newsletter form of the popup. The options below allows you to link the newsletter form to an external service. You simply need to analyze the example form of external service and then configure each information in the option fields below.

Newsletter
Enable Newsletter form Choose if you want to enable the newsletter form in the maintenance mode page.
Newsletter Submit Font Choose the font type, size and color for the newsletter submit button font.
Newsletter Submit Font hover Choose the font type, size and color for the newsletter submit button font hover status.
Newsletter Name and Email Inputs Font Choose the font type, size and color for the name and email inputs field.
Enable custom submit button's colors Choose if you want to use custom submit button's colors or your theme default ones.(Default: Custom)
Newsletter submit background The submit button background.
Newsletter submit hover background The submit button hover background.
Form configuration
Action URL Set the action url of the form.
Name "name" The attribute "name" of the name field
Name Icon Upload or select an icon to be shown in newsletter's name input field
Name field label The name field label
Email "name" The attribute "name" of the email address field.
Email icon Upload or select an icon to be shown in newsletter's email input field
Email field label The email field label
Submit button label Submit button label
Newsletter Hidden fields Set the hidden fields to include in the form. Use the form: field1=value1&field2=value2&field3=value3
Form method Set the method for the form request (POST or GET).

WooCommerce Integration

All options to configure the woocommerce part of the newsletter popup. The options below allows you to show a WooCommerce product in your popup.

WooCommerce integration
Enable the WooCommerce integration If the option is enabled, the popup shows the informations about the WooCommerce products selected below. (Default: Off)
WooCommerce Product ID Write here the ID of the product that you would like to show in your popup. You can check this Video tutorial
Enable custom submit button's colors Choose if you want to use custom submit button's colors or your theme default ones.(Default: Custom)
Newsletter submit background The submit button background.
Newsletter submit hover background The submit button hover background.

Codex

The plugin allows you to use your own custom templates and stylesheets.

Custom Stylesheet

In order to customize the style of the plugin you can easily create a file called fbanner.css within the theme folder. The file will be automatically loaded from your theme instead of the plugin folder.

In this way the style.css file contained within the plugin ( /assets/css/) will be replaced with your stylesheet. Keep in mind to copy and paste the code contained within this file if you need that.

Custom Templates

If you need to include our plugin within your theme you can also customize the templates. Copy the file yith-newsletter-popup.php from the folder "templates" of plugin folder and paste it inside the theme folder and automatically the plugin will load the templates from your theme instead of the plugin folder.

FAQ

How can I customize the Newsletter Popup?

The page is a simple template and you can override it by putting your custom template named "yith-newsletter-popup.php" inside the theme folder. You can also customize the style by adding your custom CSS in the specific option of the settings.

How can I customize the Style of the Newsletter Popup?

You can style the appearance using the option into the Plugin's Admin Panel but, if you need more advanced personalizations you can simply ovverride the current stylesheet adding your inside the theme folder. Don't forget to name it: "yith-newsletter-popup.css"

Can I deactivate the 'name' field in the newsletter module?

Yes simply leave the "Name" field label empty to achieve this.

Have I to deactivate the plugin to hide the newsletter popup?

No, you can deactivate the newsletter popup even if the plugin is active.

How can i set the product ID into WooCommerce section?

Set it is really easy! We have recorded a video tutorial about it here: Setting Product ID Tutorial

Localization

This plugin is ready for localization via .po/.mo files.

If you are not familiar with translating Wordpress plugins, it would be better to read this article: http://codex.wordpress.org/Translating_WordPress

Change the language of YITH Newsletter Popup Languages for dummies

  1. Check the values of your wp-config, the language of this file must match your translation;
  2. Find the folder languages of the plugin
  3. Duplicate default.po
  4. Rename your copy of default.po example: yit-fr_FR.po for France, yit-en_EN.po for English, yit-he_HE.po for hebraic, and so on.
  5. Download POEdit
  6. Open your file with the POEdit software
  7. Update the catalog using the POT file (Catalog -> Update from POT file...)
  8. Translate your file (edit catalog properties using POEdit to add your credits)
  9. In File click on Preferences and tick Automatically generate mo
  10. Save your file
  11. Send the new .mo and .po via FTP to your server, in the folder languages of the plugin
  12. Send the new .mo and .po via email to plugins@yithemes.com so we can improve the quality of the plugin and you can help other users. We will thank you with official credits

Version 1.0.0

  1. Initial release.