Файл: documentation/index.html
Строк: 597
<?php
<!doctype html>
<!--[if IE 6 ]><html lang="en-us" class="ie6"> <![endif]-->
<!--[if IE 7 ]><html lang="en-us" class="ie7"> <![endif]-->
<!--[if IE 8 ]><html lang="en-us" class="ie8"> <![endif]-->
<!--[if (gt IE 7)|!(IE)]><!-->
<html lang="en-us"><!--<![endif]-->
<head>
<meta charset="utf-8">
<title>myCaptcha - Powerful Human Verificator with Dictionary Maker</title>
<meta name="description" content="Thank you for purchasing my script. If you have any questions that are beyond the scope of this help file, please feel free to email via my user page contact form here. Thanks so much!">
<meta name="author" content="Alterna Networks">
<meta name="copyright" content="Alterna Networks">
<meta name="generator" content="Documenter v1.6 http://rxa.li/documenter">
<meta name="date" content="2012-04-01T00:00:00+02:00">
<link rel="stylesheet" href="css/documenter_style.css" media="all">
<link rel="shortcut icon" type="image/x-icon" href="favicon.ico" />
<script src="js/jquery.1.6.4.js"></script>
<script src="js/jquery.scrollTo-1.4.2-min.js"></script>
<script src="js/jquery.easing.js"></script>
<script>document.createElement('section');var duration=500,easing='swing';</script>
<script src="js/script.js"></script>
<style>
html{background-color:#EEEEEE;color:#383838;}
::-moz-selection{background:#333636;color:#00DFFC;}
::selection{background:#333636;color:#00DFFC;}
#documenter_sidebar #documenter_logo{background-image:url(assets/images/image_1.png);}
a{color:#008C9E;}
hr{border-top:1px solid #D4D4D4;border-bottom:1px solid #FFFFFF;}
#documenter_sidebar, #documenter_sidebar ol a{background-color:#343838;color:#FFFFFF;}
#documenter_sidebar ol a{-webkit-text-shadow:1px 1px 0px #494F4F;-moz-text-shadow:1px 1px 0px #494F4F;text-shadow:1px 1px 0px #494F4F;}
#documenter_sidebar ol{border-top:1px solid #212424;}
#documenter_sidebar ol a{border-top:1px solid #494F4F;border-bottom:1px solid #212424;color:#FFFFFF;}
#documenter_sidebar ol a:hover{background:#333636;color:#00DFFC;border-top:1px solid #333636;}
#documenter_sidebar ol a.current{background:#333636;color:#00DFFC;border-top:1px solid #333636;}
#documenter_copyright{display:block !important;visibility:visible !important;}
</style>
</head>
<body>
<div id="documenter_sidebar">
<a href="#documenter_cover" id="documenter_logo"></a>
<ol id="documenter_nav">
<li><a class="current" href="#documenter_cover">Start</a></li>
<li><a href="#description">Description</a></li>
<li><a href="#out_of_the_box">Out of the box</a></li>
<li><a href="#starting">Starting</a></li>
<li><a href="#implementation">Implementation</a></li>
<li><a href="#configuration">Configuration</a></li>
<li><a href="#qrcode_helper">qrCode Helper</a></li>
<li><a href="#dictionary_maker">Dictionary Maker</a></li>
<li><a href="#final_lines">Final lines</a></li>
</ol>
<div id="documenter_copyright">Copyright Alterna Networks 2012<br>
made with the <a href="http://rxa.li/documenter">Documenter v1.6</a>
</div>
</div>
<div id="documenter_content">
<section id="documenter_cover"><h1>myCaptcha</h1><h2>Powerful Human Verificator with Dictionary Maker</h2><hr><ul><li>Created: 04/01/2012</li><li>latest Update: 04/01/2012</li><li>By: Alterna Networks</li><li><a href=""></a></li><li>Email: <a href="mailto:ask@alternanetworks.com">ask@alternanetworks.com</a></li></ul><p>Thank you for purchasing my script. If you have any questions that are beyond the scope of this help file, please feel free to email via my user page contact form here. Thanks so much!</p></section><section id="description">
<h3>Description</h3><hr class="notop">
<p>
<strong>myCaptcha </strong>is a Powerful Human Verification System who make your site "bots safe" by adding A <a href="http://en.wikipedia.org/wiki/Turing_test">Touring Test </a>to prevent SPAM, Repeated Actions or just to verify Intelligence. </p>
<blockquote>
<p>
We've Packed a lot of useful and unique features like "<strong>The dictionary Maker</strong>", who make dictionaries ready to use with only the desired number of chars.</p>
</blockquote>
<p>
<strong>Main Features:</strong></p>
<ul>
<li>
<strong>Easy to implement.</strong></li>
<li>
<strong>Dictionary Maker.</strong></li>
<li>
Use an <strong>array </strong>as challenge or <strong>data from Database.</strong></li>
<li>
<strong>qrCode Helper</strong>, scan to see challenge.</li>
<li>
Custom Fonts.</li>
<li>
<strong>Custom Patterns</strong>, use only the Chars you want, even from non-Latin!</li>
<li>
Use <strong>directly on your PHP files</strong> or html.</li>
<li>
Return as Image or <strong>base64 </strong>encoded Image.</li>
<li>
<strong>Multi instance.</strong></li>
<li>
Use Different challenges / dictionaries for <strong>each user!</strong></li>
<li>
Use custom Backgrounds or Solid Colors.</li>
<li>
<strong>Everything is configurable</strong>; From the Angle to Size.</li>
<li>
Wave effect to Text, Image or Both.</li>
<li>
<strong>Fully AJAX Support, </strong>demo<strong> INCLUDED!</strong></li>
<li>
3 Dictionaries Included with more than <strong>50000 words!</strong></li>
<li>
Clean design.</li>
<li>
<strong>OOP code.</strong><br>
</li>
</ul>
<p>
<strong>Requirements:</strong></p>
<ul>
<li>
PHP 5x</li>
<li>
GD</li>
<li>
CURL</li>
</ul>
<p>
Notes:</p>
<p class="warning">
Almost hosting providers like hostgator.com, 1and1.com and dreamhost supports php 5.x, GD, and CURL.</p>
</section>
<section id="out_of_the_box">
<h3>Out of the box</h3><hr class="notop">
<p>
<strong>Out of the box:</strong></p>
<p>
<em>We love our costumers, so, why don't put REAL world stuff in our package?</em></p>
<ul>
<li>
<strong>myCaptcha </strong>framework</li>
<li>
Full documentation</li>
<li>
<strong>Dictionary Maker</strong></li>
<li>
<strong>Full AJAX Example</strong></li>
<li>
3 Dictionaries with more than 50000 words.
<ul>
<li>
Default dictionary</li>
<li>
Iliad by Homer - dictionary</li>
<li>
Alice in Wonderland - dictionary</li>
</ul>
</li>
<li>
12 Configuration Examples.</li>
</ul>
<p>
</p>
<p>
</p>
<p>
<strong>Fonts used in demos:</strong><br>
<br>
<img alt="" src="assets/images/image_3.png" style="width: 256px; height: 180px;"><br>
You can get for free at dafont.com</p>
<p class="warning">
<strong>Fonts not included!</strong> you can get a lot in <a href="http://dafont.com">http://dafont.com</a></p>
</section>
<section id="starting">
<h3>Starting</h3><hr class="notop">
<p>
To include <strong>myCaptcha </strong>in your projects you need to include <strong>load.php</strong> at top of your project file.</p>
<p>
<img alt="Including" src="assets/images/image_25.png" style="width: 438px; height: 60px;"></p>
<p>
<strong>STEPS:</strong></p>
<ol>
<li>
Include the <strong>load.php</strong> file.</li>
<li>
<strong>Initialize </strong>the class.</li>
<li>
<strong>Write </strong>your Image.</li>
</ol>
<p class="warning">
At this point you're ready to kick some bots.</p>
</section>
<section id="implementation">
<h3>Implementation</h3><hr class="notop">
<p>
<strong>Implementation of myCaptcha is really easy:</strong></p>
<ul>
<li>
Unzip the downloaded file from <strong>CodeCanyon</strong></li>
<li>
Upload the files to your root or desired working project directory</li>
<li>
You're ready to go!</li>
</ul>
<p>
<strong>Implementation:</strong></p>
<p>
<img alt="basic" src="assets/images/image_2.png" style="width: 511px; height: 361px;"></p>
<p>
To grab and compare the challenge for above example you must execute the <strong>challenge </strong>method:</p>
<p>
<img alt="" src="assets/images/image_8.png" style="width: 428px; height: 51px;"></p>
<p class="warning">
<strong>myCaptcha </strong>has a lot of configuration options to easy match your site or preferences!.</p>
<p>
</p>
</section>
<section id="configuration">
<h3>Configuration</h3><hr class="notop">
<p>
<strong>myCaptcha </strong>has a lot of configuration options:</p>
<p>
The constructor must be initialized with a<strong> unique ID</strong> if you want to use in multiple instances.</p>
<p>
<img alt="" src="assets/images/image_15.png"></p>
<p>
<strong>Functions to customize:</strong></p>
<p>
<strong>font</strong>:<br>
Font to use in challenge. Font must be placed at fonts dir.</p>
<p>
<img alt="" src="assets/images/image_18.png"></p>
<p>
<strong>fontSize</strong>:<br>
Specify the size of font in pixels.<br>
<img alt="" src="assets/images/image_14.png"></p>
<p>
<strong>fontAngle</strong>:<br>
Determines the maximum random angle to show challenge text, set 0 to disable.<br>
<img alt="" src="assets/images/image_22.png"></p>
<p>
useFontWave:<br>
Set true to enable font Wave effect.<br>
<img alt="" src="assets/images/image_19.png"></p>
<p>
<strong>fontWaveX </strong>and <strong>fontWaveY</strong>:<br>
Configure the effect of Wafe for text challenge<br>
<img alt="" src="assets/images/image_17.png"></p>
<p>
<strong>pattern</strong>:<br>
Use only the charst you want to make your challenges.</p>
<p>
<img alt="" src="assets/images/image_4.png"></p>
<p>
<strong>lenght</strong>:<br>
Lenght of challenge.<br>
<img alt="" src="assets/images/image_20.png"></p>
<p>
<strong>dictionary</strong>:<br>
Dictionary to use, must be a dictionary generated by the Dictionary Maker or an array of items.<br>
<img alt="" src="assets/images/image_21.png"></p>
<p>
<img alt="" src="assets/images/image_23.png"></p>
<p>
<strong>useDictionary</strong>:<br>
Set to true to use above options, set false to make challenges based on pattern. Dictionaries must be placed at dictionary dir.<br>
<img alt="" src="assets/images/image_7.png"></p>
<p>
<strong>width </strong>and <strong>height</strong>:<br>
Set the Width and Height of your challenge Image.<br>
<img alt="" src="assets/images/image_16.png"></p>
<p>
<strong>useBg</strong>:<br>
Set to true to enable background image, or false to use a solid color.<br>
<img alt="" src="assets/images/image_13.png"></p>
<p>
<strong>bg</strong>:<br>
Select the image to show as background, useBg must be set to true. Images must be placed at backgrounds dir.<br>
<img alt="" src="assets/images/image_11.png"><br>
<strong>color </strong>and <strong>bgColor</strong>:<br>
Change the color and background color of challenge in HEX colors.</p>
<p>
<img alt="" src="assets/images/image_9.png"><br>
<strong>base64</strong>:<br>
Set to true to return image as base64 encoded image.<br>
<img alt="" src="assets/images/image_12.png"></p>
<p>
<strong>image</strong>:<br>
Print the image, use at bottom of your configurations.<br>
<img alt="" src="assets/images/image_5.png"><br>
</p>
<p>
<strong>Validating:</strong></p>
<p>
To get the challenge value for make your server side comparation you must use the challenge method:</p>
<p>
<img alt="" src="assets/images/image_8.png" style="width: 428px; height: 51px;"></p>
<p>
Above code grab the value of current challenge and put ready to compare, if challenge doesn't exists will return false.</p>
<p class="warning">
<strong style="background-color: rgb(240, 254, 177); ">Special Note</strong><span style="background-color: rgb(240, 254, 177); ">: Challenge is stored in unique session id</span>.</p>
</section>
<section id="qrcode_helper">
<h3>qrCode Helper</h3><hr class="notop">
<p>
<strong>myCaptcha </strong>is bundled with a useful qrCode helper: <strong>Scan </strong>-> <strong>Read </strong>-> <strong>Write </strong>-> <strong>Validate</strong>.</p>
<p>
<strong>You can display it as Image or Base64 Encoded Image.</strong><br>
<br>
To use you must run the <strong>qr</strong> method:</p>
<p>
<img alt="" src="assets/images/image_24.png"></p>
<p>
<strong>Parameters</strong>:</p>
<ol>
<li>
<strong>ID </strong>of the challenge, <strong>must be the same</strong> from other methods.</li>
<li>
Size in pixels of qrcode.</li>
<li>
Set to true to use base64 Encoded Image or false to use as regular Image.</li>
</ol>
<p>
<img alt="" src="assets/images/image_6.png" style="width: 529px; height: 213px;"></p>
</section>
<section id="dictionary_maker">
<h3>Dictionary Maker</h3><hr class="notop">
<p>
<strong>MyCaptcha </strong>is Bundled with a powerful <strong>Dictionary Maker </strong></p>
<p>
<img alt="dictionary maker" src="assets/images/image_10.png" style="width: 1024px; height: 429px;"></p>
<blockquote>
<p>
Dictionary Maker is an easy way to make different dictionaries based on content, language or theme!</p>
<p>
You can build one for every user, type of user or visitor!</p>
</blockquote>
</section>
<section id="final_lines">
<h3>Final lines</h3><hr class="notop">
<p>
Once again, thank you so much for purchasing this script. As I said at the beginning, I'd be glad to help you if you have any questions relating to this script. No guarantees, but I'll do my best to assist. If you have a more general question relating to the script on CodeCanyon, you might consider visiting the forums and asking your question in the "Item Discussion" section.</p>
<p>
<strong>Alterna Networks</strong></p>
</section>
</div>
</body>
</html>
?>