DEPRECATION WARNING
This documentation is not using the current rendering mechanism and is probably outdated. The extension maintainer should switch to the new system. Details on how to use the rendering mechanism can be found here.
~.richSnippetFields¶
This extension provides support for Google rich snippets. Setting the following options some meta information could be configured which is being read from the database for each rated item. The configured options must be field descriptors in the rated table.
Property | Title | Type |
---|---|---|
name | Fieldname to fetch the item name from | string |
description | Fieldname to fetch the item description from | string |
aggregateRatingSchemaType | SchemaType having aggregateRating as property | string |
[tsref:plugin.tx_thrating.settings.richSnippetFields]
name¶
Property
name
Data type
Description
Fieldname to fetch the item name from.
If no or an invalid name is given, the default value consists of the constant text “Rating AX”
appendixed by the UID values of the ratingobject and the rated object.
(e.g. “Rating AX 2_30
” meaning ratingobject #2 / ratedobject #30).
Default
Rating AX xx_yy
description¶
Property
description
Data type
Description
Fieldname to fetch the item description from
Default
Example¶
1 2 3 4 5 6 7 8 9 10 | temp.pollingDemo < plugin.tx_thrating
temp.pollingDemo {
settings {
richSnippetFields {
name = pollingheader
description = pollingbodytext
url =
}
}
}
|
aggregateRatingSchemaType¶
Property
aggregateRatingSchemaType
Data type
Description
- According to Schema.org aggregateRating valid entries are:
Brand
CreativeWork
Event
Offer
Organization
Place
Product
Service
Warning
Any other value will cause an exception during frontend rendering.
Default
Product