Skip to content

Commit 281fd9e

Browse files
agileware-justinagileware-justin
committed
CIVICRM-1734 Change the help text for Message Templates and Scheduled Reminders to include link to CiviCRM Token Documentation page
1 parent 20a0376 commit 281fd9e

File tree

2 files changed

+84
-81
lines changed

2 files changed

+84
-81
lines changed

‎templates/CRM/Admin/Form/MessageTemplates.tpl

+79-81
Original file line numberDiff line numberDiff line change
@@ -8,128 +8,126 @@
88
+--------------------------------------------------------------------+
99
*}
1010
{* this template is used for adding/editing/deleting Message Templates *}
11-
{capture assign=tokenDocsRepeated}{docURL page="user/common-workflows/tokens-and-mail-merge" text="token documentation"}{/capture}
1211

1312
{if $action neq 8}
14-
<div class="help">
13+
<div class="help">
1514
{ts}Use this form to add or edit re-usable message templates.{/ts} {help id="id-intro" file="CRM/Admin/Page/MessageTemplates.hlp"}
16-
</div>
15+
</div>
1716
{/if}
1817

1918
<h3>{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}</h3>
2019

2120
<div class="crm-block crm-form-block">
22-
<div class="form-item" id="message_templates">
23-
{if $action eq 8}
24-
<div class="messages status no-popup">
25-
{icon icon="fa-info-circle"}{/icon}
26-
{ts 1=$msg_title|escape}Do you want to delete the message template '%1'?{/ts}
27-
</div>
28-
{else}
29-
<div class="crm-submit-buttons">{include file="CRM/common/formButtons.tpl" location="top"}</div>
30-
<table class="form-layout-compressed">
21+
<div class="form-item" id="message_templates">
22+
{if $action eq 8}
23+
<div class="messages status no-popup">
24+
{icon icon="fa-info-circle"}{/icon}
25+
{ts 1=$msg_title|escape}Do you want to delete the message template '%1'?{/ts}
26+
</div>
27+
{else}
28+
<div class="crm-submit-buttons">{include file="CRM/common/formButtons.tpl" location="top"}</div>
29+
<table class="form-layout-compressed">
3130
<tr>
32-
<td class="label-left">{$form.msg_title.label}</td>
33-
<td>{$form.msg_title.html}
34-
<br /><span class="description html-adjust">{ts}Descriptive title of message - used for template selection.{/ts}</span>
35-
</td>
31+
<td class="label-left">{$form.msg_title.label}</td>
32+
<td>{$form.msg_title.html}
33+
<br /><span class="description html-adjust">{ts}Descriptive title of message - used for template selection.{/ts}</span>
34+
</td>
3635
</tr>
3736
<tr>
38-
<td class="label-left">{$form.file_type.label}</td>
39-
<td>{$form.file_type.html}
40-
<br /><span class="description html-adjust">{ts}Compose a message on-screen for general use in emails or document output, or upload a pre-composed document for mail-merge.{/ts}</span>
41-
</td>
37+
<td class="label-left">{$form.file_type.label}</td>
38+
<td>{$form.file_type.html}
39+
<br /><span class="description html-adjust">{ts}Compose a message on-screen for general use in emails or document output, or upload a pre-composed document for mail-merge.{/ts}</span>
40+
</td>
4241
</tr>
4342
<tr>
44-
<td class="label-left">{$form.msg_subject.label}</td>
45-
<td>
46-
{$form.msg_subject.html|crmAddClass:huge}
47-
<input class="crm-token-selector big" data-field="msg_subject" />
48-
{help id="id-token-subject" tplFile=$tplFile isAdmin=$isAdmin file="CRM/Contact/Form/Task/Email.hlp"}
49-
<br /><span class="description">{ts}Subject for email message.{/ts} {ts 1=$tokenDocsRepeated}Tokens may be included (%1).{/ts}</span>
50-
</td>
43+
<td class="label-left">{$form.msg_subject.label}</td>
44+
<td>
45+
{$form.msg_subject.html|crmAddClass:huge}
46+
<input class="crm-token-selector big" data-field="msg_subject" />
47+
{help id="id-token-subject" tplFile=$tplFile isAdmin=$isAdmin file="CRM/Contact/Form/Task/Email.hlp"}
48+
</td>
5149
</tr>
5250
<tr>
53-
<td class="label-left">{$form.file_id.label}</td>
54-
<td>{$form.file_id.html}
55-
{if $attachment}
56-
{foreach from=$attachment key=attKey item=attVal}
57-
<div class="crm-attachment-wrapper crm-entity" id="file_{$attVal.fileID}">
58-
<strong><a class="crm-attachment" href="{$attVal.url}">{$attVal.cleanName}</a></strong>
59-
{if $attVal.description}&nbsp;-&nbsp;{$attVal.description}{/if}
60-
{if $attVal.deleteURLArgs}
61-
<a href="#" class="crm-hover-button delete-attachment" data-mimetype="{$attVal.mime_type}" data-filename="{$attVal.cleanName}" data-args="{$attVal.deleteURLArgs}" title="{ts}Delete File{/ts}"><span class="icon delete-icon"></span></a>
62-
{/if}
63-
{include file="CRM/Form/attachmentjs.tpl" context='MessageTemplate'}
64-
{/foreach}
51+
<td class="label-left">{$form.file_id.label}</td>
52+
<td>{$form.file_id.html}
53+
{if $attachment}
54+
{foreach from=$attachment key=attKey item=attVal}
55+
<div class="crm-attachment-wrapper crm-entity" id="file_{$attVal.fileID}">
56+
<strong><a class="crm-attachment" href="{$attVal.url}">{$attVal.cleanName}</a></strong>
57+
{if $attVal.description}&nbsp;-&nbsp;{$attVal.description}{/if}
58+
{if $attVal.deleteURLArgs}
59+
<a href="#" class="crm-hover-button delete-attachment" data-mimetype="{$attVal.mime_type}" data-filename="{$attVal.cleanName}" data-args="{$attVal.deleteURLArgs}" title="{ts}Delete File{/ts}"><span class="icon delete-icon"></span></a>
60+
{/if}
61+
{include file="CRM/Form/attachmentjs.tpl" context='MessageTemplate'}
62+
{/foreach}
6563
{/if}
66-
<br /><span class="description html-adjust">{ts}Upload the document in .docx or .odt format.{/ts}</span>
67-
</td>
64+
<br /><span class="description html-adjust">{ts}Upload the document in .docx or .odt format.{/ts}</span>
65+
</td>
6866
</tr>
6967
<tr>
70-
</table>
68+
</table>
7169

7270
<div id="msg_html_section" class="crm-accordion-wrapper crm-html_email-accordion ">
7371
<div class="crm-accordion-header">
74-
{ts}HTML Format{/ts}
75-
{help id="id-message-text" file="CRM/Contact/Form/Task/Email.hlp"}
72+
{ts}HTML Format{/ts}
73+
{help id="id-message-text" file="CRM/Contact/Form/Task/Email.hlp"}
7674
</div><!-- /.crm-accordion-header -->
77-
<div class="crm-accordion-body">
78-
<div class="helpIcon" id="helphtml">
79-
<input class="crm-token-selector big" data-field="msg_html" />
80-
{help id="id-token-html" tplFile=$tplFile isAdmin=$isAdmin file="CRM/Contact/Form/Task/Email.hlp"}
81-
</div>
82-
<div class="clear"></div>
83-
<div class='html'>
84-
{$form.msg_html.html|crmAddClass:huge}
85-
<div class="description">{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}</div>
86-
</div>
75+
<div class="crm-accordion-body">
76+
<div class="helpIcon" id="helphtml">
77+
<input class="crm-token-selector big" data-field="msg_html" />
78+
{help id="id-token-html" tplFile=$tplFile isAdmin=$isAdmin file="CRM/Contact/Form/Task/Email.hlp"}
79+
</div>
80+
<div class="clear"></div>
81+
<div class='html'>
82+
{$form.msg_html.html|crmAddClass:huge}
83+
<div class="description">{ts}An HTML formatted version of this message will be sent to contacts whose Email Format preference is 'HTML' or 'Both'.{/ts}</div>
84+
</div>
8785
</div><!-- /.crm-accordion-body -->
8886
</div><!-- /.crm-accordion-wrapper -->
8987

9088
<div id="msg_text_section" class="crm-accordion-wrapper crm-plaint_text_email-accordion ">
9189
<div class="crm-accordion-header">
92-
{ts}Plain-Text Format{/ts}
90+
{ts}Plain-Text Format{/ts}
9391
</div><!-- /.crm-accordion-header -->
94-
<div class="crm-accordion-body">
95-
<div class="helpIcon" id="helptext">
96-
<input class="crm-token-selector big" data-field="msg_text" />
97-
{help id="id-token-text" tplFile=$tplFile file="CRM/Contact/Form/Task/Email.hlp"}
98-
</div>
99-
<div class="clear"></div>
100-
<div class='text'>
101-
{$form.msg_text.html|crmAddClass:huge}
102-
<div class="description">{ts}Text formatted message.{/ts} {ts 1=$tokenDocsRepeated}Tokens may be included (%1).{/ts}</div>
103-
</div>
104-
</div><!-- /.crm-accordion-body -->
92+
<div class="crm-accordion-body">
93+
<div class="helpIcon" id="helptext">
94+
<input class="crm-token-selector big" data-field="msg_text" />
95+
{help id="id-token-text" tplFile=$tplFile file="CRM/Contact/Form/Task/Email.hlp"}
96+
</div>
97+
<div class="clear"></div>
98+
<div class='text'>
99+
{$form.msg_text.html|crmAddClass:huge}
100+
<div class="description">{ts}Text formatted message.{/ts}</div>
101+
</div>
102+
</div><!-- /.crm-accordion-body -->
105103
</div><!-- /.crm-accordion-wrapper -->
106104

107105
<div id="pdf_format" class="crm-accordion-wrapper crm-html_email-accordion ">
108106
<div class="crm-accordion-header">
109-
{$form.pdf_format_id.label}
107+
{$form.pdf_format_id.label}
110108
</div><!-- /.crm-accordion-header -->
111-
<div class="crm-accordion-body">
112-
<div class="spacer"></div>
113-
<div class='html'>
114-
{$form.pdf_format_id.html}
115-
{help id="id-msg-template" file="CRM/Contact/Form/Task/PDFLetterCommon.hlp"}
116-
<div class="description">{ts}Page format to use when creating PDF files using this template.{/ts}</div>
117-
</div>
109+
<div class="crm-accordion-body">
110+
<div class="spacer"></div>
111+
<div class='html'>
112+
{$form.pdf_format_id.html}
113+
{help id="id-msg-template" file="CRM/Contact/Form/Task/PDFLetterCommon.hlp"}
114+
<div class="description">{ts}Page format to use when creating PDF files using this template.{/ts}</div>
115+
</div>
118116
</div><!-- /.crm-accordion-body -->
119117
</div><!-- /.crm-accordion-wrapper -->
120118

121-
{if !$workflow_id}
122-
<table class="form-layout-compressed">
119+
{if !$workflow_id}
120+
<table class="form-layout-compressed">
123121
<tr>
124122
<td class="label-left">{$form.is_active.label}</td>
125123
<td>{$form.is_active.html}</td>
126124
</tr>
127-
</table>
125+
</table>
126+
{/if}
128127
{/if}
129-
{/if}
130-
<div class="crm-submit-buttons">{include file="CRM/common/formButtons.tpl" location="bottom"}</div>
131-
<br clear="all" />
132-
</div>
128+
<div class="crm-submit-buttons">{include file="CRM/common/formButtons.tpl" location="bottom"}</div>
129+
<br clear="all" />
130+
</div>
133131
</div> <!-- end of crm-form-block -->
134132
{include file="CRM/Mailing/Form/InsertTokens.tpl"}
135133

‎templates/CRM/Contact/Form/Task/Email.hlp

+5
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,7 @@
77
| and copyright information, see https://civicrm.org/licensing |
88
+--------------------------------------------------------------------+
99
*}
10+
{capture assign=tokentext}{ts}Find out more about CiviCRM Tokens{/ts}{/capture}
1011
{htxt id="id-from_email-title"}
1112
{ts}From Address{/ts}
1213
{/htxt}
@@ -40,6 +41,7 @@
4041
{/htxt}
4142
{htxt id="id-token-subject"}
4243
<p>{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}</p>
44+
<p>{docURL page="user/common-workflows/tokens-and-mail-merge" text=$tokentext}</p>
4345
{/htxt}
4446

4547
{htxt id="id-token-text-title"}
@@ -57,6 +59,7 @@
5759
<p>{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,
5860
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
5961
be an equal sign and a number (=12). The number (12 in this example) is the id of that custom field.{/ts}</p>
62+
<p>{docURL page="user/common-workflows/tokens-and-mail-merge" text=$tokentext}</p>
6063
{/htxt}
6164

6265
{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
8285
<p>{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,
8386
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
8487
be an equal sign and a number (=12). The number (12 in this example) is the id of that custom field.{/ts}</p>
88+
<p>{docURL page="user/common-workflows/tokens-and-mail-merge" text=$tokentext}</p>
8589
{/htxt}
8690

8791
{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
9094
{htxt id="id-message-text"}
9195
<p>{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}</p>
9296
<p>{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}</p>
97+
<p>{docURL page="user/common-workflows/tokens-and-mail-merge" text=$tokentext}</p>
9398
{/htxt}

0 commit comments

Comments
 (0)