.. You may want to use the usual include line. Uncomment and adjust the path. .. include:: ../Includes.txt ============== EXT: Donations ============== :Author: Kasper Skårhøj :Created: 2002-11-01T00:32:00 :Changed by: François Suter :Changed: 2008-06-23T21:55:45 :Email: typo3@cobweb.ch :Info 2: :Info 3: :Info 4: .. _EXT-Donations: EXT: Donations ============== Extension Key: **donations** Copyright 2007, typo3@cobweb.ch, 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: Donations 1** **Introduction 1** What does it do? 1 Screenshots 1 Credits 1 Questions and support 1 **Users manual 2** Installation 2 Setup 2 Donation process 4 **Administration 6** **Configuration 7** TypoScript Reference 7 Template 8 **To Do List 11** **Known problems 11** **Changelog 11** .. _Introduction: Introduction ------------ .. _What-does-it-do: What does it do? ^^^^^^^^^^^^^^^^ This extension is designed to collect donations on a web site, either for specific projects or in a general way. Using payment extensions (see Installation below) donations can be collected using on-line payment solutions. Although perfectly functional this is still a work in progress so you may have trouble fitting it exactly to your needs. See the To Do List below for details on missing features and future developments. .. _Screenshots: Screenshots ^^^^^^^^^^^ No single screenshot can really sum up what this extension does. Please browse this manual, many screenshots are included. In particular, you may want to refer to the “Donation process” part of the “Users manual” chapter for an overview. .. _Credits: Credits ^^^^^^^ This extension was originally created by Tonni Aagesen. Much of the code is still his as well as the application logic so many thanks go to him. His work got me very nicely kickstarted. The icons used in this extension come from the Silk Icons library ( `http://www.famfamfam.com/lab/icon/silk/ `_ ), a beatiful set of icons developed under the Creative Commons license by Mark James, of Birmingham, UK. .. _Questions-and-support: Questions and support ^^^^^^^^^^^^^^^^^^^^^ If you have questions about this extension please ask them in the general mailing list, so that everyone can benefit from the answers. If you find a bug or want to submit a feature request, use the dedicated bug tracker on the project's home page: http://forge.typo3.org/projects/show/extension-donations. .. _Users-manual: Users manual ------------ .. _Installation: Installation ^^^^^^^^^^^^ This extension requires a few other extensions for working properly: Payment Library (paymentlib), for on-line payment Money Library (moneylib), for formatting currency display Static Info Tables (static\_info\_tables), for information about currencies **It also requires PHP 5** to run because of its dependency on paymentlib. In itself Payment Library is not enough. An implementation for a specific payment gateway is necessary, like paymentlib\_ipayment or paymentlib\_quickpay. .. _Setup: Setup ^^^^^ After installing the extension several steps must be taken before it can to work correctly. **Static template** First of all it is necessary to include the static setup template. |img-1| **Projects** If projects are to be used, then at least one must be defined in the TYPO3 backend. Create a new record in the backend and choose the type “Projects”. It is not necessary to fill out all the fields, but at least a title and an amount must be entered. The amount is the total quantity of money that needs to be raised for the project. **TypoScript setup** A number of properties can be set via TypoScript, besides the defaults found in the static template. However, one setup is absolutely necessary: the definition of the payment methods that will be used for the donations. Without that, it will be impossible to perform donations. |img-2| The static template contains a list of payment methods (the “paymethods” property) that correspond to the paymentlib\_offline extension. This is just an example and serious values should definitely be set for this property. Please refer to the TypoScript Reference below. **Templates** An example template is provided with the donations extension (pi1/example.tmpl). Copy it and transform it according to your needs, without forgetting to change the “template” property in the TypoScript setup accordingly. **Content element** Last but not least, a content element for donations must be inserted in the page where the donations process is going to take place. |img-3| First choose the type “Insert plugin”, then choose the plugin “Donations”. The starting point is optional. If defined, only projects found in the selected page will be displayed in the list. If not, all projects will be displayed. You should now be able to go through a complete donation process, as detailed next. .. _Donation-process: Donation process ^^^^^^^^^^^^^^^^ A complete example donation process is described here so that every step can be properly understood. Sample screenshots are shown where appropriate. **List of projects** |img-4| When projects are used, this is the default view. It lists all projects available for donation. If projects are not being used, this view will never appear (it redirects to the donation view). Projects whose maximum amount has already been reached do not appear in this list. **Project details** This view displays all the details about a single project. It is reached by clicking on the details link of the list view above. If projects are not being used, this view will never appear (it redirects to the donation view). It is possible to go back to the projects list. |img-5| **Donation view** |img-6| This page displays the form where the donation data is entered: payment information, personal data and donation amount. The payment information comes directly from paymentlib and depends on the installed and configured payment gateways. From here, it is possible either to proceed with the payment or to go back to the projects list. **Confirmation view** The confirmation view displays the data entered in the previous step for validation before the payment process is launched. It also checks the input values and redirects to the donation view in case of errors. In such a case, the donation view is called with an error code and displays the appropriate error message. |img-7| **Receipt view** |img-8| If the online payment is successful the user is sent to the receipt view (if it fails, the user is redirect to the confirm view with an error message). This view does not only display a visual confirmation of success, it also stores the donation in the database and sends e-mails as configured. **Mails** If so configured, the donations extensions can send an e-mail both to the donator and to the site administrator. These e-mails are simple text mails, with donation information listed according to the chosen template. .. _Administration: Administration -------------- There's not much to administer in the backend regarding this extension. It is just necessary to know that three types of database entries are used: projects (table tx\_donations\_projects), for describing which projects can be donated to. As was said before, it is possible to do without projects. deposits (table tx\_donations\_deposits), which stores individual donations. transactions (table tx\_paymentlib\_transactions), generated by paymentlib for each payment transaction |img-9| If you have configured both the donations and the paymentlib extensions to store everything at the same place, you should see a view similar to the one above (in List view). .. _Configuration: Configuration ------------- .. _TypoScript-Reference: TypoScript Reference ^^^^^^^^^^^^^^^^^^^^ .. ### BEGIN~OF~TABLE ### .. _template: template """""""" .. container:: table-row Property template Data type resource Description HTML template to be used for displaying the projects list, a project's detail view, the various screens of the donation process and the mails sent to user and admin Default typo3conf/ext/donations/example.tmpl .. _depositsPID: depositsPID """"""""""" .. container:: table-row Property depositsPID Data type int Description uid of the page where the receipts should be stored Default 0 .. _disableProjects: disableProjects """"""""""""""" .. container:: table-row Property disableProjects Data type boolean Description Disable the use of projects. In this case donations are general and not dedicated to a specific project Default 0 .. _defaultCurrency: defaultCurrency """"""""""""""" .. container:: table-row Property defaultCurrency Data type string Description Each project can have a currency associated with it. However you may also define a default currency to be used for all projects or when projects are not used. Value must be the 3-letter ISO code of a currency Default USD .. _errorWrap: errorWrap """"""""" .. container:: table-row Property errorWrap Data type stdWrap Description Wrap for the error messages issued by the plugin Default wrap =
\|
.. _formName: formName """""""" .. container:: table-row Property formName Data type string Description Name of the form (to put in the name or id attribute of the form in the template) Default donateForm .. _paymethods: paymethods """""""""" .. container:: table-row Property paymethods Data type string Description Comma-separated list of all payment methods available (see Setup) Default values correspond to the paymentlib\_offline extension Default paymentlib\_offline\_bank\_check, paymentlib\_offline\_giro, paymentlib\_offline\_cod, paymentlib\_offline\_cash, .. _donateView: donateView """""""""" .. container:: table-row Property donateView Data type ->donateView Description Parameters for the donation view Default .. _confirmView: confirmView """"""""""" .. container:: table-row Property confirmView Data type ->confirmView Description Parameters for the confirmation view Default .. _receiptView: receiptView """"""""""" .. container:: table-row Property receiptView Data type ->receiptView Description Parameters for the receipt view Default .. _thankMessage: thankMessage """""""""""" .. container:: table-row Property thankMessage Data type cObj Description Thank you message to be displayed at the end of the donation process Default thankMessage = TEXT thankMessage.value = Thank you for your donation! thankMessage.wrap =

\|

.. _mail: mail """" .. container:: table-row Property mail Data type ->mail Description Mail configuration Default .. _baseWrap: baseWrap """""""" .. container:: table-row Property baseWrap Data type stdWrap Description This can be used to replace the default wrap of the plugin (
\|
) Default .. ###### END~OF~TABLE ###### [tsref:plugin.tx\_donations\_pi1] **Donate View parameters** .. ### BEGIN~OF~TABLE ### .. _projectTitle: projectTitle """""""""""" .. container:: table-row Property projectTitle Data type stdWrap Description Wrap for displaying the project title A “project” field is available containing the project title Empty it to display nothing Default projectTitle.field = project projectTitle.wrap =

Make a donation to project "\|"

.. _amountMin: amountMin """"""""" .. container:: table-row Property amountMin Data type int Description Wrap for displaying the minimum amount for donation Default amountMin.wrap = (Min: \|, .. _amountMax: amountMax """"""""" .. container:: table-row Property amountMax Data type int Description Wrap for displaying the maximum amount for donation Default amountMax.wrap = Max: \|) .. ###### END~OF~TABLE ###### [tsref:plugin.tx\_donations\_pi1.donateView] **Confirm View parameters** .. ### BEGIN~OF~TABLE ### .. _projectTitle: projectTitle """""""""""" .. container:: table-row Property projectTitle Data type stdWrap Description Wrap for displaying the project title A “project” field is available containing the project title Empty it to display nothing Default projectTitle.field = project projectTitle.wrap =

Confirm details for donation to "\|"

.. ###### END~OF~TABLE ###### [tsref:plugin.tx\_donations\_pi1.confirmView] **Receipt View parameters** .. ### BEGIN~OF~TABLE ### .. _projectTitle: projectTitle """""""""""" .. container:: table-row Property projectTitle Data type stdWrap Description Wrap for displaying the project title A “project” field is available containing the project title Empty it to display nothing Default projectTitle.field = project projectTitle.wrap =

Receipt for donation to "\|"

.. ###### END~OF~TABLE ###### [tsref:plugin.tx\_donations\_pi1.receiptView] **Mail parameters** .. ### BEGIN~OF~TABLE ### .. _sendToAdmin: sendToAdmin """"""""""" .. container:: table-row Property sendToAdmin Data type boolean Description Enable the sending of a mail to the administrator when a donation is done Default 1 .. _sendToUser: sendToUser """""""""" .. container:: table-row Property sendToUser Data type boolean Description Enable the sending of a confirmation mail to the donor Default 1 .. _senderMail: senderMail """""""""" .. container:: table-row Property senderMail Data type string Description E-mail address that should appear in the From field of the mails sent to both admin and user Default `admin@yoursite.com `_ .. _senderName: senderName """""""""" .. container:: table-row Property senderName Data type string Description Name that should appear in the From field of the mails sent to both admin and user Default Site Admin .. _adminMail: adminMail """"""""" .. container:: table-row Property adminMail Data type string Description E-mail of the administrator Default `admin@yoursite.com `_ .. _adminMessage: adminMessage """""""""""" .. container:: table-row Property adminMessage Data type string Description Introductory text at the start of the email to the administrator Default The following donation has been received: .. _adminSubject: adminSubject """""""""""" .. container:: table-row Property adminSubject Data type string Description Subject of the mail received by the administrator Default New donation received .. _userMessage: userMessage """"""""""" .. container:: table-row Property userMessage Data type string Description Introductory text at the start of the email to the donor Default Thank you for your donation! Here is your receipt: .. _userSubject: userSubject """"""""""" .. container:: table-row Property userSubject Data type string Description Subject of the mail received by the donor Default Donation confirmation .. _dateWrap: dateWrap """""""" .. container:: table-row Property dateWrap Data type stdWrap Description Formatting for dates inside the mails Default dateWrap.strftime = %Y-%m-%d .. ###### END~OF~TABLE ###### [tsref:plugin.tx\_donations\_pi1.mail] .. _Template: Template ^^^^^^^^ A template is used to format the output of the donations extension. It is comprised of several views which are detailed below along with their respective markers. **List view (###LISTVIEW###)** This produces a list of all the projects available for donation. .. ### BEGIN~OF~TABLE ### .. _ITEMS: ###ITEMS### """"""""""" .. container:: table-row Marker ###ITEMS### Function List of all projects .. ###### END~OF~TABLE ###### **Item for list view (###LISTVIEW\_ITEM###)** This is the subtemplate for each item (project) inside the list view. .. ### BEGIN~OF~TABLE ### .. _LOGO: ###LOGO### """""""""" .. container:: table-row Marker ###LOGO### Function Logo of the project (image tag) .. _TITLE: ###TITLE### """"""""""" .. container:: table-row Marker ###TITLE### Function Title of the project .. _SHORT-DESC: ###SHORT\_DESC### """"""""""""""""" .. container:: table-row Marker ###SHORT\_DESC### Function Short description of the project .. _DETAILS-LINK: ###DETAILS\_LINK### """"""""""""""""""" .. container:: table-row Marker ###DETAILS\_LINK### Function Link to details view .. _AMOUNT-MIN: ###AMOUNT\_MIN### """"""""""""""""" .. container:: table-row Marker ###AMOUNT\_MIN### Function The minimum amount of money that must be donated .. _AMOUNT-DONATED: ###AMOUNT\_DONATED### """"""""""""""""""""" .. container:: table-row Marker ###AMOUNT\_DONATED### Function The amount of money donated so far for this project .. _AMOUNT-NEEDED: ###AMOUNT\_NEEDED### """""""""""""""""""" .. container:: table-row Marker ###AMOUNT\_NEEDED### Function The amount of money needed for the project .. _CURRENCY: ###CURRENCY### """""""""""""" .. container:: table-row Marker ###CURRENCY### Function Currency for donation .. _DONATE-LINK: ###DONATE\_LINK### """""""""""""""""" .. container:: table-row Marker ###DONATE\_LINK### Function Link to the donate view .. ###### END~OF~TABLE ###### **Details view (###SINGLEVIEW###)** This template is used to show the complete information about a given project. .. ### BEGIN~OF~TABLE ### .. _LOGO: ###LOGO### """""""""" .. container:: table-row Marker ###LOGO### Function Logo of the project (image tag) .. _TITLE: ###TITLE### """"""""""" .. container:: table-row Marker ###TITLE### Function Title of the project .. _SHORT-DESC: ###SHORT\_DESC### """"""""""""""""" .. container:: table-row Marker ###SHORT\_DESC### Function Short description of the project .. _DETAILS-LINK: ###DETAILS\_LINK### """"""""""""""""""" .. container:: table-row Marker ###DETAILS\_LINK### Function Link to details view .. _AMOUNT-MIN: ###AMOUNT\_MIN### """"""""""""""""" .. container:: table-row Marker ###AMOUNT\_MIN### Function The minimum amount of money that must be donated .. _AMOUNT-DONATED: ###AMOUNT\_DONATED### """"""""""""""""""""" .. container:: table-row Marker ###AMOUNT\_DONATED### Function The amount of money donated so far for this project .. _AMOUNT-NEEDED: ###AMOUNT\_NEEDED### """""""""""""""""""" .. container:: table-row Marker ###AMOUNT\_NEEDED### Function The amount of money needed for the project .. _CURRENCY: ###CURRENCY### """""""""""""" .. container:: table-row Marker ###CURRENCY### Function Currency for donation .. _DONATE-LINK: ###DONATE\_LINK### """""""""""""""""" .. container:: table-row Marker ###DONATE\_LINK### Function Link to the donate view .. _LONG-DESC: ###LONG\_DESC### """""""""""""""" .. container:: table-row Marker ###LONG\_DESC### Function Long description of the project .. _BACK-LINK: ###BACK\_LINK### """""""""""""""" .. container:: table-row Marker ###BACK\_LINK### Function Link back to the list view .. ###### END~OF~TABLE ###### **Donate view (###DONATEVIEW###)** Input form for a donation. .. ### BEGIN~OF~TABLE ### .. _PROJECT-TITLE: ###PROJECT\_TITLE### """""""""""""""""""" .. container:: table-row Marker ###PROJECT\_TITLE### Function Form title, possibly including the project's name .. _ERROR-MESSAGE: ###ERROR\_MESSAGE### """""""""""""""""""" .. container:: table-row Marker ###ERROR\_MESSAGE### Function Placeholder for a possible error message .. _FORM-URL: ###FORM\_URL### """"""""""""""" .. container:: table-row Marker ###FORM\_URL### Function URL for submitting the form .. _FORM-NAME: ###FORM\_NAME### """""""""""""""" .. container:: table-row Marker ###FORM\_NAME### Function Name of the form .. _PAYMETHODS: ###PAYMETHODS### """""""""""""""" .. container:: table-row Marker ###PAYMETHODS### Function Placeholder for the list of payment methods available (set of radio buttons) .. _HIDDEN-FIELDS: ###HIDDEN\_FIELDS### """""""""""""""""""" .. container:: table-row Marker ###HIDDEN\_FIELDS### Function Placeholder for hidden fields used in the donation process .. _AMOUNT-MIN: ###AMOUNT\_MIN### """"""""""""""""" .. container:: table-row Marker ###AMOUNT\_MIN### Function Minimum amount of money that can be donated .. _AMOUNT-MAX: ###AMOUNT\_MAX### """"""""""""""""" .. container:: table-row Marker ###AMOUNT\_MAX### Function Maximum amount of money that can be donated .. _AMOUNT-VAL: ###AMOUNT\_VAL### """"""""""""""""" .. container:: table-row Marker ###AMOUNT\_VAL### Function Donation amount entered by the user .. _COMPANY-VAL: ###COMPANY\_VAL### """""""""""""""""" .. container:: table-row Marker ###COMPANY\_VAL### Function Name of the company entered by the user .. _NAME-VAL: ###NAME\_VAL### """"""""""""""" .. container:: table-row Marker ###NAME\_VAL### Function Name entered by the user .. _ADDR-VAL: ###ADDR\_VAL### """"""""""""""" .. container:: table-row Marker ###ADDR\_VAL### Function Address entered by the user .. _ZIP-VAL: ###ZIP\_VAL### """""""""""""" .. container:: table-row Marker ###ZIP\_VAL### Function Zip code entered by the user .. _CITY-VAL: ###CITY\_VAL### """"""""""""""" .. container:: table-row Marker ###CITY\_VAL### Function City name entered by the user .. _COUNTRY-VAL: ###COUNTRY\_VAL### """""""""""""""""" .. container:: table-row Marker ###COUNTRY\_VAL### Function Country name entered by the user .. _EMAIL-VAL: ###EMAIL\_VAL### """""""""""""""" .. container:: table-row Marker ###EMAIL\_VAL### Function E-mail address entered by the user .. _BUTTONS: ###BUTTONS### """"""""""""" .. container:: table-row Marker ###BUTTONS### Function Placeholder for the form buttons .. _BACK-LINK: ###BACK\_LINK### """""""""""""""" .. container:: table-row Marker ###BACK\_LINK### Function Link back to the project details (displayed only if projects are used) .. ###### END~OF~TABLE ###### **Confirmation view (###CONFIRMVIEW###)** Confirmation view of the donation before starting the payment process. .. ### BEGIN~OF~TABLE ### .. _PROJECT-TITLE: ###PROJECT\_TITLE### """""""""""""""""""" .. container:: table-row Marker ###PROJECT\_TITLE### Function Form title, possibly including the project's name .. _ERROR-MESSAGE: ###ERROR\_MESSAGE### """""""""""""""""""" .. container:: table-row Marker ###ERROR\_MESSAGE### Function Placeholder for a possible error message .. _FORM-URL: ###FORM\_URL### """"""""""""""" .. container:: table-row Marker ###FORM\_URL### Function URL for submitting the form .. _FORM-NAME: ###FORM\_NAME### """""""""""""""" .. container:: table-row Marker ###FORM\_NAME### Function Name of the form .. _FORM-FORM-PARAMS: ###FORM\_FORM\_PARAMS### """""""""""""""""""""""" .. container:: table-row Marker ###FORM\_FORM\_PARAMS### Function Placeholder for the additional form parameters defined by the chosen payment method .. _HIDDEN-FIELDS: ###HIDDEN\_FIELDS### """""""""""""""""""" .. container:: table-row Marker ###HIDDEN\_FIELDS### Function Placeholder for hidden fields containing all the input values .. _PAYMETHOD: ###PAYMETHOD### """"""""""""""" .. container:: table-row Marker ###PAYMETHOD### Function Chosen payment method .. _AMOUNT-VAL: ###AMOUNT\_VAL### """"""""""""""""" .. container:: table-row Marker ###AMOUNT\_VAL### Function Donation amount entered by the user .. _CURRENCY: ###CURRENCY### """""""""""""" .. container:: table-row Marker ###CURRENCY### Function Chosen currency of the transaction .. _PAYMENT-DETAILS: ###PAYMENT\_DETAILS### """""""""""""""""""""" .. container:: table-row Marker ###PAYMENT\_DETAILS### Function Placeholder for all the input fields necessary for the chosen payment method .. _COMPANY-VAL: ###COMPANY\_VAL### """""""""""""""""" .. container:: table-row Marker ###COMPANY\_VAL### Function Name of the company entered by the user .. _NAME-VAL: ###NAME\_VAL### """"""""""""""" .. container:: table-row Marker ###NAME\_VAL### Function Name entered by the user .. _ADDR-VAL: ###ADDR\_VAL### """"""""""""""" .. container:: table-row Marker ###ADDR\_VAL### Function Address entered by the user .. _ZIP-VAL: ###ZIP\_VAL### """""""""""""" .. container:: table-row Marker ###ZIP\_VAL### Function Zip code entered by the user .. _CITY-VAL: ###CITY\_VAL### """"""""""""""" .. container:: table-row Marker ###CITY\_VAL### Function City name entered by the user .. _COUNTRY-VAL: ###COUNTRY\_VAL### """""""""""""""""" .. container:: table-row Marker ###COUNTRY\_VAL### Function Country name entered by the user .. _EMAIL-VAL: ###EMAIL\_VAL### """""""""""""""" .. container:: table-row Marker ###EMAIL\_VAL### Function E-mail address entered by the user .. _BUTTONS: ###BUTTONS### """"""""""""" .. container:: table-row Marker ###BUTTONS### Function Placeholder for the form buttons .. ###### END~OF~TABLE ###### **Receipt view (###RECEIPTVIEW###)** Confirmation (receipt) view displayed after the payment process is successfully completed. .. ### BEGIN~OF~TABLE ### .. _PROJECT-TITLE: ###PROJECT\_TITLE### """""""""""""""""""" .. container:: table-row Marker ###PROJECT\_TITLE### Function Form title, possibly including the project's name .. _ERROR-MESSAGE: ###ERROR\_MESSAGE### """""""""""""""""""" .. container:: table-row Marker ###ERROR\_MESSAGE### Function Placeholder for a possible error message .. _PAYMENT-REFERENCE: ###PAYMENT\_REFERENCE### """""""""""""""""""""""" .. container:: table-row Marker ###PAYMENT\_REFERENCE### Function ID of the payment transaction .. _PAYMETHOD: ###PAYMETHOD### """"""""""""""" .. container:: table-row Marker ###PAYMETHOD### Function Chosen payment method .. _AMOUNT-VAL: ###AMOUNT\_VAL### """"""""""""""""" .. container:: table-row Marker ###AMOUNT\_VAL### Function Donation amount entered by the user .. _CURRENCY: ###CURRENCY### """""""""""""" .. container:: table-row Marker ###CURRENCY### Function Chosen currency of the transaction .. _PAYMENT-DETAILS: ###PAYMENT\_DETAILS### """""""""""""""""""""" .. container:: table-row Marker ###PAYMENT\_DETAILS### Function Placeholder for all the input fields necessary for the chosen payment method .. _COMPANY-VAL: ###COMPANY\_VAL### """""""""""""""""" .. container:: table-row Marker ###COMPANY\_VAL### Function Name of the company entered by the user .. _NAME-VAL: ###NAME\_VAL### """"""""""""""" .. container:: table-row Marker ###NAME\_VAL### Function Name entered by the user .. _ADDR-VAL: ###ADDR\_VAL### """"""""""""""" .. container:: table-row Marker ###ADDR\_VAL### Function Address entered by the user .. _ZIP-VAL: ###ZIP\_VAL### """""""""""""" .. container:: table-row Marker ###ZIP\_VAL### Function Zip code entered by the user .. _CITY-VAL: ###CITY\_VAL### """"""""""""""" .. container:: table-row Marker ###CITY\_VAL### Function City name entered by the user .. _COUNTRY-VAL: ###COUNTRY\_VAL### """""""""""""""""" .. container:: table-row Marker ###COUNTRY\_VAL### Function Country name entered by the user .. _EMAIL-VAL: ###EMAIL\_VAL### """""""""""""""" .. container:: table-row Marker ###EMAIL\_VAL### Function E-mail address entered by the user .. ###### END~OF~TABLE ###### **Mail to administrator (###ADMINMAIL###)** Information mail sent to donation recipient. .. ### BEGIN~OF~TABLE ### .. _MESSAGE: ###MESSAGE### """"""""""""" .. container:: table-row Marker ###MESSAGE### Function Introductory message .. _PROJECT-TITLE: ###PROJECT\_TITLE### """""""""""""""""""" .. container:: table-row Marker ###PROJECT\_TITLE### Function Form title, possibly including the project's name .. _PAYMENT-REFERENCE: ###PAYMENT\_REFERENCE### """""""""""""""""""""""" .. container:: table-row Marker ###PAYMENT\_REFERENCE### Function ID of the payment transaction .. _PAYMETHOD: ###PAYMETHOD### """"""""""""""" .. container:: table-row Marker ###PAYMETHOD### Function Chosen payment method .. _AMOUNT-VAL: ###AMOUNT\_VAL### """"""""""""""""" .. container:: table-row Marker ###AMOUNT\_VAL### Function Donation amount entered by the user .. _CURRENCY: ###CURRENCY### """""""""""""" .. container:: table-row Marker ###CURRENCY### Function Chosen currency of the transaction .. _COMPANY-VAL: ###COMPANY\_VAL### """""""""""""""""" .. container:: table-row Marker ###COMPANY\_VAL### Function Name of the company entered by the user .. _NAME-VAL: ###NAME\_VAL### """"""""""""""" .. container:: table-row Marker ###NAME\_VAL### Function Name entered by the user .. _ADDR-VAL: ###ADDR\_VAL### """"""""""""""" .. container:: table-row Marker ###ADDR\_VAL### Function Address entered by the user .. _ZIP-VAL: ###ZIP\_VAL### """""""""""""" .. container:: table-row Marker ###ZIP\_VAL### Function Zip code entered by the user .. _CITY-VAL: ###CITY\_VAL### """"""""""""""" .. container:: table-row Marker ###CITY\_VAL### Function City name entered by the user .. _COUNTRY-VAL: ###COUNTRY\_VAL### """""""""""""""""" .. container:: table-row Marker ###COUNTRY\_VAL### Function Country name entered by the user .. _EMAIL-VAL: ###EMAIL\_VAL### """""""""""""""" .. container:: table-row Marker ###EMAIL\_VAL### Function E-mail address entered by the user .. _DATE-VAL: ###DATE\_VAL### """"""""""""""" .. container:: table-row Marker ###DATE\_VAL### Function Date of the transaction .. ###### END~OF~TABLE ###### **Mail to user (###USERMAIL###)** Confirmation mail sent to donor. .. ### BEGIN~OF~TABLE ### .. _MESSAGE: ###MESSAGE### """"""""""""" .. container:: table-row Marker ###MESSAGE### Function Introductory message .. _PROJECT-TITLE: ###PROJECT\_TITLE### """""""""""""""""""" .. container:: table-row Marker ###PROJECT\_TITLE### Function Form title, possibly including the project's name .. _PAYMENT-REFERENCE: ###PAYMENT\_REFERENCE### """""""""""""""""""""""" .. container:: table-row Marker ###PAYMENT\_REFERENCE### Function ID of the payment transaction .. _PAYMETHOD: ###PAYMETHOD### """"""""""""""" .. container:: table-row Marker ###PAYMETHOD### Function Chosen payment method .. _AMOUNT-VAL: ###AMOUNT\_VAL### """"""""""""""""" .. container:: table-row Marker ###AMOUNT\_VAL### Function Donation amount entered by the user .. _CURRENCY: ###CURRENCY### """""""""""""" .. container:: table-row Marker ###CURRENCY### Function Chosen currency of the transaction .. _COMPANY-VAL: ###COMPANY\_VAL### """""""""""""""""" .. container:: table-row Marker ###COMPANY\_VAL### Function Name of the company entered by the user .. _NAME-VAL: ###NAME\_VAL### """"""""""""""" .. container:: table-row Marker ###NAME\_VAL### Function Name entered by the user .. _ADDR-VAL: ###ADDR\_VAL### """"""""""""""" .. container:: table-row Marker ###ADDR\_VAL### Function Address entered by the user .. _ZIP-VAL: ###ZIP\_VAL### """""""""""""" .. container:: table-row Marker ###ZIP\_VAL### Function Zip code entered by the user .. _CITY-VAL: ###CITY\_VAL### """"""""""""""" .. container:: table-row Marker ###CITY\_VAL### Function City name entered by the user .. _COUNTRY-VAL: ###COUNTRY\_VAL### """""""""""""""""" .. container:: table-row Marker ###COUNTRY\_VAL### Function Country name entered by the user .. _EMAIL-VAL: ###EMAIL\_VAL### """""""""""""""" .. container:: table-row Marker ###EMAIL\_VAL### Function E-mail address entered by the user .. _DATE-VAL: ###DATE\_VAL### """"""""""""""" .. container:: table-row Marker ###DATE\_VAL### Function Date of the transaction .. ###### END~OF~TABLE ###### .. _To-Do-List: To Do List ---------- As said in the introduction, although functional this version of the extension is still rather rough in some areas. Here is a list of planned or desirable improvements. Don't hesitate to add to that wish list. - Handle multiple languages for projects. - Better and uniform handling of error messages. - More uniform handling of currency formatting. - More flexible input form. It should be possible to define whatever fields are desired (beyond those from paymentlib) and store those field in any DB table. - Better templating with localized labels. - Input error-handling (client-side). - Use multiple currencies both for projects and as default value. .. _Known-problems: Known problems -------------- None to date. Please report any to typo3@cobweb.ch. .. _Changelog: Changelog --------- .. ### BEGIN~OF~TABLE ### .. _0-6-0: 0.6.0 ^^^^^ .. container:: table-row Version 0.6.0 Changes - Corrected use of $this->conf (thanks to Benni Mack) - Added German translation (thanks to Benni Mack) - Fixed bug in handling of min and max amount (thanks to Benni Mack) - Fixed bug in sending mails (thanks to Benni Mack) - Cleaned up a lot of code - Added security checks against XSS and email injection - Improved TYPO3 4.2 compatibility - Moved project to forge.typo3.org .. _0-5-0: 0.5.0 ^^^^^ .. container:: table-row Version 0.5.0 Changes First fully functional release: - complete donation process (with back buttons where appropriate) - input error handling (server-side) - localization of messages - possibility to not use projects - correct UTF-8 handling for template - send mail to donor and recipient - manual - many other small improvements .. _0-0-1: 0.0.1 ^^^^^ .. container:: table-row Version 0.0.1 Changes First public release by Tonni Aagesen .. ###### END~OF~TABLE ###### |img-10| EXT: Donations - 12 .. ######CUTTER_MARK_IMAGES###### .. |img-1| image:: img-1.png .. :align: left .. :border: 0 .. :height: 177 .. :hspace: 10 .. :id: graphics3 .. :name: graphics3 .. :vspace: 10 .. :width: 555 .. |img-2| image:: img-2.png .. :align: left .. :border: 0 .. :height: 275 .. :hspace: 10 .. :id: graphics2 .. :name: graphics2 .. :vspace: 10 .. :width: 371 .. |img-3| image:: img-3.png .. :align: left .. :border: 0 .. :height: 394 .. :hspace: 10 .. :id: graphics4 .. :name: graphics4 .. :vspace: 10 .. :width: 612 .. |img-4| image:: img-4.jpeg .. :align: left .. :border: 0 .. :height: 411 .. :hspace: 10 .. :id: graphics5 .. :name: graphics5 .. :vspace: 10 .. :width: 627 .. |img-5| image:: img-5.jpeg .. :align: left .. :border: 0 .. :height: 217 .. :hspace: 10 .. :id: graphics6 .. :name: graphics6 .. :vspace: 10 .. :width: 669 .. |img-6| image:: img-6.jpeg .. :align: left .. :border: 0 .. :height: 455 .. :hspace: 10 .. :id: graphics7 .. :name: graphics7 .. :vspace: 10 .. :width: 669 .. |img-7| image:: img-7.jpeg .. :align: left .. :border: 0 .. :height: 318 .. :hspace: 10 .. :id: graphics8 .. :name: graphics8 .. :vspace: 10 .. :width: 669 .. |img-8| image:: img-8.jpeg .. :align: left .. :border: 0 .. :height: 341 .. :hspace: 10 .. :id: graphics9 .. :name: graphics9 .. :vspace: 10 .. :width: 669 .. |img-9| image:: img-9.png .. :align: left .. :border: 0 .. :height: 333 .. :hspace: 10 .. :id: graphics1 .. :name: graphics1 .. :vspace: 10 .. :width: 288 .. |img-10| image:: img-10.png .. :align: left .. :border: 0 .. :height: 29 .. :id: Grafik1 .. :name: Grafik1 .. :width: 104