Re: doc: Add anchors in create_table.sgml

From: Bruce Momjian <bruce(at)momjian(dot)us>
To: Alvaro Herrera <alvherre(at)2ndquadrant(dot)com>
Cc: helix84 <helix84(at)centrum(dot)sk>, pgsql-docs(at)lists(dot)postgresql(dot)org
Subject: Re: doc: Add anchors in create_table.sgml
Date: 2020-01-17 23:22:46
Message-ID: 20200117232246.GD14054@momjian.us
Views: Raw Message | Whole Thread | Download mbox | Resend email
Thread:
Lists: pgsql-docs

On Fri, Jan 3, 2020 at 10:35:20AM -0300, Alvaro Herrera wrote:
> Hi,
>
> On 2020-Jan-02, helix84 wrote:
>
> > Hi, I prefer to bookmark docs pointing to the exact term I need and
> > with pg docs it's often been the case that the exact term doesn't have
> > an anchor or only has unstable, generated anchors. So I would very
> > much like to add stable anchors in many more places. I haven't
> > contributed to pg before, so this patch is me testing the waters. If
> > there is interest, I'd like to add stable anchors to wherever we'll
> > agree it makes sense - preferably in an automated or semi-automated
> > way.
> >
> > I read an older thread on this topic [1] which links to a custom SGML
> > parser in Python for this specific task [2]. I have experience with
> > XSLT, but not so much with SGML processing, so I would appreciate if
> > you could point me whether a custom parser is the way to go for this
> > task or I should look into a more generic SGML processing tool.
>
> Ah,
> https://www.postgresql.org/message-id/AANLkTikAgIyYfwy_2Zj8GafoC7ZFlGv5iCdab1l7VuDp@mail.gmail.com
> (We prefer our own archive to GMane's.) That thread is so old that
> Peter feels the need to point out that the Git mirror was out of date
> with CVS ... I can no longer even remember the commit process for CVS
> anymore. We also converted from SGML to XML in the meantime, so you can
> probably make do with a standard XML parser without having to write a
> custom SGML one. (Daniele Varrazzo's patch ended up as 477319829c2e.)
>
> TBH I've felt the need for anchors for <varlistentry> tags in the
> past also (IIRC the runtime-config page would be improved by them),
> but I'm not sure about adding them to every single keyword of every
> single reference page. Is that really useful?

It would be helpful if the release notes could point to specific
tables in the docs, rather than just sections.

--
Bruce Momjian <bruce(at)momjian(dot)us> http://momjian.us
EnterpriseDB http://enterprisedb.com

+ As you are, so once was I. As I am, so you will be. +
+ Ancient Roman grave inscription +

In response to

Browse pgsql-docs by date

  From Date Subject
Next Message Bruce Momjian 2020-01-18 02:20:51 Re: Argument 'week' not supported in date_trunc function with intervals
Previous Message Bruce Momjian 2020-01-17 22:47:19 Re: pg_ctl in Windows