diff options
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/lispref/commands.texi | 2 | ||||
| -rw-r--r-- | doc/lispref/control.texi | 4 | ||||
| -rw-r--r-- | doc/lispref/display.texi | 4 | ||||
| -rw-r--r-- | doc/lispref/elisp.texi | 1 | ||||
| -rw-r--r-- | doc/lispref/help.texi | 3 | ||||
| -rw-r--r-- | doc/lispref/minibuf.texi | 2 | ||||
| -rw-r--r-- | doc/lispref/strings.texi | 8 |
7 files changed, 15 insertions, 9 deletions
diff --git a/doc/lispref/commands.texi b/doc/lispref/commands.texi index aec7674284d..593054013e6 100644 --- a/doc/lispref/commands.texi +++ b/doc/lispref/commands.texi | |||
| @@ -211,7 +211,7 @@ argument. | |||
| 211 | 211 | ||
| 212 | The prompt string can use @samp{%} to include previous argument values | 212 | The prompt string can use @samp{%} to include previous argument values |
| 213 | (starting with the first argument) in the prompt. This is done using | 213 | (starting with the first argument) in the prompt. This is done using |
| 214 | @code{format} (@pxref{Formatting Strings}). For example, here is how | 214 | @code{format-message} (@pxref{Formatting Strings}). For example, here is how |
| 215 | you could read the name of an existing buffer followed by a new name to | 215 | you could read the name of an existing buffer followed by a new name to |
| 216 | give to that buffer: | 216 | give to that buffer: |
| 217 | 217 | ||
diff --git a/doc/lispref/control.texi b/doc/lispref/control.texi index 17d5c26897f..421f5cc530f 100644 --- a/doc/lispref/control.texi +++ b/doc/lispref/control.texi | |||
| @@ -990,7 +990,7 @@ should not end with any sort of punctuation. | |||
| 990 | 990 | ||
| 991 | @defun error format-string &rest args | 991 | @defun error format-string &rest args |
| 992 | This function signals an error with an error message constructed by | 992 | This function signals an error with an error message constructed by |
| 993 | applying @code{format} (@pxref{Formatting Strings}) to | 993 | applying @code{format-message} (@pxref{Formatting Strings}) to |
| 994 | @var{format-string} and @var{args}. | 994 | @var{format-string} and @var{args}. |
| 995 | 995 | ||
| 996 | These examples show typical uses of @code{error}: | 996 | These examples show typical uses of @code{error}: |
| @@ -1009,7 +1009,7 @@ These examples show typical uses of @code{error}: | |||
| 1009 | 1009 | ||
| 1010 | @code{error} works by calling @code{signal} with two arguments: the | 1010 | @code{error} works by calling @code{signal} with two arguments: the |
| 1011 | error symbol @code{error}, and a list containing the string returned by | 1011 | error symbol @code{error}, and a list containing the string returned by |
| 1012 | @code{format}. | 1012 | @code{format-message}. |
| 1013 | 1013 | ||
| 1014 | @strong{Warning:} If you want to use your own string as an error message | 1014 | @strong{Warning:} If you want to use your own string as an error message |
| 1015 | verbatim, don't just write @code{(error @var{string})}. If @var{string} | 1015 | verbatim, don't just write @code{(error @var{string})}. If @var{string} |
diff --git a/doc/lispref/display.texi b/doc/lispref/display.texi index ae59bbbdefa..36404f4dff9 100644 --- a/doc/lispref/display.texi +++ b/doc/lispref/display.texi | |||
| @@ -247,7 +247,7 @@ messages in the echo area. | |||
| 247 | @defun message format-string &rest arguments | 247 | @defun message format-string &rest arguments |
| 248 | This function displays a message in the echo area. | 248 | This function displays a message in the echo area. |
| 249 | @var{format-string} is a format string, and @var{arguments} are the | 249 | @var{format-string} is a format string, and @var{arguments} are the |
| 250 | objects for its format specifications, like in the @code{format} | 250 | objects for its format specifications, like in the @code{format-message} |
| 251 | function (@pxref{Formatting Strings}). The resulting formatted string | 251 | function (@pxref{Formatting Strings}). The resulting formatted string |
| 252 | is displayed in the echo area; if it contains @code{face} text | 252 | is displayed in the echo area; if it contains @code{face} text |
| 253 | properties, it is displayed with the specified faces (@pxref{Faces}). | 253 | properties, it is displayed with the specified faces (@pxref{Faces}). |
| @@ -375,7 +375,7 @@ reporting very fast. | |||
| 375 | When this progress reporter is subsequently used, it will display | 375 | When this progress reporter is subsequently used, it will display |
| 376 | @var{message} in the echo area, followed by progress percentage. | 376 | @var{message} in the echo area, followed by progress percentage. |
| 377 | @var{message} is treated as a simple string. If you need it to depend | 377 | @var{message} is treated as a simple string. If you need it to depend |
| 378 | on a filename, for instance, use @code{format} before calling this | 378 | on a filename, for instance, use @code{format-message} before calling this |
| 379 | function. | 379 | function. |
| 380 | 380 | ||
| 381 | The arguments @var{min-value} and @var{max-value} should be numbers | 381 | The arguments @var{min-value} and @var{max-value} should be numbers |
diff --git a/doc/lispref/elisp.texi b/doc/lispref/elisp.texi index 9044fbaec56..48c531f7731 100644 --- a/doc/lispref/elisp.texi +++ b/doc/lispref/elisp.texi | |||
| @@ -375,6 +375,7 @@ Strings and Characters | |||
| 375 | * Text Comparison:: Comparing characters or strings. | 375 | * Text Comparison:: Comparing characters or strings. |
| 376 | * String Conversion:: Converting to and from characters and strings. | 376 | * String Conversion:: Converting to and from characters and strings. |
| 377 | * Formatting Strings:: @code{format}: Emacs's analogue of @code{printf}. | 377 | * Formatting Strings:: @code{format}: Emacs's analogue of @code{printf}. |
| 378 | * Text Restyling:: Text style conversion function. | ||
| 378 | * Case Conversion:: Case conversion functions. | 379 | * Case Conversion:: Case conversion functions. |
| 379 | * Case Tables:: Customizing case conversion. | 380 | * Case Tables:: Customizing case conversion. |
| 380 | 381 | ||
diff --git a/doc/lispref/help.texi b/doc/lispref/help.texi index ca8ae3f314a..ab884f8dc80 100644 --- a/doc/lispref/help.texi +++ b/doc/lispref/help.texi | |||
| @@ -350,8 +350,7 @@ string in Emacs Lisp. | |||
| 350 | @defvar text-quoting-style | 350 | @defvar text-quoting-style |
| 351 | @cindex curved quotes | 351 | @cindex curved quotes |
| 352 | @cindex curly quotes | 352 | @cindex curly quotes |
| 353 | The value of this variable specifies the style | 353 | The value of this variable specifies the style used to generate text |
| 354 | @code{substitute-command-keys} uses when generating left and right | ||
| 355 | quotes. If the variable's value is @code{curve}, the style is | 354 | quotes. If the variable's value is @code{curve}, the style is |
| 356 | @t{‘like this’} with curved single quotes. If the value is | 355 | @t{‘like this’} with curved single quotes. If the value is |
| 357 | @code{straight}, the style is @t{'like this'} with straight | 356 | @code{straight}, the style is @t{'like this'} with straight |
diff --git a/doc/lispref/minibuf.texi b/doc/lispref/minibuf.texi index 24c7559c7d9..2aec149524d 100644 --- a/doc/lispref/minibuf.texi +++ b/doc/lispref/minibuf.texi | |||
| @@ -2413,7 +2413,7 @@ arrives, whichever comes first. The variable | |||
| 2413 | @code{minibuffer-message-timeout} specifies the number of seconds to | 2413 | @code{minibuffer-message-timeout} specifies the number of seconds to |
| 2414 | wait in the absence of input. It defaults to 2. If @var{args} is | 2414 | wait in the absence of input. It defaults to 2. If @var{args} is |
| 2415 | non-@code{nil}, the actual message is obtained by passing @var{string} | 2415 | non-@code{nil}, the actual message is obtained by passing @var{string} |
| 2416 | and @var{args} through @code{format}. @xref{Formatting Strings}. | 2416 | and @var{args} through @code{format-message}. @xref{Formatting Strings}. |
| 2417 | @end defun | 2417 | @end defun |
| 2418 | 2418 | ||
| 2419 | @deffn Command minibuffer-inactive-mode | 2419 | @deffn Command minibuffer-inactive-mode |
diff --git a/doc/lispref/strings.texi b/doc/lispref/strings.texi index c4556cbd284..326359e1da0 100644 --- a/doc/lispref/strings.texi +++ b/doc/lispref/strings.texi | |||
| @@ -801,7 +801,7 @@ they appear; it is called a @dfn{format string}. | |||
| 801 | 801 | ||
| 802 | Formatting is often useful for computing messages to be displayed. In | 802 | Formatting is often useful for computing messages to be displayed. In |
| 803 | fact, the functions @code{message} and @code{error} provide the same | 803 | fact, the functions @code{message} and @code{error} provide the same |
| 804 | formatting feature described here; they differ from @code{format} only | 804 | formatting feature described here; they differ from @code{format-message} only |
| 805 | in how they use the result of formatting. | 805 | in how they use the result of formatting. |
| 806 | 806 | ||
| 807 | @defun format string &rest objects | 807 | @defun format string &rest objects |
| @@ -815,6 +815,12 @@ are copied directly into the output, including their text properties, | |||
| 815 | if any. | 815 | if any. |
| 816 | @end defun | 816 | @end defun |
| 817 | 817 | ||
| 818 | @defun format-message string &rest objects | ||
| 819 | This function acts like @code{format}, except it also converts any | ||
| 820 | curved quotes in @var{string} as per the value of | ||
| 821 | @code{text-quoting-style}. @xref{Keys in Documentation}. | ||
| 822 | @end defun | ||
| 823 | |||
| 818 | @cindex @samp{%} in format | 824 | @cindex @samp{%} in format |
| 819 | @cindex format specification | 825 | @cindex format specification |
| 820 | A format specification is a sequence of characters beginning with a | 826 | A format specification is a sequence of characters beginning with a |