Skip to Content

Changes for page MentionsMacro

Last modified by Drunk Monkey on 2023-11-02 09:50
From version 4.1
edited by Drunk Monkey
on 2020-10-06 05:16
Change comment: Install extension [org.xwiki.platform:xwiki-platform-mentions-ui/12.8]
To version 10.1
edited by Drunk Monkey
on 2022-03-20 10:03
Change comment: Install extension [org.xwiki.platform:xwiki-platform-mentions-ui/14.1]

Summary

Details

XWiki.JavaScriptExtension[0]
Code
... ... @@ -1,16 +1,15 @@
1 1  require.config({
2 2   paths: {
3 - 'xwiki-suggestUsers': "$xwiki.getSkinFile('uicomponents/suggest/suggestUsersAndGroups.js', true))" +
4 - "?v=$escapetool.url($xwiki.version)"
3 + 'xwiki-suggestUsers': $jsontool.serialize($xwiki.getSkinFile('uicomponents/suggest/suggestUsersAndGroups.js', true))
5 5   }
6 6  });
7 7  require(['deferred!ckeditor', 'xwiki-suggestUsers', 'jquery', 'xwiki-meta'], function (ckeditorPromise, suggestUsers, $, xm) {
8 -
7 +
9 9   /**
10 10   * Get the current wiki scope for displaying global, local or global and local users
11 11   */
12 12   const userScope = "$!services.wiki.user.userScope";
13 -
12 +
14 14   // see https://stackoverflow.com/a/6248722/657524
15 15   function random6chars() {
16 16   // I generate the UID from two parts here
... ... @@ -21,7 +21,7 @@
21 21   secondPart = ("000" + secondPart.toString(36)).slice(-3);
22 22   return firstPart + secondPart;
23 23   }
24 -
23 +
25 25   /**
26 26   * Compute a new unique anchor for the given reference.
27 27   * The unique anchor is based on the mentionned user id, concatenaed with a random string of 6 alphanumeric
... ... @@ -40,8 +40,8 @@
40 40   'input': text,
41 41   'limit': 6,
42 42   };
43 - $.when(suggestUsers.loadUsers(userScope, params)).then(function (user) {
44 - const cct = user.map(function (x) {
42 + suggestUsers.loadUsers(userScope, params).then(users => {
43 + const cct = users.map(function (x) {
45 45   // insert an id because that's required by the mentions plugins.
46 46   x.id = x.value;
47 47   // Make sure to display the icon avatar or the image one.
... ... @@ -57,10 +57,10 @@
57 57   return x;
58 58   });
59 59   callback(cct);
60 - })
59 + });
61 61   }
62 62  
63 - ckeditorPromise.done(function (ckeditor) {
62 + ckeditorPromise.then(ckeditor => {
64 64   function confMentions(name) {
65 65   return {
66 66   feed: function (opts, callback) {
... ... @@ -83,7 +83,7 @@
83 83   editor.once('afterInsertHtml', function () {
84 84   editor.execCommand('xwiki-macro-insert', {
85 85   name: 'mention',
86 - inline: true,
85 + inline: 'enforce',
87 87   parameters: {
88 88   reference: param.id,
89 89   style: 'FULL_NAME',
... ... @@ -99,7 +99,7 @@
99 99   }
100 100  
101 101   function updateConf(config, name) {
102 - const newConf = config;
101 + const newConf = config || {};
103 103   newConf.mentions = newConf.mentions || [];
104 104   newConf.mentions.push(confMentions(name));
105 105   return newConf;
XWiki.WikiMacroClass[0]
Macro code
... ... @@ -1,9 +1,10 @@
1 1  {{velocity}}
2 2  #set ($reference = $wikimacro.parameters.reference)
3 3  #set ($style = $wikimacro.parameters.style)
4 -#set ($content = $services.mentions.format($reference.reference, $style))
4 +#set ($type = "$!wikimacro.parameters.type")
5 +#set ($content = $services.mentions.format($reference.reference, $style, $type))
5 5  #set ($anchor = $wikimacro.parameters.anchor)
6 -#set ($isCurrentUser = $xcontext.userReference == $reference.reference)
7 +#set ($isCurrentUser = $xcontext.userReference == $reference.reference && ($type == '' || $type == 'user'))
7 7  #set ($cssClasses = ['xwiki-mention', 'user'])
8 8  #if ($isCurrentUser)
9 9   #set ($discard = $cssClasses.add('self'))
Default category
... ... @@ -1,0 +1,1 @@
1 +Notifications
Macro description
... ... @@ -1,1 +1,1 @@
1 -Insert a user mention.
1 +Inserts a user mention.
XWiki.WikiMacroParameterClass[3]
Parameter description
... ... @@ -1,0 +1,1 @@
1 +The type of mentioned actor.
Parameter name
... ... @@ -1,0 +1,1 @@
1 +type
Parameter type
... ... @@ -1,0 +1,1 @@
1 +java.lang.String