Caution: This documentation is for eZ Publish legacy, from version 3.x to 5.x.
For 5.x documentation covering Platform see eZ Documentation Center, for difference between legacy and Platform see 5.x Architecture overview.

Groups

Summary

Sets the available groups to define the rules of transformation for.

Usage

Groups[]=<name group>

Description

The groups setting allows you to defines the available transformation groups and specify the rules of character transformation for them.
Each group uses its own set of transformation files, extensions and additional transformation rules called Commands. These groups are also used by the search engine and by some datatypes. In addition it is also possible to use the defined groups in custom code.
For each group set here, the rules that should be used for this group should be defined in their own block. For example if Groups[]=latin is set here, then the rules for this group need to be defined in block [latin].
Groups available by default are:

  • latin: Sets the transformation rules that can be used if the current charset handles Latin. By default this group uses the transformation file "latin.tr".
  • cyrillic: Sets the transformation rules that can be used if the current charset handles Cyrillic. By default this group uses the transformation file "cyrillic.tr".
  • greek: Sets the transformation rules that can be used if the current charset handles Greek. By default this group uses the transformation file "greek.tr".
  • hebrew: Sets the transformation rules that can be used if the current charset handles Hebrew. By default this group uses the transformation file "hebrew.tr".
  • search: Sets the transformation rules that can be used to normalize the search requests and to make it easier for the search engine to interpret it. By default this group uses the transformation file "search.tr".
  • urlalias_iri: Sets the transformation rules that can be used to make sure the text of URLs is transformed into characters supported by IRI (for more information please visit http://en.wikipedia.org/wiki/Internationalized_Resource_Identifier)
  • urlalias: Sets the transformation rules that can be used to make sure the characters not supported by the URI specialization (for more information please visit http://en.wikipedia.org/wiki/Uniform_Resource_Identifier) are transformed or removed when the URL alias system is making an URL.
  • urlalias_compat: Sets the transformation rules that can be used to make sure the text of URLs is transformed into characters supported by this method of transformation.
  • identifier: Sets the transformation rules that can be used to make sure the text of identifiers is transformed into ASCII equivalent characters.
  • uppercase: Sets the transformation rules that can be used to make sure the characters are transformed into the uppercase.
  • lowercase: Sets the transformation rules that can be used to make sure the characters are transformed into the lowercase.

It is also possible to create custom groups and add custom sets of transformation rules to them, in order to transform characters according to specific needs.
Please refer to the TransformationGroup setting in site.ini to learn more about the URL's text transformation methods.

Examples

Example 1
Groups[]
Groups[]=search
Groups[]=urlalias_iri
Groups[]=urlalias
Groups[]=urlalias_compat
Groups[]=identifier
Groups[]=uppercase
Groups[]=lowercase

This is the default setting.

Example 2
[Transformation]
 
Groups[]
Groups[]=search
 
[search]
 
Files[]
Files[]=search.tr
 
Extensions[]
 
Commands[]
Commands[]=search_normalize
Commands[]=lowercase

This configuration sets a group "search" which uses "search_normalize" and "lowercase" transformation rules in addition to the rules defined in the "search.tr" transformation file.

Example 3
[Transformation]
 
Groups[]
Groups[]=my_group
 
[my_group]
 
Files[]
 
Extensions[]
 
Commands[]
Commands[]=normalize
Commands[]=diacritical

This configuration sets a custom group "my_group" which uses "normalize" and "diacritical" transformation rules.

Ester Heylen (22/06/2010 11:34 am)

Ricardo Correia (26/07/2013 11:01 am)

Ester Heylen, Ricardo Correia


Comments

There are no comments.