Mentions Application
![]() | This application allows for the integration of user mentions on XWiki. |
Type | XAR |
Category | |
Developed by | |
Rating | |
License | GNU Lesser General Public License 2.1 |
Compatibility | XWiki Standard 12.4-RC1+ |
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.
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 send to the mentioned user, who will eventually received 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 relies on the standard notification mechanism of XWiki, based on XWiki Activity Stream.
User Mentions Activation
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.
Administration
Global Mentions Activation
Known related issues
- https://jira.xwiki.org/browse/XWIKI-17335
- https://jira.xwiki.org/browse/XWIKI-17332