aboutsummaryrefslogtreecommitdiffstats
path: root/doc/lispref/tips.texi
diff options
context:
space:
mode:
authorPaul Eggert2015-04-10 11:27:21 -0700
committerPaul Eggert2015-04-10 11:28:52 -0700
commita2940cd43e7931d16d3a3ce2cf5d4acd148dd00c (patch)
treed0345ac3f2d34ee9e734a8824691c1dcadf287e5 /doc/lispref/tips.texi
parentca401f6fdc512f79d6015c1759a0e8e0c3de5c9a (diff)
downloademacs-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.texi31
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
661When a documentation string refers to a Lisp symbol, write it as it 660When a documentation string refers to a Lisp symbol, write it as it
662would be printed (which usually means in lower case), with single-quotes 661would be printed (which usually means in lower case), with a grave
663around it. For example: @samp{`lambda'}. There are two exceptions: 662accent @samp{`} before and apostrophe @samp{'} after it. There are
664write @code{t} and @code{nil} without single-quotes. 663two exceptions: write @code{t} and @code{nil} without surrounding
665@end iftex 664punctuation. For example: @samp{CODE can be `lambda', nil, or t.}
666@ifnottex 665(In this manual, we use a different convention, with single-quotes
667When a documentation string refers to a Lisp symbol, write it as it 666around symbols.)
668would be printed (which usually means in lower case), with single-quotes
669around it. For example: @samp{lambda}. There are two exceptions: write
670t and nil without single-quotes. (In this manual, we use a different
671convention, with single-quotes for all symbols.)
672@end ifnottex
673 667
674@cindex hyperlinks in documentation strings 668@cindex hyperlinks in documentation strings
675Help mode automatically creates a hyperlink when a documentation string 669Help mode automatically creates a hyperlink when a documentation string
676uses a symbol name inside single quotes, if the symbol has either a 670uses a symbol name between grave accent and apostrophe, if the symbol
671has either a
677function or a variable definition. You do not need to do anything 672function or a variable definition. You do not need to do anything
678special to make use of this feature. However, when a symbol has both a 673special to make use of this feature. However, when a symbol has both a
679function definition and a variable definition, and you want to refer to 674function 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
716variable or as a function. 711variable or as a function.
717 712
718To make a hyperlink to Info documentation, write the name of the Info 713To make a hyperlink to Info documentation, write the name of the Info
719node (or anchor) in single quotes, preceded by @samp{info node}, 714node (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
721file name defaults to @samp{emacs}. For example, 716anchor}. The Info file name defaults to @samp{emacs}. For example,
722 717
723@smallexample 718@smallexample
724See Info node `Font Lock' and Info node `(elisp)Font Lock Basics'. 719See Info node `Font Lock' and Info node `(elisp)Font Lock Basics'.
725@end smallexample 720@end smallexample
726 721
727Finally, to create a hyperlink to URLs, write the URL in single 722Finally, to create a hyperlink to URLs, write the URL between grave
728quotes, preceded by @samp{URL}. For example, 723accent and apostrophe, preceded by @samp{URL}. For example,
729 724
730@smallexample 725@smallexample
731The home page for the GNU project has more information (see URL 726The home page for the GNU project has more information (see URL