.. You may want to use the usual include line. Uncomment and adjust the path. 
.. include:: ../Includes.txt

.. role:: underline


==============
EXT: MathGuard
==============

:Author:
      Kasper Skårhøj

:Created:
      2002-11-01T00:32:00

:Changed:
      2009-05-26T09:54:53

:Author:
      Dev-Team Typoheads

:Email:
      rf@typoheads.at

:Info 3:


:Info 4:


.. _EXT-MathGuard:

EXT: MathGuard
==============

Extension Key:  **mathguard**

Copyright 2009, Dev-Team Typoheads, <rf@typoheads.at>

This document is published under the Open Content License

available from http://www.opencontent.org/opl.shtml

The content of this document is related to TYPO3

\- a GNU/GPL CMS/Framework available from www.typo3.com

.. _Table-of-Contents:

Table of Contents
-----------------

**EXT: MathGuard 1**

**Introduction 1**

What does it do? 1

Screenshots 1

**Users manual 2**

Installation 2

Calling the Captcha from your extension 2

**Configuration 2**

TypoScript Configuration 2


.. _Introduction:

Introduction
------------


.. _What-does-it-do:

What does it do?
^^^^^^^^^^^^^^^^

Integrates the captcha script MathGuard
(http://freshmeat.net/projects/mathguard/) to be used by TYPO3
extensions.

*MathGuard is a PHP class that inserts a small piece of HTML code into
your HTML form which requires the user to evaluate an expression
consisting of two random numbers. When user submits the form with the
answer, the answer is hashed and compared to the security code that
has been submitted as well. This way you can easily protect your forms
from spambots. [ `http://freshmeat.net/projects/mathguard/
<http://freshmeat.net/projects/mathguard/>`_ ]*


.. _Screenshots:

*Screenshots*
^^^^^^^^^^^^^

|img-1| Taken from `http://freshmeat.net/projects/mathguard/
<http://freshmeat.net/projects/mathguard/>`_


.. _Users-manual:

Users manual
------------


.. _Installation:

Installation
^^^^^^^^^^^^

Install the extension via the extension manager.


.. _Calling-the-Captcha-from-your-extension:

Calling the Captcha from your extension
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

Get the captcha code:

::

   require_once(t3lib_extMgm::extPath('mathguard') . 'class.tx_mathguard.php');
   
   $captcha = t3lib_div::makeInstance('tx_mathguard');
   $captchaCode = $captcha->getCaptcha();

Validate the captcha:

::

   require_once(t3lib_extMgm::extPath('mathguard') . 'class.tx_mathguard.php');
   
   $captcha = t3lib_div::makeInstance('tx_mathguard');
   $valid = $captcha->validateCaptcha();


.. _Configuration:

Configuration
-------------


.. _TypoScript-Configuration:

TypoScript Configuration
^^^^^^^^^^^^^^^^^^^^^^^^

**plugin.tx\_mathguard: TS configuration.**

.. ### BEGIN~OF~TABLE ###


.. _Settings:

**Settings:**
"""""""""""""

.. container:: table-row

   a
         **Settings:**
   
   b



.. _Property:

Property:
"""""""""

.. container:: table-row

   a
         Property:
   
   b
         Data type:
   
   Description
         Description:
   
   Default
         Default



.. _question:

question
""""""""

.. container:: table-row

   a
         question
   
   b
         String
   
   Description
         Enter a custom string to be shown before the captcha.
         
         This string will get concatenated with the link to the MathGuard
         website.
         
         Example:
         
         TypoScript:
         
         plugin.tx\_mathguard.question = question. Please enter the result into
         the according field.
         
         Output:
         
         :underline:`MathGuard` question. Please enter the result into the
         according field.
   
   Default
         “security question. Please solve:” (plus translations)



.. _color:

color
"""""

.. container:: table-row

   a
         color
   
   b
         String
   
   Description
         Change the color of the output of MathGuard.
         
         You can enter anything that's a valid color in CSS.
         
         Examples:
         
         plugin.tx\_mathguard.color = maroon
         
         plugin.tx\_mathguard.color = #CDCDCD
         
         plugin.tx\_mathguard.color = #222
         
         plugin.tx\_mathguard.color = rgb(123,123,123)
   
   Default
         red


.. ###### END~OF~TABLE ######

|img-2| EXT: MathGuard - 2


.. ######CUTTER_MARK_IMAGES######

.. |img-1| image:: img-1.png
.. :align: left
.. :border: 0
.. :height: 215
.. :id: Grafik1
.. :name: Grafik1
.. :width: 302

.. |img-2| image:: img-2.png
.. :align: left
.. :border: 0
.. :height: 32
.. :id: Graphic1
.. :name: Graphic1
.. :width: 102