User Profile Application

Last modified by Thomas Mortagne on 2024/11/14 11:30

user_editPerforms operations related to the User Profile (change preferences, user watchlist, follow users, etc)
TypeXAR
Category
Developed by

XWiki Development Team

Rating
0 Votes
LicenseGNU Lesser General Public License 2.1
Bundled With

XWiki Standard

Compatibility

XWiki 3.4M1+ (Before 3.4M1 this applications was part of the Administration Application)

Installable with the Extension Manager

Description

The User Profile Application is bundled with XE/XEM and it allows users to change their profile preferences and follow the activity of other users

User Profile

You can easily access your user profile by clicking on your user name in the top right corner. The profile is also available by clicking on the drawer menu than clicking on the name.

ProfileMenu.png

Initially your profile will only display your first and last names.

RegisteredUserProfile.png

Add an avatar

You can start customizing your profile by adding an avatar. To do this, follow these steps:

XWiki 16.10.0+ Click on the button "Change Photo" located at the bottom of the avatar image above the Profile tab.

XWiki <16.10.0 Click on the pen icon located in the top right corner of the avatar image above the Profile tab.

Then, click Choose file/Browse, depending on your browser.

ChangePhoto.png

A pop-up will appear, which will allow you to select an image from your computer.

ChangePhoto1.png

After you have selected the image click on  Upload and select.

ChangePhoto2.png

Congrats! You have successfully customized your avatar.

UserProfileWithPhoto.png

Edit your profile information

To edit your profile information all you have to do is click on the yellow pen located at the top of your profile.

In the Personal Information section you may edit your first name, last name, company and write some text about you.

EditPersonalInformation.png

You can fill in your contact details in the Contact Information section. You may add your email, phone number and physical address.

EditContactInformation.png

The External Links area allows you to add links to your blog and blog feed.

EditExternalLinks.png

After you are done editing don't forget to save your changes. You have now successfully edited your profile to display information about yourself.

UserProfileContentEdit.png

Customize the information to display in the Profile tab

Starting with 4.0M2, as an administrator, you can configure which information is displayed for all users in their user Profile tab from their user profile page.

To do this, go to Administration > Users & Groups > User Profile and configure which fields of the XWiki.XWikiUsers class to display and how these fields should be grouped into sections.

If you wish to define and use some new fields, go to the XWiki.XWikiUsers page in class editor mode and add the new fields you want. Go back to the User Profile administration page and use the newly added fields.

Note: Starting with 4.0RC1, you can more easily specify the text to be used as section name.

userProfileCustomizer-withSectionIDs-screenshot.png

Recent Changes

The User profile displays a list of the pages that have been recently modified by the profile owner. This means for example if you create a new page, this event will show up in the My Activity Stream area of your profile.

UserProfileRecentChanges.png

User Preferences

The User Preferences section allows you to configure your editor and easily change your password. To access this section click on the Preferences link.

UserPreferences.png
Viewing user preferences.

Edit Preferences

To change your editor preferences click on the yellow pen in the top right corner.

UserPreferencesEdit.png
Editing user preferences.

  • Display preferences
    • Display hidden documents: By default technical documents are hidden, in the same manner as some files are hidden by your Operating System (such as Windows, Mac OS or Linux). You can decide to display those documents. Note that showing hidden documents also displays hidden macros.
    • XWiki <16.3.0  Enable extra accessibility features: This setting is useful for blind and visually impaired persons, it enables accessibility helpers in the User Interface. XWiki 16.3.0+ This user preference has been deprecated in favor of finer grained accessibility preferences. Use preferences such as Underline links instead.
  • XWiki 16.3.0+ Accessibility preferences
    • XWiki 16.3.0+ Underlining links: Pick a preferred display for links. There are three options for this preference.The default preference, Only inline links will underline only links that are inside a block of text. However links in lists or on their own will not be underlined. When Yes is picked, all links will be underlined. When No is picked, no link will be underlined. The Only inline link is a middle ground to have good readability (that's reduced when never underlining) and avoid UI cluttering (that's increased when underlining all the links).
  • Localization preferences
    • Timezone: You can define a different timezone than the one set by default.
  • Editor preferences
    • Default editor to use: You can choose between text and wysiwyg as your default editor
    • User type: Select between simple and advanced user, depending on your wiki needs. By selecting the simple user you will have access only to the default editor. If you select the advanced user, you have a wide variety of edit options.
  • Extensions Preferences
    • Enable extension conflict setup: Indicate if you want Extension Manager to ask you to confirm conflict resolution default rules (for example tell Extension Manager to ask you what to do if the document to upgrade has been removed from the wiki). The default is no.

Each time you select the value "---", it means that you are not interested in setting this preference by yourself, and you rely on the choice the Administrator of the wiki has made for you. This is the safest solution if you do not know what to do.

Change Password

To change you password, on the preferences page click on the Change password button. A new page will appear asking you to fill in the new password and reenter it. Click Update and you are done!

ChangePassword.png

Groups

It's possible to see, in the user profile, the groups the user is member of. This includes groups of groups and all wikis in case of global user.

groups.png

User Status

The "User status" feature supports messaging and networking inside the wiki. The users can now share their status messages which will be visible on profile pages and on the main dashboard.

See the documentation for the Message Stream Application.

Follow Other Users' Posts

To follow the posts of another user, go his user profile page and click on "Follow".

FollowUser.png

Notice that the "Follow" button is now named "Following".

FollowingUser.png

Unfollow an User

To unfollow an user, you have 2 options:

Go to the user's profile page and click on the red "x" to the right of the "Following" button.

UnfollowUser.png

Notice that the "Following" button is now named "Follow".

Go to your user profile, choose the "Network" tab, then click on the "Unfollow" link located to the right of the corresponding user.

UnfollowUserFormProfile.png

See the Members of Your Network

To see the members of your network,click on "Network".

SeeFollowedUsers.png

See the Network Activity

To see the network activity, click on "Network". The status messages are listed in the right column.

NetWorkTab.png

Prerequisites & Installation Instructions

We recommend using the Extension Manager to install this extension (Make sure that the text "Installable with the Extension Manager" is displayed at the top right location on this page to know if this extension can be installed with the Extension Manager). Note that installing Extensions when being offline is currently not supported and you'd need to use some complex manual method.

You can also use the following manual method, which is useful if this extension cannot be installed with the Extension Manager or if you're using an old version of XWiki that doesn't have the Extension Manager:

  1. Log in the wiki with a user having Administration rights
  2. Go to the Administration page and select the Import category
  3. Follow the on-screen instructions to upload the downloaded XAR
  4. Click on the uploaded XAR and follow the instructions
  5. You'll also need to install all dependent Extensions that are not already installed in your wiki

Dependencies

Dependencies for this extension (org.xwiki.platform:xwiki-platform-user-profile-ui 16.9.0):

Get Connected