From: Eli Zaretskii <eliz@gnu.org>
Date: Tue, 16 Aug 2011 08:26:46 +0000 (+0300)
Subject: Document the new "mirroring" Unicode character property.
X-Git-Tag: emacs-pretest-24.0.90~104^2~124^2~33
X-Git-Url: http://git.eshelyaron.com/gitweb/?a=commitdiff_plain;h=108628738193907452fc32b9d8a4be44ff589d89;p=emacs.git

Document the new "mirroring" Unicode character property.

 src/nonascii.texi (Character Properties): Document the `mirroring'
 property.  Add index entries.
---

diff --git a/doc/lispref/ChangeLog b/doc/lispref/ChangeLog
index 40ad3dc8c52..58ce89b7eef 100644
--- a/doc/lispref/ChangeLog
+++ b/doc/lispref/ChangeLog
@@ -1,5 +1,8 @@
 2011-08-16  Eli Zaretskii  <eliz@gnu.org>
 
+	* nonascii.texi (Character Properties): Document the `mirroring'
+	property.  Add index entries.
+
 	* syntax.texi (Categories): Add an example of defining a new
 	category and category table.
 
diff --git a/doc/lispref/nonascii.texi b/doc/lispref/nonascii.texi
index 77337899923..83f9f424834 100644
--- a/doc/lispref/nonascii.texi
+++ b/doc/lispref/nonascii.texi
@@ -388,6 +388,7 @@ character's classification.
 Corresponds to the @code{Canonical_Combining_Class} Unicode property.
 The value is an integer number.
 
+@cindex bidirectional class of characters
 @item bidi-class
 Corresponds to the Unicode @code{Bidi_Class} property.  The value is a
 symbol whose name is the Unicode @dfn{directional type} of the
@@ -426,10 +427,21 @@ superscripts, Roman numerals, currency numerators, and encircled
 numbers.  For example, the value of this property for the character
 @code{U+2155} (@sc{vulgar fraction one fifth}) is @code{0.2}.
 
+@cindex mirroring of characters
 @item mirrored
 Corresponds to the Unicode @code{Bidi_Mirrored} property.  The value
 of this property is a symbol, either @code{Y} or @code{N}.
 
+@item mirroring
+Corresponds to the Unicode @code{Bidi_Mirroring_Glyph} property.  The
+value of this property is a character whose glyph represents the
+mirror image of the character's glyph, or @code{nil} if there's no
+defined mirroring glyph.  All the characters whose @code{mirrored}
+property is @code{N} have @code{nil} as their @code{mirroring}
+property; however, some characters whose @code{mirrored} property is
+@code{Y} also have @code{nil} for @code{mirroring}, because no
+appropriate characters exist with mirrored glyphs.
+
 @item old-name
 Corresponds to the Unicode @code{Unicode_1_Name} property.  The value
 is a string.