aboutsummaryrefslogtreecommitdiffstats
path: root/doc/lispref/control.texi
diff options
context:
space:
mode:
authorAlan Mackenzie2017-09-30 11:08:16 +0000
committerAlan Mackenzie2017-10-01 11:27:16 +0000
commit8c18dcbc784a97196d6513e5556de48af4cea617 (patch)
treec929074b0c9d9e6eabbefac9326c90dc4511d06c /doc/lispref/control.texi
parent5f76ac150a28e4de940790f96f0f751c8ee5d4c7 (diff)
downloademacs-8c18dcbc784a97196d6513e5556de48af4cea617.tar.gz
emacs-8c18dcbc784a97196d6513e5556de48af4cea617.zip
Amend documentation for text-quoting-style becoming a user option.
* doc/lispref/control.texi (Signaling Errors): * doc/lispref/display.texi (Displaying Messages): * doc/lispref/strings.texi (Formatting Strings): Edit for brevity, farming out the details to the new Text Quoting Style node. * doc/lispref/help.texi (Text Quoting Style): New section. Move detailed discussion of text-quoting-style here. Add discussion about how to output grave accent and apostrophe in documentation and messages. Adjust xrefs to point to this section when appropriate. * etc/NEWS: text-quoting-style semantics have not changed.
Diffstat (limited to 'doc/lispref/control.texi')
-rw-r--r--doc/lispref/control.texi14
1 files changed, 4 insertions, 10 deletions
diff --git a/doc/lispref/control.texi b/doc/lispref/control.texi
index c39e035459e..4eddbe9c122 100644
--- a/doc/lispref/control.texi
+++ b/doc/lispref/control.texi
@@ -1101,16 +1101,10 @@ These examples show typical uses of @code{error}:
1101error symbol @code{error}, and a list containing the string returned by 1101error symbol @code{error}, and a list containing the string returned by
1102@code{format-message}. 1102@code{format-message}.
1103 1103
1104The @code{text-quoting-style} variable controls what quotes are 1104Typically grave accent and apostrophe in the format translate to
1105generated; @xref{Keys in Documentation}. A call using a format like 1105matching 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
1107generates a message like @t{"Missing ‘foo’"} with matching curved 1107or inhibit this translation.
1108quotes. In contrast, a call using a format like @t{"Missing '%s'"}
1109with only apostrophes typically generates a message like @t{"Missing
1110’foo’"} with only closing curved quotes, an unusual style in English.
1111One way around this problem is to bind @code{text-quoting-style} to
1112the symbol @code{grave} around the call to @code{error}; this causes
1113@acronym{ASCII} quote characters to be output unchanged.
1114 1108
1115@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
1116verbatim, don't just write @code{(error @var{string})}. If @var{string} 1110verbatim, don't just write @code{(error @var{string})}. If @var{string}