File: //home/Test/wp/wp-content/plugins/5sec-maintenance-mode/documentation/index.html
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
<html>
<head>
<meta http-equiv="content-type" content="text/html;charset=utf-8">
<title>5sec Maintenance Mode Documentation</title>
<meta name="description" content="5sec Maintenance Mode Premium WordpRess plugin documentation by Web factory Ltd. Sold exclusively on CodeCanyon.">
<meta name="lang" content="en">
<link rel="stylesheet" href="assets/blueprint-css/screen.css" type="text/css" media="screen, projection">
<link rel="stylesheet" href="assets/blueprint-css/print.css" type="text/css" media="print">
<!--[if lt IE 8]><link rel="stylesheet" href="assets/blueprint-css/ie.css" type="text/css" media="screen, projection"><![endif]-->
<link rel="stylesheet" href="assets/blueprint-css/plugins/fancy-type/screen.css" type="text/css" media="screen, projection">
</head>
<body>
<div class="container">
<h3 class="center alt">“5sec Maintenance Mode” Documentation by “Web factory Ltd” v1.2</h3>
<hr>
<h1 class="center">“5sec Maintenance Mode” WordPress plugin</h1>
<div class="borderTop">
<div class="span-6 colborder info prepend-1">
<p class="prepend-top">
Created: 2012/06/26, revision 5<br>
By: Web factory Ltd<br>
Support: <a href="http://codecanyon.net/user/webfactory">via CodeCanyon</a>
</p>
</div><!-- end div .span-6 -->
<div class="span-12 last">
<p class="prepend-top append-0">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 <a href="http://codecanyon.net/user/webfactory">contact form</a>. Have a good one!</p>
</div>
</div><!-- end div .borderTop -->
<hr>
<h2 id="toc" class="alt">Table of Contents</h2>
<ol class="alpha">
<li><a href="http://5sec-maintenance-mode.webfactoryltd.com/">Online documentation, examples and help</a></li>
<li><a href="#installation">Installation</a></li>
<li><a href="#configuration">Configuration</a></li>
<li><a href="#faq">FAQ</a></li>
<li><a href="#credits">Sources and Credits</a></li>
</ol>
<hr>
<h3 id="installation"><strong>B) Installation</strong> - <a href="#toc">top</a></h3>
<h4>Installation</h4>
<ol>
<li>Download the plugin ZIP file.</li>
<li>Open your WP admin and go to Plugins -> Add New -> Upload. Browse for the ZIP file <em>5sec-maintenance-mode-plugin.zip</em> on your computer and hit “Install Now”.</li>
<li>Activate the plugin.</li>
</ol>
<h4>Post install checkup</h4>
<p>After plugin installation maintenance mode will be <b>turned off</b> (your site will work normally as it did before you installed it). To enable Maintenance Mode open Tools - 5sec Maintenance Mode and set status to enabled.</p>
<h4>Upgrade</h4>
<ol>
<li>Deactivate and delete plugin in your WP admin -> Plugins.</li>
<li>Use the Add New -> Upload function to upload the new ZIP file.</li>
<li>Activate the plugin.</li>
</ol>
<hr>
<h3 id="configuration"><strong>C) Configuration</strong> - <a href="#toc">top</a></h3>
<p>All plugin settings are located under WP admin - Tools - 5sec Maintenance Mode.</p>
<h4>General Settings</h4>
These settings control the overall behaviour and style of MM.
<ul>
<li>status - enable maintenance mode in order for any other settings to take effect</li>
<li>theme - 6 predefined themes can be customized in many way. If needed you can further customize them by editing their HTML files located in plugin's folder "/themes". Every theme has only one, simple HTML file and they can easily be edited.</li>
<li>maintenance page title - you can write plain text or use one of our variables to pull data straight from WordPress. You are free to leave any content fields blank.</li>
<li>maintenance page heading 1 - same as above. In themes this heading is shown in H1 tags.</li>
<li>maintenance page heading 2 - same as above. In themes this heading is shown in H2 tags.</li>
<li>maintenance page content - same as above.</li>
<li>show countdown timer - if you opt to display the countdown be sure to set the time when maintenance is going to be finished so there's actually a time to countdown to</li>
<li>show progress meter - graphical progress bar/meter will show your visitors the progress you've made. Be sure to set the actual progress percentage.</li>
<li>google analytics UA code - if you want to track maintenance page visitors put your complete UA ID here; ie: UA-123456-12</li>
</ul>
<h4>Access Settings</h4>
<p>While doing maintenance it's needed that some visitors see the normal site while the majority only see the maintenance page. By default only administrators should have access to the site. By utilizing the following setting you can fine-tune that.</p>
<ul>
<li>temporary access link - giving this link to people will allow them temporary access to the site while it's still under maintenance mode. Please note that only one temporary link is active at any time. If you give someone the link and then generate a new one they wont be able to access the site anymore using the old link.</li>
<li>whitelisted IP addresses - visitors with IP addresses noted above will <b>not</b> be affected by maintenance mode and will always see the "normal" site. You can use the asterisk (*) as a wildchar, ie: "192.168.0.*". Please enter one IP address per line.</li>
<li>whitelisted user roles - selected user roles will <b>not</b> be affected by maintenance mode and will always see the "normal" site.</li>
</ul>
<h4>Advanced Settings</h4>
<ul>
<li>respond with HTTP 503 header - while your site is under maintenance mode search engines (their crawlers to be more precise) should be notified of this temporary state which will prevent them from crawling your temporary page. We strongly suggest to keep this option enabled.</li>
<li>disable feeds - this option should also be kept enabled because it prevents surfers from (accidentally or on purpose) opening your feeds while maintenance is running</li>
<li>hide admin notices - while maintenance is enabled three notices will be shown: above the WP admin login form, in the admin bar and as a notice on all admin pages. If your bothered by these notices disable them.</li>
<li>compatibility mode - enable this mode only if you're having problems with the plugin and maintenance mode wont show up on the site.</li>
</ul>
<h4>Variables available in maintenance page content settings</h4>
<p>These variables will make is easier to create content and give a more consistent content throughout your site.</p>
<ul>
<li>{blog-title} - blog title, as set in WP Options - General</li>
<li>{blog-tagline} - blog tagline, as set in WP Options - General</li>
<li>{blog-url} - blog URL (site address), as set in WP Options - General</li>
<li>{blog-login-url} - URL to blog login form</li>
</ul>
<hr>
<h3 id="faq"><strong>D) FAQ</strong> - <a href="#toc">top</a></h3>
<h4>Will this plugin slow my site down?</h4>
<p>No, that's ridiculous. The plugins simply loads an HTML file from the disk and displays it instead of the usual content. Your site will actually load faster while maintenance mode is enabled since the maintenance page itself is really lightweight.</p>
<h4>I locked myself out of my site!!!</h4>
<p>Don't panic. You are just not logged in any more and thus you see the maintenance page instead of the site. Simply login to WP admin (www.yoursite.com/wp-login.php) and everything will get back to normal.</p>
<h4>Maintenance mode is running. How can I show my client the site without turning maintenance mode off?</h4>
<p>Easy. Open settings and scroll down to <em>Temporary Access Link</em>. Send him that link and he'll be able to reach the site in normal fashion.</p>
<hr>
<h3 id="credits"><strong>E) Sources and Credits</strong> - <a href="#toc">top</a></h3>
<p>The following PHP related assets and other copyrighted materials were used in this script's code:</p>
<ul>
<li><strong>jQuery</strong><br>www.jquery.com<br>Licenced under MIT and GNU GPL version 2</li>
<li><b>Countdown for jQuery</b><br />
http://keith-wood.name/countdown.html<br>
Written by Keith Wood, January 2008.<br>
Dual licensed under the GPL and MIT licenses
</li>
<li><b>jQuery Progress Bar plugin</b><br />
Copyright (c) 2008 Gary Teo<br />
http://t.wits.sg/<br />
GPL Licence
</li>
<li><b>Plush Icons Set</b><br />
by Cuberto-ru<br />
http://cuberto-ru.deviantart.com/art/Plush-Icons-Set-172873075<br />
free for all uses
</li>
<li><b>Free Icon Set for Web Developers: Coded</b><br>
by Thomas McGee<br>
http://www.smashingmagazine.com/2010/12/23/free-icon-set-for-web-developers-coded/<br>
free and without any restrictions
</li>
<li><b>Stock photo: Wheelbarrow</b><br>
by brokenarts<br>
http://www.sxc.hu/photo/206210<br>
free for use on websites
</li>
<li><b>Retro Toys: A Free Icon Set</b><br>
by Helen Gkizi<br>
http://www.smashingmagazine.com/2009/05/10/retro-toys-a-free-icon-set/<br>
completely free and may be used for any private or commercial project without any restrictions
</li>
<li><b>Switch icon</b><br>
by Mickka<br>
http://mickka.deviantart.com/art/Switch-icon-145997284<br>
free for all use
</li>
</ul>
<hr>
<p>Once again, <strong>thank you</strong> 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.</p>
<p class="append-bottom alt large"><strong>Web factory Ltd.</strong></p>
<p><a href="#toc">Go To Table of Contents</a></p>
<hr class="space">
</div><!-- end div .container -->
</body>
</html>