Back to top

YITH Maintenance Mode Documentation

Thank you so much for using our plugin.

YITH Maintenance Mode - 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 information in regard to installing 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 > Maintenance Mode and be sure that Enable Maintenance Mode is ticked.

Settings

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

General

General Settings
Enable Maintenance Mode Enable the plugin
Roles The user roles enabled to see the frontend. Check a role to enable it to show the website with maintenance mode active.
Message The message displayed. You can also use HTML code.
Custom style Insert here your custom CSS style.
Mascotte If you want, you can set here a mascotte image to show above the main box, in the right side.
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 paragraphs inside the message text.
Colors
Border top color Choose the color for the big border top of the main box.

Background

Background Settings
Background image Upload or choose from your media library the background image
Background Color Choose a background color
Background Repeat Select the repeat mode for the background image.
Background Position Select the position for the background image.
Background Attachment Select the attachment for the background image.

Logo

Customize the logo

Logo Settings
Logo image Upload or choose from your media library the logo image
Logo tagline Set the tagline to show below the logo image
Logo tagline font Choose the font type, size and color for the tagline text.

Newsletter

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

Newsletter
Enable Newsletter form Choose if you want to enable the newsletter form in the maintenance mode page.
Newsletter Email Font Choose the font type, size and color for the email input field.
Newsletter Submit Font Choose the font type, size and color for the email submit.
Newsletter submit background The submit button background.
Newsletter submit hover background The submit button hover background.
Title The title displayed above the newsletter form.
Form configuration
Action URL Set the action url of the form.
Form method Set the method for the form request (POST or GET).
"Email" field label The label for the email field
"Email" field name The "name" attribute for the email field
Submit button label The label for the submit button
Newsletter Hidden fields Set the hidden fields to include in the form. Use the form: field1=value1&field2=value2&field3=value3

Socials

Socials
Facebook Set the URL of your facebook profile
Twitter Set the URL of your twitter profile
Google+ Set the URL of your Google+ profile
Youtube Set the URL of your youtube profile
RSS Set the URL of your RSS feed
Skype Set the username of your skype account
Email Write here your email address
Behance Set the URL of your Behance profile
Dribble Set the URL of your dribble profile
FlickR Set the URL of your Flickr profile
Instagram Set the URL of your instagram profile
Pinterest Set the URL of your Pinterest profile
Tumblr Set the URL of your Tumblr profile
LinkedIn Set the URL of your LinkedIn profile

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 maintenance.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 maintenance.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

Can I customize the maintenance mode page?

Yes, the page is a simple template and you can override it by putting the file template "maintenance.php" inside the theme folder. You can also customize the style by adding your custom CSS in the specific option of the settings.

Have I deactive the plugin to deactive the maintenance mode page?

No, you can deactive the maintenance mode page even if the plugin is active.

Localization

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

If you are not familiar with translating Wordpress plugins, I recommend you reading this article: http://codex.wordpress.org/Translating_WordPress

Change the language of YITH Maintenance Mode Languages for dummies

  1. Check the values of your wp-config, the language of this file must match to 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.1.4 - Released: Sep, 23 - 2014

  1. Fixed: Bugs with W3 Total Cache

Version 1.1.3 - Released: Sep, 16 - 2014

  1. Updated: Plugin Core Framework

Version 1.1.2

  1. Fixed: newsletter default options values
  2. Fixed: load custom template and style from theme
  3. Added: load default skin option file from theme

Version 1.1.1

  1. Added: WPML support
  2. Fixed minor bugs

Version 1.1.0

  1. Added: new 4 skins
  2. Fixed: button preview for the typography options, when italian language is active.

Version 1.0.2

  1. Fixed minor bugs

Version 1.0.1

  1. Added HTTP Status Code for the page showing in the maintenance mode active

Version 1.0.0

  1. Initial release.