all messages for Emacs-related lists mirrored at yhetil.org
 help / color / mirror / code / Atom feed
From: David Kastrup <dak@gnu.org>
Cc: emacs-devel@gnu.org
Subject: Re: What is normal these days (display.texi)?
Date: Sat, 08 Jul 2006 15:52:24 +0200	[thread overview]
Message-ID: <85r70w19wn.fsf@lola.goethe.zz> (raw)
In-Reply-To: <m1FzCa1-0004EkC@rattlesnake.com> (Robert J. Chassell's message of "Sat, 8 Jul 2006 13:10:41 +0000 (UTC)")

"Robert J. Chassell" <bob@rattlesnake.com> writes:

>     >     ! precisely at the right margin, not at a word boundary.
>     >     ! @xref{Filling}, @ref{Longlines,, Long Lines Mode, emacs,
>     >     ! The GNU Emacs Manual}.
>     >
>     > That doesn't seem like proper Texinfo usage; is it?
>
>     What's wrong with it?
>
> @ref is for the end of a sentence.

This is the end of a sentence.

>     As far as I can see, it is following the specs to the letter, and
>     it works.
>
> No, it is not following the documentation.
>
>     @xref{Filling, , ,emacs, The GNU Emacs Manual}, @ref{Longlines,,
>     Long Lines Mode, emacs, The GNU Emacs Manual}.
>
> produces
>
>     *Note Filling: (emacs)Filling, *Note Long Lines Mode:
>     (emacs)Longlines.
>
> in Info

Not here.  Here it produces:

   Note that continuation is different from filling; continuation
happens on the screen only, not in the buffer contents, and it breaks a
line precisely at the right margin, not at a word boundary.  *Note
Filling::, *Note Long Lines Mode: (emacs)Longlines.

(with some of the above invisible, like the "::" and the "Longlines".

> (and a fairly similar output for DVI).
>
> You need an `and see' before the @ref, since it is without a capital
> `S' and in the latter part of a sentence.

But it comes with its own "see", so adding one would make it into
"see see Long Lines Mode".

And the dvi actually looks something like
See section filling, page xxx, section "Long lines" ...

So one would probably just want to add "and", like Eli said.

> Plus, you need to complete the first part of the sentence.
> For example:
>
>     @xref{Filling, , ,emacs, The GNU Emacs Manual}, for more
>     information; and also see @ref{Longlines,, Long Lines Mode, emacs,
>     The GNU Emacs Manual}.
>
> (without the indentation of this example)
>
> The documentation says:
>
>     (texinfo)ref
>
>     `@ref' is nearly the same as `@xref' except that it does not
>     generate a `See' in the printed output, just the reference itself.
>     This makes it useful as the last part of a sentence.

Well, it _does_ add "see" in Emacs' builtin info reader, and I use it
as the last part of a sentence.

I think adding "and" should do the trick here.

-- 
David Kastrup, Kriemhildstr. 15, 44793 Bochum

  reply	other threads:[~2006-07-08 13:52 UTC|newest]

Thread overview: 19+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2006-07-07  9:10 What is normal these days (display.texi)? Kim F. Storm
2006-07-07  9:17 ` David Kastrup
2006-07-07 15:13   ` Kim F. Storm
2006-07-07 15:49     ` David Kastrup
2006-07-08  1:13       ` Richard Stallman
2006-07-08  8:31         ` David Kastrup
2006-07-08 12:57           ` Eli Zaretskii
2006-07-08 20:57             ` Richard Stallman
2006-07-08 13:10           ` Robert J. Chassell
2006-07-08 13:52             ` David Kastrup [this message]
2006-07-08 17:50               ` Robert J. Chassell
2006-07-08 14:34             ` Eli Zaretskii
2006-07-08 22:19       ` Kim F. Storm
2006-07-08 22:31         ` David Kastrup
2006-07-10  8:56         ` David Kastrup
2006-07-10 10:55           ` Kim F. Storm
2006-07-10 11:09             ` David Kastrup
2006-07-10 12:05               ` Kim F. Storm
2006-07-08  1:12   ` Richard Stallman

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=85r70w19wn.fsf@lola.goethe.zz \
    --to=dak@gnu.org \
    --cc=emacs-devel@gnu.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
Code repositories for project(s) associated with this external index

	https://git.savannah.gnu.org/cgit/emacs.git
	https://git.savannah.gnu.org/cgit/emacs/org-mode.git

This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.