diff options
| author | Paul Eggert | 2015-04-10 11:27:21 -0700 |
|---|---|---|
| committer | Paul Eggert | 2015-04-10 11:28:52 -0700 |
| commit | a2940cd43e7931d16d3a3ce2cf5d4acd148dd00c (patch) | |
| tree | d0345ac3f2d34ee9e734a8824691c1dcadf287e5 /doc/lispref/tips.texi | |
| parent | ca401f6fdc512f79d6015c1759a0e8e0c3de5c9a (diff) | |
| download | emacs-a2940cd43e7931d16d3a3ce2cf5d4acd148dd00c.tar.gz emacs-a2940cd43e7931d16d3a3ce2cf5d4acd148dd00c.zip | |
Minor quoting etc. fixes to lispref manual
* doc/lispref/tips.texi (Documentation Tips):
Distinguish more clearly among grave accent, apostrophe,
and single quote.
* doc/lispref/README, doc/lispref/buffers.texi:
* doc/lispref/commands.texi, doc/lispref/control.texi:
* doc/lispref/customize.texi, doc/lispref/display.texi:
* doc/lispref/elisp.texi, doc/lispref/files.texi:
* doc/lispref/frames.texi, doc/lispref/hash.texi:
* doc/lispref/help.texi, doc/lispref/internals.texi:
* doc/lispref/loading.texi, doc/lispref/makefile.w32-in:
* doc/lispref/markers.texi, doc/lispref/modes.texi:
* doc/lispref/nonascii.texi, doc/lispref/objects.texi:
* doc/lispref/os.texi, doc/lispref/positions.texi:
* doc/lispref/strings.texi, doc/lispref/syntax.texi:
* doc/lispref/text.texi, doc/lispref/tips.texi:
* doc/lispref/two-volume-cross-refs.txt, doc/lispref/windows.texi:
Use American-style double quoting in ordinary text,
and quote 'like this' when single-quoting in ASCII text.
Also, fix some minor spacing issues.
Diffstat (limited to 'doc/lispref/tips.texi')
| -rw-r--r-- | doc/lispref/tips.texi | 31 |
1 files changed, 13 insertions, 18 deletions
diff --git a/doc/lispref/tips.texi b/doc/lispref/tips.texi index 8970efe72fb..cc1f0e42750 100644 --- a/doc/lispref/tips.texi +++ b/doc/lispref/tips.texi | |||
| @@ -657,23 +657,18 @@ starting double-quote is not part of the string! | |||
| 657 | 657 | ||
| 658 | @anchor{Docstring hyperlinks} | 658 | @anchor{Docstring hyperlinks} |
| 659 | @item | 659 | @item |
| 660 | @iftex | ||
| 661 | When a documentation string refers to a Lisp symbol, write it as it | 660 | When a documentation string refers to a Lisp symbol, write it as it |
| 662 | would be printed (which usually means in lower case), with single-quotes | 661 | would be printed (which usually means in lower case), with a grave |
| 663 | around it. For example: @samp{`lambda'}. There are two exceptions: | 662 | accent @samp{`} before and apostrophe @samp{'} after it. There are |
| 664 | write @code{t} and @code{nil} without single-quotes. | 663 | two exceptions: write @code{t} and @code{nil} without surrounding |
| 665 | @end iftex | 664 | punctuation. For example: @samp{CODE can be `lambda', nil, or t.} |
| 666 | @ifnottex | 665 | (In this manual, we use a different convention, with single-quotes |
| 667 | When a documentation string refers to a Lisp symbol, write it as it | 666 | around symbols.) |
| 668 | would be printed (which usually means in lower case), with single-quotes | ||
| 669 | around it. For example: @samp{lambda}. There are two exceptions: write | ||
| 670 | t and nil without single-quotes. (In this manual, we use a different | ||
| 671 | convention, with single-quotes for all symbols.) | ||
| 672 | @end ifnottex | ||
| 673 | 667 | ||
| 674 | @cindex hyperlinks in documentation strings | 668 | @cindex hyperlinks in documentation strings |
| 675 | Help mode automatically creates a hyperlink when a documentation string | 669 | Help mode automatically creates a hyperlink when a documentation string |
| 676 | uses a symbol name inside single quotes, if the symbol has either a | 670 | uses a symbol name between grave accent and apostrophe, if the symbol |
| 671 | has either a | ||
| 677 | function or a variable definition. You do not need to do anything | 672 | function or a variable definition. You do not need to do anything |
| 678 | special to make use of this feature. However, when a symbol has both a | 673 | special to make use of this feature. However, when a symbol has both a |
| 679 | function definition and a variable definition, and you want to refer to | 674 | function definition and a variable definition, and you want to refer to |
| @@ -716,16 +711,16 @@ documentation will be shown, even if the symbol is also defined as a | |||
| 716 | variable or as a function. | 711 | variable or as a function. |
| 717 | 712 | ||
| 718 | To make a hyperlink to Info documentation, write the name of the Info | 713 | To make a hyperlink to Info documentation, write the name of the Info |
| 719 | node (or anchor) in single quotes, preceded by @samp{info node}, | 714 | node (or anchor) between grave accent and apostrophe, preceded by |
| 720 | @samp{Info node}, @samp{info anchor} or @samp{Info anchor}. The Info | 715 | @samp{info node}, @samp{Info node}, @samp{info anchor} or @samp{Info |
| 721 | file name defaults to @samp{emacs}. For example, | 716 | anchor}. The Info file name defaults to @samp{emacs}. For example, |
| 722 | 717 | ||
| 723 | @smallexample | 718 | @smallexample |
| 724 | See Info node `Font Lock' and Info node `(elisp)Font Lock Basics'. | 719 | See Info node `Font Lock' and Info node `(elisp)Font Lock Basics'. |
| 725 | @end smallexample | 720 | @end smallexample |
| 726 | 721 | ||
| 727 | Finally, to create a hyperlink to URLs, write the URL in single | 722 | Finally, to create a hyperlink to URLs, write the URL between grave |
| 728 | quotes, preceded by @samp{URL}. For example, | 723 | accent and apostrophe, preceded by @samp{URL}. For example, |
| 729 | 724 | ||
| 730 | @smallexample | 725 | @smallexample |
| 731 | The home page for the GNU project has more information (see URL | 726 | The home page for the GNU project has more information (see URL |