summaryrefslogtreecommitdiff
path: root/src/doc.c
diff options
context:
space:
mode:
authorAlan Mackenzie <acm@muc.de>2015-06-18 21:00:20 +0000
committerAlan Mackenzie <acm@muc.de>2015-06-18 21:08:02 +0000
commit52c3946c872c8bd96508f74cdda5cbb90c664306 (patch)
tree30c756647f4acea5c8c6d52fe59e9f49778f7541 /src/doc.c
parent711e14ddad7fb1e80a86c79e37a957929e8c01a3 (diff)
downloademacs-52c3946c872c8bd96508f74cdda5cbb90c664306.tar.gz
Make translation of quotes to curly in doc strings optional.
src/doc.c (traditional, prefer-unicode): new symbols. (help-quote-translation): new variable. (Fsubstitute_command_keys): make translation of quotes dependent on `help-quote-translation'; also translate curly quotes back to ASCII ones. lisp/cus-start.el (top-level): Add a customization entry for `help-quote-translation'.
Diffstat (limited to 'src/doc.c')
-rw-r--r--src/doc.c34
1 files changed, 32 insertions, 2 deletions
diff --git a/src/doc.c b/src/doc.c
index f1ba64359a6..6794ec777ae 100644
--- a/src/doc.c
+++ b/src/doc.c
@@ -932,7 +932,8 @@ Otherwise, return a new string. */)
strp = SDATA (string) + idx;
}
}
- else if (strp[0] == '`')
+ else if ((Vhelp_quote_translation == Qprefer_unicode)
+ && (strp[0] == '`'))
{
in_quote = true;
start = (unsigned char *) "\xE2\x80\x98"; /* ‘ */
@@ -942,12 +943,27 @@ Otherwise, return a new string. */)
idx = strp - SDATA (string) + 1;
goto subst;
}
- else if (strp[0] == '\'' && in_quote)
+ else if ((Vhelp_quote_translation == Qprefer_unicode)
+ && (strp[0] == '\'' && in_quote))
{
in_quote = false;
start = (unsigned char *) "\xE2\x80\x99"; /* ’ */
goto subst_quote;
}
+
+ else if ((Vhelp_quote_translation == Qtraditional)
+ && (strp[0] == 0xE2)
+ && (strp[1] == 0x80)
+ && ((strp[2] == 0x98) /* curly opening quote */
+ || (strp[2] == 0x99))) /* curly closing quote */
+ {
+ start = (strp[2] == 0x98) ? "`" : "'";
+ length = 1;
+ length_byte = 1;
+ idx = strp - SDATA (string) + 3;
+ goto subst;
+ }
+
else if (! multibyte) /* just copy other chars */
*bufp++ = *strp++, nchars++;
else
@@ -977,6 +993,8 @@ void
syms_of_doc (void)
{
DEFSYM (Qfunction_documentation, "function-documentation");
+ DEFSYM (Qtraditional, "traditional");
+ DEFSYM (Qprefer_unicode, "prefer-unicode");
DEFVAR_LISP ("internal-doc-file-name", Vdoc_file_name,
doc: /* Name of file containing documentation strings of built-in symbols. */);
@@ -986,6 +1004,18 @@ syms_of_doc (void)
doc: /* A list of files used to build this Emacs binary. */);
Vbuild_files = Qnil;
+ DEFVAR_LISP ("help-quote-translation", Vhelp_quote_translation,
+ doc: /* How to translate quotes for display in *Help*.
+If the value is nil (default), no translation is done.
+If it's the symbol `traditional', any occurrences of the curly quotes
+are translated to their ASCII "equivalents", GRAVE and APOSTROPHE.
+If it's the symbol `prefer-unicode', any matched pairs of GRAVE and
+APOSTROPHE will get translated into the "equivalent" curly quotes.
+
+Note that any translation done is done in a fresh copy of the doc
+string, and doesn't overwrite the original characters. */);
+ Vhelp_quote_translation = Qnil;
+
defsubr (&Sdocumentation);
defsubr (&Sdocumentation_property);
defsubr (&Ssnarf_documentation);