.. You may want to use the usual include line. Uncomment and adjust the path. .. include:: ../Includes.txt ========================= 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 |img-1| |img-2| EXT: Viral Mail (Linktip) - mbviralmail .. _EXT-Viral-Mail-Linktip: EXT: Viral Mail (Linktip) ========================= Extension Key: mbviralmail Language: en Keywords: viral, mail, viralmail, link, tip, linktip Copyright 2000-2008, Markus Brunner, 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: Table of Contents ----------------- `EXT: Viral Mail (Linktip) 1 <#1.EXT:%20Viral%20Mail%20(Linktip)|outline>`_ **`Introduction 3 <#1.1.Introduction|outline>`_** `What does it do? 3 <#1.1.1.What%20does%20it%20do_|outline>`_ `Screenshots 4 <#1.1.3.Screenshots|outline>`_ **`Users manual 6 <#1.2.Users%20manual|outline>`_** `Viral Mail Form 6 <#1.2.1.Viral%20Mail%20Form|outline>`_ `Viral Mail Statistic 6 <#1.2.2.Viral%20Mail%20Statistic|outline>`_ `FAQ 7 <#1.2.3.FAQ|outline>`_ **`Administration 8 <#1.3.Administration|outline>`_** **`Configuration 9 <#1.4.Configuration|outline>`_** `FAQ 9 <#1.4.1.FAQ|outline>`_ `Reference 10 <#1.4.2.Reference|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>`_** `Important guidelines 16 <#2.Important%20guidelines|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>`_** `Inserting images 18 <#2.2.1.Inserting%20images|outline>`_ `Paragraph styles 18 <#2.2.2.Paragraph%20styles|outline>`_ `Linking 19 <#2.2.3.Linking|outline>`_ `Meta data and updates 19 <#2.2.4.Meta%20data%20and%20updates|outline>`_ `Help by documentation.openoffice.org 19 <#2.2.5.Help%20by%20documentation.openoffice.org|outline>`_ .. _Introduction: Introduction ------------ .. _What-does-it-do: 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”: .. _Screenshots: Screenshots ^^^^^^^^^^^ .. _Link: Link """" |img-3| .. _Form: Form """" |img-4| .. _Form-Error: Form-Error """""""""" |img-5| .. _Form-Success: Form-Success """""""""""" |img-6| .. _Form-with-disabled-fields-name-text: Form with disabled fields (name, text) """""""""""""""""""""""""""""""""""""" |img-7| .. _Counter-in-Page-Setup-Extended: Counter in Page-Setup “Extended” """""""""""""""""""""""""""""""" |img-8| .. _Counter-Statistic: Counter Statistic """"""""""""""""" |img-9| .. _Users-manual: Users manual ------------ .. _Viral-Mail-Form: 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. |img-10| Select the Plugin |img-11| ...and Save |img-12| 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: 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” |img-13| ...and Save |img-12| .. _FAQ: FAQ ^^^ Is it possible to send HTML-Mails with Images? Yes. .. _Administration: Administration -------------- This Extension produces no own database-tables, so there are no exclude-fields. There's nothing to do in this section. .. _Configuration: Configuration ------------- At first include the static TypoScript-File “Viral Mail Form (mbviralmail)” into your Main Template: |img-14| .. _FAQ: 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 .. _Reference: Reference ^^^^^^^^^ .. _Change-of-the-Form: 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: 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: TypoScript """""""""" .. ### BEGIN~OF~TABLE ### .. _template: template ~~~~~~~~ .. container:: table-row 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: html\_mail ~~~~~~~~~~ .. container:: table-row Property html\_mail Data type boolean Description Choose if you wanna send HTML-Mails (1) instead of TEXT-Mails (0). Default 0 .. _upload-folder: upload\_folder ~~~~~~~~~~~~~~ .. container:: table-row 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: postmaster\_mail ~~~~~~~~~~~~~~~~ .. container:: table-row Property postmaster\_mail Data type string Description Mail-Address for CC Default empty .. _hide-from-field: hide\_from\_field ~~~~~~~~~~~~~~~~~ .. container:: table-row 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: show\_locallang\_from\_and\_post\_var\_from ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. container:: table-row 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: hide\_text\_field ~~~~~~~~~~~~~~~~~ .. container:: table-row Property hide\_text\_field Data type boolean Description You can hide the text-field in the Form-Output. Default 0 .. _reply-email: reply\_email ~~~~~~~~~~~~ .. container:: table-row 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 `noreply@domain.com `_ .. _use-javascript: use\_javascript ~~~~~~~~~~~~~~~ .. container:: table-row 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: use\_mootools ~~~~~~~~~~~~~ .. container:: table-row Property use\_mootools Data type boolean Description If you enable this option, mootools is used instead of JQuery Default 0 .. _js-framework-already-included: js\_framework\_already\_included ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. container:: table-row 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: use\_js\_dollar\_conflict\_mode ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. container:: table-row 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: statistic\_storage\_folder\_pid ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. container:: table-row Property statistic\_storage\_folder\_pid Data type int Description PID of the Folder in which all the statistic-entries are stored. Default 1 .. ###### END~OF~TABLE ###### .. _Include-the-Extension-via-TypoScript: 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: Tutorial -------- See `Users Manual <#1.2.Users%20manual|outline>`_ and `Configuration <#1.4.Configuration|outline>`_ . .. _Known-problems: 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: To-Do list ---------- Resolve Problem: Mootools using the Dollar-Conflict-Mode is not working .. _ChangeLog: ChangeLog --------- See ChangeLog-File in Extension-Root. 15 .. ######CUTTER_MARK_IMAGES###### .. |img-1| image:: img-1.png .. :align: left .. |img-2| image:: img-2.png .. :border: 0 .. :height: 21 .. :hspace: 9 .. :id: Grafik2 .. :name: Grafik2 .. :width: 87 .. |img-3| image:: img-3.png .. :align: left .. :border: 0 .. :height: 36 .. :id: Grafik1 .. :name: Grafik1 .. :width: 86 .. |img-4| image:: img-4.png .. :align: left .. :border: 0 .. :height: 249 .. :id: Grafik3 .. :name: Grafik3 .. :width: 288 .. |img-5| image:: img-5.png .. :align: left .. :border: 0 .. :height: 294 .. :id: Grafik4 .. :name: Grafik4 .. :width: 288 .. |img-6| image:: img-6.png .. :align: left .. :border: 0 .. :height: 294 .. :id: Grafik5 .. :name: Grafik5 .. :width: 288 .. |img-7| image:: img-7.png .. :align: left .. :border: 0 .. :height: 78 .. :id: Grafik6 .. :name: Grafik6 .. :width: 246 .. |img-8| image:: img-8.png .. :align: left .. :border: 0 .. :height: 46 .. :id: Grafik7 .. :name: Grafik7 .. :width: 180 .. |img-9| image:: img-9.png .. :align: left .. :border: 0 .. :height: 80 .. :id: Grafik8 .. :name: Grafik8 .. :width: 182 .. |img-10| image:: img-10.png .. :align: left .. :border: 0 .. :height: 234 .. :id: Grafik10 .. :name: Grafik10 .. :width: 470 .. |img-11| image:: img-11.png .. :align: left .. :border: 0 .. :height: 30 .. :id: Grafik9 .. :name: Grafik9 .. :width: 470 .. |img-12| image:: img-12.png .. :align: left .. :border: 0 .. :height: 38 .. :id: Grafik11 .. :name: Grafik11 .. :width: 99 .. |img-13| image:: img-13.png .. :align: left .. :border: 0 .. :height: 67 .. :id: Grafik12 .. :name: Grafik12 .. :width: 320 .. |img-14| image:: img-14.png .. :align: left .. :border: 0 .. :height: 427 .. :id: Grafik14 .. :name: Grafik14 .. :width: 548