From: Justin Freeman Date: Tue, 11 May 2021 04:52:51 +0000 (+1000) Subject: CIVICRM-1734 Change the help text for Message Templates and Scheduled Reminders to... X-Git-Url: https://vcs.fsf.org/?a=commitdiff_plain;h=281fd9e9a348d317d608ffdd1bc36753db3415b1;p=civicrm-core.git CIVICRM-1734 Change the help text for Message Templates and Scheduled Reminders to include link to CiviCRM Token Documentation page --- diff --git a/templates/CRM/Admin/Form/MessageTemplates.tpl b/templates/CRM/Admin/Form/MessageTemplates.tpl index 537e567516..34208cc2c4 100644 --- a/templates/CRM/Admin/Form/MessageTemplates.tpl +++ b/templates/CRM/Admin/Form/MessageTemplates.tpl @@ -8,128 +8,126 @@ +--------------------------------------------------------------------+ *} {* this template is used for adding/editing/deleting Message Templates *} -{capture assign=tokenDocsRepeated}{docURL page="user/common-workflows/tokens-and-mail-merge" text="token documentation"}{/capture} {if $action neq 8} -
+
{ts}Use this form to add or edit re-usable message templates.{/ts} {help id="id-intro" file="CRM/Admin/Page/MessageTemplates.hlp"} -
+
{/if}

{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 eq 8} -
- {icon icon="fa-info-circle"}{/icon} - {ts 1=$msg_title|escape}Do you want to delete the message template '%1'?{/ts} -
-{else} -
{include file="CRM/common/formButtons.tpl" location="top"}
- +
+ {if $action eq 8} +
+ {icon icon="fa-info-circle"}{/icon} + {ts 1=$msg_title|escape}Do you want to delete the message template '%1'?{/ts} +
+ {else} +
{include file="CRM/common/formButtons.tpl" location="top"}
+
- - + + - - + + - - + + - - + +
{ts}Upload the document in .docx or .odt format.{/ts} + -
{$form.msg_title.label}{$form.msg_title.html} -
{ts}Descriptive title of message - used for template selection.{/ts} - 		{$form.msg_title.label}{$form.msg_title.html} +
{ts}Descriptive title of message - used for template selection.{/ts} +
{$form.file_type.label}{$form.file_type.html} -
{ts}Compose a message on-screen for general use in emails or document output, or upload a pre-composed document for mail-merge.{/ts} - 		{$form.file_type.label}{$form.file_type.html} +
{ts}Compose a message on-screen for general use in emails or document output, or upload a pre-composed document for mail-merge.{/ts} +
{$form.msg_subject.label} - {$form.msg_subject.html|crmAddClass:huge} - - {help id="id-token-subject" tplFile=$tplFile isAdmin=$isAdmin file="CRM/Contact/Form/Task/Email.hlp"} -
{ts}Subject for email message.{/ts} {ts 1=$tokenDocsRepeated}Tokens may be included (%1).{/ts} - 		{$form.msg_subject.label} + {$form.msg_subject.html|crmAddClass:huge} + + {help id="id-token-subject" tplFile=$tplFile isAdmin=$isAdmin file="CRM/Contact/Form/Task/Email.hlp"} +
{$form.file_id.label}{$form.file_id.html} - {if $attachment} - {foreach from=$attachment key=attKey item=attVal} -
- {$attVal.cleanName} - {if $attVal.description} - {$attVal.description}{/if} - {if $attVal.deleteURLArgs} - - {/if} - {include file="CRM/Form/attachmentjs.tpl" context='MessageTemplate'} - {/foreach} +
{$form.file_id.label}{$form.file_id.html} + {if $attachment} + {foreach from=$attachment key=attKey item=attVal} +
+ {$attVal.cleanName} + {if $attVal.description} - {$attVal.description}{/if} + {if $attVal.deleteURLArgs} + + {/if} + {include file="CRM/Form/attachmentjs.tpl" context='MessageTemplate'} + {/foreach} {/if} -
{ts}Upload the document in .docx or .odt format.{/ts} -
+
- {ts}HTML Format{/ts} - {help id="id-message-text" file="CRM/Contact/Form/Task/Email.hlp"} + {ts}HTML Format{/ts} + {help id="id-message-text" file="CRM/Contact/Form/Task/Email.hlp"}
-
-
- - {help id="id-token-html" tplFile=$tplFile isAdmin=$isAdmin file="CRM/Contact/Form/Task/Email.hlp"} -
-
-
- {$form.msg_html.html|crmAddClass:huge} -
{ts}An HTML formatted version of this message will be sent to contacts whose Email Format preference is 'HTML' or 'Both'.{/ts} {ts 1=$tokenDocsRepeated}Tokens may be included (%1).{/ts}
-
+
+
+ + {help id="id-token-html" tplFile=$tplFile isAdmin=$isAdmin file="CRM/Contact/Form/Task/Email.hlp"} +
+
+
+ {$form.msg_html.html|crmAddClass:huge} +
{ts}An HTML formatted version of this message will be sent to contacts whose Email Format preference is 'HTML' or 'Both'.{/ts}
+
- {ts}Plain-Text Format{/ts} + {ts}Plain-Text Format{/ts}
-
-
- - {help id="id-token-text" tplFile=$tplFile file="CRM/Contact/Form/Task/Email.hlp"} -
-
-
- {$form.msg_text.html|crmAddClass:huge} -
{ts}Text formatted message.{/ts} {ts 1=$tokenDocsRepeated}Tokens may be included (%1).{/ts}
-
-
+
+
+ + {help id="id-token-text" tplFile=$tplFile file="CRM/Contact/Form/Task/Email.hlp"} +
+
+
+ {$form.msg_text.html|crmAddClass:huge} +
{ts}Text formatted message.{/ts}
+
+
- {$form.pdf_format_id.label} + {$form.pdf_format_id.label}
-
-
-
- {$form.pdf_format_id.html} - {help id="id-msg-template" file="CRM/Contact/Form/Task/PDFLetterCommon.hlp"} -
{ts}Page format to use when creating PDF files using this template.{/ts}
-
+
+
+
+ {$form.pdf_format_id.html} + {help id="id-msg-template" file="CRM/Contact/Form/Task/PDFLetterCommon.hlp"} +
{ts}Page format to use when creating PDF files using this template.{/ts}
+
- {if !$workflow_id} - + {if !$workflow_id} +
-
{$form.is_active.label} {$form.is_active.html}
+ + {/if} {/if} - {/if} -
{include file="CRM/common/formButtons.tpl" location="bottom"}
-
-
+
{include file="CRM/common/formButtons.tpl" location="bottom"}
+
+
{include file="CRM/Mailing/Form/InsertTokens.tpl"} diff --git a/templates/CRM/Contact/Form/Task/Email.hlp b/templates/CRM/Contact/Form/Task/Email.hlp index 2498458c78..92d987b7b3 100644 --- a/templates/CRM/Contact/Form/Task/Email.hlp +++ b/templates/CRM/Contact/Form/Task/Email.hlp @@ -7,6 +7,7 @@ | and copyright information, see https://civicrm.org/licensing | +--------------------------------------------------------------------+ *} +{capture assign=tokentext}{ts}Find out more about CiviCRM Tokens{/ts}{/capture} {htxt id="id-from_email-title"} {ts}From Address{/ts} {/htxt} @@ -40,6 +41,7 @@ {/htxt} {htxt id="id-token-subject"}

{ts}Use a token in the Subject when you are sending mail to a number of recipients and want to include their name and / or other values from their contact record automatically in the subject line.{/ts}

+

{docURL page="user/common-workflows/tokens-and-mail-merge" text=$tokentext}

{/htxt} {htxt id="id-token-text-title"} @@ -57,6 +59,7 @@

{ts}Custom tokens (based on custom data) can be added for organizations as well. These tokens will not be displayed in the list of available tokens, but can be added manually. The format is {literal}{contact.custom_12}{/literal} – where 12 is the ID of the custom data field. To find the custom data field ID, go Administer > Customize Data & Screens > Custom Fields and click ‘edit’ on the field you want to use. Look at the URL. The last part of the URL will be an equal sign and a number (=12). The number (12 in this example) is the id of that custom field.{/ts}

+

{docURL page="user/common-workflows/tokens-and-mail-merge" text=$tokentext}

{/htxt} {htxt id="id-token-html-title"} @@ -82,6 +85,7 @@ be an equal sign and a number (=12). The number (12 in this example) is the id o

{ts}Custom tokens (based on custom data) can be added for organizations as well. These tokens will not be displayed in the list of available tokens, but can be added manually. The format is {literal}{contact.custom_12}{/literal} – where 12 is the ID of the custom data field. To find the custom data field ID, go Administer > Customize Data & Screens > Custom Fields and click ‘edit’ on the field you want to use. Look at the URL. The last part of the URL will be an equal sign and a number (=12). The number (12 in this example) is the id of that custom field.{/ts}

+

{docURL page="user/common-workflows/tokens-and-mail-merge" text=$tokentext}

{/htxt} {htxt id="id-message-text-title"} @@ -90,4 +94,5 @@ be an equal sign and a number (=12). The number (12 in this example) is the id o {htxt id="id-message-text"}

{ts}You can send your email as a simple text-only message, as an HTML formatted message, or both. Text-only messages are sufficient for most email communication - and some recipients may prefer not to receive HTML formatted messages.{/ts}

{ts}HTML messages have more visual impact, allow you to include images, and may be more readable if you are including links to website pages. However, different email programs may interpret HTML formats differently - so use this option cautiously unless you have a template format that has been tested with different web and desktop email programs.{/ts}

+

{docURL page="user/common-workflows/tokens-and-mail-merge" text=$tokentext}

{/htxt}