Re: Another modest proposal for docs formatting: catalog descriptions

From: Tom Lane <tgl(at)sss(dot)pgh(dot)pa(dot)us>
To: "Jonathan S(dot) Katz" <jkatz(at)postgresql(dot)org>
Cc: Alvaro Herrera <alvherre(at)2ndquadrant(dot)com>, Fabien COELHO <coelho(at)cri(dot)ensmp(dot)fr>, pgsql-docs(at)lists(dot)postgresql(dot)org, PostgreSQL Developers <pgsql-hackers(at)lists(dot)postgresql(dot)org>
Subject: Re: Another modest proposal for docs formatting: catalog descriptions
Date: 2020-05-08 22:53:36
Message-ID: 23610.1588978416@sss.pgh.pa.us
Views: Raw Message | Whole Thread | Download mbox | Resend email
Thread:
Lists: pgsql-docs pgsql-hackers

Here's a more fully fleshed out draft for this, with stylesheet
markup to get extra space around the column type names.

I realized that I can probably automate this conversion, unlike the
function-table conversion: I'm not feeling any need to editorialize
on the column descriptions, so I can probably just extract the data
from the SGML programmatically and rebuild it as I want. Seems like
it should be a fairly quick process. So, if this seems good from
your standpoint, please push up the patch on main.css and then I'll
see about doing the edit.

(BTW, said patch also removes some no-longer-used detritus from the
earlier markup attempt.)

regards, tom lane

Attachment Content-Type Size
catalog-description-prototype-2.patch text/x-diff 17.0 KB
website-style.patch text/x-diff 1.3 KB
pg-aggregate-v2.png image/png 193.9 KB

In response to

Responses

Browse pgsql-docs by date

  From Date Subject
Next Message Fabien COELHO 2020-05-09 06:54:10 Re: Another modest proposal for docs formatting: catalog descriptions
Previous Message Magnus Hagander 2020-05-08 20:50:11 Re: This is not true or at the very least confusing

Browse pgsql-hackers by date

  From Date Subject
Next Message Tomas Vondra 2020-05-08 23:14:17 Re: Incremental sorts and EXEC_FLAG_REWIND
Previous Message Ranier Vilela 2020-05-08 22:25:36 Re: [PATCH] Fix division by zero (explain.c)