changeset 101865:4e643f5b16ea

(Explicit Encoding): Document the `charset' text property produced by decode-coding-region and decode-coding-string.
author Eli Zaretskii <eliz@gnu.org>
date Sat, 07 Feb 2009 11:48:00 +0000
parents 267681f66b59
children b05303a22a91
files doc/lispref/nonascii.texi
diffstat 1 files changed, 16 insertions(+), 0 deletions(-) [+]
line wrap: on
line diff
--- a/doc/lispref/nonascii.texi	Sat Feb 07 11:09:56 2009 +0000
+++ b/doc/lispref/nonascii.texi	Sat Feb 07 11:48:00 2009 +0000
@@ -1568,6 +1568,10 @@
 
 If decoded text is inserted in some buffer, this command returns the
 length of the decoded text.
+
+This command puts a @code{charset} text property on the decoded text.
+The value of the property states the character set used to decode the
+original text.
 @end deffn
 
 @defun decode-coding-string string coding-system &optional nocopy buffer
@@ -1583,6 +1587,18 @@
 If optional argument @var{buffer} specifies a buffer, the decoded text
 is inserted in that buffer after point (point does not move).  In this
 case, the return value is the length of the decoded text.
+
+@cindex @code{charset}, text property
+This function puts a @code{charset} text property on the decoded text.
+The value of the property states the character set used to decode the
+original text:
+
+@example
+@group
+(decode-coding-string "Gr\374ss Gott" 'latin-1)
+     @result{} #("Gr@"uss Gott" 0 9 (charset iso-8859-1))
+@end group
+@end example
 @end defun
 
 @defun decode-coding-inserted-region from to filename &optional visit beg end replace