]> code.delx.au - gnu-emacs/commitdiff
Document insert-char changes.
authorChong Yidong <cyd@gnu.org>
Tue, 17 Jul 2012 07:43:01 +0000 (15:43 +0800)
committerChong Yidong <cyd@gnu.org>
Tue, 17 Jul 2012 07:43:01 +0000 (15:43 +0800)
* doc/emacs/basic.texi (Inserting Text): Replace ucs-insert with
insert-char.  Provide more details of input.

* doc/lispref/mule.texi (International Chars, Input Methods): Likewise.

* doc/lispref/text.texi (Insertion): Document insert-char changes.

* src/editfns.c (Finsert_char): Doc fix.

doc/emacs/ChangeLog
doc/emacs/basic.texi
doc/emacs/mule.texi
doc/lispref/ChangeLog
doc/lispref/text.texi
etc/NEWS
src/ChangeLog
src/editfns.c

index 72244c6dfa9eaa62bd72319ee1525617583d88c8..6783e8431109a5a91c6e694de6413b97dd141379 100644 (file)
@@ -1,3 +1,10 @@
+2012-07-17  Chong Yidong  <cyd@gnu.org>
+
+       * basic.texi (Inserting Text): Replace ucs-insert with
+       insert-char.  Provide more details of input.
+
+       * mule.texi (International Chars, Input Methods): Likewise.
+
 2012-07-13  Chong Yidong  <cyd@gnu.org>
 
        * custom.texi (Examining): Update C-h v message.
index 9c4b303d2826cdb7e4637b43d1bd8ff2a83348bf..16ccdba086635d215af006c3ea008d68d37742f8 100644 (file)
@@ -97,28 +97,29 @@ To use decimal or hexadecimal instead of octal, set the variable
 the letters @kbd{a} to @kbd{f} serve as part of a character code,
 just like digits.  Case is ignored.
 
-@findex ucs-insert
+@findex insert-char
 @kindex C-x 8 RET
 @cindex Unicode characters, inserting
 @cindex insert Unicode character
 @cindex characters, inserting by name or code-point
-  Instead of @kbd{C-q}, you can use the command @kbd{C-x 8 @key{RET}}
-(@code{ucs-insert}).  This prompts for the Unicode name or code-point
+  Alternatively, you can use the command @kbd{C-x 8 @key{RET}}
+(@code{insert-char}).  This prompts for the Unicode name or code-point
 of a character, using the minibuffer.  If you enter a name, the
 command provides completion (@pxref{Completion}).  If you enter a
-code-point, it should be a hexadecimal number (which is the convention
-for Unicode).  The command then inserts the corresponding character
-into the buffer.  For example, both of the following insert the
-infinity sign (Unicode code-point @code{U+221E}):
+code-point, it should be as a hexadecimal number (the convention for
+Unicode), or a number with a specified radix, e.g.@: @code{#o23072}
+(octal); @xref{Integer Basics,,, elisp, The Emacs Lisp Reference
+Manual}.  The command then inserts the corresponding character into
+the buffer.  For example, both of the following insert the infinity
+sign (Unicode code-point @code{U+221E}):
 
 @example
 @kbd{C-x 8 @key{RET} infinity @key{RET}}
 @kbd{C-x 8 @key{RET} 221e @key{RET}}
 @end example
 
-  A numeric argument to either @kbd{C-q} or @kbd{C-x 8 @key{RET}}
-specifies how many copies of the character to insert
-(@pxref{Arguments}).
+  A numeric argument to @kbd{C-q} or @kbd{C-x 8 @key{RET}} specifies
+how many copies of the character to insert (@pxref{Arguments}).
 
 @node Moving Point
 @section Changing the Location of Point
index 59e945eee96be563a3a2d58ac2711c9ac11648c2..1dfae79c7885a1094053700591f2adcec4f7b881 100644 (file)
@@ -146,7 +146,7 @@ displayed on your terminal, they appear as @samp{?} or as hollow boxes
 used, generally don't have keys for all the characters in them.  You
 can insert characters that your keyboard does not support, using
 @kbd{C-q} (@code{quoted-insert}) or @kbd{C-x 8 @key{RET}}
-(@code{ucs-insert}).  @xref{Inserting Text}.  Emacs also supports
+(@code{insert-char}).  @xref{Inserting Text}.  Emacs also supports
 various @dfn{input methods}, typically one for each script or
 language, which make it easier to type characters in the script.
 @xref{Input Methods}.
@@ -548,7 +548,7 @@ possible characters to type next is displayed in the echo area (but
 not when you are in the minibuffer).
 
   Another facility for typing characters not on your keyboard is by
-using @kbd{C-x 8 @key{RET}} (@code{ucs-insert}) to insert a single
+using @kbd{C-x 8 @key{RET}} (@code{insert-char}) to insert a single
 character based on its Unicode name or code-point; see @ref{Inserting
 Text}.
 
index 5378cc16cdb6f8824798a450306eb58703a8b928..bc01d64c509dd4827dc0528163d819dcb6c7561c 100644 (file)
@@ -1,3 +1,7 @@
+2012-07-17  Chong Yidong  <cyd@gnu.org>
+
+       * text.texi (Insertion): Document insert-char changes.
+
 2012-07-15  Leo Liu  <sdl.web@gmail.com>
 
        * display.texi (Fringe Bitmaps): Add exclamation-mark.
index c1e12ccf3a3d861fff97d6c7033c4dcd1966620b..d115322f84f0761a7f6c5ae43cbf94d87e51dc2e 100644 (file)
@@ -401,19 +401,23 @@ ends at the insertion point, the inserted text falls inside that
 overlay.
 @end defun
 
-@defun insert-char character count &optional inherit
-This function inserts @var{count} instances of @var{character} into the
-current buffer before point.  The argument @var{count} should be an
-integer, and @var{character} must be a character.  The value is @code{nil}.
+@deffn Command insert-char character &optional count inherit
+This command inserts @var{count} instances of @var{character} into the
+current buffer before point.  The argument @var{count} must be an
+integer, and @var{character} must be a character.
+
+If called interactively, this command prompts for @var{character}
+using its Unicode name or its code point.  @xref{Inserting Text,,,
+emacs, The GNU Emacs Manual}.
 
 This function does not convert unibyte character codes 128 through 255
 to multibyte characters, not even if the current buffer is a multibyte
 buffer.  @xref{Converting Representations}.
 
-If @var{inherit} is non-@code{nil}, then the inserted characters inherit
+If @var{inherit} is non-@code{nil}, the inserted characters inherit
 sticky text properties from the two characters before and after the
 insertion point.  @xref{Sticky Properties}.
-@end defun
+@end deffn
 
 @defun insert-buffer-substring from-buffer-or-name &optional start end
 This function inserts a portion of buffer @var{from-buffer-or-name}
index 9eac4af64a34e4df77d4b1deffdc1545ad387975..bf7880bd1ac205d68c986b6fb2a78e1eca81245c 100644 (file)
--- a/etc/NEWS
+++ b/etc/NEWS
@@ -140,6 +140,7 @@ invokes `set-buffer-file-coding-system'.
 ** Setting `enable-remote-dir-locals' to non-nil allows directory
 local variables on remote hosts.
 
++++
 ** `insert-char' is now a command, and `ucs-insert' an obsolete alias
 for it.
 
index 8c8ba4dd143a5f36f48c21264fcd37c208e38e57..82bedfdf2c481edf4adca5cca8b443919b04e3d1 100644 (file)
@@ -1,3 +1,7 @@
+2012-07-17  Chong Yidong  <cyd@gnu.org>
+
+       * editfns.c (Finsert_char): Doc fix.
+
 2012-07-17  Dmitry Antipov  <dmantipov@yandex.ru>
 
        Fix previous change to make Fmemory_free always accurate.
index 5dc561a400ecf3536ff2f4426681042b2bdaed65..9cfd0449daa40f9251ce19b03ff810683cfcd0f9 100644 (file)
@@ -2369,27 +2369,34 @@ usage: (insert-before-markers-and-inherit &rest ARGS)  */)
 }
 \f
 DEFUN ("insert-char", Finsert_char, Sinsert_char, 1, 3,
-       "(list (read-char-by-name \"Unicode (name or hex): \")\
+       "(list (read-char-by-name \"Insert character (Unicode name or hex): \")\
         (prefix-numeric-value current-prefix-arg)\
         t))",
        doc: /* Insert COUNT copies of CHARACTER.
-Interactively, prompts for a Unicode character name or a hex number
-using `read-char-by-name'.
+Interactively, prompt for CHARACTER.  You can specify CHARACTER in one
+of these ways:
 
-You can type a few of the first letters of the Unicode name and
-use completion.  If you type a substring of the Unicode name
-preceded by an asterisk `*' and use completion, it will show all
-the characters whose names include that substring, not necessarily
-at the beginning of the name.
+ - As its Unicode character name, e.g. \"LATIN SMALL LETTER A\".
+   Completion is available; if you type a substring of the name
+   preceded by an asterisk `*', Emacs shows all names which include
+   that substring, not necessarily at the beginning of the name.
 
-This function also accepts a hexadecimal number of Unicode code
-point or a number in hash notation, e.g. #o21430 for octal,
-#x2318 for hex, or #10r8984 for decimal.
+ - As a hexadecimal code point, e.g. 263A.  Note that code points in
+   Emacs are equivalent to Unicode up to 10FFFF (which is the limit of
+   the Unicode code space).
 
-Point, and before-insertion markers, are relocated as in the function `insert'.
-The optional third arg INHERIT, if non-nil, says to inherit text properties
-from adjoining text, if those properties are sticky.  If called
-interactively, INHERIT is t.  */)
+ - As a code point with a radix specified with #, e.g. #o21430
+   (octal), #x2318 (hex), or #10r8984 (decimal).
+
+If called interactively, COUNT is given by the prefix argument.  If
+omitted or nil, it defaults to 1.
+
+Inserting the character(s) relocates point and before-insertion
+markers in the same ways as the function `insert'.
+
+The optional third argument INHERIT, if non-nil, says to inherit text
+properties from adjoining text, if those properties are sticky.  If
+called interactively, INHERIT is t.  */)
   (Lisp_Object character, Lisp_Object count, Lisp_Object inherit)
 {
   int i, stringlen;