User Directory Application
 | Displays a directory of all users in the wiki |
| Type | XAR |
| Category | Application |
| Developed by | |
| Rating | |
| License | GNU Lesser General Public License 2.1 |
| Bundled With | XWiki Standard |
| Compatibility | Since 5.1M1 (before that was bundled in XWiki's XAR). |
Table of contents
Description
Lists all users present in the current wiki.
Default View
See View all User on the Wiki.
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.
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.
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
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)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:
- Log in the wiki with a user having Administration rights
- Go to the Administration page and select the Import category
- Follow the on-screen instructions to upload the downloaded XAR
- Click on the uploaded XAR and follow the instructions
- 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-directory-ui 18.4.0):
- org.xwiki.platform:xwiki-platform-rendering-macro-velocity 18.4.0
- org.xwiki.rendering:xwiki-rendering-macro-html 18.4.0
- org.xwiki.rendering:xwiki-rendering-macro-message 18.4.0
- org.xwiki.platform:xwiki-platform-rendering-macro-include 18.4.0
- org.xwiki.platform:xwiki-platform-tag-ui 18.4.0
- org.xwiki.platform:xwiki-platform-livetable-ui 18.4.0
