From: Paul Eggert Date: Sun, 12 Apr 2015 00:44:44 +0000 (+0000) Subject: Minor quoting etc. fixes to misc manuals X-Git-Url: http://cgit.sxemacs.org/?p=gnus;a=commitdiff_plain;h=1c6a21a4400e5b04aeb7d1a2c93ed2af90163a47 Minor quoting etc. fixes to misc manuals Fix some minor quoting and spacing issues. Distinguish more clearly among grave accent and apostrophe (which are ASCII) and single quote (which is not). Prefer the standard terms "apostrophe" and "grave accent" to alternative names that can be confusing. Use apostrophes to single-quote ASCII text. --- diff --git a/texi/auth.texi b/texi/auth.texi index 0d5da9582..c68861256 100644 --- a/texi/auth.texi +++ b/texi/auth.texi @@ -110,11 +110,11 @@ The @code{user} is the user name. It's known as @var{:user} in You can use spaces inside a password or other token by surrounding the token with either single or double quotes. -You can use single quotes inside a password or other token by +You can use apostrophes inside a password or other token by surrounding it with double quotes, e.g., @code{"he'llo"}. Similarly you can use double quotes inside a password or other token by surrounding -it with single quotes, e.g., @code{'he"llo'}. You can't mix both (so a -password or other token can't have both single and double quotes). +it with apostrophes, e.g., @code{'he"llo'}. You can't mix both (so a +password or other token can't have both apostrophes and double quotes). All this is optional. You could just say (but we don't recommend it, we're just showing that it's possible) diff --git a/texi/gnus-faq.texi b/texi/gnus-faq.texi index 8eb7c771a..8126827ff 100644 --- a/texi/gnus-faq.texi +++ b/texi/gnus-faq.texi @@ -1112,7 +1112,7 @@ resulting in: :O \-> ... | 115 |Raymond Scholz | 1:24 :O \-> ... | 19 |Lars Magne Ingebrigt |15:33 :O Slow mailing list | 13 |Lars Magne Ingebrigt |Sat 23:49 -:O Re: `@@' mark not documented | 13 |Lars Magne Ingebrigt |Sat 23:50 +:O Re: '@@' mark not documented | 13 |Lars Magne Ingebrigt |Sat 23:50 :R > Re: Gnus still doesn't count messages prope| 23 |Lars Magne Ingebrigt |Sat 23:57 :O \-> ... | 18 |Kai Grossjohann | 0:35 :O \-> ... | 13 |Lars Magne Ingebrigt | 0:56 @@ -1501,7 +1501,7 @@ entries. Say @samp{c} to create a new entry, @samp{b} to search your BBDB and @samp{C-o} to add a new field to an entry. If you want to add a sender to the BBDB you can -also just hit `:' on the posting in the summary buffer and +also just hit @kbd{:} on the posting in the summary buffer and you are done. When you now compose a new mail, hit @samp{TAB} to cycle through know recipients. diff --git a/texi/gnus-news.el b/texi/gnus-news.el index 81986f2dd..ba8a46312 100644 --- a/texi/gnus-news.el +++ b/texi/gnus-news.el @@ -85,7 +85,7 @@ paragraph-separate: \"[ ]*$\"\nend:\n") (infile (concat dir infile)) (buffer (find-file-noselect (concat dir outfile)))) (with-temp-buffer - ;; Could be done using `texinfmt' stuff as in `infohack.el'. + ;; Could be done using 'texinfmt' stuff as in 'infohack.el'. (insert (shell-command-to-string (concat gnus-news-makeinfo-command " " @@ -102,7 +102,7 @@ paragraph-separate: \"[ ]*$\"\nend:\n") (save-excursion (while (re-search-forward "^ " nil t) (replace-match ""))) - ;; Avoid `*' from @ref at beginning of line: + ;; Avoid '*' from @ref at beginning of line: (save-excursion (while (re-search-forward "^\\*Note" nil t) (replace-match " \\&"))) diff --git a/texi/gnus-news.texi b/texi/gnus-news.texi index c5b96e740..ef6573fc7 100644 --- a/texi/gnus-news.texi +++ b/texi/gnus-news.texi @@ -13,8 +13,8 @@ @c carry prominent notices stating who last changed them. @c This file contains a list of news features Gnus. It is supposed to be -@c included in `gnus.texi'. `GNUS-NEWS' is automatically generated from -@c this file (see `gnus-news.el'). +@c included in 'gnus.texi'. 'GNUS-NEWS' is automatically generated from +@c this file (see 'gnus-news.el'). @itemize @bullet diff --git a/texi/gnus.texi b/texi/gnus.texi index b448d3e04..7a794280a 100644 --- a/texi/gnus.texi +++ b/texi/gnus.texi @@ -11913,8 +11913,8 @@ controlling variable is a predicate list, as described above. @ifinfo @c Avoid sort of redundant entries in the same section for the printed -@c manual, but add them in info to allow `i gnus-treat-foo-bar RET' or -@c `i foo-bar'. +@c manual, but add them in info to allow 'i gnus-treat-foo-bar RET' or +@c 'i foo-bar'. @vindex gnus-treat-buttonize @vindex gnus-treat-buttonize-head @vindex gnus-treat-capitalize-sentences @@ -14987,7 +14987,7 @@ this means @samp{gssapi}, @samp{kerberos4}, @samp{digest-md5}, @samp{cram-md5}, @samp{anonymous} or the default @samp{login}. @item :program -When using the `shell' :stream, the contents of this variable is +When using the @samp{shell} :stream, the contents of this variable is mapped into the @code{imap-shell-program} variable. This should be a @code{format}-like string (or list of strings). Here's an example: @@ -17768,7 +17768,7 @@ So you send a ``reminder'' message (actually, a diary one) to yourself. @item You forget all about it and keep on getting and reading new mail, as usual. @item -From time to time, as you type `g' in the group buffer and as the date +From time to time, as you type @kbd{g} in the group buffer and as the date is getting closer, the message will pop up again to remind you of your appointment, just as if it were new and unread. @item @@ -19648,7 +19648,7 @@ Immediately scoring. @end table @item -If you are scoring on `e' (extra) headers, you will then be prompted for +If you are scoring on @samp{e} (extra) headers, you will then be prompted for the header name on which you wish to score. This must be a header named in gnus-extra-headers, and @samp{TAB} completion is available. @@ -21354,8 +21354,8 @@ variable. To work correctly the @code{nnir-namazu-remove-prefix} variable must also be correct. This is the prefix to remove from each file name -returned by Namazu in order to get a proper group name (albeit with `/' -instead of `.'). +returned by Namazu in order to get a proper group name (albeit with @samp{/} +instead of @samp{.}). For example, suppose that Namazu returns file names such as @samp{/home/john/Mail/mail/misc/42}. For this example, use the @@ -21368,18 +21368,20 @@ correct group name @samp{mail.misc}. Extra switches may be passed to the namazu search command by setting the variable @code{nnir-namazu-additional-switches}. It is particularly important not to pass any any switches to namazu that will change the -output format. Good switches to use include `--sort', `--ascending', -`--early' and `--late'. Refer to the Namazu documentation for further +output format. Good switches to use include @option{--sort}, +@option{--ascending}, @option{--early} and @option{--late}. +Refer to the Namazu documentation for further information on valid switches. -Mail must first be indexed with the `mknmz' program. Read the documentation -for namazu to create a configuration file. Here is an example: +Mail must first be indexed with the @command{mknmz} program. Read the +documentation for namazu to create a configuration file. Here is an +example: @cartouche @example package conf; # Don't remove this line! - # Paths which will not be indexed. Don't use `^' or `$' anchors. + # Paths which will not be indexed. Don't use '^' or '$' anchors. $EXCLUDE_PATH = "spam|sent"; # Header fields which should be searchable. case-insensitive @@ -21451,7 +21453,7 @@ when searching all groups on a server. @item nnir-summary-line-format The format specification to be used for lines in an nnir summary buffer. -All the items from `gnus-summary-line-format' are available, along with +All the items from @code{gnus-summary-line-format} are available, along with three items unique to nnir summary buffers: @example @@ -21465,7 +21467,7 @@ If @code{nil} (the default) this will use @code{gnus-summary-line-format}. @item nnir-retrieve-headers-override-function If non-@code{nil}, a function that retrieves article headers rather than using the gnus built-in function. This function takes an article list and -group as arguments and populates the `nntp-server-buffer' with the +group as arguments and populates the @code{nntp-server-buffer} with the retrieved headers. It should then return either 'nov or 'headers indicating the retrieved header format. Failure to retrieve headers should return @code{nil}. @@ -26124,10 +26126,10 @@ their @code{:char} property, or showing the marks as full strings. @lisp ;; show the marks as single characters (see the :char property in -;; `gnus-registry-marks'): +;; 'gnus-registry-marks'): ;; (defalias 'gnus-user-format-function-M 'gnus-registry-article-marks-to-chars) -;; show the marks by name (see `gnus-registry-marks'): +;; show the marks by name (see 'gnus-registry-marks'): ;; (defalias 'gnus-user-format-function-M 'gnus-registry-article-marks-to-names) @end lisp @@ -27817,7 +27819,7 @@ As a result of the following change, the @file{~/News/overview/} directory is not used any more. You can safely delete the entire hierarchy. -@c FIXME: `gnus-load' is mentioned in README, which is not included in +@c FIXME: 'gnus-load' is mentioned in README, which is not included in @c the repository. We should find a better place for this item. @item @code{(require 'gnus-load)} diff --git a/texi/message.texi b/texi/message.texi index a48e4956e..7d8f5e47c 100644 --- a/texi/message.texi +++ b/texi/message.texi @@ -2006,13 +2006,13 @@ that look like: Hallvard B Furuseth writes: @end example -@c FIXME: Add `message-insert-formatted-citation-line' and -@c `message-citation-line-format' +@c FIXME: Add 'message-insert-formatted-citation-line' and +@c 'message-citation-line-format'. Point will be at the beginning of the body of the message when this function is called. -Note that Gnus provides a feature where clicking on `writes:' hides the +Note that Gnus provides a feature where clicking on @samp{writes:} hides the cited text. If you change the citation line too much, readers of your messages will have to adjust their Gnus, too. See the variable @code{gnus-cite-attribution-suffix}. @xref{Article Highlighting, ,