[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
Documentation about @url is confusing
From: |
Akim Demaille |
Subject: |
Documentation about @url is confusing |
Date: |
Tue, 19 Feb 2019 19:29:10 +0100 |
Hi guys!
The version of Texinfo I have (and the current source according to
http://git.savannah.gnu.org/cgit/texinfo.git/tree/doc/texinfo.texi) are
confusing about @url:
> 6.10.1 '@url' Examples
> ----------------------
>
> First, here is an example of the simplest form of '@url', with just one
> argument. The given url is both the target and the visible text of the
> link:
>
> The official GNU ftp site is @uref{http://ftp.gnu.org/gnu}.
>
> produces:
> The official GNU ftp site is <http://ftp.gnu.org/gnu>.
>
> Two-argument form of '@url'
> ...........................
>
> Here is an example of the two-argument form:
> The official @uref{http://ftp.gnu.org/gnu, GNU ftp site}
> holds programs and texts.
There is a continuous mix between @url and @uref. Eventually, it's unclear
which one is recommended. The source file says
@node @code{@@url}
@section @code{@@url}, @code{@@address@hidden@var{url}[, @var{text}][,
@address@hidden
@address@hidden old name
@findex uref
@cindex Uniform resource locator, referring to
@cindex URL, referring to
so I guess we are expected to prefer @url to @uref (according to the @c
comment), but it's not very clearly stated.
Cheers!
- Documentation about @url is confusing,
Akim Demaille <=