User Directory Application

Last modified by Thomas Mortagne on 2024/07/05 17:54

userDisplays a directory of all users in the wiki
TypeXAR
Category
Developed by

XWiki Development Team

Rating
0 Votes
LicenseGNU Lesser General Public License 2.1
Bundled With

XWiki Standard

Compatibility

Since 5.1M1 (before that was bundled in XWiki's XAR).

Description

Lists all users present in the current wiki.

Default View

user-directory.png

Customization

It's possible to customize the columns to display in the directory's table.

Note: The Picture ("_avatar") and the User ID ("doc.name") columns are unmodifiable and will always appear first in the user directory.

For the entire wiki

Starting with XWiki 6.3M1, the administrator of the wiki can customize the default columns to be displayed by the user directory.

userDirectoryGloballyConfigurableInAdministration.png

To do this, the admin needs to use the "User Directory" application configuration section in the wiki's Administration area.

Resetting to default will use the application-default columns "first_name" and "last_name".

For each user

By default, each user can customize his own view of the User Directory by choosing which columns to see.

user-directory-customization.png

To do this, the user needs to use the "customize" link inside the info box at the top of the user directory's display.

Resetting to default will use the columns set by the admin for the entire wiki (see the previous section).

Preventing Customization

The instructions below should be considered as hacks and they're not official features of the User Directory Application. Thus they may not work in the future or not be perfect with regards to upgrades. In the future, if this use case is asked enough, we would need to make it an official configuration option.

It's possible to prevent users from customizing the User Directory, by editing the Main.UserDirectory page and changing the line from:

#displayUserDirectory(true)

to

#displayUserDirectory(false)

Get Connected