diff options
Diffstat (limited to 'doc/src')
-rw-r--r-- | doc/src/sgml/unaccent.sgml | 36 |
1 files changed, 31 insertions, 5 deletions
diff --git a/doc/src/sgml/unaccent.sgml b/doc/src/sgml/unaccent.sgml index af9cad5d8c7..aef0031dcbc 100644 --- a/doc/src/sgml/unaccent.sgml +++ b/doc/src/sgml/unaccent.sgml @@ -45,9 +45,9 @@ <itemizedlist> <listitem> <para> - Each line represents a pair, consisting of a character with accent - followed by a character without accent. The first is translated into - the second. For example, + Each line represents one translation rule, consisting of a character with + accent followed by a character without accent. The first is translated + into the second. For example, <programlisting> À A Á A @@ -57,6 +57,27 @@ Å A Æ A </programlisting> + The two characters must be separated by whitespace, and any leading or + trailing whitespace on a line is ignored. + </para> + </listitem> + + <listitem> + <para> + Alternatively, if only one character is given on a line, instances of + that character are deleted; this is useful in languages where accents + are represented by separate characters. + </para> + </listitem> + + <listitem> + <para> + As with other <productname>PostgreSQL</> text search configuration files, + the rules file must be stored in UTF-8 encoding. The data is + automatically translated into the current database's encoding when + loaded. Any lines containing untranslatable characters are silently + ignored, so that rules files can contain rules that are not applicable in + the current encoding. </para> </listitem> </itemizedlist> @@ -132,8 +153,8 @@ mydb=# select ts_headline('fr','Hôtel de la Mer',to_tsquery('fr','Hotels') <para> The <function>unaccent()</> function removes accents (diacritic signs) from - a given string. Basically, it's a wrapper around the - <filename>unaccent</> dictionary, but it can be used outside normal + a given string. Basically, it's a wrapper around + <filename>unaccent</>-type dictionaries, but it can be used outside normal text search contexts. </para> @@ -146,6 +167,11 @@ unaccent(<optional><replaceable class="PARAMETER">dictionary</replaceable>, </op </synopsis> <para> + If the <replaceable class="PARAMETER">dictionary</replaceable> argument is + omitted, <literal>unaccent</> is assumed. + </para> + + <para> For example: <programlisting> SELECT unaccent('unaccent', 'Hôtel'); |