~.ratings.{name}

This page is divided into the following sections:

Each rating could have a special graphical configuration. Use this section to configure it. The configurations are seperated into subsections identified by a distinct name.

Within each you could do all typoscript settings described in ~.settings and ~.fluid (see Example).

Best practice would be to include such configuration in your own template. It is recommended to use distinct names for your ratingconfigurations. Additionally - if you’d like to adjust the default given configurations - remember that your settings will override or enhance the default settings. But it is not possible to delete settings of the default. It is recommended to just copy the configuration you want from the file EXT:th_rating/Configuration/TypoScript/setup.txt or take one from the examples in this documentation. Then choose a different name and make your adjustments as you want.

Reference

Property Title Type
imagefile File resource of the rating garphic string
barimage Sets the imagetype to bar- or starrating boolean
tilt Activate up/down orientation boolean

[tsref:plugin.tx_thrating.settings.ratings.{name}]

imagefile

Property

imagefile

Data type

string

Description

Imagename of the graphical representation including path. Path must be given relative to SITE_ROOT (e.g. typo3conf/ext/th_rating/Resources/Public/Css/stars.gif)

Default

barimage

Property

barimage

Data type

boolean

Description

Sets the imagetype to barrating (1) or starrating (0)

Default

0

tilt

Property

tilt

Data type

boolean

Description

If set the imagetype has up/down orientation

Default

0

Example

Here an example which is also included in one of the default configurations:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
plugin.tx_thrating.ratings {
   #use this section to configure your own ratingConfigurations
   exampleRatingConfig {
      imagefile = typo3conf/ext/th_rating/Resources/Public/Css/rating_bar.png
      barimage = 1
      tilt = 0
      settings {
         showNoFEUser = 1
         showNotRated = 1
         mapAnonymous = 0
         cookieLifetime = 0
      }
      fluid {
         layouts {
            default {
               hideSummary = {$plugin.tx_thrating.config.hideSummary}
               showCurrentRates = 1
               showSectionContent = 1
            }
         }
         partials {
            usersRating {
               showTextInfo = 1
               showGraphicInfo = 0
            }
            infoBlock {
               showAnonymousVotes = 1
            }
         }
      }
   }

Graphics requirements

The graphic contains icons or stripes for all states:

  • not rated (e.g. File_Req_nr.png )
  • rated (e.g. File_Req_r.png )
  • choose rating (e.g. File_Req_cr.png )

It is recommended to choose icons of identical dimensions. These icons must be arranged in one file depending on the imagetype in a manner as follows:

Classic starrating Tilt starrating Barrating Tilt barrating smileyLikes
File_Req_classic_starrating File_Req_tilt_starrating File_Req_barrating File_Req_tilt_barrating File_Req_tilt_starrating
stars starsTilt barrating facesbartilt smiley

The table shows all preconfigured rating configuration and their names.

All icons (except those of the type barrating) are taken from http://openiconlibrary.sourceforge.net/. All upper listed icons are licensed by GPL2 or PD. I appreciate the great work of those authors. Anyway, if the usage of any icon hits the copyright of any person I´d ask this person to drop me a mail if he/she want me to remove it.