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


============
Tip-A-Friend
============

:Created:
      2004-04-01T17:27:57

:Changed by:
      Thorsten Kahler

:Changed:
      2010-02-17T12:18:42

:Author:
      Kasper Skårhøj

:Email:
      kasper@typo3.com

:Info 3:


:Info 4:


.. _Tip-A-Friend:

Tip-A-Friend
============

Extension Key:  **tipafriend**

Copyright 2004, Kasper Skårhøj, <kasper@typo3.com>

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

**Tip-A-Friend 1**

**Introduction 1**

What does it do? 1

**Users manual 2**

**Administration 2**

**Configuration 2**

**Known problems 2**

**To-Do list 2**

**Changelog 2**


.. _Introduction:

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


.. _What-does-it-do:

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

The extension draws a form which allows the website user to send a
local link to another email address with a comment attached.

|img-1|


.. _Users-manual:

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

This extension provides one frontend plugin which is usually
completely set up and configured by an administrator.


.. _Administration:

Administration
--------------


.. _Configuration:

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

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


.. _templateFile:

templateFile
^^^^^^^^^^^^

.. container:: table-row

   Property
         templateFile
   
   Data type
         resource
   
   Description
         The template-file.
         
         See example in 'media/scripts/tipafriend\_template.tmpl'
   
   Default
         EXT:tipafriend/pi/tipafriend\_template.tmpl



.. _code:

code
^^^^

.. container:: table-row

   Property
         code
   
   Data type
         string /stdWrap
   
   Description
         Code to define, what the script does. Case sensitive.
   
   Default



.. _defaultCode:

defaultCode
^^^^^^^^^^^

.. container:: table-row

   Property
         defaultCode
   
   Data type
         string
   
   Description
         The default code (see above) if the value is empty. By default it's
         not set and a help screen will appear
   
   Default



.. _wrap1:

wrap1
^^^^^

.. container:: table-row

   Property
         wrap1
   
   Data type
         ->stdWrap
   
   Description
         Global Wrap 1. This will be splitted into the markers ###GW1B### and
         ###GW1E###. Don't change the input value by the settings, only wrap it
         in something.
         
         **Example:**
         
         wrap1.wrap = <B> \|</B>
   
   Default



.. _wrap2:

wrap2
^^^^^

.. container:: table-row

   Property
         wrap2
   
   Data type
         ->stdWrap
   
   Description
         Global Wrap 2 (see above)
   
   Default



.. _color1:

color1
^^^^^^

.. container:: table-row

   Property
         color1
   
   Data type
         string /stdWrap
   
   Description
         Value for ###GC1### marker (Global color 1)
   
   Default



.. _color2:

color2
^^^^^^

.. container:: table-row

   Property
         color2
   
   Data type
         string /stdWrap
   
   Description
         Value for ###GC2### marker (Global color 2)
   
   Default



.. _color3:

color3
^^^^^^

.. container:: table-row

   Property
         color3
   
   Data type
         string /stdWrap
   
   Description
         Value for ###GC3### marker (Global color 3)
   
   Default



.. _typolink:

typolink
^^^^^^^^

.. container:: table-row

   Property
         typolink
   
   Data type
         ->typolink
   
   Description
         TypoLink configuration for the TIPLINK to the TIPFORM page.
         .additionalParams is added the parameter “&tipUrl=”
   
   Default



.. _htmlmail:

htmlmail
^^^^^^^^

.. container:: table-row

   Property
         htmlmail
   
   Data type
         boolean
   
   Description
         If set, the page is fetched as HTML and send in HTML (a plain text
         version is sent as well).
   
   Default
         0


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

[tsref:plugin.tipafriend]


.. _Known-problems:

Known problems
--------------


.. _To-Do-list:

To-Do list
----------


.. _Changelog:

Changelog
---------

|img-2| Tip-A-Friend - 2


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

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

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