transform.ini [search] #

The block [search] of settings/transform.ini, with 3 setting(s).

[<group>]
Rules[]=<command>(<option>[,<option>])
or
Rules[]=<command>

Commands:
normalize

• Normalizes multiple characters with similar meaning to one type
• Looks for rule named <parameter>_normalize for each parameter
• If no parameters are used it will find all normalize rules

search_normalize

• Runs normalization rules required for search engine
• Looks for rule named <parameter>_search_normalize for each parameter
• If no parameters are used it will find all search rules

transform

• Transforms one type of character into another
• Looks for rule named <parameter1>_to_<parameter2>
• If no parameters are used it will find all transformation rules

decompose

• Turns special characters into strings representing the character
• Looks for rule named <parameter>_decompose for each parameter
• If no parameters are used it will find all decompose rules

lowercase

• Turns characters into their lowercase variant if possible
• Looks for rule named <parameter>_lowercase for each parameter
• If no parameters are used it will find all lowercase rules

uppercase

• Turns characters into their uppercase variant if possible
• Looks for rule named <parameter>_uppercase for each parameter
• If no parameters are used it will find all uppercase rules

transliterate

• Converts from one type of charset to another by finding similar
  characters or strings
• Looks for rule named <parameter1>_transliterate_<parameter2>
• If no parameters are used it will find all transliteration rules

diacritical

• Removes diacriticals from characters
• Looks for rule named <parameter>_diacritical for each parameter
• If no parameters are used it will find all diacritical rules

rule

• Runs custom transformation rule
• Looks for rule named <parameter> for each parameter
• If no parameters are used it will do nothing

Special commands:
url_cleanup

• Performs cleanups to make the text presentable in a URL

identifier_cleanup

• Performs cleanups to make the text usable as an identifier

search_cleanup:

• Performs cleanup to make the text parsable by the search engine
• Looks for rule named <parameter>_search_cleanup for each parameter
  Rules used by the search engine, these rules ensures that
  the index or search text is normalized in such way
  to make it easier for the engine to work with it.

Never edit settings/transform.ini itself: an update replaces it. Put the settings you change in an override, which wins over the shipped file:

• settings/override/transform.ini.append.php for every siteaccess,
• settings/siteaccess/<siteaccess>/transform.ini.append.php for one siteaccess,
• extension/<extension>/settings/transform.ini.append.php in an extension (read when the extension is active).

Files #

Extra transformation files for search

Default: a list of 1: search.tr.

<?php /* #?ini charset="utf-8"?
# settings/override/transform.ini.append.php
[search]
# an empty "Files[]" first replaces the shipped list; without it the items are added
Files[]
Files[]=search.tr
*/ ?>

Extensions #

Extensions that have transformation files when search is used

Default: an empty list.

<?php /* #?ini charset="utf-8"?
# settings/override/transform.ini.append.php
[search]
# an empty "Extensions[]" first replaces the shipped list; without it the items are added
Extensions[]
*/ ?>

Commands #

The commands to use for search
Commands[]=transform

Default: a list of 8: decompose, normalize, diacritical, search_normalize, lowercase, transform(inverted,normal), transform(math,ascii), search_cleanup.

<?php /* #?ini charset="utf-8"?
# settings/override/transform.ini.append.php
[search]
# an empty "Commands[]" first replaces the shipped list; without it the items are added
Commands[]
Commands[]=decompose
Commands[]=normalize
Commands[]=diacritical
Commands[]=search_normalize
Commands[]=lowercase
Commands[]=transform(inverted,normal)
Commands[]=transform(math,ascii)
Commands[]=search_cleanup
*/ ?>

Related #

• All blocks of transform.ini
• All INI files
• The settings page

Generated by ./console exp:help:examples from settings/transform.ini. Do not edit this page: change the source and generate again (how). Free documentation: GFDL 1.3 or later.