CRM-13984 - Add help regarding use of receipt message, AND cleanup the Thank-you...
authorDave Greenberg <dave@civicrm.org>
Fri, 12 Dec 2014 01:37:00 +0000 (17:37 -0800)
committerDave Greenberg <dave@civicrm.org>
Fri, 12 Dec 2014 01:37:00 +0000 (17:37 -0800)
----------------------------------------
* CRM-13984:
  https://issues.civicrm.org/jira/browse/CRM-13984

CRM/Contribute/Form/ContributionPage/ThankYou.php
templates/CRM/Contribute/Form/ContributionPage/ThankYou.hlp [new file with mode: 0644]
templates/CRM/Contribute/Form/ContributionPage/ThankYou.tpl

index f65978fcfd4eadbc74fb090145b2b1691a328ef7..e8999678f259d83f87d798b31773b3ad6c9b01aa 100644 (file)
@@ -63,8 +63,18 @@ class CRM_Contribute_Form_ContributionPage_ThankYou extends CRM_Contribute_Form_
 
     // thank you title and text (html allowed in text)
     $this->add('text', 'thankyou_title', ts('Thank-you Page Title'), CRM_Core_DAO::getAttribute('CRM_Contribute_DAO_ContributionPage', 'thankyou_title'), TRUE);
-    $this->addWysiwyg('thankyou_text', ts('Thank-you Message'), CRM_Core_DAO::getAttribute('CRM_Contribute_DAO_ContributionPage', 'thankyou_text'));
-    $this->addWysiwyg('thankyou_footer', ts('Thank-you Page Footer'), CRM_Core_DAO::getAttribute('CRM_Contribute_DAO_ContributionPage', 'thankyou_footer'));
+
+    $attributes = CRM_Core_DAO::getAttribute('CRM_Contribute_DAO_ContributionPage', 'thankyou_text');
+    $attributes['click_wysiwyg'] = true;
+    $this->addWysiwyg('thankyou_text', ts('Thank-you Message'), $attributes);
+    // FIXME: This hack forces height of editor to 175px. Need to modify QF classes for editors to allow passing
+    // explicit height and width.
+    $footerAttribs = array(
+      'rows' => 2,
+      'cols' => 40,
+      'click_wysiwyg' => true,
+    );
+    $this->addWysiwyg('thankyou_footer', ts('Thank-you Footer'), $footerAttribs);
 
     $this->addElement('checkbox', 'is_email_receipt', ts('Email Receipt to Contributor?'), NULL, array('onclick' => "showReceipt()"));
     $this->add('text', 'receipt_from_name', ts('Receipt From Name'), CRM_Core_DAO::getAttribute('CRM_Contribute_DAO_ContributionPage', 'receipt_from_name'));
diff --git a/templates/CRM/Contribute/Form/ContributionPage/ThankYou.hlp b/templates/CRM/Contribute/Form/ContributionPage/ThankYou.hlp
new file mode 100644 (file)
index 0000000..465d40f
--- /dev/null
@@ -0,0 +1,105 @@
+{*
+ +--------------------------------------------------------------------+
+ | CiviCRM version 4.5                                                |
+ +--------------------------------------------------------------------+
+ | Copyright CiviCRM LLC (c) 2004-2014                                |
+ +--------------------------------------------------------------------+
+ | This file is a part of CiviCRM.                                    |
+ |                                                                    |
+ | CiviCRM is free software; you can copy, modify, and distribute it  |
+ | under the terms of the GNU Affero General Public License           |
+ | Version 3, 19 November 2007 and the CiviCRM Licensing Exception.   |
+ |                                                                    |
+ | CiviCRM is distributed in the hope that it will be useful, but     |
+ | WITHOUT ANY WARRANTY; without even the implied warranty of         |
+ | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.               |
+ | See the GNU Affero General Public License for more details.        |
+ |                                                                    |
+ | You should have received a copy of the GNU Affero General Public   |
+ | License and the CiviCRM Licensing Exception along                  |
+ | with this program; if not, contact CiviCRM LLC                     |
+ | at info[AT]civicrm[DOT]org. If you have questions about the        |
+ | GNU Affero General Public License or the licensing of CiviCRM,     |
+ | see the CiviCRM license FAQ at http://civicrm.org/licensing        |
+ +--------------------------------------------------------------------+
+*}
+
+{htxt id="id_thankyou-title-title"}
+  {ts}Thank-you Page Title{/ts}
+{/htxt}
+{htxt id="id_thankyou-title"}
+  <p>{ts}This title will be displayed at the top of the thank-you / transaction confirmation page.{/ts}</p>
+{/htxt}
+
+{htxt id="id_thankyou-text-title"}
+  {ts}Thank-you Message{/ts}
+{/htxt}
+{htxt id="id_thankyou-text"}
+  <p>{ts}Enter text (and optional HTML layout) for the thank-you block that will appear at the top of the Thank-you page.{/ts}</p>
+{/htxt}
+
+{htxt id="id_footer-text-title"}
+  {ts}Thank-you Page Footer{/ts}
+{/htxt}
+{htxt id="id_footer-text"}
+  <p>{ts}Enter link(s) and/or text that you want to appear at the bottom of the thank-you page. You can use this content area to encourage contributors to visit a tell-a-friend
+  page or take some other action.{/ts}<p>
+  <p>{ts}NOTE: Social media links will be automatically included if you have enabled 'Social media sharing' for this page (see the 'Title' tab).{/ts}</p>
+{/htxt}
+
+{capture assign=msgUrl}{crmURL p='civicrm/admin/messageTemplates' q="reset=1"}{/capture}
+{htxt id="id_is-email-receipt-title"}
+  {ts}Automatic Receipting{/ts}
+{/htxt}
+{htxt id="id_is-email-receipt"}
+  <p>{ts}Check this box if you want an electronic receipt to be sent automatically to the contributor's email address.{/ts}</p>
+  <p>{ts 1=$msgUrl}The "Contributions - Receipt (on-line)" System Workflow Message Template provides content and formatting for the receipt.
+  You can modify it from <a href="%1">Administer > Communications > Message Templates > System Workflow Messages</a>. You can also provide
+  specific messaging for contributions received via this contribution page using the "Receipt Message" field below.{/ts}</p>
+{/htxt}
+
+{htxt id="id_receipt-from-name-title"}
+  {ts}Name of Receipt Sender{/ts}
+{/htxt}
+{htxt id="id_receipt-from-name"}
+  <p>{ts}Enter the FROM name to be used in receipt emails.{/ts}</p>
+{/htxt}
+
+{htxt id="id_receipt-from-email-title"}
+  {ts}Email Address of Receipt Sender{/ts}
+{/htxt}
+{htxt id="id_receipt-from-email"}
+  <p>{ts}Enter the FROM email address to be used in receipt emails.{/ts}</p>
+{/htxt}
+
+{htxt id="id_receipt-text-title"}
+  {ts}Additional Receipt Message{/ts}
+{/htxt}
+{htxt id="id_receipt-text"}
+  <p>{ts}Enter a message you want included at the beginning of emailed receipts. This message will be inserted at the top of the "Contributions - Receipt (on-line)"
+  System Workflow Message.{/ts}</p>
+  <p>{ts}IMPORTANT: Keep in mind that this message will be included in ALL of the following types of receipts related to this online contribution page{/ts}:
+    <ul>
+      <li>{ts}One-time online contributions{/ts}</li>
+      <li>{ts}Recurring online contributions (if enabled for this page){/ts}</li>
+      <li>{ts}Automatically renewing membership payments (if enabled for this page){/ts}</li>
+    </ul>
+  </p>
+  <p>{ts}NOTE: The text entered here will be used for both TEXT and HTML versions of receipt emails so we do not recommend including HTML tags / formatting here.{/ts}</p>
+{/htxt}
+
+{htxt id="id_receipt-cc-title"}
+  {ts}CC Receipts{/ts}
+{/htxt}
+{htxt id="id_receipt-cc"}
+  <p>{ts}If you want member(s) of your organization to receive a carbon copy of each emailed receipt, enter one or more email addresses here. Multiple email
+addresses should be separated by a comma (e.g. jane@example.org, paula@example.org).{/ts}</p>
+{/htxt}
+
+{htxt id="id_receipt-bcc-title"}
+  {ts}BCC Receipts{/ts}
+{/htxt}
+{htxt id="id_receipt-bcc"}
+  <p>{ts}If you want member(s) of your organization to receive a BLIND carbon copy of each emailed receipt, enter one or more email addresses here. Multiple email
+  addresses should be separated by a comma (e.g. jane@example.org, paula@example.org).{/ts}</p>
+{/htxt}
index 15844dfdb79da39bd3d6fe8b924d589989c9a597..8ee05572b6a460da4f4fb6ba7ce01852ca24c3d3 100644 (file)
     <p>{ts}Use this form to configure the thank-you message and receipting options. Contributors will see a confirmation and thank-you page after whenever an online contribution is successfully processed. You provide the content and layout of the thank-you section below. You also control whether an electronic receipt is automatically emailed to each contributor - and can add a custom message to that receipt.{/ts}</p>
 </div>
     <div class="crm-submit-buttons">{include file="CRM/common/formButtons.tpl" location="top"}</div>
-    <table class="form-layout-compressed">
+    <table class="form-layout">
     <tr class="crm-contribution-contributionpage-thankyou-form-block-thankyou_title">
-       <td class="label">{$form.thankyou_title.label}{if $action == 2}{include file='CRM/Core/I18n/Dialog.tpl' table='civicrm_contribution_page' field='thankyou_title' id=$contributionPageID}{/if}</td>
-       <td class="html-adjust">{$form.thankyou_title.html}<br />
-           <span class="description">{ts}This title will be displayed at the top of the thank-you / transaction confirmation page.{/ts}</span>
+       <td class="label">{$form.thankyou_title.label}{if $action == 2}{include file='CRM/Core/I18n/Dialog.tpl' table='civicrm_contribution_page' field='thankyou_title' id=$contributionPageID}{/if} {help id="id_thankyou-title"}</td>
+       <td class="html-adjust">{$form.thankyou_title.html}
        </td>
     </tr>
     <tr class="crm-contribution-contributionpage-thankyou-form-block-thankyou_text">
-       <td class="label">{$form.thankyou_text.label}{if $action == 2}{include file='CRM/Core/I18n/Dialog.tpl' table='civicrm_contribution_page' field='thankyou_text' id=$contributionPageID}{/if}</td>
-       <td class="html-adjust">{$form.thankyou_text.html}<br />
-            <span class="description">{ts}Enter text (and optional HTML layout tags) for the thank-you message that will appear at the top of the confirmation page.{/ts}</span>
-       </td>
+       <td class="label">{$form.thankyou_text.label}{if $action == 2}{include file='CRM/Core/I18n/Dialog.tpl' table='civicrm_contribution_page' field='thankyou_text' id=$contributionPageID}{/if}<br />{help id="id_thankyou-text"}</td>
+       <td class="html-adjust">{$form.thankyou_text.html}<br /></td>
     </tr>
     <tr class="crm-contribution-contributionpage-thankyou-form-block-thankyou_footer">
-       <td class="label">{$form.thankyou_footer.label}{if $action == 2}{include file='CRM/Core/I18n/Dialog.tpl' table='civicrm_contribution_page' field='thankyou_footer' id=$contributionPageID}{/if}</td>
-       <td class="html-adjust">{$form.thankyou_footer.html}<br />
-            <span class="description">{ts}Enter link(s) and/or text that you want to appear at the bottom of the thank-you page. You can use this content area to encourage contributors to visit a tell-a-friend page or take some other action.{/ts}</span>
-       </td>
+       <td class="label">{$form.thankyou_footer.label}{if $action == 2}{include file='CRM/Core/I18n/Dialog.tpl' table='civicrm_contribution_page' field='thankyou_footer' id=$contributionPageID}{/if} {help id="id_footer-text"}</td>
+       <td class="html-adjust">{$form.thankyou_footer.html}<br /></td>
     </tr>
     <tr class="crm-contribution-contributionpage-thankyou-form-block-is_email_receipt">
        <td class="label"></td>
-       <td class="html-adjust">{$form.is_email_receipt.html}{$form.is_email_receipt.label}<br />
-            <span class="description">{ts}Check this box if you want an electronic receipt to be sent automatically.{/ts}</span>
+       <td class="html-adjust">{$form.is_email_receipt.html}{$form.is_email_receipt.label} {help id="id_is-email-receipt"}
        </td>
     </tr>
     </table>
-    <table id="receiptDetails" class="form-layout-compressed">
+    <table id="receiptDetails" class="form-layout">
     <tr class="crm-contribution-contributionpage-thankyou-form-block-receipt_from_name">
-  <td class="label">{$form.receipt_from_name.label}{if $action == 2}{include file='CRM/Core/I18n/Dialog.tpl' table='civicrm_contribution_page' field='receipt_from_name' id=$contributionPageID}{/if}
+      <td class="label">{$form.receipt_from_name.label}{if $action == 2}{include file='CRM/Core/I18n/Dialog.tpl' table='civicrm_contribution_page' field='receipt_from_name' id=$contributionPageID}{/if} {help id="id_receipt-from-name"}
       </td>
-      <td class="html-adjust">{$form.receipt_from_name.html}<br />
-          <span class="description">{ts}Enter the FROM name to be used when receipts are emailed to contributors.{/ts}</span>
+      <td class="html-adjust">{$form.receipt_from_name.html}
   </td>
     </tr>
     <tr class="crm-contribution-contributionpage-thankyou-form-block-receipt_from_email">
-  <td class="label">{$form.receipt_from_email.label}{$reqMark}
-  </td>
-  <td class="html-adjust">{$form.receipt_from_email.html}<br />
-      <span class="description">{ts}Enter the FROM email address to be used when receipts are emailed to contributors.{/ts}</span>
-  </td>
+      <td class="label">{$form.receipt_from_email.label}{$reqMark} {help id="id_receipt-from-email"}</td>
+      <td class="html-adjust">{$form.receipt_from_email.html}</td>
     </tr>
     <tr class="crm-contribution-contributionpage-thankyou-form-block-receipt_text">
-  <td class="label">{$form.receipt_text.label}{if $action == 2}{include file='CRM/Core/I18n/Dialog.tpl' table='civicrm_contribution_page' field='receipt_text' id=$contributionPageID}{/if}
-  </td>
-  <td class="html-adjust">{$form.receipt_text.html}<br />
-      <span class="description">{ts}Enter a message you want included at the beginning of emailed receipts. NOTE: This text will be included in both TEXT and HTML versions of receipt emails so we do not recommend including HTML tags / formatting here.{/ts}<br /></span>
-  </td>
+      <td class="label">{$form.receipt_text.label}{if $action == 2}{include file='CRM/Core/I18n/Dialog.tpl' table='civicrm_contribution_page' field='receipt_text' id=$contributionPageID}{/if}  {help id="id_receipt-text"}</td>
+      <td class="html-adjust">{$form.receipt_text.html}<br /></td>
     </tr>
     <tr class="crm-contribution-contributionpage-thankyou-form-block-cc_receipt">
-  <td class="label">{$form.cc_receipt.label}
-      </td>
-  <td class="html-adjust">{$form.cc_receipt.html}<br />
-      <span  class="description">{ts}If you want member(s) of your organization to receive a carbon copy of each emailed receipt, enter one or more email addresses here. Multiple email addresses should be separated by a comma (e.g. jane@example.org, paula@example.org).{/ts}
-      </span>
-  </td>
+      <td class="label">{$form.cc_receipt.label} {help id="id_receipt-cc"}</td>
+      <td class="html-adjust">{$form.cc_receipt.html}</td>
     </tr>
     <tr class="crm-contribution-contributionpage-thankyou-form-block-bcc_receipt">
-  <td class="label">{$form.bcc_receipt.label}
-  </td>
-  <td class="html-adjust">{$form.bcc_receipt.html}<br />
-      <span class="description">{ts}If you want member(s) of your organization to receive a BLIND carbon copy of each emailed receipt, enter one or more email addresses here. Multiple email addresses should be separated by a comma (e.g. jane@example.org, paula@example.org).{/ts}</span>
-  </td>
+      <td class="label">{$form.bcc_receipt.label} {help id="id_receipt-bcc"}</td>
+      <td class="html-adjust">{$form.bcc_receipt.html}</td>
     </tr>
     </table>
     <div class="crm-submit-buttons">{include file="CRM/common/formButtons.tpl" location="bottom"}</div>