diff options
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/lispref/help.texi | 29 | ||||
| -rw-r--r-- | doc/lispref/tips.texi | 8 |
2 files changed, 32 insertions, 5 deletions
diff --git a/doc/lispref/help.texi b/doc/lispref/help.texi index ce29f3f5bc3..44a680c4a22 100644 --- a/doc/lispref/help.texi +++ b/doc/lispref/help.texi | |||
| @@ -319,10 +319,22 @@ specifies @var{mapvar}'s value as the keymap for any following | |||
| 319 | @samp{\[@var{command}]} sequences in this documentation string. | 319 | @samp{\[@var{command}]} sequences in this documentation string. |
| 320 | 320 | ||
| 321 | @item ` | 321 | @item ` |
| 322 | (grave accent) stands for a left single quotation mark (@samp{‘}). | 322 | (grave accent) stands for a left quote, and alters the interpretation |
| 323 | of the next unmatched apostrophe. | ||
| 323 | 324 | ||
| 324 | @item ' | 325 | @item ' |
| 325 | (apostrophe) stands for a right single quotation mark (@samp{’}) if | 326 | (apostrophe) stands for a right quote if preceded by grave accent and |
| 327 | there are no intervening apostrophes. Otherwise, apostrophe stands | ||
| 328 | for itself. | ||
| 329 | |||
| 330 | @item ‘ | ||
| 331 | (left single quotation mark) stands for a left quote. | ||
| 332 | |||
| 333 | @item ’ | ||
| 334 | (right single quotation mark) stands for a right quote. | ||
| 335 | |||
| 336 | @item ' | ||
| 337 | (apostrophe) stands for a right quote if | ||
| 326 | preceded by grave accent and there are no intervening apostrophes. | 338 | preceded by grave accent and there are no intervening apostrophes. |
| 327 | Otherwise, apostrophe stands for itself. | 339 | Otherwise, apostrophe stands for itself. |
| 328 | 340 | ||
| @@ -335,6 +347,19 @@ and @samp{\=\=} puts @samp{\=} into the output. | |||
| 335 | @strong{Please note:} Each @samp{\} must be doubled when written in a | 347 | @strong{Please note:} Each @samp{\} must be doubled when written in a |
| 336 | string in Emacs Lisp. | 348 | string in Emacs Lisp. |
| 337 | 349 | ||
| 350 | @defvar help-quote-translation | ||
| 351 | @cindex curved quotes | ||
| 352 | The value of this variable specifies the style | ||
| 353 | @code{substitute-command-keys} uses when generating left and right | ||
| 354 | quotes. If the variable's value is @code{?‘} (U+2018 LEFT SINGLE | ||
| 355 | QUOTATION MARK), the style is @t{‘like this’} with curved single | ||
| 356 | quotes. If the value is @code{?'} (apostrophe), the style is @t{'like | ||
| 357 | this'} with apostrophes. If the value is @code{?`} (grave accent), | ||
| 358 | the style is @t{`like this'} with grave accent and apostrophe. The | ||
| 359 | default value @code{nil} means to use curved single quotes if | ||
| 360 | displayable and apostrophes otherwise. | ||
| 361 | @end defvar | ||
| 362 | |||
| 338 | @defun substitute-command-keys string | 363 | @defun substitute-command-keys string |
| 339 | This function scans @var{string} for the above special sequences and | 364 | This function scans @var{string} for the above special sequences and |
| 340 | replaces them by what they stand for, returning the result as a string. | 365 | replaces them by what they stand for, returning the result as a string. |
diff --git a/doc/lispref/tips.texi b/doc/lispref/tips.texi index 9144497d5f1..7107bb45872 100644 --- a/doc/lispref/tips.texi +++ b/doc/lispref/tips.texi | |||
| @@ -671,9 +671,11 @@ Documentation strings can also use an older single-quoting convention, | |||
| 671 | which quotes symbols with grave accent @t{`} and apostrophe | 671 | which quotes symbols with grave accent @t{`} and apostrophe |
| 672 | @t{'}: @t{`like-this'} rather than @t{‘like-this’}. This | 672 | @t{'}: @t{`like-this'} rather than @t{‘like-this’}. This |
| 673 | older convention was designed for now-obsolete displays in which grave | 673 | older convention was designed for now-obsolete displays in which grave |
| 674 | accent and apostrophe were mirror images. Documentation in this older | 674 | accent and apostrophe were mirror images. |
| 675 | convention is converted to the standard convention when it is copied | 675 | |
| 676 | into a help buffer. @xref{Keys in Documentation}. | 676 | Documentation using either convention is converted to the user's |
| 677 | preferred format when it is copied into a help buffer. @xref{Keys in | ||
| 678 | Documentation}. | ||
| 677 | 679 | ||
| 678 | @cindex hyperlinks in documentation strings | 680 | @cindex hyperlinks in documentation strings |
| 679 | Help mode automatically creates a hyperlink when a documentation string | 681 | Help mode automatically creates a hyperlink when a documentation string |