Upgrade - nodebb-plugin-topic-ratings

[brazzerstop]

How I can change code to show userRating, not a average in stars icons (star-o if user was not vote and solid star with userRating after vote) Because my users don't understand what star he was choise after vote...

[baris]

That logic happens here https://github.com/NodeBB/nodebb-plugin-topic-ratings/blob/master/library.js#L46-L63, feel free to modify.

[brazzerstop]

@baris said in Upgrade - nodebb-plugin-topic-ratings:

You could filter the topics in a hook like filter:topics.filterSortedTids and only return ones that have more than a certain rating.

GPT recommend me to do this

1. In plugin.json add new hook

"hooks": [
  {
    "hook": "filter:category.topics.prepare", 
    "method": "sortTopicsByRating"
  }
]

2. In library.js add new methid sortTopicsByRating

plugin.sortTopicsByRating = function (data, callback) {
  if (data.req.query.sort === 'rating') {
    data.req.query.sort = '-rating';
  }

  callback(null, data);
};

3. In templates/categories.tpl add this code for sorted

<li data-sort="rating"><a href="#">[[global:topics_sorted_by_rating]]</a></li>

4. In public/js/topic-ratings.js add this javascript

$(window).on('action:ajaxify.end', function () {
  var $sortDropdown = $('.category-header .dropdown-menu');

  if ($sortDropdown.length) {
    var $ratingSortItem = $('<li data-sort="rating"><a href="#">[[global:topics_sorted_by_rating]]</a></li>');
    $sortDropdown.append($ratingSortItem);

    $ratingSortItem.on('click', function () {
      var url = window.location.href;
      url = url.replace(/(\?|&)sort=\w+/, '');
      url += (url.indexOf('?') >= 0 ? '&' : '?') + 'sort=rating';
      ajaxify.go(url);
    });
  }
});

Bot say after this I can sorted a topics via url ?sort=rating

I'm not tested this code, but it looks not bad...

[brazzerstop]

How can I get data about the number of ratings with a specific rating star?

I mean something like this example:

We can view a data for rating of 5 star - 226 votes (review) and others...

[baris]

For the data stored by this plugin you can get that info with the below calls.

await db.sortedSetCount(`tid:1:ratings`, 1, 1);
await db.sortedSetCount(`tid:1:ratings`, 2, 2);
await db.sortedSetCount(`tid:1:ratings`, 3, 3);
await db.sortedSetCount(`tid:1:ratings`, 4, 4);
await db.sortedSetCount(`tid:1:ratings`, 5, 5);

These will give the number of ratings given for each rating from 1 to 5

[bdinfl]

Are there screenshots of the UI for this? I'm wondering where the user rates a topic - are the rating options presented when replying to a topic, or can it be done at the discussions/topics page without clicking into the topic?

[baris]

@bdinfl you put the ratings in your template with <!-- IMPORT partials/ratings.tpl --> It can go on the topic list or inside a topic.

[bdinfl]

Thank you!

[bdinfl]

@baris I’m new to NodeBB, so are there step-by-step instructions to set this up? You wrote above to put it in the template but in Github it says to put it in the custom theme. I saw that I could install it through the Plugins section of the Admin dashboard, but then I see the attached “Invalid Event” errors.

[baris]

Those errors seem unrelated to this plugin, what version of nodebb are you using and what is the version of nodebb-plugin-mentions?

To get ratings plugin working you can open up templates/partials/topics_list.tpl in harmony theme and place <!-- IMPORT partials/ratings.tpl --> after this line. After that run ./nodebb build and restart nodebb.

[bdinfl]

I just installed NodeBB yesterday, so I assume 3.8.1.

In trying to minimize the build, I think I deleted plugin-mentions, maybe without rebuilding, so I should have looked into that more before posting.

For the ratings plugin, I can't find that path or the theme directory, so maybe I have to create it? I'm using Docker on a Mac.

[baris]

That file should be in your nodebb folder, so it would be /path/to/nodebb/node_modules/nodebb-theme-harmony/templates/partials/topics_list.tpl.

[bdinfl]

No luck, but thank you. I assume it's because I used a Docker image, so maybe I'll start over with a regular installation.

[bdinfl]

@baris It seems to have worked with a standard installation, but I assume I should see some settings at this page?

[baris]

Nah, this plugin just has a placeholder ACP page, it doesn't have any settings. If you see the ratings on each topic and rate it is working.

[bdinfl]

@baris