summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorBruno Haible <bruno@clisp.org>2009-05-11 00:26:30 +0200
committerBruno Haible <bruno@clisp.org>2009-05-11 00:26:30 +0200
commit7e44f1d590a84678b99750034d3561a94e0da08c (patch)
tree666196888a68e8250d287580b2d01f3917bbc5db /doc
parentd992f64ea8d77e98eaabca415b8c18ab4fc241f3 (diff)
downloadlibunistring-7e44f1d590a84678b99750034d3561a94e0da08c.tar.gz
Document what title case is.
Diffstat (limited to 'doc')
-rw-r--r--doc/unicase.texi31
1 files changed, 31 insertions, 0 deletions
diff --git a/doc/unicase.texi b/doc/unicase.texi
index 97d0d5e..5b39901 100644
--- a/doc/unicase.texi
+++ b/doc/unicase.texi
@@ -42,6 +42,33 @@ Returns the lowercase mapping of the Unicode character @var{uc}.
@deftypefun ucs4_t uc_totitle (ucs4_t @var{uc})
Returns the titlecase mapping of the Unicode character @var{uc}.
+
+The titlecase mapping of a character is to be used when the character should
+look like upper case and the following characters are lower cased.
+
+For most characters, this is the same as the uppercase mapping. There are
+only few characters where the title case variant and the uuper case variant
+are different. These characters occur in the Latin writing of the Croatian,
+Bosnian, and Serbian languages.
+
+@c Normally we would use .33 space for each column, but this is too much in
+@c TeX mode, see
+@c <http://lists.gnu.org/archive/html/bug-texinfo/2009-05/msg00016.html>.
+@multitable @columnfractions .31 .31 .31
+@headitem Lower case @tab Title case @tab Upper case
+@item LATIN SMALL LETTER LJ
+ @tab LATIN CAPITAL LETTER L WITH SMALL LETTER J
+ @tab LATIN CAPITAL LETTER LJ
+@item LATIN SMALL LETTER NJ
+ @tab LATIN CAPITAL LETTER N WITH SMALL LETTER J
+ @tab LATIN CAPITAL LETTER NJ
+@item LATIN SMALL LETTER DZ
+ @tab LATIN CAPITAL LETTER D WITH SMALL LETTER Z
+ @tab LATIN CAPITAL LETTER DZ
+@item LATIN SMALL LETTER DZ WITH CARON
+ @tab LATIN CAPITAL LETTER D WITH SMALL LETTER Z WITH CARON
+ @tab LATIN CAPITAL LETTER DZ WITH CARON
+@end multitable
@end deftypefun
@node Case mappings of strings
@@ -94,6 +121,10 @@ case-mapping. It can also be NULL, for no normalization.
@deftypefunx {uint32_t *} u32_totitle (const uint32_t *@var{s}, size_t @var{n}, const char *@var{iso639_language}, uninorm_t @var{nf}, uint32_t *@var{resultbuf}, size_t *@var{lengthp})
Returns the titlecase mapping of a string.
+Mapping to title case means that, in each word, the first cased character
+is being mapped to title case and the remaining characters of the word
+are being mapped to lower case.
+
The @var{nf} argument identifies the normalization form to apply after the
case-mapping. It can also be NULL, for no normalization.
@end deftypefun