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.
This commit is contained in:
parent
ca401f6fdc
commit
a2940cd43e
26 changed files with 80 additions and 86 deletions
|
@ -21,15 +21,15 @@ Buying a manual from the Free Software Foundation helps support our GNU
|
|||
development work. See <http://shop.fsf.org/>.
|
||||
(At time of writing, this manual is out of print.)
|
||||
|
||||
* The master file for formatting this manual for Tex is called `elisp.texi'.
|
||||
* The master file for formatting this manual for Tex is called 'elisp.texi'.
|
||||
It contains @include commands to include all the chapters that make up
|
||||
the manual.
|
||||
|
||||
* This distribution contains a Makefile that you can use with GNU Make.
|
||||
|
||||
** To make an Info file, you need to install Texinfo, then run `make info'.
|
||||
** To make an Info file, you need to install Texinfo, then run 'make info'.
|
||||
|
||||
** Use `make elisp.pdf' or `make elisp.html' to create PDF or HTML versions.
|
||||
** Use 'make elisp.pdf' or 'make elisp.html' to create PDF or HTML versions.
|
||||
|
||||
|
||||
This file is part of GNU Emacs.
|
||||
|
|
|
@ -844,7 +844,7 @@ names start with a space are not considered at all.
|
|||
|
||||
If @var{buffer} is not supplied (or if it is not a live buffer), then
|
||||
@code{other-buffer} returns the first buffer in the selected frame's
|
||||
local buffer list. (If @var{frame} is non-@code{nil}, it returns the
|
||||
local buffer list. (If @var{frame} is non-@code{nil}, it returns the
|
||||
first buffer in @var{frame}'s local buffer list instead.)
|
||||
|
||||
If @var{frame} has a non-@code{nil} @code{buffer-predicate} parameter,
|
||||
|
|
|
@ -1462,7 +1462,7 @@ the symbols @code{handle} (the scroll bar handle), @code{above-handle}
|
|||
(the area above the handle), @code{below-handle} (the area below the
|
||||
handle), @code{up} (the up arrow at one end of the scroll bar), or
|
||||
@code{down} (the down arrow at one end of the scroll bar).
|
||||
@c The `top', `bottom', and `end-scroll' codes don't seem to be used.
|
||||
@c The 'top', 'bottom', and 'end-scroll' codes don't seem to be used.
|
||||
@end table
|
||||
|
||||
|
||||
|
@ -1720,7 +1720,7 @@ occurred.
|
|||
|
||||
@vindex mouse-wheel-up-event
|
||||
@vindex mouse-wheel-down-event
|
||||
This kind of event is generated only on some kinds of systems. On some
|
||||
This kind of event is generated only on some kinds of systems. On some
|
||||
systems, @code{mouse-4} and @code{mouse-5} are used instead. For
|
||||
portable code, use the variables @code{mouse-wheel-up-event} and
|
||||
@code{mouse-wheel-down-event} defined in @file{mwheel.el} to determine
|
||||
|
@ -1856,7 +1856,7 @@ into another window. That produces a pair of events like these:
|
|||
@end smallexample
|
||||
|
||||
The frame with input focus might not take up the entire screen, and
|
||||
the user might move the mouse outside the scope of the frame. Inside
|
||||
the user might move the mouse outside the scope of the frame. Inside
|
||||
the @code{track-mouse} special form, that produces an event like this:
|
||||
|
||||
@smallexample
|
||||
|
|
|
@ -1025,7 +1025,7 @@ the circumstances of the error.
|
|||
|
||||
The argument @var{error-symbol} must be an @dfn{error symbol}---a symbol
|
||||
defined with @code{define-error}. This is how Emacs Lisp classifies different
|
||||
sorts of errors. @xref{Error Symbols}, for a description of error symbols,
|
||||
sorts of errors. @xref{Error Symbols}, for a description of error symbols,
|
||||
error conditions and condition names.
|
||||
|
||||
If the error is not handled, the two arguments are used in printing
|
||||
|
|
|
@ -842,7 +842,7 @@ symbols, and symbols are not treated like other Lisp expressions.
|
|||
|
||||
@item (radio @var{element-types}@dots{})
|
||||
This is similar to @code{choice}, except that the choices are displayed
|
||||
using `radio buttons' rather than a menu. This has the advantage of
|
||||
using ``radio buttons'' rather than a menu. This has the advantage of
|
||||
displaying documentation for the choices when applicable and so is often
|
||||
a good choice for a choice between constant functions
|
||||
(@code{function-item} customization types).
|
||||
|
|
|
@ -2790,7 +2790,7 @@ then the new definition of the @code{mode-line} face inherits from the
|
|||
functions instead of setting @code{face-remapping-alist} directly, to
|
||||
avoid trampling on remappings applied elsewhere. These functions are
|
||||
intended for buffer-local remappings, so they all make
|
||||
@code{face-remapping-alist} buffer-local as a side-effect. They manage
|
||||
@code{face-remapping-alist} buffer-local as a side-effect. They manage
|
||||
@code{face-remapping-alist} entries of the form
|
||||
|
||||
@example
|
||||
|
@ -2820,11 +2820,11 @@ pass this object as an argument to @code{face-remap-remove-relative}
|
|||
if you need to remove the remapping later.
|
||||
|
||||
@example
|
||||
;; Remap the `escape-glyph' face into a combination
|
||||
;; of the `highlight' and `italic' faces:
|
||||
;; Remap the 'escape-glyph' face into a combination
|
||||
;; of the 'highlight' and 'italic' faces:
|
||||
(face-remap-add-relative 'escape-glyph 'highlight 'italic)
|
||||
|
||||
;; Increase the size of the `default' face by 50%:
|
||||
;; Increase the size of the 'default' face by 50%:
|
||||
(face-remap-add-relative 'default :height 1.5)
|
||||
@end example
|
||||
@end defun
|
||||
|
@ -4557,7 +4557,7 @@ not affect the amount of raising or lowering, which is based on the
|
|||
faces used for the text.
|
||||
@end table
|
||||
|
||||
@c We put all the `@code{(when ...)}' on one line to encourage
|
||||
@c We put all the '@code{(when ...)}' on one line to encourage
|
||||
@c makeinfo's end-of-sentence heuristics to DTRT. Previously, the dot
|
||||
@c was at eol; the info file ended up w/ two spaces rendered after it.
|
||||
You can make any display specification conditional. To do that,
|
||||
|
@ -5628,7 +5628,7 @@ so that it's easy to define special-purpose types of buttons for
|
|||
specific tasks.
|
||||
|
||||
@defun define-button-type name &rest properties
|
||||
Define a `button type' called @var{name} (a symbol).
|
||||
Define a ``button type'' called @var{name} (a symbol).
|
||||
The remaining arguments
|
||||
form a sequence of @var{property value} pairs, specifying default
|
||||
property values for buttons with this type (a button's type may be set
|
||||
|
@ -5781,7 +5781,7 @@ Return @code{t} if button-type @var{type} is a subtype of @var{supertype}.
|
|||
These are commands and functions for locating and operating on
|
||||
buttons in an Emacs buffer.
|
||||
|
||||
@code{push-button} is the command that a user uses to actually `push'
|
||||
@code{push-button} is the command that a user uses to actually ``push''
|
||||
a button, and is bound by default in the button itself to @key{RET}
|
||||
and to @key{mouse-2} using a local keymap in the button's overlay or
|
||||
text properties. Commands that are useful outside the buttons itself,
|
||||
|
@ -6643,7 +6643,7 @@ Non-@acronym{ASCII}, non-printing characters @code{U+0080} to
|
|||
@samp{\230}).
|
||||
|
||||
@item format-control
|
||||
Characters of Unicode General Category `Cf', such as @samp{U+200E}
|
||||
Characters of Unicode General Category ``Cf'', such as @samp{U+200E}
|
||||
(Left-to-Right Mark), but excluding characters that have graphic
|
||||
images, such as @samp{U+00AD} (Soft Hyphen).
|
||||
|
||||
|
@ -6652,9 +6652,9 @@ Characters for there is no suitable font, or which cannot be encoded
|
|||
by the terminal's coding system.
|
||||
@end table
|
||||
|
||||
@c FIXME: this can also be `acronym', but that's not currently
|
||||
@c FIXME: this can also be 'acronym', but that's not currently
|
||||
@c completely implemented; it applies only to the format-control
|
||||
@c group, and only works if the acronym is in `char-acronym-table'.
|
||||
@c group, and only works if the acronym is in 'char-acronym-table'.
|
||||
The @var{method} symbol should be one of @code{zero-width},
|
||||
@code{thin-space}, @code{empty-box}, or @code{hex-code}. These have
|
||||
the same meanings as in @code{glyphless-char-display}, above.
|
||||
|
|
|
@ -247,9 +247,9 @@ Appendices
|
|||
@end ignore
|
||||
|
||||
@c Do NOT modify the following 3 lines! They must have this form to
|
||||
@c be correctly identified by `texinfo-multiple-files-update'. In
|
||||
@c be correctly identified by 'texinfo-multiple-files-update'. In
|
||||
@c particular, the detailed menu header line MUST be identical to the
|
||||
@c value of `texinfo-master-menu-header'. See texnfo-upd.el.
|
||||
@c value of 'texinfo-master-menu-header'. See texnfo-upd.el.
|
||||
|
||||
@detailmenu
|
||||
--- The Detailed Node Listing ---
|
||||
|
|
|
@ -423,7 +423,7 @@ To do so, execute the following code:
|
|||
You might wish to save the file modes value returned by
|
||||
@code{backup-buffer} and use that (if non-@code{nil}) to set the mode
|
||||
bits of the file that you write. This is what @code{save-buffer}
|
||||
normally does. @xref{Making Backups,, Making Backup Files}.
|
||||
normally does. @xref{Making Backups,, Making Backup Files}.
|
||||
|
||||
The hook functions in @code{write-file-functions} are also responsible
|
||||
for encoding the data (if desired): they must choose a suitable coding
|
||||
|
@ -3352,8 +3352,8 @@ from the buffer is actually written to the file, it intermixes the
|
|||
specified annotations at the corresponding positions. All this takes
|
||||
place without modifying the buffer.
|
||||
|
||||
@c ??? What about ``overriding'' conversions like those allowed
|
||||
@c ??? for `write-region-annotate-functions', below? --ttn
|
||||
@c ??? What about "overriding" conversions like those allowed
|
||||
@c ??? for 'write-region-annotate-functions', below? --ttn
|
||||
|
||||
In contrast, when reading, the annotations intermixed with the text
|
||||
are handled immediately. @code{insert-file-contents} sets point to
|
||||
|
@ -3406,8 +3406,8 @@ with one argument, the number of characters inserted, and with point
|
|||
at the beginning of the inserted text. Each function should leave
|
||||
point unchanged, and return the new character count describing the
|
||||
inserted text as modified by the function.
|
||||
@c ??? The docstring mentions a handler from `file-name-handler-alist'
|
||||
@c "intercepting" `insert-file-contents'. Hmmm. --ttn
|
||||
@c ??? The docstring mentions a handler from 'file-name-handler-alist'
|
||||
@c "intercepting" 'insert-file-contents'. Hmmm. --ttn
|
||||
@end defvar
|
||||
|
||||
We invite users to write Lisp programs to store and retrieve text
|
||||
|
|
|
@ -2693,7 +2693,7 @@ This function returns @code{t} if the screen can display shades of gray.
|
|||
This function returns non-@code{nil} if all the face attributes in
|
||||
@var{attributes} are supported (@pxref{Face Attributes}).
|
||||
|
||||
The definition of `supported' is somewhat heuristic, but basically
|
||||
The definition of ``supported'' is somewhat heuristic, but basically
|
||||
means that a face containing all the attributes in @var{attributes},
|
||||
when merged with the default face for display, can be represented in a
|
||||
way that's
|
||||
|
@ -2703,14 +2703,14 @@ way that's
|
|||
different in appearance than the default face, and
|
||||
|
||||
@item
|
||||
`close in spirit' to what the attributes specify, if not exact.
|
||||
``close in spirit'' to what the attributes specify, if not exact.
|
||||
@end enumerate
|
||||
|
||||
Point (2) implies that a @code{:weight black} attribute will be
|
||||
satisfied by any display that can display bold, as will
|
||||
@code{:foreground "yellow"} as long as some yellowish color can be
|
||||
displayed, but @code{:slant italic} will @emph{not} be satisfied by
|
||||
the tty display code's automatic substitution of a `dim' face for
|
||||
the tty display code's automatic substitution of a ``dim'' face for
|
||||
italic.
|
||||
@end defun
|
||||
|
||||
|
|
|
@ -154,7 +154,7 @@ This is equivalent to @code{make-hash-table}, but with a different style
|
|||
argument list. The argument @var{test} specifies the method
|
||||
of key lookup.
|
||||
|
||||
This function is obsolete. Use @code{make-hash-table} instead.
|
||||
This function is obsolete. Use @code{make-hash-table} instead.
|
||||
@end defun
|
||||
|
||||
You can also create a new hash table using the printed representation
|
||||
|
|
|
@ -171,7 +171,7 @@ several symbols in a @file{*Help*} buffer.
|
|||
(defun describe-symbols (pattern)
|
||||
"Describe the Emacs Lisp symbols matching PATTERN.
|
||||
All symbols that have PATTERN in their name are described
|
||||
in the `*Help*' buffer."
|
||||
in the *Help* buffer."
|
||||
(interactive "sDescribe symbols matching: ")
|
||||
(let ((describe-func
|
||||
(function
|
||||
|
|
|
@ -898,14 +898,14 @@ DEFUN ("coordinates-in-window-p", Fcoordinates_in_window_p,
|
|||
@group
|
||||
switch (coordinates_in_window (w, x, y))
|
||||
@{
|
||||
case ON_NOTHING: /* NOT in window at all. */
|
||||
case ON_NOTHING: /* NOT in window at all. */
|
||||
return Qnil;
|
||||
@end group
|
||||
|
||||
...
|
||||
|
||||
@group
|
||||
case ON_MODE_LINE: /* In mode line of window. */
|
||||
case ON_MODE_LINE: /* In mode line of window. */
|
||||
return Qmode_line;
|
||||
@end group
|
||||
|
||||
|
@ -1317,8 +1317,8 @@ except to shape their child windows. Emacs Lisp programs usually have
|
|||
no access to the parent windows; they operate on the windows at the
|
||||
leaves of the tree, which actually display buffers.
|
||||
|
||||
@c FIXME: These two slots and the `buffer' slot below were replaced
|
||||
@c with a single slot `contents' on 2013-03-28. --xfq
|
||||
@c FIXME: These two slots and the 'buffer' slot below were replaced
|
||||
@c with a single slot 'contents' on 2013-03-28. --xfq
|
||||
@item hchild
|
||||
@itemx vchild
|
||||
These fields contain the window's leftmost child and its topmost child
|
||||
|
|
|
@ -76,7 +76,7 @@ If Auto Compression mode is enabled, as it is by default, then if
|
|||
of the file before trying other file names. It decompresses and loads
|
||||
it if it exists. It looks for compressed versions by appending each
|
||||
of the suffixes in @code{jka-compr-load-suffixes} to the file name.
|
||||
The value of this variable must be a list of strings. Its standard
|
||||
The value of this variable must be a list of strings. Its standard
|
||||
value is @code{(".gz")}.
|
||||
|
||||
If the optional argument @var{nosuffix} is non-@code{nil}, then
|
||||
|
|
|
@ -31,7 +31,7 @@ texinfodir = $(srcdir)/../misc
|
|||
INFO_EXT=.info
|
||||
INFO_OPTS=--no-split
|
||||
|
||||
# Redefine `TEX' if `tex' does not invoke plain TeX. For example:
|
||||
# Redefine 'TEX' if 'tex' does not invoke plain TeX. For example:
|
||||
# TEX=platex
|
||||
TEX=tex
|
||||
INSTALL_INFO = install-info
|
||||
|
@ -102,7 +102,7 @@ srcs = \
|
|||
|
||||
.PHONY: clean
|
||||
|
||||
# The info file is named `elisp'.
|
||||
# The info file is named 'elisp'.
|
||||
|
||||
info: $(infodir)/elisp$(INFO_EXT)
|
||||
|
||||
|
|
|
@ -287,8 +287,8 @@ This function returns the position that @var{marker} points to, or
|
|||
This function returns the buffer that @var{marker} points into, or
|
||||
@code{nil} if it points nowhere.
|
||||
|
||||
@c FIXME: The `buffer' argument of `set-marker' already defaults to
|
||||
@c the current buffer, why use `(current-buffer)' explicitly here?
|
||||
@c FIXME: The 'buffer' argument of 'set-marker' already defaults to
|
||||
@c the current buffer, why use '(current-buffer)' explicitly here?
|
||||
@example
|
||||
@group
|
||||
(setq m (make-marker))
|
||||
|
@ -712,4 +712,3 @@ A region is valid if it has a non-zero size, or if the user option
|
|||
cases, you should not use @code{region-active-p}, since if the region
|
||||
is empty it is often more appropriate to operate on point.
|
||||
@end defun
|
||||
|
||||
|
|
|
@ -749,7 +749,7 @@ The new mode has its own abbrev table, kept in the variable
|
|||
@item
|
||||
The new mode has its own mode hook, @code{@var{variant}-hook}. It
|
||||
runs this hook, after running the hooks of its ancestor modes, with
|
||||
@code{run-mode-hooks}, as the last thing it does. @xref{Mode Hooks}.
|
||||
@code{run-mode-hooks}, as the last thing it does. @xref{Mode Hooks}.
|
||||
@end itemize
|
||||
|
||||
In addition, you can specify how to override other aspects of
|
||||
|
@ -1122,7 +1122,7 @@ the conventions listed above:
|
|||
(let ((st (make-syntax-table)))
|
||||
(modify-syntax-entry ?\" ". " st)
|
||||
(modify-syntax-entry ?\\ ". " st)
|
||||
;; Add `p' so M-c on `hello' leads to `Hello', not `hello'.
|
||||
;; Add 'p' so M-c on 'hello' leads to 'Hello', not 'hello'.
|
||||
(modify-syntax-entry ?' "w p" st)
|
||||
st)
|
||||
"Syntax table used while in `text-mode'.")
|
||||
|
@ -3425,7 +3425,7 @@ provided grammar is precise enough, @code{transpose-sexps} can correctly
|
|||
transpose the two arguments of a @code{+} operator, taking into account
|
||||
the precedence rules of the language.
|
||||
|
||||
Calling `smie-setup' is also sufficient to make TAB indentation work in
|
||||
Calling @code{smie-setup} is also sufficient to make TAB indentation work in
|
||||
the expected way, extends @code{blink-matching-paren} to apply to
|
||||
elements like @code{begin...end}, and provides some commands that you
|
||||
can bind in the major mode keymap.
|
||||
|
@ -3874,7 +3874,7 @@ of instructions (enclosed in a @code{@{...@}} or @code{begin...end}
|
|||
block).
|
||||
|
||||
@var{method} should be the method name that was passed to
|
||||
`smie-rules-function'.
|
||||
@code{smie-rules-function}.
|
||||
@end defun
|
||||
|
||||
@node SMIE Indentation Example
|
||||
|
|
|
@ -248,7 +248,7 @@ unibyte string, it is returned unchanged. Use this function for
|
|||
characters.
|
||||
@end defun
|
||||
|
||||
@c FIXME: Should `@var{character}' be `@var{byte}'?
|
||||
@c FIXME: Should '@var{character}' be '@var{byte}'?
|
||||
@defun byte-to-string byte
|
||||
@cindex byte to string
|
||||
This function returns a unibyte string containing a single byte of
|
||||
|
@ -1375,7 +1375,7 @@ alternatives described above.
|
|||
|
||||
The optional argument @var{accept-default-p}, if non-@code{nil},
|
||||
should be a function to determine whether a coding system selected
|
||||
without user interaction is acceptable. @code{select-safe-coding-system}
|
||||
without user interaction is acceptable. @code{select-safe-coding-system}
|
||||
calls this function with one argument, the base coding system of the
|
||||
selected coding system. If @var{accept-default-p} returns @code{nil},
|
||||
@code{select-safe-coding-system} rejects the silently selected coding
|
||||
|
@ -1437,7 +1437,7 @@ don't change these variables; instead, override them using
|
|||
@cindex file contents, and default coding system
|
||||
@defopt auto-coding-regexp-alist
|
||||
This variable is an alist of text patterns and corresponding coding
|
||||
systems. Each element has the form @code{(@var{regexp}
|
||||
systems. Each element has the form @code{(@var{regexp}
|
||||
. @var{coding-system})}; a file whose first few kilobytes match
|
||||
@var{regexp} is decoded with @var{coding-system} when its contents are
|
||||
read into a buffer. The settings in this alist take priority over
|
||||
|
|
|
@ -595,8 +595,8 @@ FOO ; @r{A symbol named @samp{FOO}, different from @samp{foo}.}
|
|||
|
||||
@cindex @samp{##} read syntax
|
||||
@ifinfo
|
||||
@c This uses ``colon'' instead of a literal `:' because Info cannot
|
||||
@c cope with a `:' in a menu
|
||||
@c This uses "colon" instead of a literal ':' because Info cannot
|
||||
@c cope with a ':' in a menu.
|
||||
@cindex @samp{#@var{colon}} read syntax
|
||||
@end ifinfo
|
||||
@ifnotinfo
|
||||
|
@ -999,7 +999,7 @@ of a string returns the same string.
|
|||
The read syntax for a string is a double-quote, an arbitrary number
|
||||
of characters, and another double-quote, @code{"like this"}. To
|
||||
include a double-quote in a string, precede it with a backslash; thus,
|
||||
@code{"\""} is a string containing just a single double-quote
|
||||
@code{"\""} is a string containing just one double-quote
|
||||
character. Likewise, you can include a backslash by preceding it with
|
||||
another backslash, like this: @code{"this \\ is a single embedded
|
||||
backslash"}.
|
||||
|
|
|
@ -974,7 +974,7 @@ to access the value of @var{variable}. If @var{value} is omitted or
|
|||
removes @var{variable} from the environment. Otherwise, @var{value}
|
||||
should be a string.
|
||||
|
||||
@c FIXME: Document `substitute-env-vars'? --xfq
|
||||
@c FIXME: Document 'substitute-env-vars'? --xfq
|
||||
If the optional argument @var{substitute} is non-@code{nil}, Emacs
|
||||
calls the function @code{substitute-env-vars} to expand any
|
||||
environment variables in @var{value}.
|
||||
|
@ -2384,7 +2384,7 @@ The path to a sound file to play when the notification pops up.
|
|||
@item :sound-name @var{name}
|
||||
A themable named sound from the freedesktop.org sound naming
|
||||
specification from @samp{$XDG_DATA_DIRS/sounds}, to play when the
|
||||
notification pops up. Similar to the icon name, only for sounds. An
|
||||
notification pops up. Similar to the icon name, only for sounds. An
|
||||
example would be @samp{"message-new-instant"}.
|
||||
|
||||
@item :suppress-sound
|
||||
|
@ -2393,9 +2393,9 @@ ability.
|
|||
|
||||
@item :resident
|
||||
When set the server will not automatically remove the notification
|
||||
when an action has been invoked. The notification will remain resident
|
||||
when an action has been invoked. The notification will remain resident
|
||||
in the server until it is explicitly removed by the user or by the
|
||||
sender. This hint is likely only useful when the server has the
|
||||
sender. This hint is likely only useful when the server has the
|
||||
@code{:persistence} capability.
|
||||
|
||||
@item :transient
|
||||
|
|
|
@ -664,7 +664,7 @@ quotes are ignored.)
|
|||
This function moves forward out of @var{arg} (default 1) levels of
|
||||
parentheses. A negative argument means move backward but still to a
|
||||
less deep spot. If @var{escape-strings} is non-@code{nil} (as it is
|
||||
interactively), move out of enclosing strings as well. If
|
||||
interactively), move out of enclosing strings as well. If
|
||||
@var{no-syntax-crossing} is non-@code{nil} (as it is interactively), prefer
|
||||
to break out of any enclosing string instead of moving to the start of
|
||||
a list broken across multiple strings. On error, location of point is
|
||||
|
|
|
@ -956,12 +956,12 @@ is not truncated.
|
|||
|
||||
@example
|
||||
@group
|
||||
(format "The word `%7s' has %d letters in it."
|
||||
(format "The word '%7s' has %d letters in it."
|
||||
"foo" (length "foo"))
|
||||
@result{} "The word ` foo' has 3 letters in it."
|
||||
(format "The word `%7s' has %d letters in it."
|
||||
@result{} "The word ' foo' has 3 letters in it."
|
||||
(format "The word '%7s' has %d letters in it."
|
||||
"specification" (length "specification"))
|
||||
@result{} "The word `specification' has 13 letters in it."
|
||||
@result{} "The word 'specification' has 13 letters in it."
|
||||
@end group
|
||||
@end example
|
||||
|
||||
|
@ -1003,9 +1003,9 @@ ignored.
|
|||
(format "%-6d is padded on the right" 123)
|
||||
@result{} "123 is padded on the right"
|
||||
|
||||
(format "The word `%-7s' actually has %d letters in it."
|
||||
(format "The word '%-7s' actually has %d letters in it."
|
||||
"foo" (length "foo"))
|
||||
@result{} "The word `foo ' actually has 3 letters in it."
|
||||
@result{} "The word 'foo ' actually has 3 letters in it."
|
||||
@end group
|
||||
@end example
|
||||
|
||||
|
|
|
@ -203,7 +203,7 @@ suppressed.
|
|||
The Lisp modes have two string quote characters: double-quote (@samp{"})
|
||||
and vertical bar (@samp{|}). @samp{|} is not used in Emacs Lisp, but it
|
||||
is used in Common Lisp. C also has two string quote characters:
|
||||
double-quote for strings, and single-quote (@samp{'}) for character
|
||||
double-quote for strings, and apostrophe (@samp{'}) for character
|
||||
constants.
|
||||
|
||||
Human text has no string quote characters. We do not want quotation
|
||||
|
|
|
@ -512,7 +512,7 @@ non-@code{nil} and the character inserted is in the table
|
|||
@c Cross refs reworded to prevent overfull hbox. --rjc 15mar92
|
||||
This command performs abbrev expansion if Abbrev mode is enabled and
|
||||
the inserted character does not have word-constituent
|
||||
syntax. (@xref{Abbrevs}, and @ref{Syntax Class Table}.) It is also
|
||||
syntax. (@xref{Abbrevs}, and @ref{Syntax Class Table}.) It is also
|
||||
responsible for calling @code{blink-paren-function} when the inserted
|
||||
character has close parenthesis syntax (@pxref{Blinking}).
|
||||
|
||||
|
|
|
@ -657,23 +657,18 @@ starting double-quote is not part of the string!
|
|||
|
||||
@anchor{Docstring hyperlinks}
|
||||
@item
|
||||
@iftex
|
||||
When a documentation string refers to a Lisp symbol, write it as it
|
||||
would be printed (which usually means in lower case), with single-quotes
|
||||
around it. For example: @samp{`lambda'}. There are two exceptions:
|
||||
write @code{t} and @code{nil} without single-quotes.
|
||||
@end iftex
|
||||
@ifnottex
|
||||
When a documentation string refers to a Lisp symbol, write it as it
|
||||
would be printed (which usually means in lower case), with single-quotes
|
||||
around it. For example: @samp{lambda}. There are two exceptions: write
|
||||
t and nil without single-quotes. (In this manual, we use a different
|
||||
convention, with single-quotes for all symbols.)
|
||||
@end ifnottex
|
||||
would be printed (which usually means in lower case), with a grave
|
||||
accent @samp{`} before and apostrophe @samp{'} after it. There are
|
||||
two exceptions: write @code{t} and @code{nil} without surrounding
|
||||
punctuation. For example: @samp{CODE can be `lambda', nil, or t.}
|
||||
(In this manual, we use a different convention, with single-quotes
|
||||
around symbols.)
|
||||
|
||||
@cindex hyperlinks in documentation strings
|
||||
Help mode automatically creates a hyperlink when a documentation string
|
||||
uses a symbol name inside single quotes, if the symbol has either a
|
||||
uses a symbol name between grave accent and apostrophe, if the symbol
|
||||
has either a
|
||||
function or a variable definition. You do not need to do anything
|
||||
special to make use of this feature. However, when a symbol has both a
|
||||
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
|
|||
variable or as a function.
|
||||
|
||||
To make a hyperlink to Info documentation, write the name of the Info
|
||||
node (or anchor) in single quotes, preceded by @samp{info node},
|
||||
@samp{Info node}, @samp{info anchor} or @samp{Info anchor}. The Info
|
||||
file name defaults to @samp{emacs}. For example,
|
||||
node (or anchor) between grave accent and apostrophe, preceded by
|
||||
@samp{info node}, @samp{Info node}, @samp{info anchor} or @samp{Info
|
||||
anchor}. The Info file name defaults to @samp{emacs}. For example,
|
||||
|
||||
@smallexample
|
||||
See Info node `Font Lock' and Info node `(elisp)Font Lock Basics'.
|
||||
@end smallexample
|
||||
|
||||
Finally, to create a hyperlink to URLs, write the URL in single
|
||||
quotes, preceded by @samp{URL}. For example,
|
||||
Finally, to create a hyperlink to URLs, write the URL between grave
|
||||
accent and apostrophe, preceded by @samp{URL}. For example,
|
||||
|
||||
@smallexample
|
||||
The home page for the GNU project has more information (see URL
|
||||
|
|
|
@ -108,8 +108,8 @@ on elisp2-fn-vol-number-added
|
|||
(volume-index-markup "II")
|
||||
to create elisp2-fn-vol-number-added
|
||||
|
||||
insert elisp2-fn-vol-number-added into vol1.fn: do following `cat'
|
||||
insert elisp1-fn-vol-number-added into vol2.fn: do following `cat'
|
||||
insert elisp2-fn-vol-number-added into vol1.fn: do following 'cat'
|
||||
insert elisp1-fn-vol-number-added into vol2.fn: do following 'cat'
|
||||
|
||||
% cat elisp2-fn-vol-number-added >> vol1.fn
|
||||
% cat elisp1-fn-vol-number-added >> vol2.fn
|
||||
|
@ -126,7 +126,7 @@ Be sure that .fn file has no blank lines.
|
|||
|
||||
### Create merged .toc file with volume number headings.
|
||||
|
||||
append vol2.toc to vol1.toc with following `cat'
|
||||
append vol2.toc to vol1.toc with following 'cat'
|
||||
|
||||
% cat vol1.toc vol2.toc > elisp-toc-2vol.toc
|
||||
|
||||
|
|
|
@ -2412,7 +2412,7 @@ the window split and the values of
|
|||
and @code{split-width-threshold} (@pxref{Choosing Window Options}).
|
||||
|
||||
Now suppose we combine this call with a preexisting setup for
|
||||
`display-buffer-alist' as follows.
|
||||
@code{display-buffer-alist} as follows.
|
||||
|
||||
@example
|
||||
@group
|
||||
|
|
Loading…
Add table
Reference in a new issue