Re: doc: Add anchors in create_table.sgml

From: helix84 <helix84(at)centrum(dot)sk>
To: Alvaro Herrera <alvherre(at)2ndquadrant(dot)com>
Cc: pgsql-docs(at)lists(dot)postgresql(dot)org
Subject: Re: doc: Add anchors in create_table.sgml
Date: 2020-01-02 20:56:00
Message-ID: CAGdvKqgHpOwo2+XRY_1W_FF46UvuDe=zODN_iGiS7V4mfB-8gw@mail.gmail.com
Views: Raw Message | Whole Thread | Download mbox | Resend email
Thread:
Lists: pgsql-docs

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.

Thanks in advance and let me take this opportunity to thank you all
for this wonderful piece of software.

[1] https://www.postgresql-archive.org/Please-provide-stable-target-anchors-td2167039.html
[2] https://bitbucket.org/dvarrazzo/pg-doc-anchors/src/default/

Regards,
~~helix84

On Thu, Jan 2, 2020 at 4:56 PM Alvaro Herrera <alvherre(at)2ndquadrant(dot)com> wrote:
>
> On 2020-Jan-02, PG Doc comments form wrote:
>
> > The following documentation comment has been logged on the website:
> >
> > Page: https://www.postgresql.org/docs/12/sql-createtable.html
> > Description:
> >
> > From 73ad66d721a3f87500857cdc6b1f4d810f2875df Mon Sep 17 00:00:00 2001
> > From: =?UTF-8?q?Ivan=20Mas=C3=A1r?= <helix84(at)centrum(dot)sk>
> > Date: Thu, 2 Jan 2020 09:15:34 +0100
> > Subject: [PATCH] doc: Add anchors in create_table.sgml
>
> Can you comment a little on the reason for adding these? I'm not
> opposed to doing so, but we don't have them in every possible place (we
> have in 607 of ~4300 varlistentries by my count), so it needs some
> rationale.
>
>
> --
> Álvaro Herrera https://www.2ndQuadrant.com/
> PostgreSQL Development, 24x7 Support, Remote DBA, Training & Services

In response to

Responses

Browse pgsql-docs by date

  From Date Subject
Next Message PG Doc comments form 2020-01-02 21:24:42 glossary
Previous Message Alvaro Herrera 2020-01-02 15:56:32 Re: doc: Add anchors in create_table.sgml