CustomField Admin - Decouple page code from form code
[civicrm-core.git] / templates / CRM / Custom / 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-group_intro-title"}
11 {ts}Custom Fields{/ts}
12 {/htxt}
13 {htxt id="id-group_intro"}
14 {ts}Use this form to set the title, the type of record the fields will be used for, and set-level help. You will then be able to add any number of fields to the set.{/ts} {docURL page="user/organising-your-data/creating-custom-fields"}
15 {/htxt}
16
17 {htxt id="id-title-title"}
18 {ts}Title{/ts}
19 {/htxt}
20 {htxt id="id-title"}
21 {ts}For 'inline' display custom sets, this title will appear as the fieldset legend. If you choose the 'tab' display style (which is available for Contact record custom fields), the title will be used for the navigation tab.{/ts}
22 {/htxt}
23
24 {htxt id="id-display_style-title"}
25 {ts}Display Style{/ts}
26 {/htxt}
27 {htxt id="id-display_style"}
28 {ts}Select 'Inline' to include this set of fields in the main contact Add/Edit form and Contact Summary screens. Select 'Tab' or 'Tab with Table' to create a separate navigation tab for display and editing these values (generally for less frequently accessed and/or larger sets of fields). 'Tab with Table' is recommended for customs data sets which allow multiple records.{/ts}
29 <p class="font-italic">{ts}NOTE: This setting applies only to custom sets used for Contact records (e.g. Individuals, Households, Organizations, or ALL contact types).{/ts}</p>
30 {/htxt}
31
32 {htxt id="id-extends-title"}
33 {ts}Used For{/ts}
34 {/htxt}
35 {htxt id="id-extends"}
36 {ts}Select the type of record that this set of custom fields is applicable for. You can configure custom data for a specific type of contact (e.g. Individuals but NOT Organizations), ANY type of contact, or other record types such as activities, contributions, memberships and event participants.{/ts}
37 <p>{ts}EXAMPLE: If you are using CiviEvent, and you want to collect information from people registering for your events, select "Participants". If the information is specific to one type of participant (e.g. event volunteers), select "Participants (role)" and then select the role (e.g. 'Volunteer').{/ts}</p>
38 <p>{ts}If your site uses Contact Subtypes, you can assign this set of custom fields to a specific subtype (e.g. 'Student'), OR you can select '- Any -' which makes the fields available to contacts of the parent type (e.g. 'Individual') as well as to any subtypes.{/ts}</p>
39 {/htxt}
40
41 {capture assign=importMultipleURL}{crmURL p="civicrm/import/custom" q="reset=1"}{/capture}
42 {htxt id="id-is_multiple-title"}
43 {ts}Allow Multiple Records{/ts}
44 {/htxt}
45 {htxt id="id-is_multiple"}
46 <p>{ts}Checking this box allows you to enter multiple sets of values for a given contact.{/ts}</p>
47 <p>{ts}<strong>EXAMPLE:</strong> When creating a set of custom fields used to collect <strong>Employment History</strong> - you might have fields for Job Title, Start Date, End Date, and Reason for Leaving. Checking the "multiple records" box allows you to collect information for multiple jobs.{/ts}</p>
48 <p>{ts}You can also set the maximum number of records which can be recorded per contact. Using the previous example, you might only want data for the three most recent jobs.{/ts}</p>
49 <p>{ts 1=$importMultipleURL}Use the <a href="%1">Multi-value Custom Data Import tool</a> to import data into multiple record custom fields (contact records must already exist).{/ts}</p>
50 <p>
51 {ts}CAUTION: The following features are NOT available for custom fields in 'multiple record' custom set:{/ts}
52 <ul>
53 <li>{ts}They can not be Exported{/ts}</li>
54 <li>{ts}If they are included in a report as a display column, only the first set of values are shown.{/ts}</li>
55 </ul>
56 </p>
57 {/htxt}
58
59 {htxt id="id-max_multiple-title"}
60 {ts}Maximum Records{/ts}
61 {/htxt}
62 {htxt id="id-max_multiple"}
63 {ts}If you want to set a specific limit on the maximum number of records, enter that number. Otherwise leave this field blank.{/ts}
64 {/htxt}
65
66 {htxt id="id-weight-title"}
67 {ts}Order{/ts}
68 {/htxt}
69 {htxt id="id-weight"}
70 {ts}Weight controls the order in which custom field sets are presented when there are more than one. Enter a positive or negative integer - lower numbers are displayed ahead of higher numbers.{/ts}
71 {/htxt}
72
73 {htxt id="id-collapse-title"}
74 {ts}Collapsed on Page{/ts}
75 {/htxt}
76 {htxt id="id-collapse"}
77 {ts}Check this box if you want only the title for this fieldset to be displayed when the page is initially loaded (fields are hidden).{/ts}
78 {/htxt}
79
80 {htxt id="id-collapse-adv-title"}
81 {ts}Collapsed on Search{/ts}
82 {/htxt}
83 {htxt id="id-collapse-adv"}
84 {ts}Check this box if you want only the title for this fieldset to be displayed when the page is initially loaded (fields are hidden) on advanced search.{/ts}
85 {/htxt}
86
87 {htxt id="id-is-public-title"}
88 {ts}Is this Custom Group Public{/ts}
89 {/htxt}
90 {htxt id="id-is-public"}
91 {ts}Check this box if you want this custom group to be displayed on public forms e.g. Event Information page. Only public custom groups will be included in event receipts.{/ts} {docURL page="user/organising-your-data/creating-custom-fields/#is-this-custom-field-set-public"}
92 {/htxt}
93
94 {htxt id="id-help_pre-title"}
95 {ts}Pre Help{/ts}
96 {/htxt}
97 {htxt id="id-help_pre"}
98 {ts}Explanatory text displayed at the beginning of this sets of fields.{/ts}
99 {/htxt}
100
101 {htxt id="id-help_post-title"}
102 {ts}Post Help{/ts}
103 {/htxt}
104 {htxt id="id-help_post"}
105 {ts}Explanatory text displayed below this set of fields.{/ts}
106 {/htxt}