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.
EXT: Viral Mail (Linktip)¶
Author: | Kasper Skårhøj |
---|---|
Created: | 2002-11-01T00:32:00 |
Changed: | 2011-04-19T18:23:16.210000000 |
Classification: | mbviralmail |
Description: | Easy to handle and comfortable Extension for Linktips. Also saves the number of Submitions on page-basis. forAdmins (use this for Administrators) forDevelopers (use this for Developers) forBeginners (manuals covering TYPO3 basics) forIntermediates (manuals going into more depth) |
Keywords: | viral, mail, viralmail, link, tip, linktip |
Author: | Markus Brunner |
Email: | mail@markusbrunner-design.de |
URL: | http://www.markusbrunner-design.de |
Language: | en |
EXT: Viral Mail (Linktip) - mbviralmail
EXT: Viral Mail (Linktip)¶
Extension Key: mbviralmail
Language: en
Keywords: viral, mail, viralmail, link, tip, linktip
Copyright 2000-2008, Markus Brunner, <mail@markusbrunner-design.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.org
Table of Contents¶
`Introduction 3 <#1.1.Introduction|outline>`_
`Users manual 6 <#1.2.Users%20manual|outline>`_
`Administration 8 <#1.3.Administration|outline>`_
`Configuration 9 <#1.4.Configuration|outline>`_
`Tutorial 12 <#1.5.Tutorial|outline>`_
`Known problems 13 <#1.6.Known%20problems|outline>`_
`To-Do list 14 <#1.7.To-Do%20list|outline>`_
`ChangeLog 15 <#1.8.ChangeLog|outline>`_
`HowTo update a manual to the new layout 17 <#2.1.HowTo%20update%20a %20manual%20to%20the%20new%20layout|outline>`_
`Issues with Open Office documentation for TYPO3 18 <#2.2.Issues%20w ith%20Open%20Office%20documentation%20for%20TYPO3|outline>`_
Introduction¶
What does it do?¶
- Displays a form for the submit of a link tip. For the reason that this is a very important feature to get to know your website, it is like viral marketing → viral mail.
- Furthermore it has the possibility to only show a link (text or/and picture) to minimize the needed place. Via Jquery the form pops up.
- Additionally the submit of a linktip for a page can be counted. Therefore the table “pages” gets an additional field. With the second Frontend-Plugin included you can output the statistic of the counters for all pages. Additionally you see the counter in the Page-Setup in the Tab “Extended”:
Users manual¶
Viral Mail Form¶
After installation of the extension in the Extension Manager, you can insert the Viral Mail plugin (pi1) on each page as a Content Element.
Select the Plugin
...and Save
Now you can configure the Plugin Output in the Template (mbviralmail/res/template.tpl → not necessary) and via TypoScript (not necessary if you include the static TypoScript-File to your Main Template) or change the Language-Output (mbviralmail/pi1/locallang.xml and mbviralmail/pi2/locallang.xml)
Viral Mail Statistic¶
After installation of the extension in the Extension Manager, you can insert the Viral Mail plugin (pi2) on each page as a Plugin. But you usually will include this Plugin only on an Admin-Page which isn't visible for normal Frontend-Users.
Select a plugin e.g. Viral Mail Form (see above)
In the setup under the tab Plugin, select the Plugin “Viral Mail Statistic Output”
...and Save
Administration¶
This Extension produces no own database-tables, so there are no exclude-fields. There's nothing to do in this section.
Configuration¶
At first include the static TypoScript-File “Viral Mail Form (mbviralmail)” into your Main Template:
FAQ¶
Why doesn't the plugin work correctly?
Did you include the Static TypoScript Template?
How to send HTML-Mails?
TypoScript: plugin.tx_mbviralmail_pi1.htmlmail = 1
How to hide the name-input-field?
TypoScript: plugin.tx_mbviralmail_pi1.hidefromfield = 1
How to hide the textarea-field?
TypoScript: plugin.tx_mbviralmail_pi1.hidetextfield = 1
How to deactivate the JavaScript version?
TypoScript: plugin.tx_mbviralmail_pi1.usejavascript = 0
How to influence the time how long the form shows before disappearing after a successful submit?
TypoScript: plugin.tx_mbviralmail_pi1.closingtime = 5000 [in Milliseconds!]
How to get a copy of each link tip via mail (CC)?
TypoScript: plugin.tx_mbviralmail_pi1.postmastermail = yourmailname@domain.com
How to change the Mailtext or Subject?
Mailtext or Subject are like other language-specific text-outputs, located in the plugin-specific Language-File (mbviralmail/pi1/locallang.xml for the form and mbviralmail/pi2/locallang.xml for the statistic)
How to use Images in HTML Mails?
- Use the Upload-Folder, that can be specified via TypoScript: plugin.tx_mbviralmail_pi1.uploadfolder = fileadmin/user_uploads/ [this is default]
- You can use the Upload-Folder-Setting in the template mbviralmail/res/template.tpl in the SubPart ###PARTVIRALMAILHTML### with <img src=”###UPLOADFOLDER###mypic.gif” />
Reference¶
Change of the Form¶
You can configure the whole output of a form in the file mbviralmail/res/template.tpl in the Subpart ###VIRALMAILFORM###.
You have these markers:
###ACTION### = embed-Page###LEGEND### = Locallang###REACTIONCLASS### = .success/.error###REACTION### = Locallang reaction.success/reaction.error###LABELMAIL### = Locallang labelmail###INFOMAIL### = Locallang infomail###VALUEMAIL### = POST- VALUE###LABELFROM### = Locallang labelfrom###INFOFROM### = Locallang infofrom###VALUEFROM### = POST-VALUE###HIDEFROM### = css-class display-none if TS: hidefromfield = 1###VALUESUBMIT### = Locallang valuesubmit
Change of the Mail¶
You can configure the whole output of a text- or html-mail in the file mbviralmail/res/template.tpl.
- HTML-Mail is in the Subpart ###PARTVIRALMAILHTML###
- TEXT-Mail is in the Subpart ###PARTVIRALMAILTEXT###
Additionally to the text you can enter, you have these markers to fill the mail:
###UPLOADFOLDER### = TS: uploadfolder = fileadmin/user_uploads/ [only HTML-Mail]###LINK### = embed-Page-Link###MAILTEXT### = Locallang mailtxt###SENDFROM### = POST-VALUE (who has sends the mail)###SENDTEXT### = POST-VALUE (what message is send with the link tip)
TypoScript¶
template¶
Property
template
Data type
string
Description
If you don't wann use the standard Template-File (mbviralmail/res/template.tpl), enter the path to your own template (e.g. fileadmin/templates/viralmail.tpl).
Default
empty
html_mail¶
Property
html_mail
Data type
boolean
Description
Choose if you wanna send HTML-Mails (1) instead of TEXT-Mails (0).
Default
0
upload_folder¶
Property
upload_folder
Data type
string
Description
Fills the template marker with a path to an image-folder usable within HTML-Mails.
Default
fileadmin/user_uploads/
postmaster_mail¶
Property
postmaster_mail
Data type
string
Description
Mail-Address for CC
Default
empty
hide_from_field¶
Property
hide_from_field
Data type
boolean
Description
You can hide the from-field in the Form-Output.
Default
0
show_locallang_from_and_post_var_from¶
Property
show_locallang_from_and_post_var_from
Data type
boolean
Description
Choose if both Locallang 'from_name' and Post-Var 'from' should be visible in mail.
Default
0
hide_text_field¶
Property
hide_text_field
Data type
boolean
Description
You can hide the text-field in the Form-Output.
Default
0
reply_email¶
Property
reply_email
Data type
string
Description
Here you can enter an email which users get as a reply email, when they wanna answer in their E-Mail-Client.
Default
use_javascript¶
Property
use_javascript
Data type
boolean
Description
Here you can choose if you wanna take advantage of the JavaScript- Functions for hiding and showing the form. Otherwise the form is visible permanentely.
Default
1
use_mootools¶
Property
use_mootools
Data type
boolean
Description
If you enable this option, mootools is used instead of JQuery
Default
0
js_framework_already_included¶
Property
js_framework_already_included
Data type
boolean
Description
If you have already included a Framework-Version, activate this option to prevent the extension from loading a second Framework-Version.
Default
0
use_js_dollar_conflict_mode¶
Property
use_js_dollar_conflict_mode
Data type
boolean
Description
It normally includes a JS-File, which prevents a crash between different JavaScript-Frameworks like Mootools (or Jquery if used with Mootools), which have the same $ Function. By this option, instead of $ → $j (Jquery) AND $m (Mootools) is used instead.
Default
1
statistic_storage_folder_pid¶
Property
statistic_storage_folder_pid
Data type
int
Description
PID of the Folder in which all the statistic-entries are stored.
Default
1
Include the Extension via TypoScript¶
This is only an example and reflects the whole needed TypoScript, so no static-TypoScript-File is neede furthermore. Of course you don't need this, if you include the plugin as a Content Element.
page = PAGE
page.typeNum = 0
plugin.tx_mbviralmail_pi1 {
### Mail-Properties ###
# Template-File
template =
# choose if html (1) or text (0) mail
html_mail = 0
# for pictures in html mail
upload_folder = fileadmin/user_uploads/
# Mail-Address for CC
postmaster_mail =
# From-Property
hide_from_field = 0
show_locallang_from_and_post_var_from = 0
# Text Property
hide_text_field = 0
# Reply-Property
reply_email = noreply@domain.com
### JavaScript ###
# Enable JavaScript Functions
use_javascript = 1
# enable the mootools-Framework instead of JQuery
use_mootools = 0
# If JS-Library is already embedded turn this option on
js_framework_already_included = 0
# If js_framework_already_included = 1, this option has no effect, otherwise the framework uses $j (JQuery) OR $m (Mootools) instead of $
use_js_dollar_conflict_mode = 1
# Closing Time after successful Submit (Milliseconds)
closing_time = 5000
# Statistic-Storage-Folder
statistic_storage_folder_pid = 1
}
page.10 < plugin.tx_mbviralmail_pi1
Tutorial¶
See Users Manual and Configuration .
Known problems¶
Corrupted Links in some E-Mail-Clients when using GET-Parameters instead of Real-Url (e.g. Outlook Express 6: http://localhost/typo3_master/index.php?idF&idF )
To-Do list¶
Resolve Problem: Mootools using the Dollar-Conflict-Mode is not working