Documentation

Installation:

  1. Upload the c5j_ratings folder to your site’s /packages directory.
  2. In the Concrete CMS Dashboard, go to Extend Concrete, locate “Macareux Page Ratings,” and click Install.
  3. Add the “Rating Button” block to any page (Page > Edit > Add Block).

Usage:

  • Rating Button block: place it where you want users to react. The current total is displayed next to the icon.
  • Dashboard report: visit Dashboard > Ratings to browse and filter ratings, or export CSV.

Configuration notes:

  • The add-on registers a grouped asset set named c5j_ratings, including its CSS and JS.
  • Security: the package uses a time-based token to validate rating actions.
  • Cleanup: ratings tied to deleted pages or users are automatically removed via event listeners.

FAQ:

  • Can guests rate? The block counts ratings based on requests; if your site distinguishes guests vs. users, you can still display totals. For logged-in users, repeated clicks are ignored based on user/session context.
  • Will this slow down my site? The add-on uses small assets and simple database interactions, and it’s safe to cache the block output. The package also registers assets efficiently.
  • Is it compatible with Concrete 9? Yes, assets and dashboard pages are compatible with both v8.x and v9.x.