From: Dave Greenberg
Date: Mon, 15 Apr 2013 20:07:14 +0000 (-0700)
Subject: CRM-12325 Corrected erroneous help info on message template page and form, and consol...
X-Git-Url: https://vcs.fsf.org/?a=commitdiff_plain;h=b1dfb5883effff0d482cb62274c3017cae307d92;p=civicrm-core.git
CRM-12325 Corrected erroneous help info on message template page and form, and consolidated the help. Also added help and link to book on Scheduled Reminders page.
----------------------------------------
* CRM-12325: Correct and clarify help regarding use of tokens for events, memberships, and activities in message templates
http://issues.civicrm.org/jira/browse/CRM-12325
---
diff --git a/templates/CRM/Admin/Form/MessageTemplates.tpl b/templates/CRM/Admin/Form/MessageTemplates.tpl
index 99bdfba867..1d97ce9668 100644
--- a/templates/CRM/Admin/Form/MessageTemplates.tpl
+++ b/templates/CRM/Admin/Form/MessageTemplates.tpl
@@ -29,7 +29,7 @@
{if $action eq 1}{ts}New Message Template{/ts}{elseif $action eq 2}{ts}Edit Message Template{/ts}{else}{ts}Delete Message Template{/ts}{/if}
{if $action neq 8}
- {ts}Use this form to add or edit re-usable message templates.{/ts} {help id="id-msgTplIntro" file="CRM/Admin/Page/MessageTemplates.hlp"}
+ {ts}Use this form to add or edit re-usable message templates.{/ts} {help id="id-intro" file="CRM/Admin/Page/MessageTemplates.hlp"}
{/if}
diff --git a/templates/CRM/Admin/Page/MessageTemplates.hlp b/templates/CRM/Admin/Page/MessageTemplates.hlp
index 28035f8703..8c24b0123f 100644
--- a/templates/CRM/Admin/Page/MessageTemplates.hlp
+++ b/templates/CRM/Admin/Page/MessageTemplates.hlp
@@ -24,18 +24,20 @@
+--------------------------------------------------------------------+
*}
{capture assign=tokenDocLink}{docURL page="user/common-workflows/tokens-and-mail-merge"}{/capture}
-{capture assign=memberTypesDocLink}{docURL page="user/membership/setup"}{/capture}
+{capture assign=schedRemindersDocLink}{docURL page="user/current/email/scheduled-reminders/"}{/capture}
+{capture assign=schedRemURL}{crmURL p='civicrm/admin/scheduleReminders' q="reset=1"}{/capture}
{htxt id="id-intro-title"}
- {ts}Message templates{/ts}
+ {ts}Message Templates{/ts}
{/htxt}
{htxt id="id-intro"}
-{ts}Templates allow you to save and re-use messages with layouts. You can use them when sending email to one or more contacts. If you are using the CiviMail component - you can use templates for your messages. If you are using the CiviMember component, you will need to create one or more message templates for membership renewal reminders.{/ts} {$memberTypesDocLink}
+{ts}Templates allow you to save and re-use messages with layouts. You can use them when sending email or letters to one or more contacts. If you are using CiviMail for enewsletters, newsletter templates take care of the layout so authors can focus on content.
{/ts}
+
+{ts}You may include tokens to represent fields (like a contact's "first name") in the message subject and body. These will be replaced with the actual value of the corresponding field in the outgoing message. Click "Insert Tokens" for a searchable list of available tokens.{/ts} {$tokenDocLink}
-{ts}You may include tokens to represent fields (like a contact's "first name") in the message subject and body. These will be replaced with the actual value of the corresponding field in the outgoing message EXAMPLE: Dear {ldelim}contact.first_name{rdelim}.
-{/ts} {$tokenDocLink}
+{ts 1=$schedRemURL}Messages used for membership renewal reminders, as well as event and activity related reminders generally use tokens specific to membership, participant or activity records. For example, a membership renewal reminder may include the membership type and end date tokens. The Scheduled Reminders screen includes these tokens in the "Insert Tokens" tool, so it is best to create reminder templates there.{/ts} {$schedRemindersDocLink}
{/htxt}
@@ -51,16 +53,6 @@
{/htxt}
-{htxt id="id-msgTplIntro-title"}
- {ts}Message Templates{/ts}
-{/htxt}
-{htxt id="id-msgTplIntro"}
-
-{ts}Use this form to add or edit re-usable message templates. Once you save a message template, you can use it when sending mail to one or more contacts. If you are using the CiviMember component, you can also use a message template to send Membership Renewal Reminders. You may include tokens to represent fields (like a contact's "first name") in the message subject and body. These will be replaced with the actual value of the corresponding field in the outgoing message. EXAMPLE: Dear{ldelim}contact.first_name{rdelim}.
-{/ts} {$tokenDocLink}
-
-{/htxt}
-
{htxt id="id-view_system_default-title"}
{ts}Default{/ts}
{/htxt}
diff --git a/templates/CRM/Admin/Page/MessageTemplates.tpl b/templates/CRM/Admin/Page/MessageTemplates.tpl
index abd4853590..d1db68227d 100644
--- a/templates/CRM/Admin/Page/MessageTemplates.tpl
+++ b/templates/CRM/Admin/Page/MessageTemplates.tpl
@@ -100,9 +100,10 @@
{if $type eq 'userTemplates'}
- {ts}User-driven message templates allow you to save and re-use messages with layouts. They are useful if you need to send similar emails to contacts on a recurring basis. You can also use them in CiviMail Mailings and they are required for CiviMember membership renewal reminders.{/ts} {help id="id-intro"}
+ {capture assign=schedRemURL}{crmURL p='civicrm/admin/scheduleReminders' q="reset=1"}{/capture}
+ {ts 1=$schedRemURL}User-driven message templates allow you to save and re-use messages with layouts. They are useful if you need to send similar emails or letters to contacts on a recurring basis. You can also use them in CiviMail mailings. Messages used for membership renewal reminders, as well as event and activity related reminders should be created via
Scheduled Reminders.{/ts} {help id="id-intro"}
{else}
- {ts}System workflow message templates are used to generate the emails sent to consituents and administrators for contribution receipts, event confirmations and many other workflows. You can customize the style and wording of these messages here.{/ts} {help id="id-system-workflow"}
+ {ts}System workflow message templates are used to generate the emails sent to constituents and administrators for contribution receipts, event confirmations and many other workflows. You can customize the style and wording of these messages here.{/ts} {help id="id-system-workflow"}
{/if}
diff --git a/templates/CRM/Admin/Page/ScheduleReminders.tpl b/templates/CRM/Admin/Page/ScheduleReminders.tpl
index 7cc39e35fc..6499909da7 100644
--- a/templates/CRM/Admin/Page/ScheduleReminders.tpl
+++ b/templates/CRM/Admin/Page/ScheduleReminders.tpl
@@ -29,6 +29,10 @@
{if $action eq 1 or $action eq 2 or $action eq 8 or $action eq 16384}
{include file="CRM/Admin/Form/ScheduleReminders.tpl"}
{else}
+{capture assign=schedRemindersDocLink}{docURL page="user/current/email/scheduled-reminders/"}{/capture}
+
+ {ts}Scheduled reminders allow you to automatically send messages to contacts regarding their memberships, participation in events, or other activities.{/ts} {$schedRemindersDocLink}
+
{if $rows}
{include file="CRM/Admin/Page/Reminders.tpl"}