Login / Status
developer.Resource
Home . Documentation . Document Library . Extension Manuals
Sponsors
hosted by punkt.deTYPO3 and Open Source Magazine

1.4. Configuration

This section describes TypoScript configuration.

Property:

Data type:

Description:

Default:

storagePid

integer

Page uid where rating records are stored.

empty (value of {$plugin.tx_ratings_pi1.storagePid} constant)

templateFile

string

Template file for the plugin. Accepts either site-relative path or extension-related path (EXT: prefix)

EXT:comments/res/pi1_template.html (value of {$plugin.tx_ratings_pi1.templateFile} constant)

minValue

integer

Minimum rating value. This must not be changed once ratings are being used. Changing value requires CSS adjustments (length of voting bar)

1

maxValue

integer

Maximum rating value. This must not be changed once ratings are being used. Changing value requires CSS adjustments (length of voting bar)

5

ratingImageWidth

integer

Width of a single rating bar image. Must be adjustted if non-default image is used

11

mode

auto or static

auto means that ratings will operate as they normally do on web sites (user votes and he cannot vote on this item any more). static means that user will not be able to vote: ratings will be read-only

auto

disableIpCheck

boolean

Disables IP address check for voting. If check is disabled, users may vote any number of times on the item (useful for testing). Notice: users will have to reload page to vote again!

0

additionalCSS

string

Allows to change appearance of ratings without changing template. Typically ratingImageWidth needs to be changed to.

There are several predefined CSS files that can be reused:

  1. komodeomedia.css (width=30px)Copyright © Rogie King, KOMODEO MEDIA, http://komodomedia.com/blog/index.php/2006/01/09/css-star-rating-part-deux/

  2. masugadesign.css (width=30px) Copyright © Ryan Masuga, ryan@masugadesign.com (http://www.masugadesign.com/the-lab/scripts/unobtrusive-ajax-star-rating-bar/)

  3. yvoschaap.css (width=25px)Copyright © Yvo Schaap, http://www.yvoschaap.com/index.php/weblog/css_star_rater_ajax_version/Original CSS and images © KOMODEO MEDIA

See Screenshots section for examples of images. Other royalty free images can be included (send them to me by e-mail).

(Note to copyright owners: since you give your scripts for free, I (Dmitry Dulepov, dmitry@typo3.org) took liberty to use images and provide references to your web sites to honor your great work. However, if you feel that your images should be removed, drop me a message by e-mail. Providing this images with this TYPO3 extension is entirely my personal idea and I alone should be responsible for this action. By I do hope that you are not against using these images in Open Source software.)

FAQ

Q: I disabled IP check but after I rate the item, I cannot rate it again!

A: You need to reload page to rate again. This is a technical limitation due to usage of AJAX.

Q: I included another CSS but images are cut or clicks do not work properly

A: You forgot to adjust ratingImageWidth parameter. See Configuration section

Q: I try to use extension with TYPO3 3.x/4.0 but...

A: Sorry this extension is not tested and will not be supported under any TYPO3 version below 4.1

Q: I try to use extension but it gives me PHP errors

A: Your PHP version is less than 5.1. Extension does not work with ancient PHP versions.

Q: Can each content item on the page be rated?

A: No. But this feature can be added if you sponsor it (100€).