Re: [PATCH] Missing links between system catalog documentation pages - Mailing list pgsql-hackers

From Alvaro Herrera
Subject Re: [PATCH] Missing links between system catalog documentation pages
Date
Msg-id 20200621150802.GA1221@alvherre.pgsql
Whole thread Raw
In response to Re: [PATCH] Missing links between system catalog documentation pages  (Tom Lane <tgl@sss.pgh.pa.us>)
Responses Re: [PATCH] Missing links between system catalog documentation pages
List pgsql-hackers
On 2020-Jun-21, Tom Lane wrote:

> That has not been our practice up to now, eg in comparable cases in
> discussions of GUC variables, only the first reference is xref-ified.
> I think it could be kind of annoying to make every reference a link,
> both for regular readers (the link decoration is too bold in most
> browsers) and for users of screen-reader software.

In the glossary I also changed things so that only the first reference
of a term in another term's definition is linked; my experience reading
the originals as submitted (which did link them all at some point) is
that the extra links are very distracting, bad for readability.  So +1
for not adding links to every single mention.

> There is a fair question as to how far apart two references should
> be before we <xref> both of them.  But I think that distance
> does need to be more than zero, and probably more than one para.

Nod.

-- 
Álvaro Herrera                https://www.2ndQuadrant.com/
PostgreSQL Development, 24x7 Support, Remote DBA, Training & Services



pgsql-hackers by date:

Previous
From: ilmari@ilmari.org (Dagfinn Ilmari Mannsåker)
Date:
Subject: vs for command line tools in the docs
Next
From: Tom Lane
Date:
Subject: Re: vs for command line tools in the docs