User Mentions Application
Macro to mention a user |
Type | XAR |
Category | Application |
Developed by | |
Rating | |
License | GNU Lesser General Public License 2.1 |
Compatibility | XWiki Standard 12.4+ |
Table of contents
Description
This Mentions application allows for the integration of user mentions on XWiki.
Overview
This application integrates the user mentions feature in XWiki. Users can mention other users using a dedicated macro. Users are then notified of the pages in which they are mentioned through XWiki activity stream.
Mentions Auto-Completion
To assist quickly mentioning users, an auto-completion is displayed when '@' is typed in the rich editor.
A list of users matching the characters typed after the '@' is presented as you type.
Mention Macro
The mention macro allows for the insertion of the mention to a user in a body of text.
It has two parameters:
- The identifier of the mentioned user
- The mode of display of the mentioned user identity:
- First and last name
- First name only
- User login
The mention macro can be user in all long text fields of the Wiki, for instance:
- The body of the documents
- Long text fields of the applications
- Comments
- Annotations
A notification will be sent to the mentioned user, who will eventually receive it according to its notifications settings.
Using the Rich Editor
To insert a mention:
- In the rich editor menu click on add a mention and select other macros
- Search for the User Mention entry and click on select
- Look for a user name in the first field
- Select a display method for the mention:
- First and last name of the user (e.g., John Doe)
- First name only (e.g., John)
- User login (e.g., JDoe)
These steps are detailed in the gallery below.
Using the Source Editor
{{mention identifier="XWiki.Admin" displayChoice="FIRST_NAME"/}}
{{mention identifier="XWiki.Admin" displayChoice="LOGIN"/}}
Notifications
The mentions rely on the standard notification mechanism of XWiki, based on XWiki Activity Stream.
User Mentions Activation
A user can choose if and how they want to receive their mentions through the notifications, using the notifications settings.
To do so, choose the notification entry in the user's profile and turn the toggle buttons on in the Notification menu or Email columns of the Mentions row.
Administration
Global Mentions Activation
Notifications can be globally configured on the wiki administration, in the Notifications entry (under the Other category).
To do so, turn the toggle buttons on in the Notification menu or Email columns of the Mentions row.
The users of the wiki still have the possibility to change these settings individually (see the User Mentions Activation section).
Mentions Colors Administration
Mentions colors can be configured in the wiki administration, in the sub-section Mentions of the Other section.
Two colors can be configured, the default color of the mentions, and the colors of the mentions to the current users.
Known related issues
- https://jira.xwiki.org/browse/XWIKI-17335
- https://jira.xwiki.org/browse/XWIKI-17332
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
Release Notes
v1.0
Dependencies
Dependencies for this extension (org.xwiki.contrib:mentions-ui 1.0):
- org.xwiki.contrib:mentions-api 1.0