diff options
| author | Paul Eggert | 2015-08-02 15:58:02 -0700 |
|---|---|---|
| committer | Paul Eggert | 2015-08-02 15:58:31 -0700 |
| commit | fa10e77790a207aeabf354c9f5667b3dbde55bb2 (patch) | |
| tree | 9ab7b0e8bbd340d76f34583aeaa7721c7f59008f /src/doc.c | |
| parent | fc9206b73a254a400245578b94542cfe82c68e9c (diff) | |
| download | emacs-fa10e77790a207aeabf354c9f5667b3dbde55bb2.tar.gz emacs-fa10e77790a207aeabf354c9f5667b3dbde55bb2.zip | |
Redo text-quoting-style variable
Rename help-quote-translation to text-quoting-style,
and use symbols rather than characters as values.
This follows suggestions along these lines by Alan Mackenzie in:
http://lists.gnu.org/archive/html/emacs-devel/2015-06/msg00343.html
and by Drew Adams in:
http://lists.gnu.org/archive/html/emacs-devel/2015-08/msg00048.html
* doc/lispref/help.texi (Keys in Documentation)
* etc/NEWS:
* lisp/cus-start.el (standard):
* src/doc.c (Fsubstitute_command_keys, syms_of_doc):
Document and/or implement the new behavior instead of the old.
(syms_of_doc): New symbols 'grave' and 'straight'.
Diffstat (limited to 'src/doc.c')
| -rw-r--r-- | src/doc.c | 27 |
1 files changed, 14 insertions, 13 deletions
| @@ -715,7 +715,7 @@ as the keymap for future \\=\\[COMMAND] substrings. | |||
| 715 | Each \\=‘ and \\=’ are replaced by left and right quote. Each \\=` is | 715 | Each \\=‘ and \\=’ are replaced by left and right quote. Each \\=` is |
| 716 | replaced by left quote, and each ' preceded by \\=` and without | 716 | replaced by left quote, and each ' preceded by \\=` and without |
| 717 | intervening ' is replaced by right quote. Left and right quote | 717 | intervening ' is replaced by right quote. Left and right quote |
| 718 | characters are specified by ‘help-quote-translation’. | 718 | characters are specified by ‘text-quoting-style’. |
| 719 | 719 | ||
| 720 | \\=\\= quotes the following character and is discarded; thus, | 720 | \\=\\= quotes the following character and is discarded; thus, |
| 721 | \\=\\=\\=\\= puts \\=\\= into the output, \\=\\=\\=\\[ puts \\=\\[ into the output, and | 721 | \\=\\=\\=\\= puts \\=\\= into the output, \\=\\=\\=\\[ puts \\=\\[ into the output, and |
| @@ -751,11 +751,11 @@ Otherwise, return a new string. */) | |||
| 751 | GCPRO4 (string, tem, keymap, name); | 751 | GCPRO4 (string, tem, keymap, name); |
| 752 | 752 | ||
| 753 | enum { unicode, grave_accent, apostrophe } quote_translation = unicode; | 753 | enum { unicode, grave_accent, apostrophe } quote_translation = unicode; |
| 754 | if (EQ (Vhelp_quote_translation, make_number ('`'))) | 754 | if (EQ (Vtext_quoting_style, Qgrave)) |
| 755 | quote_translation = grave_accent; | 755 | quote_translation = grave_accent; |
| 756 | else if (EQ (Vhelp_quote_translation, make_number ('\''))) | 756 | else if (EQ (Vtext_quoting_style, Qstraight)) |
| 757 | quote_translation = apostrophe; | 757 | quote_translation = apostrophe; |
| 758 | else if (NILP (Vhelp_quote_translation) | 758 | else if (NILP (Vtext_quoting_style) |
| 759 | && DISP_TABLE_P (Vstandard_display_table)) | 759 | && DISP_TABLE_P (Vstandard_display_table)) |
| 760 | { | 760 | { |
| 761 | Lisp_Object dv = DISP_CHAR_VECTOR (XCHAR_TABLE (Vstandard_display_table), | 761 | Lisp_Object dv = DISP_CHAR_VECTOR (XCHAR_TABLE (Vstandard_display_table), |
| @@ -1024,6 +1024,8 @@ void | |||
| 1024 | syms_of_doc (void) | 1024 | syms_of_doc (void) |
| 1025 | { | 1025 | { |
| 1026 | DEFSYM (Qfunction_documentation, "function-documentation"); | 1026 | DEFSYM (Qfunction_documentation, "function-documentation"); |
| 1027 | DEFSYM (Qgrave, "grave"); | ||
| 1028 | DEFSYM (Qstraight, "straight"); | ||
| 1027 | 1029 | ||
| 1028 | DEFVAR_LISP ("internal-doc-file-name", Vdoc_file_name, | 1030 | DEFVAR_LISP ("internal-doc-file-name", Vdoc_file_name, |
| 1029 | doc: /* Name of file containing documentation strings of built-in symbols. */); | 1031 | doc: /* Name of file containing documentation strings of built-in symbols. */); |
| @@ -1033,15 +1035,14 @@ syms_of_doc (void) | |||
| 1033 | doc: /* A list of files used to build this Emacs binary. */); | 1035 | doc: /* A list of files used to build this Emacs binary. */); |
| 1034 | Vbuild_files = Qnil; | 1036 | Vbuild_files = Qnil; |
| 1035 | 1037 | ||
| 1036 | DEFVAR_LISP ("help-quote-translation", Vhelp_quote_translation, | 1038 | DEFVAR_LISP ("text-quoting-style", Vtext_quoting_style, |
| 1037 | doc: /* Style to use for single quotes in help. | 1039 | doc: /* Style to use for single quotes when generating text. |
| 1038 | The value is a left single quote character of some style. | 1040 | ‘curve’ means quote with curved single quotes \\=‘like this\\=’. |
| 1039 | Quote \\=‘like this\\=’ if the value is ?\\=‘ (left single quotation mark). | 1041 | ‘straight’ means quote with straight apostrophes 'like this'. |
| 1040 | Quote 'like this' if the value is ?' (apostrophe). | 1042 | ‘grave’ means quote with grave accent and apostrophe \\=`like this'. |
| 1041 | Quote \\=`like this' if the value is ?\\=` (grave accent). | 1043 | The default value nil acts like ‘curve’ if curved single quotes are |
| 1042 | The default value is nil, which means quote with left single quotation mark | 1044 | displayable, and like ‘grave’ otherwise. */); |
| 1043 | if displayable, and with grave accent otherwise. */); | 1045 | Vtext_quoting_style = Qnil; |
| 1044 | Vhelp_quote_translation = Qnil; | ||
| 1045 | 1046 | ||
| 1046 | defsubr (&Sdocumentation); | 1047 | defsubr (&Sdocumentation); |
| 1047 | defsubr (&Sdocumentation_property); | 1048 | defsubr (&Sdocumentation_property); |