xref output, nodes vs. sections

View: New views
3 Messages — Rating Filter:   Alert me  

xref output, nodes vs. sections

by Karl Berry :: Rate this Message:

Reply to Author | View Threaded | Show Only this Message

Back on this mail from August (sorry).

    > It looks like you also change the xref targets to use section names?

    Indeed, it is one possibility. But there is a variable (and even
    a command line option) that changes the behaviour, I set it in the
    default case.

Options are good, but the default xref output should match what makeinfo
does.  Yes?

    In texinfo.tex both are used, unless I am wrong

Suppose we have

@chapter Sectitle
@node Foo

Then, in texinfo.tex, a simple "@xref{Foo}" outputs "See Foo, page 1",
where Foo is the node name, not the section name.  It is possible to use
a multi-arg @xref command to change the output.  There is also an
(undocumented) option to use section names instead.

In the Info output, the output uses both:
"*Note Sectitle:: foo".

In the HTML output, just the node name (like texinfo.tex):
"<a href="#Top">Top</a>".

    (and I think that it is quite ugly).

I agree, but I'm doubtful about changing the default output at this point.
Wdyt?

Thanks,
Karl



Re: xref output, nodes vs. sections

by Patrice Dumas :: Rate this Message:

Reply to Author | View Threaded | Show Only this Message

On Mon, Oct 26, 2009 at 01:58:57PM -0500, Karl Berry wrote:
>
>     Indeed, it is one possibility. But there is a variable (and even
>     a command line option) that changes the behaviour, I set it in the
>     default case.
>
> Options are good, but the default xref output should match what makeinfo
> does.  Yes?

Unless I am wrong, it does so (unless called as texi2html).

>     In texinfo.tex both are used, unless I am wrong
>
> Suppose we have
>
> @chapter Sectitle
> @node Foo
>
> Then, in texinfo.tex, a simple "@xref{Foo}" outputs "See Foo, page 1",
> where Foo is the node name, not the section name.  It is possible to use
> a multi-arg @xref command to change the output.  There is also an
> (undocumented) option to use section names instead.

Ok, I thought it was done in the default case.

> In the Info output, the output uses both:
> "*Note Sectitle:: foo".

Unless I am wrong only if it is given as second or third argument.

> In the HTML output, just the node name (like texinfo.tex):
> "<a href="#Top">Top</a>".
>
>     (and I think that it is quite ugly).
>
> I agree, but I'm doubtful about changing the default output at this point.
> Wdyt?

I can't see why it couldn't be changed, unless it has some meaning
as a cross ref and isn't only a name (for example like in Info where the
text of the reference is not independent of the reference itself -- while
in html the text can be changed as long as the references in a href= is
kept). Anyway, and unless I missed something the default is the
same than makeinfo --html unless called as texi2html.

--
Pat



Re: xref output, nodes vs. sections

by Karl Berry :: Rate this Message:

Reply to Author | View Threaded | Show Only this Message

    > In the Info output, the output uses both:
    > "*Note Sectitle:: foo".

    Unless I am wrong only if it is given as second or third argument.

Yes, you're right.  Sorry.

    Anyway, and unless I missed something the default is the
    same than makeinfo --html unless called as texi2html.

Ok, good.  Thanks.