Update Group.hlp
[civicrm-core.git] / templates / CRM / UF / Form / Group.hlp
1 {*
2 +--------------------------------------------------------------------+
3 | Copyright CiviCRM LLC. All rights reserved. |
4 | |
5 | This work is published under the GNU AGPLv3 license with some |
6 | permitted exceptions and without any warranty. For full license |
7 | and copyright information, see https://civicrm.org/licensing |
8 +--------------------------------------------------------------------+
9 *}
10 {htxt id='id-description-title'}
11 {ts}Help Description{/ts}
12 {/htxt}
13 {htxt id='id-description'}
14 {ts}Explanatory text for profile.{/ts}
15 {/htxt}
16
17 {htxt id='id-used_for-title'}
18 {ts}Used For{/ts}
19 {/htxt}
20 {htxt id='id-used_for'}
21 {ts}Profiles can be used in many different ways (and a single profile can be used in multiple contexts){/ts}:<br />
22 <ul class="left-alignment">
23 <li>{ts}You can collect additional information about a donor or event participant by including profiles directly in Online Contribution Pages and Event Registration forms. When using a profile in this manner you do not need to check any of the "Used For" checkboxes.{/ts}</li>
24 <li>{ts}Check <strong>Standalone Form or Directory</strong> if you want it to use this profile for custom forms, or contact listing and view screens (from the civicrm/profile path).{/ts}</li>
25 <li>{ts}Check <strong>Search Results</strong> to use this profile to display an alternate set of results columns for CiviCRM Basic and Advanced Search.{/ts}</li>
26 {if $config->userSystem->supports_form_extensions EQ '1'}
27 <li>{ts}Check <strong>User Registration</strong> if you want this Profile to be included in the New Account registration form.{/ts}</li>
28 <li>{ts}Check <strong>View/Edit User Account</strong> to include it in the view and edit screens for existing user accounts.{/ts}</li>
29 {/if}
30 </ul>
31 {docURL page="user/organising-your-data/profiles/"}
32 {/htxt}
33
34 {htxt id='id-profile_weight-title'}
35 {ts}Weight{/ts}
36 {/htxt}
37 {htxt id='id-profile_weight'}
38 {ts}Weight controls the order in which profiles are presented when more than one profile is included in User Registration or My Account screens. Enter a positive or negative integer - lower numbers are displayed ahead of higher numbers.{/ts}
39 {/htxt}
40
41 {htxt id='id-help_pre-title'}
42 {ts}Help Pre-Form{/ts}
43 {/htxt}
44 {htxt id='id-help_pre'}
45 {ts}Explanatory text displayed at the beginning of the form.{/ts}{ts}Note that this help text is displayed on profile create/edit screens only.{/ts}
46 {/htxt}
47
48 {htxt id='id-help_post-title'}
49 {ts}Help Post-Form{/ts}
50 {/htxt}
51 {htxt id='id-help_post'}
52 {ts}Explanatory text displayed at the end of the form.{/ts}{ts}Note that this help text is displayed on profile create/edit screens only.{/ts}
53 {/htxt}
54
55 {htxt id='id-limit_group-title'}
56 {ts}Limit Group{/ts}
57 {/htxt}
58 {htxt id='id-limit_group'}
59 {ts}Select a group if you are using this profile for search and listings, AND you want to limit the listings to members of a specific group.{/ts}
60 {/htxt}
61
62 {htxt id='id-add_group-title'}
63 {ts}Add to Group{/ts}
64 {/htxt}
65 {htxt id='id-add_group'}
66 {ts}Select a group if you want contacts to be automatically added to that group when the profile is submitted.{/ts}
67 {/htxt}
68
69 {htxt id='id-notify_email-title'}
70 {ts}Notify Email{/ts}
71 {/htxt}
72 {htxt id='id-notify_email'}
73 {ts}If you want member(s) of your organization to receive a notification email whenever this Profile form is used to enter or update contact information, enter one or more email addresses here. Multiple email addresses should be separated by a comma (e.g. jane@example.org, paula@example.org). The first email address listed will be used as the FROM address in the notifications.{/ts}
74 {/htxt}
75
76 {htxt id='id-post_URL-title'}
77 {ts}Redirect{/ts}
78 {/htxt}
79 {htxt id='id-post_URL'}
80 {ts}If you are using this profile as a contact signup or edit form, and want to redirect the user to a static URL after they've submitted the form, you can also use contact tokens in URL - enter the complete URL here. If this field is left blank, the built-in Profile form will be redisplayed with a generic status message - 'Your contact information has been saved.'{/ts}
81 {/htxt}
82
83 {htxt id='id-add_cancel_button-title'}
84 {ts}Add Cancel Button{/ts}
85 {/htxt}
86 {htxt id='id-add_cancel_button'}
87 {ts}Enable/Disable this checkbox to add/remove cancel button on the profile form.{/ts}
88 {/htxt}
89
90 {htxt id='id-cancel_URL-title'}
91 {ts}Cancel Redirect{/ts}
92 {/htxt}
93 {htxt id='id-cancel_URL'}
94 {ts}If you are using this profile as a contact signup or edit form, and want to redirect the user to a static URL if they click the Cancel button - enter the complete URL here. If this field is left blank, the built-in Profile form will be redisplayed.{/ts}
95 {/htxt}
96
97 {htxt id='id-cancel_button_text-title'}
98 {ts}Cancel Button Text{/ts}
99 {/htxt}
100 {htxt id='id-cancel_button_text'}
101 {ts}Override the default button text for the cancel button for this profile{/ts}
102 {/htxt}
103
104 {htxt id='id-submit_button_text-title'}
105 {ts}Submit Button Text{/ts}
106 {/htxt}
107 {htxt id='id-submit_button_text'}
108 {ts}Override the default button text for the submit button for this profile{/ts}
109 {/htxt}
110
111 {htxt id='id-add_captcha-title'}
112 {ts}reCaptcha{/ts}
113 {/htxt}
114 {htxt id='id-add_captcha'}
115 {capture assign="miscURL"}{crmURL p="civicrm/admin/setting/misc" q="reset=1"}{/capture}
116 <p>{ts}When reCAPTCHA is enabled for a profile form, anonymous users are required to read an image with letters and numbers and enter the value in a field. This helps prevent abuse by automated scripts.{/ts}</p>
117 <p>{ts 1="https://www.google.com/recaptcha" 2=$miscURL}To use reCAPTCHA you must sign up at <a href="%1" target="_blank">Google's reCaptcha site</a> to get your public and private keys. Then enter both keys in <a href="%2">Administer CiviCRM &raquo; System Settings &raquo; Misc (Undelete, PDFs, Limits, Logging, Captcha, etc.)</a>.{/ts}</p>
118 <p><strong>{ts}Do not enable this feature if you are using this profile as an HTML Form Snippet embedded in a non-CiviCRM web page. reCAPTCHA requires dynamic page generation. Submitting a stand-alone form with reCAPTCHA included will always result in a reCAPTCHA validation error.{/ts}</strong></p>
119 {if $config->userSystem->supports_form_extensions EQ '1'}
120 <p><strong>{ts}reCAPTCHA is also not available when a profile is used inside the User Registration and My Account screens.{/ts}</strong></p>
121 {/if}
122 {/htxt}
123
124 {htxt id='id-is_cms_user-title'}
125 {ts}Account Creation{/ts}
126 {/htxt}
127 {htxt id='id-is_cms_user'}
128 {ts 1=`$config->userFramework`}If you are using this profile as a contact signup form, using it in an online contribution page OR an event registration page, anonymous users will be given the option to create a %1 User Account as part of completing the form.{/ts}
129 {if $config->userSystem->is_drupal EQ '1'}
130 {ts}This feature requires your Drupal User Settings to allow 'vistors to create accounts' (with or without administrator approval). The 'Email Verification' option may be enabled or disabled.{/ts}
131 {ts}If the 'Email Verification' option is enabled, users will receive a welcome email from Drupal with login information. Otherwise they will select a Password inline, and if administrator approval is not required they will be automatically logged in as soon as the transaction is completed.{/ts}
132 {elseif $config->userFramework EQ 'Joomla'}
133 {ts}This feature requires the 'Allow User Registration' setting to be 'Yes' in Joomla Global Configuration >> System Settings.{/ts}
134 {/if}
135 {ts}In addition, you must include a Primary Email Address field in the profile.{/ts}
136 {/htxt}
137
138 {htxt id='id-is_update_dupe-title'}
139 {ts}Duplicate Matching{/ts}
140 {/htxt}
141 {htxt id='id-is_update_dupe'}
142 <p>{ts}If you are using the profile as a contact signup and editing form - this option controls what happens if the data matches an existing contact record. Using this option user can update the matching record or create a duplicate record or otherwise he will get a 'duplicate record' warning, and their input will not be saved. Contact matching is based on your configured 'Strict' rule for identifying duplicate contacts.{/ts} {docURL page="user/common-workflows/deduping-and-merging"}</p>
143 <p>{ts}This setting is ignored if the profile is embedded in an online contribution, membership signup or event registration form. In this case a contact match always results in the transaction being linked to the matching contact.</p>{/ts}
144 <p>{ts}In all cases, the check for an existing matching contact uses the default "Individual Strict Duplicate Matching Rule" (match on email address). If you are concerned with existing contact data being over-written by anonymous visitors, you can modify this rule to make matches less likely (or even impossible). For example, if you NEVER want anonymous input to match (i.e. always create a new contact record) - edit that rule and set the 'weight threshold' higher than 10. You will then need to run Find Duplicates periodically using a different rule, and merge any duplicate records with their associated memberships, contributions, etc.{/ts}</p>
145 <p>{ts}NOTE: If there are multiple matching contacts, the first matching record is used.{/ts}</p>
146 {/htxt}
147
148 {htxt id='id-is_map-title'}
149 {ts}Map Link{/ts}
150 {/htxt}
151 {htxt id='id-is_map'}
152 {ts}If enabled, a Map link is included on the profile listings rows and detail screens for any contacts whose records include sufficient location data for your mapping provider.{/ts}
153 {/htxt}
154
155 {htxt id='id-is_edit_link-title'}
156 {ts}Edit Link{/ts}
157 {/htxt}
158 {htxt id='id-is_edit_link'}
159 {ts}Check this box if you want to include a link in the listings to Edit profile fields. Only users with permission to edit the contact will see this link.{/ts}
160 {/htxt}
161
162 {htxt id='id-is_uf_link-title'}
163 {ts}User Link{/ts}
164 {/htxt}
165 {htxt id='id-is_uf_link'}
166 {ts 1=`$config->userFramework`}Check this box if you want to include a link in the listings to view contacts' %1 user account information (e.g. their 'My Account' page). This link will only be included for contacts who have a user account on your website.{/ts}
167 {/htxt}
168
169 {htxt id='id-is_proximity_search-title'}
170 {ts}Proximity Search{/ts}
171 {/htxt}
172 {htxt id='id-is_proximity_search'}
173 <p>
174 {ts}If you are using this profile as a search form, you can choose to include proximity searching. When enabled, a proximity search block will be added to the search criteria. This block will contain fields to set the proximity start address, and a field to set a 'Radius' (distance from that address).{/ts}
175 </p>
176 <p>
177 {ts}Set Proximity Search as required if you want all searches using this profile to require the user to enter a start address and a radius.{/ts}
178 </p>
179 <p>
180 {ts}IMPORTANT: You must enable a Mapping Provider in order to use the Proximity Search feature (Administer > System Settings > Mapping and Geocoding).{/ts}
181 </p>
182 {/htxt}