pgsql: Doc: revise formatting of function/operator tables.

From: Tom Lane <tgl(at)sss(dot)pgh(dot)pa(dot)us>
To: pgsql-committers(at)lists(dot)postgresql(dot)org
Subject: pgsql: Doc: revise formatting of function/operator tables.
Date: 2020-04-18 00:50:52
Message-ID: E1jPbh6-0003ig-4d@gemulon.postgresql.org
Views: Raw Message | Whole Thread | Download mbox | Resend email
Thread:
Lists: pgsql-committers

Doc: revise formatting of function/operator tables.

The table layout ideas proposed in commit e894c6183 were not as widely
popular as I'd hoped. After discussion, we've settled on a layout
that's effectively a single-column table with cell contents much like a
<varlistentry> description of the function or operator; though we're not
actually using <varlistentry>, because it'd add way too much vertical
space. Instead the effect is accomplished using line-break processing
instructions to separate the description and example(s), plus CSS or FO
customizations to produce indentation of all but the first line in each
cell. While technically this is a bit grotty, it does have the
advantage that we won't need to write nearly as much boilerplate markup.

This patch updates tables 9.30, 9.31, and 9.33 (which were touched by
the previous patch) to the revised style, and additionally converts
table 9.10. A lot of work still remains to do, but hopefully it won't
be too controversial.

Thanks to Andrew Dunstan, Pierre Giraud, Robert Haas, Alvaro Herrera,
David Johnston, Jonathan Katz, Isaac Morland for valuable ideas.

Discussion: https://postgr.es/m/8691.1586798003@sss.pgh.pa.us

Branch
------
master

Details
-------
https://git.postgresql.org/pg/commitdiff/737d69ffc3cfb2e093975411c1becd65ad029478

Modified Files
--------------
doc/src/sgml/func.sgml | 1926 +++++++++++++++++-------------------
doc/src/sgml/stylesheet-common.xsl | 7 +
doc/src/sgml/stylesheet-fo.xsl | 31 +
doc/src/sgml/stylesheet.css | 14 +
4 files changed, 937 insertions(+), 1041 deletions(-)

Browse pgsql-committers by date

  From Date Subject
Next Message David Rowley 2020-04-18 02:11:04 pgsql: Fix possible crash with GENERATED ALWAYS columns
Previous Message Andrew Dunstan 2020-04-17 21:05:33 pgsql: Revert "Only provide new libpq sslpasskey hook for openssl-enabl