Difference between revisions of "Additional name fields"

Jump to: navigation, search
m (Example 1)
 
(15 intermediate revisions by 6 users not shown)
Line 1: Line 1:
{{New features}}
+
{{Accounts}}
 +
As well as first name and surname, the following additional name fields may be used:
  
Moodle 2.6 now has four additional name fields. These fields allow for further detail to be displayed about the user. The additional name fields are:
 
 
* First name - phonetic
 
* First name - phonetic
 
* Surname - phonetic
 
* Surname - phonetic
Line 7: Line 7:
 
* Alternate name
 
* Alternate name
  
[[File:26names.png]]
+
==Administration settings==
  
==Display==
+
===Full name format===
 +
[[File:participants-after.png|thumb|List of users with full names displayed]]
 +
An administrator can set how names are displayed across the site via the setting 'Full name format' (fullnamedisplay) in ''Administration > Site administration > Users > Permissions > User policies''. The default setting is ''language'', which means that names are displayed according to information from the language pack used on the site. Alternatively, the following placeholders may be used:
  
The display of the user's full name is determined by the capability *Add capability here*
 
 
[[File:participants-after.png]]
 
 
==Configuration==
 
 
Configuration of the additional name fields is done in the following Administration page [Administration ► Site administration ► Users ► Permissions ► User policies].
 
The setting to change is "Full name format" (fullnamedisplay).
 
This setting uses the following placeholders:
 
 
* firstname
 
* firstname
 
* lastname
 
* lastname
Line 26: Line 19:
 
* middlename
 
* middlename
 
* alternatename
 
* alternatename
* language (used on its own to force the use of the language pack)
 
By default it has the place-holder "language" and it will use the local language pack to determine how user names are displayed. (location: /lang/en/moodle.php - fullnamedisplay)
 
  
To enable the additional name fields, just enter in the placeholders into the text box. The order that you enter in the names will be the order that they are displayed around Moodle.
+
For example, a user with first name John, surname Doe, middle name James, first name phonetic Jon, and surname phonetic Dough will have his name displayed as
  
===Example 1===
+
*John James Doe when 'Full name format' is set to ''firstname middlename lastname'' and
{| class="wikitable"
+
*Doe John (Dough Jon) when 'Full name format' is set to ''lastname firstname (lastnamephonetic firstnamephonetic)''
!First name  
 
!Surname
 
!Middle name
 
!Surname - phonetic
 
!First name - phonetic
 
|-
 
|John
 
|Doe
 
|James
 
|Dough
 
|Jon
 
|}
 
  
'''Full name format setting'''
+
Users with the [[Capabilities/moodle/site:viewfullnames|view full names capability]] (by default users with the role of manager, teacher or non-editing teacher) can always see first and last names, regardless of the "Full name format" setting.
  
<blockquote>firstname middlename lastname</blockquote>
+
Note for sites upgrading from an earlier version: The 'Full name format' setting was previously in ''Site policies''.
  
will display:
+
===Alternative full name format===
  
<blockquote>John James Doe</blockquote>
+
The alternative full name format setting may be used to define how names are shown to users with the [[Capabilities/moodle/site:viewfullnames|view full names capability]]. For example, it may be set to ''lastname firstname (lastnamephonetic firstnamephonetic)'' so that phonetic names are also displayed.
  
Other characters can be included in the setting such as commas and parenthesis.
+
==User profile settings==
  
===Example 2===
+
Users can enter additional names by editing their profile in ''Administration > My profile settings > Edit profile''.
  
'''Full name format setting'''
+
First name, surname and any additional names specified by an administrator in 'Full name format' are listed in the General section. Additional names not specified in 'Full name format' are listed in an "Additional names' section.
  
<blockquote>lastname firstname (lastnamephonetic firstnamephonetic)</blockquote>
+
{|
 
+
| [[File:name fields in general section.png|thumb|Name fields as specified in 'Full name format']]
will display:
+
| [[File:additional name fields.png|thumb|Additional name fields]]
 
+
|}
<blockquote>Doe John (Dough Jon)</blockquote>
 
 
 
==Updating the user's profile==
 
 
 
==Upgrade from previous versions==
 
  
When upgrading to 2.6, the "Full name format" (fullnamedisplay) setting found in [Administration ► Site administration ► Security ► Site policies] will automatically be changed over. All of the additional name fields will be blank.
+
[[es:Campos de nombre adicionales]]
 +
[[de:Zusätzliche Namen]]
 +
[[ja:追加氏名フィールド]]
 +
[[fr:Champs pour noms supplémentaires]]

Latest revision as of 12:34, 13 May 2019

As well as first name and surname, the following additional name fields may be used:

  • First name - phonetic
  • Surname - phonetic
  • Middle name
  • Alternate name

Administration settings

Full name format

List of users with full names displayed

An administrator can set how names are displayed across the site via the setting 'Full name format' (fullnamedisplay) in Administration > Site administration > Users > Permissions > User policies. The default setting is language, which means that names are displayed according to information from the language pack used on the site. Alternatively, the following placeholders may be used:

  • firstname
  • lastname
  • firstnamephonetic
  • lastnamephonetic
  • middlename
  • alternatename

For example, a user with first name John, surname Doe, middle name James, first name phonetic Jon, and surname phonetic Dough will have his name displayed as

  • John James Doe when 'Full name format' is set to firstname middlename lastname and
  • Doe John (Dough Jon) when 'Full name format' is set to lastname firstname (lastnamephonetic firstnamephonetic)

Users with the view full names capability (by default users with the role of manager, teacher or non-editing teacher) can always see first and last names, regardless of the "Full name format" setting.

Note for sites upgrading from an earlier version: The 'Full name format' setting was previously in Site policies.

Alternative full name format

The alternative full name format setting may be used to define how names are shown to users with the view full names capability. For example, it may be set to lastname firstname (lastnamephonetic firstnamephonetic) so that phonetic names are also displayed.

User profile settings

Users can enter additional names by editing their profile in Administration > My profile settings > Edit profile.

First name, surname and any additional names specified by an administrator in 'Full name format' are listed in the General section. Additional names not specified in 'Full name format' are listed in an "Additional names' section.

Name fields as specified in 'Full name format'
Additional name fields