Topic Ratings Plugin

[angus (Angus McLeod)]

If you’re talking about this plugin and not polls:

• A user can only submit one rating per topic. Once you’ve submitted your rating, you can still post in the topic, but the rating controls will not appear in the composer again.
• Rating controls will appear in:
  1. Topics in a category with ratings enabled
  2. Topics with a ratings tag

As @cpradio said, this plugin uses both TopicCustomFields and PostCustomFields, however I can’t see any reason why moving a topic from one category to another would affect the ratings control visibility logic. The logic for deciding whether to show the ratings controls in the composer is dependent on CategoryCustomFields which are not being migrated in this case.

Topic and post custom fields are used to store ratings and average ratings, not to decide whether to show rating controls.

[tophee (Christoph)]

@angus

If you’re talking about this plugin and not polls:

Yes, it’s ratings, not polls.

@angus

The logic for deciding whether to show the ratings controls in the composer is dependent on CategoryCustomFields which are not being migrated in this case.

So are you saying this is the reason why I’m not seeing the ratings controls? No, I think you’re saying that the CustomCategoryFields are not being moved because I moved the post into rather than out of a rating category.

[angus (Angus McLeod)]

@tophee

CustomCategoryFields are not being moved because I moved the post into rather than out of a rating category.

Correct. CategoryCustomFields are not affected by topics being moved.

tbh, I haven’t tested the ratings client logic in the scenario you’re dealing with: moving an existing topic into a ratings category. I’ll take a look at that scenario this weekend. Thanks.

[hnaseri (Hosein Naseri)]

Can you add aggregated rating schema support to this plugin?

[angus (Angus McLeod)]

If I understand correctly how schema.org works (which I’m still not sure I do, even after a using it a few times), the schema for AggregateRating will only work if it is within the scope of a ‘type’. It seems these scope types support AggregateRating:

As it (seems) to be type dependent, I’m not sure it makes sense to support it directly in this plugin as that would involve choosing a particular type, e.g. Product or Service. Not all users of this plugin will be using it for one particular type.

If someone else knows more about schemas and can confirm or deny this, that would help (@vinothkannans?)

You could still add schema support for AggregateRating within the scope of a particular type, by forking this plugin and adding a new file:

app/views/connectors/topic_header/aggregate_rating.html.erb

the contents of which would look something like one of the existing schema.org markup blocks in the topics/show.html.erb view e.g. the tags markup.

[vinothkannans (Vinoth Kannan)]

We can add AggregateRating by default. In the allowed schema type list it have CreativeWork. In Discourse we are using DiscussionForumPosting as default schema type. It is a part of CreativeWork (CreativeWork > Article > SocialMediaPosting > DiscussionForumPosting). So it is 100% appropriate to use AggregateRating in topic ratings .

I manually tested this functionality in Google’s testing tool.

[hnaseri (Hosein Naseri)]

I cant edit post below a rating topic anymore.

[angus (Angus McLeod)]

@hnaseri

I cant edit post below a rating topic anymore.

Thanks for the report. Bug fixed.

Edit bugfix

@hnaseri

Can you add aggregated rating schema support to this plugin?

As per @vinothkannans’s advice, I’ve added aggregateRating as part of CreativeWork.

Add aggregateRating structured data

@vinothkannans You probably are already aware that Google’s structured data testing tool is complaining about the DiscussionForumPosting microdata for core Discourse topic views not having images. I’m not sure if that omission means the DiscussionForumPosting microdata blocks will be ignored?

[vinothkannans (Vinoth Kannan)]

I think it needs some changes in both on your code and Discourse core. I will create a PR once it changed in core. For now okay

[dalerka (Daler)]

Today I enabled this plugin for the first time on a pretty fresh discourse install and I don’t see the star-rating buttons in a reply box (composer) and I get the following error:
https://github.com/angusmcleod/discourse-ratings/issues/10

Update: after rebuilding the discourse app, I can no longer reproduce the TypeError... but I still don’t see the star-ratings buttons.

[angus (Angus McLeod)]

Hey :). The addObject exception is actually unrelated to this plugin. It’s a Discourse exception. I’ve been meaning to report it.

Composer Messages Exception

Steps to repro: On a vanilla instance with a new user, start to compose your first message. The education.new_topic composer message will appear. Dismiss it. Write until the draft process is triggered and the draft saves. Refresh the page. The composer will re-open with your draft. An exception will be thrown. _findMessages attempts to add the welcome message to queuedForTyping, which is null at the time it is assigned. The issue is with the sequence of reseting queuedForTyping …

As to the ratings buttons not appearing, I can’t repro it unfortunately. Can you send me some screenshots with the console open?

I tested it locally and on my sandbox here: https://discourse.angusmcleod.com.au/c/ratings

Composer:

Topic:

Topic List:

[dalerka (Daler)]

Thanks! and sorry for undeserved attribution of a bug.
On screenshots you can see no errors in the Console and no stars-buttons in the Composer or the average-rating div.

Update:

1. The plugin works well if the post is created in the rating-enabled category initially. However it doesn’t work for the posts in such directory which have been created/edited before error-less installation of this plugin (i.e. I had some Discourse-related error on the server when initially installed this plugin, but after rebuild there was no error).

2. Unfortunately the plugin doesn’t appear to be working for the posts initially created in a non-rating category, when those posts have been moved to a rating-enabled category, which is sad :’(

[angus (Angus McLeod)]

Thanks for figuring that out. It should work for such ‘pre-existing’ topics now.

https://github.com/angusmcleod/discourse-ratings/commit/2dd9fb80284e9b339f240008a6e8526dd3cb6aac

[dalerka (Daler)]

Thank you that was fast! Indeed, now I can rate the pre-existing topics. However I can also place multiple ratings with the same user, which kind of allows for rating-abuse:

[Tumi]

Hi , nice plugin

It is possible to create a ranking of this ratings ?

For example i wanna to show the most importand topic from all category or selected in admin menu
For example i want to show on the sidebar Top 10 best rating topic from category X and category Y
It is possiible ?
It would be perfect if the top post will depend on Number of stars + number of votes (quality ratio)

[angus (Angus McLeod)]

Given enough time, everything breaks, aka entropy … fixed as well

https://github.com/angusmcleod/discourse-ratings/commit/5d08b456a97e884fc41028323a98007fc0b07a7c

[angus (Angus McLeod)]

Hey

@Tumi

It is possible to create a ranking of this ratings ?

Yes, it’s possible. In a separate plugin you could add a new topic list that sorts topics based on the average_rating topic custom field.

Here’s an example of how to create a new topic list that is sorted by a custom field:

• discourse-events/plugin.rb at main · paviliondev/discourse-events · GitHub

@Tumi

i want to show on the sidebar Top 10 best rating topic from category X and category Y

Well, you’ll need a sidebar first. Then a widget that has a topic list in it. Here’s some I prepared earlier:

GitHub - paviliondev/discourse-layouts: A Discourse plugin that allows you to...

GitHub - angusmcleod/layouts-topic-list

So all you need to do is change the topic list in the layouts-topic-list widget to the topic list you created in your new plugin.

1. Follow the beginners guide to creating a plugin

2. Add the layouts plugin with the topic list widget

3. Copy / paste the new topic list code I’ve linked above

4. Change a few variable names and urls in the topic list widget and the topic list code.

[meglio (Anton)]

For some reason, ratings checkbox is now shown in some composers, and users don’t understand why?

I never configured it or turned on anything like that.

[meglio (Anton)]

I think I caught it: it is shown when EDITING messages. Even if it’s turned off.

[angus (Angus McLeod)]

Thanks for the report Fixed.

https://github.com/angusmcleod/discourse-ratings/commit/a5dbae0f9e8dfb633f0eb787502aab491e50c1ca