diff options
| author | Paul Eggert | 2017-10-01 21:58:52 -0700 |
|---|---|---|
| committer | Paul Eggert | 2017-10-01 21:58:52 -0700 |
| commit | 4829a3b033b119b088947d14b73efc197b2547fa (patch) | |
| tree | ef9a96d2fa02c559ce69ff3ac9a272af84e5f6e9 /doc/lispref | |
| parent | ee3024c70d2974b59ecdd04b75d18d7258262e70 (diff) | |
| parent | 5172fa02cccaab2500ecf85aaf65b8deed54d42e (diff) | |
| download | emacs-4829a3b033b119b088947d14b73efc197b2547fa.tar.gz emacs-4829a3b033b119b088947d14b73efc197b2547fa.zip | |
Merge from origin/emacs-26
5172fa02cc Prefer HTTPS to HTTP for gnu.org
8cdd8b920a Merge from Gnulib
60b7668b89 Keep eww buffer current when looking up CSS on MDN
bd49b6f1b3 Workaround for faulty localtime() under macOS 10.6
913808e224 Doc amendment for syntax-ppss.
98dc91fda8 Remove incorrect NEWS entry about 'find-library'
539d8626cd Remove inadvertent changes to syntax.texi in last commit.
8c18dcbc78 Amend documentation for text-quoting-style becoming a user...
5f76ac150a Make the value nil in text-quoting-style mean what it does...
d5e4e004fa Make text-quoting-style customizable. Introduce t and new...
1ba3471b9b eshell.texi improvements
7abb5c3960 Fix ns-win.el on GNUstep
07ea5ef99a Fix reference style in org.texi
b03b4f6d79 Improve handling of iconification of child frames (Bug#28611)
ba9139c501 Revert "Don't lose arguments to eshell aliases (Bug#27954)"
43fac3beae Make "unsafe directory" error message more informative (Bu...
c59ddb2120 Fix slot typecheck in eieio-persistent
8b2ab5014b Fix semantic-ia-fast-jump
5b45e7e1c3 Bind vc-region-history
f172894595 Exit macro definition on undefined keys
289fe6c0d1 Reset bidi-paragraph-direction on article rendering
a4f7518817 Fix url-http use of url-current-object
4a755ed421 Avoid assertions in vc-hg.el on MS-Windows
cb93a6ce72 Improve documentation of 'copy-sequence'
200ef6f721 Minor update of ack.texi
cb407d3e87 * doc/emacs/emacs.texi (Acknowledgments): Add more contrib...
82b6c765ff Improve indexing of multi-file/buffer Isearch commands
645ff6c702 Add CAM02 JCh and CAM02-UCS J'a'b' conversions
157007b58e Fix uses of @kindex in the Emacs manual
63a45e8837 Merge branch 'emacs-26' of git.savannah.gnu.org:/srv/git/e...
3ab2f9bbb9 Merge from gnulib
cbc8324488 Prefer HTTPS to HTTP for gnu.org
bbda601d1d ; Spelling fixes
695cf5300b Wait for frame visibility with timeout in w32term too
e1f6e3127a Bring back the busy wait after x_make_frame_visible (Bug#2...
bccf635217 ; * src/gtkutil.c (xg_check_special_colors): Add another G...
f428757cdb Merge branch 'emacs-26' of git.savannah.gnu.org:/srv/git/e...
26d58f0c58 ; Standardize license notices
73dba0f466 Fix last doc string change in simple.el
Diffstat (limited to 'doc/lispref')
| -rw-r--r-- | doc/lispref/ChangeLog.1 | 10 | ||||
| -rw-r--r-- | doc/lispref/control.texi | 11 | ||||
| -rw-r--r-- | doc/lispref/display.texi | 13 | ||||
| -rw-r--r-- | doc/lispref/doclicense.texi | 2 | ||||
| -rw-r--r-- | doc/lispref/elisp.texi | 1 | ||||
| -rw-r--r-- | doc/lispref/frames.texi | 30 | ||||
| -rw-r--r-- | doc/lispref/gpl.texi | 8 | ||||
| -rw-r--r-- | doc/lispref/help.texi | 80 | ||||
| -rw-r--r-- | doc/lispref/sequences.texi | 5 | ||||
| -rw-r--r-- | doc/lispref/strings.texi | 11 | ||||
| -rw-r--r-- | doc/lispref/syntax.texi | 13 |
11 files changed, 124 insertions, 60 deletions
diff --git a/doc/lispref/ChangeLog.1 b/doc/lispref/ChangeLog.1 index 490f216b4cf..3fab757c963 100644 --- a/doc/lispref/ChangeLog.1 +++ b/doc/lispref/ChangeLog.1 | |||
| @@ -497,7 +497,7 @@ | |||
| 497 | Improve doc for use of 'int', and discuss 'ssize_t'. | 497 | Improve doc for use of 'int', and discuss 'ssize_t'. |
| 498 | * internals.texi (C Integer Types): Mention 'int' for other | 498 | * internals.texi (C Integer Types): Mention 'int' for other |
| 499 | randomish values that lie in 'int' range. Mention 'ssize_t'. See: | 499 | randomish values that lie in 'int' range. Mention 'ssize_t'. See: |
| 500 | http://lists.gnu.org/archive/html/emacs-devel/2014-10/msg00019.html | 500 | https://lists.gnu.org/archive/html/emacs-devel/2014-10/msg00019.html |
| 501 | 501 | ||
| 502 | Use AUTO_CONS instead of SCOPED_CONS, etc. | 502 | Use AUTO_CONS instead of SCOPED_CONS, etc. |
| 503 | * internals.texi (Stack-allocated Objects): | 503 | * internals.texi (Stack-allocated Objects): |
| @@ -971,7 +971,7 @@ | |||
| 971 | 971 | ||
| 972 | * markers.texi (Moving Marker Positions): Clarify guidance about | 972 | * markers.texi (Moving Marker Positions): Clarify guidance about |
| 973 | when to move markers and when to create a new one, as discussed at | 973 | when to move markers and when to create a new one, as discussed at |
| 974 | http://debbugs.gnu.org/cgi/bugreport.cgi?bug=16818#17 | 974 | https://debbugs.gnu.org/cgi/bugreport.cgi?bug=16818#17 |
| 975 | 975 | ||
| 976 | 2014-03-02 Glenn Morris <rgm@gnu.org> | 976 | 2014-03-02 Glenn Morris <rgm@gnu.org> |
| 977 | 977 | ||
| @@ -2154,7 +2154,7 @@ | |||
| 2154 | 2154 | ||
| 2155 | * internals.texi (C Integer Types): New section. | 2155 | * internals.texi (C Integer Types): New section. |
| 2156 | This follows up and records an email in | 2156 | This follows up and records an email in |
| 2157 | <http://lists.gnu.org/archive/html/emacs-devel/2012-07/msg00496.html>. | 2157 | <https://lists.gnu.org/archive/html/emacs-devel/2012-07/msg00496.html>. |
| 2158 | 2158 | ||
| 2159 | 2012-12-10 Stefan Monnier <monnier@iro.umontreal.ca> | 2159 | 2012-12-10 Stefan Monnier <monnier@iro.umontreal.ca> |
| 2160 | 2160 | ||
| @@ -2475,7 +2475,7 @@ | |||
| 2475 | * os.texi (Time of Day): | 2475 | * os.texi (Time of Day): |
| 2476 | Update for new time stamp format (HIGH LOW MICROSEC PICOSEC). | 2476 | Update for new time stamp format (HIGH LOW MICROSEC PICOSEC). |
| 2477 | These instances were missed the first time around. | 2477 | These instances were missed the first time around. |
| 2478 | Problem reported by Glenn Morris in <http://bugs.gnu.org/12706#25>. | 2478 | Problem reported by Glenn Morris in <https://bugs.gnu.org/12706#25>. |
| 2479 | 2479 | ||
| 2480 | 2012-10-24 Chong Yidong <cyd@gnu.org> | 2480 | 2012-10-24 Chong Yidong <cyd@gnu.org> |
| 2481 | 2481 | ||
| @@ -6288,7 +6288,7 @@ | |||
| 6288 | 2009-04-11 Eli Zaretskii <eliz@gnu.org> | 6288 | 2009-04-11 Eli Zaretskii <eliz@gnu.org> |
| 6289 | 6289 | ||
| 6290 | * display.texi (Overlays): Overlays don't scale well. See | 6290 | * display.texi (Overlays): Overlays don't scale well. See |
| 6291 | http://lists.gnu.org/archive/html/emacs-devel/2009-04/msg00243.html. | 6291 | https://lists.gnu.org/archive/html/emacs-devel/2009-04/msg00243.html. |
| 6292 | 6292 | ||
| 6293 | 2009-04-10 Chong Yidong <cyd@stupidchicken.com> | 6293 | 2009-04-10 Chong Yidong <cyd@stupidchicken.com> |
| 6294 | 6294 | ||
diff --git a/doc/lispref/control.texi b/doc/lispref/control.texi index 401a999cf23..4eddbe9c122 100644 --- a/doc/lispref/control.texi +++ b/doc/lispref/control.texi | |||
| @@ -1101,13 +1101,10 @@ These examples show typical uses of @code{error}: | |||
| 1101 | error symbol @code{error}, and a list containing the string returned by | 1101 | error symbol @code{error}, and a list containing the string returned by |
| 1102 | @code{format-message}. | 1102 | @code{format-message}. |
| 1103 | 1103 | ||
| 1104 | The @code{text-quoting-style} variable controls what quotes are | 1104 | Typically grave accent and apostrophe in the format translate to |
| 1105 | generated; @xref{Keys in Documentation}. A call using a format like | 1105 | matching curved quotes, e.g., @t{"Missing `%s'"} might result in |
| 1106 | @t{"Missing `%s'"} with grave accents and apostrophes typically | 1106 | @t{"Missing ‘foo’"}. @xref{Text Quoting Style}, for how to influence |
| 1107 | generates a message like @t{"Missing ‘foo’"} with matching curved | 1107 | or inhibit this translation. |
| 1108 | quotes. In contrast, a call using a format like @t{"Missing '%s'"} | ||
| 1109 | with only apostrophes typically generates a message like @t{"Missing | ||
| 1110 | ’foo’"} with only closing curved quotes, an unusual style in English. | ||
| 1111 | 1108 | ||
| 1112 | @strong{Warning:} If you want to use your own string as an error message | 1109 | @strong{Warning:} If you want to use your own string as an error message |
| 1113 | verbatim, don't just write @code{(error @var{string})}. If @var{string} | 1110 | 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 3dae984f339..afd09cfb330 100644 --- a/doc/lispref/display.texi +++ b/doc/lispref/display.texi | |||
| @@ -265,13 +265,10 @@ properties, it is displayed with the specified faces (@pxref{Faces}). | |||
| 265 | The string is also added to the @file{*Messages*} buffer, but without | 265 | The string is also added to the @file{*Messages*} buffer, but without |
| 266 | text properties (@pxref{Logging Messages}). | 266 | text properties (@pxref{Logging Messages}). |
| 267 | 267 | ||
| 268 | The @code{text-quoting-style} variable controls what quotes are | 268 | Typically grave accent and apostrophe in the format translate to |
| 269 | generated; @xref{Keys in Documentation}. A call using a format like | 269 | matching curved quotes, e.g., @t{"Missing `%s'"} might result in |
| 270 | @t{"Missing `%s'"} with grave accents and apostrophes typically | 270 | @t{"Missing ‘foo’"}. @xref{Text Quoting Style}, for how to influence |
| 271 | generates a message like @t{"Missing ‘foo’"} with matching curved | 271 | or inhibit this translation. |
| 272 | quotes. In contrast, a call using a format like @t{"Missing '%s'"} | ||
| 273 | with only apostrophes typically generates a message like @t{"Missing | ||
| 274 | ’foo’"} with only closing curved quotes, an unusual style in English. | ||
| 275 | 272 | ||
| 276 | In batch mode, the message is printed to the standard error stream, | 273 | In batch mode, the message is printed to the standard error stream, |
| 277 | followed by a newline. | 274 | followed by a newline. |
| @@ -7035,7 +7032,7 @@ window display table nor a buffer display table defined, or when Emacs | |||
| 7035 | is outputting text to the standard output or error streams. Although its | 7032 | is outputting text to the standard output or error streams. Although its |
| 7036 | default is typically @code{nil}, in an interactive session if the | 7033 | default is typically @code{nil}, in an interactive session if the |
| 7037 | terminal cannot display curved quotes, its default maps curved quotes | 7034 | terminal cannot display curved quotes, its default maps curved quotes |
| 7038 | to ASCII approximations. @xref{Keys in Documentation}. | 7035 | to ASCII approximations. @xref{Text Quoting Style}. |
| 7039 | @end defvar | 7036 | @end defvar |
| 7040 | 7037 | ||
| 7041 | The @file{disp-table} library defines several functions for changing | 7038 | The @file{disp-table} library defines several functions for changing |
diff --git a/doc/lispref/doclicense.texi b/doc/lispref/doclicense.texi index 542edaad258..eaf3da0e92d 100644 --- a/doc/lispref/doclicense.texi +++ b/doc/lispref/doclicense.texi | |||
| @@ -414,7 +414,7 @@ The Free Software Foundation may publish new, revised versions | |||
| 414 | of the GNU Free Documentation License from time to time. Such new | 414 | of the GNU Free Documentation License from time to time. Such new |
| 415 | versions will be similar in spirit to the present version, but may | 415 | versions will be similar in spirit to the present version, but may |
| 416 | differ in detail to address new problems or concerns. See | 416 | differ in detail to address new problems or concerns. See |
| 417 | @uref{https://www.gnu.org/copyleft/}. | 417 | @uref{https://www.gnu.org/licenses/}. |
| 418 | 418 | ||
| 419 | Each version of the License is given a distinguishing version number. | 419 | Each version of the License is given a distinguishing version number. |
| 420 | If the Document specifies that a particular numbered version of this | 420 | If the Document specifies that a particular numbered version of this |
diff --git a/doc/lispref/elisp.texi b/doc/lispref/elisp.texi index 4cbcdf855d1..c7525945845 100644 --- a/doc/lispref/elisp.texi +++ b/doc/lispref/elisp.texi | |||
| @@ -940,6 +940,7 @@ Documentation | |||
| 940 | * Documentation Basics:: Where doc strings are defined and stored. | 940 | * Documentation Basics:: Where doc strings are defined and stored. |
| 941 | * Accessing Documentation:: How Lisp programs can access doc strings. | 941 | * Accessing Documentation:: How Lisp programs can access doc strings. |
| 942 | * Keys in Documentation:: Substituting current key bindings. | 942 | * Keys in Documentation:: Substituting current key bindings. |
| 943 | * Text Quoting Style:: Quotation marks in doc strings and messages. | ||
| 943 | * Describing Characters:: Making printable descriptions of | 944 | * Describing Characters:: Making printable descriptions of |
| 944 | non-printing characters and key sequences. | 945 | non-printing characters and key sequences. |
| 945 | * Help Functions:: Subroutines used by Emacs help facilities. | 946 | * Help Functions:: Subroutines used by Emacs help facilities. |
diff --git a/doc/lispref/frames.texi b/doc/lispref/frames.texi index f66ecee8e8e..07a8b825026 100644 --- a/doc/lispref/frames.texi +++ b/doc/lispref/frames.texi | |||
| @@ -3076,15 +3076,14 @@ as long as the parameter is not changed or reset. Technically, this | |||
| 3076 | makes the child frame's window-system window a child window of the | 3076 | makes the child frame's window-system window a child window of the |
| 3077 | parent frame's window-system window. | 3077 | parent frame's window-system window. |
| 3078 | 3078 | ||
| 3079 | @cindex top-level frame | ||
| 3080 | @cindex reparent frame | 3079 | @cindex reparent frame |
| 3081 | @cindex nest frame | 3080 | @cindex nest frame |
| 3082 | The @code{parent-frame} parameter can be changed at any time. Setting | 3081 | The @code{parent-frame} parameter can be changed at any time. Setting |
| 3083 | it to another frame @dfn{reparents} the child frame. Setting it to | 3082 | it to another frame @dfn{reparents} the child frame. Setting it to |
| 3084 | another child frame makes the frame a @dfn{nested} child frame. Setting | 3083 | another child frame makes the frame a @dfn{nested} child frame. Setting |
| 3085 | it to @code{nil} restores the frame's status as a @dfn{top-level | 3084 | it to @code{nil} restores the frame's status as a top-level frame---a |
| 3086 | frame}---a frame whose window-system window is a child of its display's | 3085 | frame whose window-system window is a child of its display's root |
| 3087 | root window. | 3086 | window. |
| 3088 | 3087 | ||
| 3089 | Since child frames can be arbitrarily nested, a frame can be both a | 3088 | Since child frames can be arbitrarily nested, a frame can be both a |
| 3090 | child and a parent frame. Also, the relative roles of child and parent | 3089 | child and a parent frame. Also, the relative roles of child and parent |
| @@ -3203,7 +3202,11 @@ a number of other ways as well. Here we sketch a few of them: | |||
| 3203 | @item | 3202 | @item |
| 3204 | The semantics of maximizing and iconifying child frames is highly | 3203 | The semantics of maximizing and iconifying child frames is highly |
| 3205 | window-system dependent. As a rule, applications should never invoke | 3204 | window-system dependent. As a rule, applications should never invoke |
| 3206 | these operations for child frames. | 3205 | these operations for on frames. By default, invoking |
| 3206 | @code{iconify-frame} on a child frame will try to iconify the top-level | ||
| 3207 | frame corresponding to that child frame instead. To obtain a different | ||
| 3208 | behavior, users may customize the option @code{iconify-child-frame} | ||
| 3209 | described below. | ||
| 3207 | 3210 | ||
| 3208 | @item | 3211 | @item |
| 3209 | Raising, lowering and restacking child frames (@pxref{Raising and | 3212 | Raising, lowering and restacking child frames (@pxref{Raising and |
| @@ -3259,6 +3262,23 @@ frame in the largest empty area of an existing window. This can be | |||
| 3259 | useful to avoid that a child frame obscures any text shown in that | 3262 | useful to avoid that a child frame obscures any text shown in that |
| 3260 | window. | 3263 | window. |
| 3261 | 3264 | ||
| 3265 | Customizing the following option can be useful to tweak the behavior of | ||
| 3266 | @code{iconify-frame} for child frames. | ||
| 3267 | |||
| 3268 | @defvar iconify-child-frame | ||
| 3269 | This option tells Emacs how to proceed when it is asked to iconify a | ||
| 3270 | child frame. If it is @code{nil}, @code{iconify-frame} will do nothing | ||
| 3271 | when invoked on a child frame. If it is @code{iconify-top-level}, Emacs | ||
| 3272 | will try to iconify the top-level frame that is the ancestor of this | ||
| 3273 | child frame instead. If it is @code{make-invisible}, Emacs will try to | ||
| 3274 | make this child frame invisible instead of iconifying it. | ||
| 3275 | |||
| 3276 | Any other value means to try iconifying the child frame. Since such an | ||
| 3277 | attempt may not be honored by all window managers and can even lead to | ||
| 3278 | making the child frame unresponsive to user actions, the default is to | ||
| 3279 | iconify the top level frame instead. | ||
| 3280 | @end defvar | ||
| 3281 | |||
| 3262 | 3282 | ||
| 3263 | @node Mouse Tracking | 3283 | @node Mouse Tracking |
| 3264 | @section Mouse Tracking | 3284 | @section Mouse Tracking |
diff --git a/doc/lispref/gpl.texi b/doc/lispref/gpl.texi index 0e2e212acb1..c007dc06966 100644 --- a/doc/lispref/gpl.texi +++ b/doc/lispref/gpl.texi | |||
| @@ -5,7 +5,7 @@ | |||
| 5 | @c hence no sectioning command or @node. | 5 | @c hence no sectioning command or @node. |
| 6 | 6 | ||
| 7 | @display | 7 | @display |
| 8 | Copyright @copyright{} 2007 Free Software Foundation, Inc. @url{http://fsf.org/} | 8 | Copyright @copyright{} 2007 Free Software Foundation, Inc. @url{https://fsf.org/} |
| 9 | 9 | ||
| 10 | Everyone is permitted to copy and distribute verbatim copies of this | 10 | Everyone is permitted to copy and distribute verbatim copies of this |
| 11 | license document, but changing it is not allowed. | 11 | license document, but changing it is not allowed. |
| @@ -684,7 +684,7 @@ MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE@. See the GNU | |||
| 684 | General Public License for more details. | 684 | General Public License for more details. |
| 685 | 685 | ||
| 686 | You should have received a copy of the GNU General Public License | 686 | You should have received a copy of the GNU General Public License |
| 687 | along with this program. If not, see @url{http://www.gnu.org/licenses/}. | 687 | along with this program. If not, see @url{https://www.gnu.org/licenses/}. |
| 688 | @end smallexample | 688 | @end smallexample |
| 689 | 689 | ||
| 690 | Also add information on how to contact you by electronic and paper mail. | 690 | Also add information on how to contact you by electronic and paper mail. |
| @@ -707,11 +707,11 @@ use an ``about box''. | |||
| 707 | You should also get your employer (if you work as a programmer) or school, | 707 | You should also get your employer (if you work as a programmer) or school, |
| 708 | if any, to sign a ``copyright disclaimer'' for the program, if necessary. | 708 | if any, to sign a ``copyright disclaimer'' for the program, if necessary. |
| 709 | For more information on this, and how to apply and follow the GNU GPL, see | 709 | For more information on this, and how to apply and follow the GNU GPL, see |
| 710 | @url{http://www.gnu.org/licenses/}. | 710 | @url{https://www.gnu.org/licenses/}. |
| 711 | 711 | ||
| 712 | The GNU General Public License does not permit incorporating your | 712 | The GNU General Public License does not permit incorporating your |
| 713 | program into proprietary programs. If your program is a subroutine | 713 | program into proprietary programs. If your program is a subroutine |
| 714 | library, you may consider it more useful to permit linking proprietary | 714 | library, you may consider it more useful to permit linking proprietary |
| 715 | applications with the library. If this is what you want to do, use | 715 | applications with the library. If this is what you want to do, use |
| 716 | the GNU Lesser General Public License instead of this License. But | 716 | the GNU Lesser General Public License instead of this License. But |
| 717 | first, please read @url{http://www.gnu.org/philosophy/why-not-lgpl.html}. | 717 | first, please read @url{https://www.gnu.org/licenses/why-not-lgpl.html}. |
diff --git a/doc/lispref/help.texi b/doc/lispref/help.texi index cb214113523..4aa9b95180e 100644 --- a/doc/lispref/help.texi +++ b/doc/lispref/help.texi | |||
| @@ -33,6 +33,7 @@ Help, emacs, The GNU Emacs Manual}. | |||
| 33 | * Documentation Basics:: Where doc strings are defined and stored. | 33 | * Documentation Basics:: Where doc strings are defined and stored. |
| 34 | * Accessing Documentation:: How Lisp programs can access doc strings. | 34 | * Accessing Documentation:: How Lisp programs can access doc strings. |
| 35 | * Keys in Documentation:: Substituting current key bindings. | 35 | * Keys in Documentation:: Substituting current key bindings. |
| 36 | * Text Quoting Style:: Quotation marks in doc strings and messages. | ||
| 36 | * Describing Characters:: Making printable descriptions of | 37 | * Describing Characters:: Making printable descriptions of |
| 37 | non-printing characters and key sequences. | 38 | non-printing characters and key sequences. |
| 38 | * Help Functions:: Subroutines used by Emacs help facilities. | 39 | * Help Functions:: Subroutines used by Emacs help facilities. |
| @@ -336,6 +337,7 @@ specifies @var{mapvar}'s value as the keymap for any following | |||
| 336 | (grave accent) stands for a left quote. | 337 | (grave accent) stands for a left quote. |
| 337 | This generates a left single quotation mark, an apostrophe, or a grave | 338 | This generates a left single quotation mark, an apostrophe, or a grave |
| 338 | accent depending on the value of @code{text-quoting-style}. | 339 | accent depending on the value of @code{text-quoting-style}. |
| 340 | @xref{Text Quoting Style}. | ||
| 339 | 341 | ||
| 340 | @item ' | 342 | @item ' |
| 341 | (apostrophe) stands for a right quote. | 343 | (apostrophe) stands for a right quote. |
| @@ -351,25 +353,24 @@ and @samp{\=\=} puts @samp{\=} into the output. | |||
| 351 | @strong{Please note:} Each @samp{\} must be doubled when written in a | 353 | @strong{Please note:} Each @samp{\} must be doubled when written in a |
| 352 | string in Emacs Lisp. | 354 | string in Emacs Lisp. |
| 353 | 355 | ||
| 354 | @defvar text-quoting-style | 356 | @defopt text-quoting-style |
| 355 | @cindex curved quotes | 357 | @cindex curved quotes |
| 356 | @cindex curly quotes | 358 | @cindex curly quotes |
| 357 | The value of this variable is a symbol that specifies the style Emacs | 359 | The value of this variable is a symbol that specifies the style Emacs |
| 358 | should use for single quotes in the wording of help and messages. | 360 | should use for single quotes in the wording of help and messages. If |
| 359 | If the variable's value is @code{curve}, the style is | 361 | the variable's value is @code{curve}, the style is @t{‘like this’} |
| 360 | @t{‘like this’} with curved single quotes. If the value is | 362 | with curved single quotes. If the value is @code{straight}, the style |
| 361 | @code{straight}, the style is @t{'like this'} with straight | 363 | is @t{'like this'} with straight apostrophes. If the value is |
| 362 | apostrophes. If the value is @code{grave}, | 364 | @code{grave}, quotes are not translated and the style is @t{`like |
| 363 | quotes are not translated and the style is @t{`like | 365 | this'} with grave accent and apostrophe, the standard style before |
| 364 | this'} with grave accent and apostrophe, the standard style | 366 | Emacs version 25. The default value @code{nil} acts like @code{curve} |
| 365 | before Emacs version 25. The default value @code{nil} | 367 | if curved single quotes seem to be displayable, and like @code{grave} |
| 366 | acts like @code{curve} if curved single quotes are displayable, and | 368 | otherwise. |
| 367 | like @code{grave} otherwise. | 369 | |
| 368 | 370 | This option is useful on platforms that have problems with curved | |
| 369 | This variable can be used by experts on platforms that have problems | 371 | quotes. You can customize it freely according to your personal |
| 370 | with curved quotes. As it is not intended for casual use, it is not a | 372 | preference. |
| 371 | user option. | 373 | @end defopt |
| 372 | @end defvar | ||
| 373 | 374 | ||
| 374 | @defun substitute-command-keys string | 375 | @defun substitute-command-keys string |
| 375 | This function scans @var{string} for the above special sequences and | 376 | This function scans @var{string} for the above special sequences and |
| @@ -429,6 +430,53 @@ C-g abort-recursive-edit | |||
| 429 | strings---for instance, you can refer to functions, variables, and | 430 | strings---for instance, you can refer to functions, variables, and |
| 430 | sections of this manual. @xref{Documentation Tips}, for details. | 431 | sections of this manual. @xref{Documentation Tips}, for details. |
| 431 | 432 | ||
| 433 | @node Text Quoting Style | ||
| 434 | @section Text Quoting Style | ||
| 435 | |||
| 436 | Typically, grave accents and apostrophes are treated specially in | ||
| 437 | documentation strings and diagnostic messages, and translate to matching | ||
| 438 | single quotation marks (also called ``curved quotes''). For example, | ||
| 439 | the documentation string @t{"Alias for `foo'."} and the function call | ||
| 440 | @code{(message "Alias for `foo'.")} both translate to @t{"Alias for | ||
| 441 | ‘foo’."}. Less commonly, Emacs displays grave accents and apostrophes | ||
| 442 | as themselves, or as apostrophes only (e.g., @t{"Alias for 'foo'."}). | ||
| 443 | Documentation strings and message formats should be written so that | ||
| 444 | they display well with any of these styles. For example, the | ||
| 445 | documentation string @t{"Alias for 'foo'."} is probably not what you | ||
| 446 | want, as it can display as @t{"Alias for ’foo’."}, an unusual style in | ||
| 447 | English. | ||
| 448 | |||
| 449 | Sometimes you may need to display a grave accent or apostrophe | ||
| 450 | without translation, regardless of text quoting style. In a | ||
| 451 | documentation string, you can do this with escapes. For example, in | ||
| 452 | the documentation string @t{"\\=`(a ,(sin 0)) ==> (a 0.0)"} the grave | ||
| 453 | accent is intended to denote Lisp code, so it is escaped and displays | ||
| 454 | as itself regardless of quoting style. In a call to @code{message} or | ||
| 455 | @code{error}, you can avoid translation by using a format @t{"%s"} | ||
| 456 | with an argument that is a call to @code{format}. For example, | ||
| 457 | @code{(message "%s" (format "`(a ,(sin %S)) ==> (a %S)" x (sin x)))} | ||
| 458 | displays a message that starts with grave accent regardless of text | ||
| 459 | quoting style. | ||
| 460 | |||
| 461 | @defopt text-quoting-style | ||
| 462 | @cindex curved quotes | ||
| 463 | @cindex curly quotes | ||
| 464 | The value of this user option is a symbol that specifies the style | ||
| 465 | Emacs should use for single quotes in the wording of help and | ||
| 466 | messages. If the option's value is @code{curve}, the style is | ||
| 467 | @t{‘like this’} with curved single quotes. If the value is | ||
| 468 | @code{straight}, the style is @t{'like this'} with straight | ||
| 469 | apostrophes. If the value is @code{grave}, quotes are not translated | ||
| 470 | and the style is @t{`like this'} with grave accent and apostrophe, the | ||
| 471 | standard style before Emacs version 25. The default value @code{nil} | ||
| 472 | acts like @code{curve} if curved single quotes seem to be displayable, | ||
| 473 | and like @code{grave} otherwise. | ||
| 474 | |||
| 475 | This option is useful on platforms that have problems with curved | ||
| 476 | quotes. You can customize it freely according to your personal | ||
| 477 | preference. | ||
| 478 | @end defopt | ||
| 479 | |||
| 432 | @node Describing Characters | 480 | @node Describing Characters |
| 433 | @section Describing Characters for Help Messages | 481 | @section Describing Characters for Help Messages |
| 434 | @cindex describe characters and events | 482 | @cindex describe characters and events |
diff --git a/doc/lispref/sequences.texi b/doc/lispref/sequences.texi index c7cf9f5e1af..5ae1567c128 100644 --- a/doc/lispref/sequences.texi +++ b/doc/lispref/sequences.texi | |||
| @@ -155,7 +155,10 @@ This function generalizes @code{aref} (@pxref{Array Functions}) and | |||
| 155 | @cindex copying sequences | 155 | @cindex copying sequences |
| 156 | This function returns a copy of @var{seqr}, which should be either a | 156 | This function returns a copy of @var{seqr}, which should be either a |
| 157 | sequence or a record. The copy is the same type of object as the | 157 | sequence or a record. The copy is the same type of object as the |
| 158 | original, and it has the same elements in the same order. | 158 | original, and it has the same elements in the same order. However, if |
| 159 | @var{seqr} is empty, like a string or a vector of zero length, the | ||
| 160 | value returned by this function might not be a copy, but an empty | ||
| 161 | object of the same type and identical to @var{seqr}. | ||
| 159 | 162 | ||
| 160 | Storing a new element into the copy does not affect the original | 163 | Storing a new element into the copy does not affect the original |
| 161 | @var{seqr}, and vice versa. However, the elements of the copy | 164 | @var{seqr}, and vice versa. However, the elements of the copy |
diff --git a/doc/lispref/strings.texi b/doc/lispref/strings.texi index 219225d412b..dd004927caf 100644 --- a/doc/lispref/strings.texi +++ b/doc/lispref/strings.texi | |||
| @@ -826,17 +826,14 @@ to the produced string representations of the argument @var{objects}. | |||
| 826 | @defun format-message string &rest objects | 826 | @defun format-message string &rest objects |
| 827 | @cindex curved quotes, in formatted messages | 827 | @cindex curved quotes, in formatted messages |
| 828 | @cindex curly quotes, in formatted messages | 828 | @cindex curly quotes, in formatted messages |
| 829 | @cindex @code{text-quoting-style}, and formatting messages | ||
| 830 | This function acts like @code{format}, except it also converts any | 829 | This function acts like @code{format}, except it also converts any |
| 831 | grave accents (@t{`}) and apostrophes (@t{'}) in @var{string} as per the | 830 | grave accents (@t{`}) and apostrophes (@t{'}) in @var{string} as per the |
| 832 | value of @code{text-quoting-style}. | 831 | value of @code{text-quoting-style}. |
| 833 | 832 | ||
| 834 | A format that quotes with grave accents and apostrophes @t{`like | 833 | Typically grave accent and apostrophe in the format translate to |
| 835 | this'} typically generates curved quotes @t{‘like this’}. In | 834 | matching curved quotes, e.g., @t{"Missing `%s'"} might result in |
| 836 | contrast, a format that quotes with only apostrophes @t{'like this'} | 835 | @t{"Missing ‘foo’"}. @xref{Text Quoting Style}, for how to influence |
| 837 | typically generates two closing curved quotes @t{’like this’}, an | 836 | or inhibit this translation. |
| 838 | unusual style in English. @xref{Keys in Documentation}, for how the | ||
| 839 | @code{text-quoting-style} variable affects generated quotes. | ||
| 840 | @end defun | 837 | @end defun |
| 841 | 838 | ||
| 842 | @cindex @samp{%} in format | 839 | @cindex @samp{%} in format |
diff --git a/doc/lispref/syntax.texi b/doc/lispref/syntax.texi index e3ae53536f9..b37f2b22b82 100644 --- a/doc/lispref/syntax.texi +++ b/doc/lispref/syntax.texi | |||
| @@ -751,7 +751,8 @@ position. This function does that conveniently. | |||
| 751 | 751 | ||
| 752 | @defun syntax-ppss &optional pos | 752 | @defun syntax-ppss &optional pos |
| 753 | This function returns the parser state that the parser would reach at | 753 | This function returns the parser state that the parser would reach at |
| 754 | position @var{pos} starting from the beginning of the buffer. | 754 | position @var{pos} starting from the beginning of the visible portion |
| 755 | of the buffer. | ||
| 755 | @iftex | 756 | @iftex |
| 756 | See the next section for | 757 | See the next section for |
| 757 | @end iftex | 758 | @end iftex |
| @@ -762,11 +763,11 @@ for a description of the parser state. | |||
| 762 | 763 | ||
| 763 | The return value is the same as if you call the low-level parsing | 764 | The return value is the same as if you call the low-level parsing |
| 764 | function @code{parse-partial-sexp} to parse from the beginning of the | 765 | function @code{parse-partial-sexp} to parse from the beginning of the |
| 765 | buffer to @var{pos} (@pxref{Low-Level Parsing}). However, | 766 | visible portion of the buffer to @var{pos} (@pxref{Low-Level |
| 766 | @code{syntax-ppss} uses a cache to speed up the computation. Due to | 767 | Parsing}). However, @code{syntax-ppss} uses caches to speed up the |
| 767 | this optimization, the second value (previous complete subexpression) | 768 | computation. Due to this optimization, the second value (previous |
| 768 | and sixth value (minimum parenthesis depth) in the returned parser | 769 | complete subexpression) and sixth value (minimum parenthesis depth) in |
| 769 | state are not meaningful. | 770 | the returned parser state are not meaningful. |
| 770 | 771 | ||
| 771 | This function has a side effect: it adds a buffer-local entry to | 772 | This function has a side effect: it adds a buffer-local entry to |
| 772 | @code{before-change-functions} (@pxref{Change Hooks}) for | 773 | @code{before-change-functions} (@pxref{Change Hooks}) for |