DEPRECATION WARNING
This documentation is not using the current rendering mechanism and is probably outdated. The extension maintainer should switch to the new system. Details on how to use the rendering mechanism can be found here.
Tip-A-Friend Plus¶
| Created: | 2004-04-01T17:27:57 |
|---|---|
| Changed by: | Nicole Cordes |
| Changed: | 2013-05-30T21:42:53.110000000 |
| Author: | Nicole Cordes |
| Email: | cordes@cps-it.de |
| Info 3: | |
| Info 4: |
Tip-A-Friend Plus¶
Extension Key: tipafriend_plus
Copyright 2013, Nicole Cordes, <cordes@cps-it.de>
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¶
Tip-A-Friend 1
Introduction 1
What does it do? 1
User Manual 1
Add a Form 1
Add a Link 1
Add a Link on every page 1
Sheet: General 2
Sheet: Email-Texts 2
Configuration 3
TypoScript Constants Reference 3
Update 3
Introduction¶
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.
User Manual¶
Add a Form¶
The frontend-form can be added everywhere on the site as a content- element. The PID of this page has to be used later to configure the links to the form. Set this page as “hidden in the menu”, so it doesn't appear in the menu tree.
Add a Link¶
A single link can be added everywhere as a content element. Change the code in the general-sheet to TIPLINK. Set the link over the PIDtipform constant in TS or with the Constant Editor.
Add a Link on every page¶
To add a link on every page with TypoScript add something like this in the setup-field of the template and map it to the desired element:
lib.tipafriend = USER
lib.tipafriend {
userFunc = tx_tipafriendplus_pi1->main
code = TIPLINK
value = Recommend this page
typolink.parameter = {$plugin.tipafriend_plus.PIDtipForm}
typolink.target = _self
typolink.ATagParams = {$plugin.tipafriend_plus.ATagParams}
}
Flexform-Sheet: General¶
Code
TIPFORM¶
FIELD
TIPFORM
Description
Displays the form in which to enter the email address of the recipient.
TIPLINK¶
FIELD
TIPLINK
Description
Makes a link from the current page to the TIPFORM page.
Admit Html-Mail Option:
If checked a checkbox that allows the user to send html-mails will appear in the frontend-send-form.
Disclaimer:
Diclaimer text for frontend-send-form.
Flexform-Sheet: Email-Texts¶
Email : Subject
The subject field of the email. If left empty a default value will be used. Default (eng) : “Tip: Check this”.
Email: Text between sender and URL
The text that appears in the email body after the sender and before the link to the recommended page. If left empty a default value will be used. Default (eng): “wants you to take a look at this link:”
Email: Text before Message
The text that appears in the email body before the message. If left empty a default value will be used. Default (eng): “Message:”
Email: Footer
The text that appears in the email body at the end. If left empty a default value will be used. Default (eng): “Best regards”
Configuration¶
TypoScript Constants Reference¶
PIDtipForm¶
Property
PIDtipForm
Data type
Int
Description
Set the PID for the links to the form-page
Example:
plugin.tipafriend_plus.PIDtipForm = 17
Default
htmlMail¶
Property
htmlMail
Data type
Boolean
Description
Has to be set to 1 to allow Html-Mails.
Example:
plugin.tipafriend_plus.htmlMail = 1
To be able to send Html-Mail it is also necessary to include the following in your TS-config:
page.config.incT3Lib_htmlmail = 1
Default
0
templateFile¶
Property
templateFile
Data type
String
Description
Choose the desired template file.
Example:
plugin.tipafriend_plus.templateFile = EXT:tipafriend_plus/pi1/tipafriend_plus_template.tmpl
Default
EXT:tipafriend_plus/pi1/tipafriend_plus_css.tmpl
ATagParams¶
Property
ATagParams
Data type
String
Description
Add addiotional parameter to the link, e.g a class
Example:
plugin.tipafriend_plus.ATagParams = class="tipafriend"
Default
class="tx_tipafriend_tiplink"
Update¶
In case an old version of typafriend was used: If a customized version of the template was used, the freeCap CAPTCHA has to be included in the template.
Old code:
<TR bgcolor="###GC1###"><TD>###GW1B###Repeat code: *###GW1E###<BR>###GW2B###(To prevent misuse of this form we kindly ask you to read the letters in the image and repeat them in the form field.)###GW2E###</TD><TD></TD><TD>###CAPTCHA_HTML###<input type="text" size=30 name="TIPFORM[captchaResponse]" value=""></TD></TR>
New code with sc_freecap:
<!--###CAPTCHA_INSERT### this subpart is removed if CAPTCHA is not enabled! --><TR bgcolor="###GC1###"><TD>###GW1B###Repeat code: *###GW1E###<BR>###GW2B###(To prevent misuse of this form we kindly ask you to read the letters in the image and repeat them in the form field.)###GW2E###</TD><TD></TD><TD>###SR_FREECAP_IMAGE###<input type="text" size="15" id="tx_your_extension_id_pi1_captcha_response" name="TIPFORM[captcha_response]" title="###SR_FREECAP_NOTICE###" value=""></TD></TR><!--###CAPTCHA_INSERT###-->
Update from version 0.1.6¶
If you use an own (modified) template you have to make sure you submit the proper tipHash according to the used tipUrl format. Please see the current extension template and use one of the provided marker ###HASH###, ###HASH_ENCODED### or ###HASH_SPECIALCHARS###
Furthermore since version 0.1.7 it is possible to render the tip-a-friend link without any template file. Please see an example above in the user manual part.
Tip-A-Friend Plus - 4