Rating AX

• Configuration
  • FAQ
  • Installation
  • Reference
    • Section: ratings
    • Section: settings
    • Constants plugin.tx_thrating.config
    • Constants plugin.tx_thrating.settings
    • Constants plugin.tx_thrating.view

Configuration¶

• Technical information; Installation, Reference of TypoScript, configuration options on system level, how to extend it, the technical details, how to debug it.
• language should be technical, assuming developer knowledge of TYPO3. Small examples/visuals are always encouraged.
• Target group: Developers

Knowledge of Extbase/Fluid framework would be helpful to understand how to configure this extension.

FAQ¶

TBD

Installation¶

1. Install this extension as usual
2. Do all updates on the database as suggested by the extension manager.
   There are 4 tables that are updated with some default entries.
3. Include the template of this extension
4. Open the TS Constant Editor and at least set the option "FE Users and Groups [pid]".
   This id should link to the website users container page of you website.
5. If you like to see the examples:
   Make sure that two website entries exist having uid 1 and 2.
6. Update the configuration of jQuery extension
   1. Open Module "T3 jQuery" in BE Admint Tools
   2. Choose "Process an Analyze t3jquery.txt in extensions
   3. Select extension "th_rating"
   4. Press "Check"
   5. Pres "Merge and Use"

Reference¶

The basic configuration to use this extension as a cObj in your TSConfig or in your own extension is already done within the default template. The only changes are necessary if you like to alter the usage type (MVC-Action).

- ratinglinks
  graphical presentation to do and to display ratings
- show
  display the actual vote of the currently logged on FE user in plain text
- new
  generate a classic form element (default: drop-drown select field) for voting. If the user has already voted action 'show' is used.

  plugin.tx_thrating.switchableControllerActions {
     Vote {
         1 = ratinglinks
         #1 = show
         #1 = new
     }
  }

[tsref:plugin.tx_thrating]

Section: ratings¶

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

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

Example

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

     plugin.tx_thrating.ratings {
         #use this section to configure your own graphics
         barrating {
             imagefile = typo3conf/ext/th_rating/Resources/Public/Css/rating_bar.png
             barimage = 1
             tilt = 0
         }
     }

Graphics requirements:

• not rated (e.g. )
• rated (e.g. )
• choose rating (e.g. )

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
stars	starsTilt	barrating	facesbartilt

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/. This site showed all icons licensed by GPL2. I appreciate the great work of these 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.

Section: settings¶

Each rating could have a special graphical configuration. Use this section to configure it.

The configurations a seperated into subsections identified by a distinct name.

[tsref:plugin.tx_thrating.settings]

Example

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

     plugin.tx_thrating.settings {
        ratetable = tt_content
        ratefield = uid
        #ratingobject = 1
        ratedobjectuid = 1
        #display = stars  - not needed if default is used
     }

Constants plugin.tx_thrating.config¶

The following constants must be set once per site.

[tsref:plugin.tx_thrating.config]

Example
Here an example which is also included as the defaults constant configuration:

    plugin.tx_thrating.settings {
        feUserStoragePid = 6
        storagePid = 0
    }

Constants plugin.tx_thrating.settings¶

The following constants must be set once per site.

[tsref:plugin.tx_thrating.settings]

Example

Here an example which is also included as the defaults constant configuration:

    plugin.tx_thrating.settings {
        feUserStoragePid = 6
        storagePid = 0
    }

Constants plugin.tx_thrating.view¶

The following constants must be set once per site.

[tsref:plugin.tx_thrating.settings.view]

Example

Here an example which is also included as the defaults constant configuration:

    plugin.tx_thrating.view {
        templateRootPath = EXT:th_rating/Resources/Private/Templates/
        partialRootPath = EXT:th_rating/Resources/Private/Partials/
        layoutRootPath = EXT:th_rating/Resources/Private/Layouts/
    }