[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
Re: `@pxref`: contradicting statements in manual
From: |
Jean-Christophe Helary |
Subject: |
Re: `@pxref`: contradicting statements in manual |
Date: |
Thu, 6 Jan 2022 17:27:18 +0900 |
> On Jan 6, 2022, at 17:17, Werner LEMBERG <wl@gnu.org> wrote:
>
>
>
> The documentation
> https://www.gnu.org/software/texinfo/manual/texinfo/html_node/_0040pxref.html
> says:
>
> The effect of `@pxref{node-name}` is similar to that of `see
> @ref{node-name}`. However, in many circumstance the latter is
> preferrable, as this makes it clear in the Info output that the word
> “see” should be present.
>
> This implies a recommendation against using `@pxref`, preferring `see
> @ref`. However, in
> https://www.gnu.org/software/texinfo/manual/texinfo/html_node/_0040ref.html
> you can find the following:
>
> The `@ref` command can tempt writers to express themselves in a
> manner that is suitable for a printed manual but looks awkward in
> the Info format. Bear in mind that your audience could be using
> both the printed and the Info format.
>
> This implies exactly the opposite.
>
> IMHO, the first quote should be improved, probably referring to the
> second quote if good formatting for the Info format is desired.
I'd love to have a recommendation not to use tags that add arbitrary English
strings :-)
Unless there is a working (easy to use and well documented) mechanism to
localize said strings.
--
Jean-Christophe Helary @brandelune
https://mac4translators.blogspot.com
https://sr.ht/~brandelune/omegat-as-a-book/
Re: `@pxref`: contradicting statements in manual, Eli Zaretskii, 2022/01/06