Re: adding a TOC to the psql reference page

From: "David G(dot) Johnston" <david(dot)g(dot)johnston(at)gmail(dot)com>
To: Bruce Momjian <bruce(at)momjian(dot)us>
Cc: grgbnc(at)gmail(dot)com, pgsql-docs(at)lists(dot)postgresql(dot)org
Subject: Re: adding a TOC to the psql reference page
Date: 2020-04-30 22:26:32
Message-ID: CAKFQuwYckX+wJnOqa09=vmhTVeLa5Aa=Q5NFyhzaPFHGq65ZSA@mail.gmail.com
Views: Raw Message | Whole Thread | Download mbox | Resend email
Thread:
Lists: pgsql-docs

On Thu, Apr 30, 2020 at 3:17 PM Bruce Momjian <bruce(at)momjian(dot)us> wrote:

> On Thu, Apr 30, 2020 at 08:48:09PM +0000, PG Doc comments form wrote:
>
> > Since https://www.postgresql.org/docs/current/app-psql.html is quite
> long,
> > it would be nice to add a detailed table of contents at its beginning, in
> > order to:
> >
> > - allow for easier browsing
> >
> > - allow to reference individual psql options, meta-commands, variables,
> > prompts and environment variables by using their respective id attribute
>
> Yes, I can see the value in that, but I don't think we do that for any
> other SQL comments. Would doing it just for psql make sense?
>
>
Yes.

Other parts of the documentation have TOC sections so its not like we don't
do it ever. And even if by general rule the applications don't get a TOC
(there isn't one that I'm aware of) psql would still warrant an exception
given its position as the primary user interface to the system and the
extensiveness of the documentation itself (a byproduct of being the primary
user interface).

David J.

In response to

Browse pgsql-docs by date

  From Date Subject
Next Message grg bnc 2020-04-30 23:04:51 Re: adding a TOC to the psql reference page
Previous Message Tom Lane 2020-04-30 22:21:32 Re: adding a TOC to the psql reference page