{"id":19640682,"url":"https://github.com/daniel-km/omeka-plugin-rating","last_synced_at":"2026-05-15T10:32:02.492Z","repository":{"id":18550695,"uuid":"21752146","full_name":"Daniel-KM/Omeka-plugin-Rating","owner":"Daniel-KM","description":"Plugin for Omeka that adds a widget to allow users to rate items or other records instantly via Ajax.","archived":false,"fork":false,"pushed_at":"2018-03-26T05:37:57.000Z","size":51,"stargazers_count":3,"open_issues_count":0,"forks_count":1,"subscribers_count":5,"default_branch":"master","last_synced_at":"2025-01-09T18:58:08.781Z","etag":null,"topics":["annotation","omeka","omeka-plugin","rateit","rating"],"latest_commit_sha":null,"homepage":"","language":"PHP","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Daniel-KM.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2014-07-11T21:34:53.000Z","updated_at":"2020-02-09T16:33:10.000Z","dependencies_parsed_at":"2022-09-24T11:02:46.206Z","dependency_job_id":null,"html_url":"https://github.com/Daniel-KM/Omeka-plugin-Rating","commit_stats":null,"previous_names":[],"tags_count":2,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Daniel-KM%2FOmeka-plugin-Rating","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Daniel-KM%2FOmeka-plugin-Rating/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Daniel-KM%2FOmeka-plugin-Rating/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Daniel-KM%2FOmeka-plugin-Rating/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Daniel-KM","download_url":"https://codeload.github.com/Daniel-KM/Omeka-plugin-Rating/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":240947648,"owners_count":19883030,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["annotation","omeka","omeka-plugin","rateit","rating"],"created_at":"2024-11-11T14:06:27.434Z","updated_at":"2026-05-15T10:32:02.461Z","avatar_url":"https://github.com/Daniel-KM.png","language":"PHP","funding_links":[],"categories":[],"sub_categories":[],"readme":"Rating (plugin for Omeka)\n=========================\n\n[Rating] is a plugin for [Omeka] that adds a widget to allow users to rate items\nor other records instantly via Ajax.\n\nThe plugin uses [RateIt], a jQuery (star) rating plugin, whose main qualities\nare: light, fast, progressive enhancement, touch support, customizable,\nunobtrusive JavaScript, use of HTML5 data attributes, RTL support, ARIA and\nkeyboard support.\n\n\nInstallation\n------------\n\nUncompress files and rename plugin folder \"Rating\".\n\nThen install it like any other Omeka plugin and follow the config instructions.\n\nThe plugin can use [GuestUser] if it is installed.\n\n* Note about privacy\n\nTo avoid multiple ratings by the same visitor (not identified user), the IP is\nchecked. This option can be enabled or disabled for privacy purpose. When\ndisabled, no check is done for anonymous visitors. Furthermore, IP can be set\nclear or hashed (md5).\n\n\nDisplaying Rating Widget\n------------------------\n\nThe widget can be displayed via three mechanisms.\n\n* Hooks\n\nThe plugin will add the rating widget automatically on `items/show` and\n`items/browse` pages via the hook, if the current user has right to use it:\n\n```php\nfire_plugin_hook('public_items_show', array('view' =\u003e $this, 'item' =\u003e $item));\n```\n\n* Helpers\n\nIf you need more flexibility, in particular for records other than items\n(collections, files, exhibits, exhibit pages, simple pages), you can use helper:\n\n```php\n// Attach css and js before calling head() (or add tags anywhere).\nqueue_css_file('rating');\nqueue_js_file('RateIt/jquery.rateit.min');\n\n// Anywhere in the page. Can be called multiple times with different records.\necho $this-\u003erating()-\u003ewidget($record, $user, $display);\n\n// Anywhere in the page after the last rating widget.\necho common('rating-js');\n```\n\nRights are automatically managed. The javascript codes are managed separately to\nget a lower code, in particular in browse pages. `$display` is an ordered array\nthat contains parameters to choose the type of widget (see below). Default is to\nshow the average score of the record.\n\nIf you just need the average score or the specific rate of a user, use:\n\n```php\necho $this-\u003erating()-\u003escore($record);\necho $this-\u003erating()-\u003erate($record, $user);\n```\n\n* Shortcodes\n\n[Shortcodes] are supported (Omeka 2.2 or above). Some illustrative examples:\n\n```\n[rating record_id=1]\n[rating record_type='Collection' record_id=1 user=1]\n[rating record_type='Item' record_id=1 display=\"score text, rate visual\"]\n[rating record_type='Item' record_id=1 display=\"rate visual, score text\" user=2]\n```\n\nOptions are:\n- `record_type`: an Omeka record type , e.g. \"Item\" (default) or \"Collection\".\n- `record_id` (required): the identifier of the record.\n- `user`: allows to get the rate of the specified user. If not set, the current\nuser is selected. Not used with score.\n- `display` (optional): ordered comma separated options to choose the\nform of the widget:\n  - \"score\": raw value without css (default if no user; exclusive from other\n  ones).\n  - \"score text\": just the score with css.\n  - \"score visual\": visual average score and count of ratings for the record.\n  - \"rate\": raw value without css (default if user is set; exclusive from other\n  ones).\n  - \"rate text\": just the rate with css\n  - \"rate visual\": widget that allows user to rate the record (if allowed).\n\nAs the helper, rights are automatically managed. Javascript and css are added\nautomatically too. Visual and text results can be themed.\n\n\nWarning\n-------\n\nUse it at your own risk.\n\nIt’s always recommended to backup your files and your databases and to check\nyour archives regularly so you can roll back if needed.\n\n\nTroubleshooting\n---------------\n\nSee online issues on the [plugin issues] page on GitHub.\n\n\nLicense\n-------\n\n* Rating Plugin\n\nThis plugin is published under the [CeCILL v2.1] licence, compatible with\n[GNU/GPL] and approved by [FSF] and [OSI].\n\nIn consideration of access to the source code and the rights to copy, modify and\nredistribute granted by the license, users are provided only with a limited\nwarranty and the software's author, the holder of the economic rights, and the\nsuccessive licensors only have limited liability.\n\nIn this respect, the risks associated with loading, using, modifying and/or\ndeveloping or reproducing the software by the user are brought to the user's\nattention, given its Free Software status, which may make it complicated to use,\nwith the result that its use is reserved for developers and experienced\nprofessionals having in-depth computer knowledge. Users are therefore encouraged\nto load and test the suitability of the software as regards their requirements\nin conditions enabling the security of their systems and/or data to be ensured\nand, more generally, to use and operate it in the same conditions of security.\nThis Agreement may be freely reproduced and published, provided it is not\naltered, and that no provisions are either added or removed herefrom.\n\n\n* RateIt widget\n\nThe [RateIt] jQuery (star) rating plugin is released under the [MIT licence] (MIT).\n\nCopyright (c) 2013 Gideon Junge\n\nPermission is hereby granted, free of charge, to any person obtaining a copy of\nthis software and associated documentation files (the \"Software\"), to deal in\nthe Software without restriction, including without limitation the rights to\nuse, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of\nthe Software, and to permit persons to whom the Software is furnished to do so,\nsubject to the following conditions:\n\nThe above copyright notice and this permission notice shall be included in all\ncopies or substantial portions of the Software.\n\nTHE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\nIMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS\nFOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR\nCOPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER\nIN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN\nCONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.\n\n\nContact\n-------\n\nCurrent maintainers:\n\n* Daniel Berthereau (see [Daniel-KM] on GitHub)\n\n\nCopyright\n---------\n\n* Copyright Daniel Berthereau, 2013-2015\n* Copyright Gideon Junge, 2013-2014 ([RateIt])\n\n\n[Omeka]: https://omeka.org\n[RateIt]: https://rateit.codeplex.com\n[Rating]: https://github.com/Daniel-KM/Omeka-plugin-Rating\n[Shortcodes]: https://omeka.org/codex/Shortcodes\n[plugin issues]: https://github.com/Daniel-KM/Omeka-plugin-Rating/issues\n[GuestUser]: https://github.com/omeka/plugin-GuestUser\n[CeCILL v2.1]: https://www.cecill.info/licences/Licence_CeCILL_V2.1-en.html\n[GNU/GPL]: https://www.gnu.org/licenses/gpl-3.0.html\n[FSF]: https://www.fsf.org\n[OSI]: http://opensource.org\n[MIT licence]: http://opensource.org/licenses/MIT\n[Daniel-KM]: https://github.com/Daniel-KM \"Daniel Berthereau\"\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdaniel-km%2Fomeka-plugin-rating","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdaniel-km%2Fomeka-plugin-rating","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdaniel-km%2Fomeka-plugin-rating/lists"}