From: Karl O. Pinc <kop@karlpinc.com>
To: Alvaro Herrera <alvherre@alvh.no-ip.org>
Cc: PostgreSQL Hackers <pgsql-hackers@lists.postgresql.org>
Subject: Re: Doc: Rework contrib appendix -- informative titles, tweaked sentences
Date: Sun, 22 Jan 2023 14:42:46 -0600
Message-ID: <20230122144246.0ff87372@slate.karlpinc.com> (raw)
In-Reply-To: <20230122080903.693b171a@slate.karlpinc.com>
References: <20230120191203.7nyqjbw3qe7xx4ru@alvherre.pgsql>
<20230120191238.ds5l4ehuxve4zn42@alvherre.pgsql>
<20230120142225.3d3be8a3@slate.karlpinc.com>
<20230121081143.322bcf9f@slate.karlpinc.com>
<20230122080903.693b171a@slate.karlpinc.com>
On Sun, 22 Jan 2023 08:09:03 -0600
"Karl O. Pinc" <kop@karlpinc.com> wrote:
> On Sat, 21 Jan 2023 08:11:43 -0600
> "Karl O. Pinc" <kop@karlpinc.com> wrote:
>
> > Attached are 2 v9 patch versions. I don't think I like them.
> > I think the v8 versions are better. But I thought it
> > wouldn't hurt to show them to you.
> >
> > On Fri, 20 Jan 2023 14:22:25 -0600
> > "Karl O. Pinc" <kop@karlpinc.com> wrote:
> >
> > > Attached are 2 alternatives:
> > > (They touch separate files so the ordering is meaningless.)
> > >
> > >
> > > v8-0001-List-trusted-and-obsolete-extensions.patch
> > >
> > > Instead of putting [trusted] and [obsolete] in the titles
> > > of the modules, like v7 does, add a list of them into the text.
> > >
> >
> > v9 puts the list in vertical format, 5 columns.
> >
> > But the column spacing in HTML is ugly, and I don't
> > see a parameter to set to change it. I suppose we could
> > do more work on the stylesheets, but this seems excessive.
>
> Come to think of it, this should be fixed by using CSS
> with a
>
> table.simplelist
Actually, this CSS, added to doc/src/sgml/stylesheet.css,
makes the column spacing look pretty good:
/* Adequate spacing between columns in a simplelist non-inline table */
.simplelist td { padding-left: 2em; padding-right: 2em; }
(No point in specifying table, since td only shows up in tables.)
Note that the default simplelist type value is "vert", causing a 1
column vertical display. There are a number of these in the
documenation. I kind of like what the above css does to these
layouts. An example would be the layout in
doc/src/sgml/html/datatype-boolean.html, which is the "Data Types"
section "Boolean Type" sub-section.
For other places affected see: grep -l doc/src/sgml/*.sgml simplelist
Attached are 2 patches:
v10-0001-List-trusted-and-obsolete-extensions.patch
List trusted extenions in 4 columns, with the CSS altered
to put spacing between vertical columns. I changed this
from the 5 columns of v9 because with 5 columns there
was a little bit of overflow into the right hand margin
of a US-letter PDF. The PDF still has an ugly page
break right before the table. To avoid that use the v8
version, which presents the list inline.
v10-0002-Page-break-before-sect1-in-contrib-appendix-when-pdf.patch
This is exactly like the v8 version. See my comments earlier
about v8 v.s. v9.
Regards,
Karl <kop@karlpinc.com>
Free Software: "You don't pay back, you pay forward."
-- Robert A. Heinlein
Attachments:download all (2 files, .tar.gz)v10-0001-List-trusted-and-obsolete-extensions.patch (text/x-patch, 2.3K) downloaddiff --git a/doc/src/sgml/contrib.sgml b/doc/src/sgml/contrib.sgmlindex 12c79b798b..b9f3268cad 100644--- a/doc/src/sgml/contrib.sgml+++ b/doc/src/sgml/contrib.sgml@@ -84,6 +84,32 @@ CREATE EXTENSION <replaceable>extension_name</replaceable>;
provide access to outside-the-database functionality.
</para>
+ <para id="contrib-trusted-extensions">These are the trusted extensions:+ </para>++ <simplelist type="vert" columns="4">+ <member><xref linkend="btree-gin"/></member>+ <member><xref linkend="btree-gist"/></member>+ <member><xref linkend="citext"/></member>+ <member><xref linkend="cube"/></member>+ <member><xref linkend="dict-int"/></member>+ <member><xref linkend="fuzzystrmatch"/></member>+ <member><xref linkend="hstore"/></member>+ <member><xref linkend="intarray"/></member>+ <member><xref linkend="isn"/></member>+ <member><xref linkend="lo"/></member>+ <member><xref linkend="ltree"/></member>+ <member><xref linkend="pgcrypto"/></member>+ <member><xref linkend="pgtrgm"/></member>+ <member><xref linkend="seg"/></member>+ <member><xref linkend="tablefunc"/></member>+ <member><xref linkend="tcn"/></member>+ <member><xref linkend="tsm-system-rows"/></member>+ <member><xref linkend="tsm-system-time"/></member>+ <member><xref linkend="unaccent"/></member>+ <member><xref linkend="uuid-ossp"/></member>+ </simplelist> +
<para>
Many extensions allow you to install their objects in a schema of your
choice. To do that, add <literal>SCHEMA
@@ -100,6 +126,15 @@ CREATE EXTENSION <replaceable>extension_name</replaceable>;
component for details.
</para>
+ <para id="contrib-obsolete">+ These modules and extensions are obsolete:++ <simplelist type="inline">+ <member><xref linkend="intagg"/></member>+ <member><xref linkend="xml2"/></member>+ </simplelist>+ </para>+
&adminpack;
&amcheck;
&auth-delay;
diff --git a/doc/src/sgml/stylesheet.css b/doc/src/sgml/stylesheet.cssindex 6410a47958..61d8a6537d 100644--- a/doc/src/sgml/stylesheet.css+++ b/doc/src/sgml/stylesheet.css@@ -163,3 +163,6 @@ acronym { font-style: inherit; }
width: 75%;
}
}
++/* Adequate spacing between columns in a simplelist non-inline table */+table.simplelist td { padding-left: 2em; padding-right: 2em; }v10-0002-Page-break-before-sect1-in-contrib-appendix-when-pdf.patch (text/x-patch, 479B) downloaddiff --git a/doc/src/sgml/stylesheet-fo.xsl b/doc/src/sgml/stylesheet-fo.xslindex 0c4dff92c4..68a46f9e24 100644--- a/doc/src/sgml/stylesheet-fo.xsl+++ b/doc/src/sgml/stylesheet-fo.xsl@@ -132,4 +132,12 @@
</fo:bookmark>
</xsl:template>
+<!-- Every sect1 in the appendix describing contributed modules+ gets a page break -->++<xsl:template match="id('contrib')/sect1">+ <fo:block break-after='page'/>+ <xsl:apply-imports/>+</xsl:template>+
</xsl:stylesheet>
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Reply to all the recipients using the --to and --cc options:
reply via email
To: pgsql-www@postgresql.org
Cc: kop@karlpinc.com, alvherre@alvh.no-ip.org, pgsql-hackers@lists.postgresql.org
Subject: Re: Doc: Rework contrib appendix -- informative titles, tweaked sentences
In-Reply-To: <20230122144246.0ff87372@slate.karlpinc.com>
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
This inbox is served by DDX for PostgreSQL; see mirroring instructions
for how to clone and mirror all data and code used for this inbox