unofficial mirror of emacs-devel@gnu.org 
 help / color / mirror / code / Atom feed
* Re: [Emacs-diffs] /srv/bzr/emacs/trunk r110632: * text.texi (Org Authoring): Change @ref to @pxref.
       [not found] <mailman.690771.1351016269.854.emacs-diffs@gnu.org>
@ 2012-10-23 19:24 ` Eli Zaretskii
  2012-10-23 19:51   ` Bastien
  0 siblings, 1 reply; 4+ messages in thread
From: Eli Zaretskii @ 2012-10-23 19:24 UTC (permalink / raw)
  To: Bastien Guerry; +Cc: emacs-devel

This change is wrong:

> === modified file 'doc/emacs/text.texi'
> --- a/doc/emacs/text.texi	2012-06-17 05:13:40 +0000
> +++ b/doc/emacs/text.texi	2012-10-23 16:12:59 +0000
> @@ -1399,7 +1399,7 @@
>  #+end_example
>  @end example
>  
> -  For further details, see @ref{Exporting,,,org, The Org Manual} and
> +  For further details, @pxref{Exporting,,,org, The Org Manual}, and
>  @ref{Publishing,,,org, The Org Manual}.

@pxref should only be used inside parentheses.  What was the problem
with "see @ref", apart of the fact that a comma was missing after the
closing brace?



^ permalink raw reply	[flat|nested] 4+ messages in thread

* Re: [Emacs-diffs] /srv/bzr/emacs/trunk r110632: * text.texi (Org Authoring): Change @ref to @pxref.
  2012-10-23 19:24 ` [Emacs-diffs] /srv/bzr/emacs/trunk r110632: * text.texi (Org Authoring): Change @ref to @pxref Eli Zaretskii
@ 2012-10-23 19:51   ` Bastien
  2012-10-23 20:36     ` Eli Zaretskii
  0 siblings, 1 reply; 4+ messages in thread
From: Bastien @ 2012-10-23 19:51 UTC (permalink / raw)
  To: Eli Zaretskii; +Cc: emacs-devel

Eli Zaretskii <eliz@gnu.org> writes:

> This change is wrong:
>
>> === modified file 'doc/emacs/text.texi'
>> --- a/doc/emacs/text.texi	2012-06-17 05:13:40 +0000
>> +++ b/doc/emacs/text.texi	2012-10-23 16:12:59 +0000
>> @@ -1399,7 +1399,7 @@
>>  #+end_example
>>  @end example
>>  
>> -  For further details, see @ref{Exporting,,,org, The Org Manual} and
>> +  For further details, @pxref{Exporting,,,org, The Org Manual}, and
>>  @ref{Publishing,,,org, The Org Manual}.
>
> @pxref should only be used inside parentheses.  

Then (info "(texinfo)ref") is giving a misleading example:

8.6 `@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.

For example,

     For more information, @pxref{This}, and @ref{That}.

> What was the problem with "see @ref", apart of the fact that a comma
> was missing after the closing brace?

The period after the first ref@{...} in the info documentation.

See at the end of (info "(emacs)Org Authoring"):

   For further details, see *note Exporting: (org)Exporting. and *note Publishing:
 (org)Publishing.                                   ^^^

-- 
 Bastien



^ permalink raw reply	[flat|nested] 4+ messages in thread

* Re: [Emacs-diffs] /srv/bzr/emacs/trunk r110632: * text.texi (Org Authoring): Change @ref to @pxref.
  2012-10-23 19:51   ` Bastien
@ 2012-10-23 20:36     ` Eli Zaretskii
  2012-10-23 21:27       ` Bastien
  0 siblings, 1 reply; 4+ messages in thread
From: Eli Zaretskii @ 2012-10-23 20:36 UTC (permalink / raw)
  To: Bastien; +Cc: emacs-devel

> From: Bastien <bzg@gnu.org>
> Cc: emacs-devel@gnu.org
> Date: Tue, 23 Oct 2012 21:51:38 +0200
> 
> > @pxref should only be used inside parentheses.  
> 
> Then (info "(texinfo)ref") is giving a misleading example:

Indeed, it does.  The next node in the Texinfo manual says:

  The parenthetical reference command, `@pxref', is nearly the same as
  `@xref', but it is best used at the end of a sentence or before a
  closing parenthesis.

The place where you used it is neither of these two.

> > What was the problem with "see @ref", apart of the fact that a comma
> > was missing after the closing brace?
> 
> The period after the first ref@{...} in the info documentation.
> 
> See at the end of (info "(emacs)Org Authoring"):
> 
>    For further details, see *note Exporting: (org)Exporting. and *note Publishing:
>  (org)Publishing.                                   ^^^

If I add a comma after the first @ref, like this:

    For further details, see @ref{Exporting,,,org, The Org Manual}, and
  @ref{Publishing,,,org, The Org Manual}.                        ^^^

there's no period in the Info output:

     For further details, see *note Exporting: (org)Exporting, and *note
  Publishing: (org)Publishing.



^ permalink raw reply	[flat|nested] 4+ messages in thread

* Re: [Emacs-diffs] /srv/bzr/emacs/trunk r110632: * text.texi (Org Authoring): Change @ref to @pxref.
  2012-10-23 20:36     ` Eli Zaretskii
@ 2012-10-23 21:27       ` Bastien
  0 siblings, 0 replies; 4+ messages in thread
From: Bastien @ 2012-10-23 21:27 UTC (permalink / raw)
  To: Eli Zaretskii; +Cc: emacs-devel

Eli Zaretskii <eliz@gnu.org> writes:

> If I add a comma after the first @ref, like this:
>
>     For further details, see @ref{Exporting,,,org, The Org Manual}, and
>   @ref{Publishing,,,org, The Org Manual}.                        ^^^
>
> there's no period in the Info output:
>
>      For further details, see *note Exporting: (org)Exporting, and *note
>   Publishing: (org)Publishing.

I didn't know this, thanks.  

I just committed a change with your solution.

-- 
 Bastien



^ permalink raw reply	[flat|nested] 4+ messages in thread

end of thread, other threads:[~2012-10-23 21:27 UTC | newest]

Thread overview: 4+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
     [not found] <mailman.690771.1351016269.854.emacs-diffs@gnu.org>
2012-10-23 19:24 ` [Emacs-diffs] /srv/bzr/emacs/trunk r110632: * text.texi (Org Authoring): Change @ref to @pxref Eli Zaretskii
2012-10-23 19:51   ` Bastien
2012-10-23 20:36     ` Eli Zaretskii
2012-10-23 21:27       ` Bastien

Code repositories for project(s) associated with this public inbox

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

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).