Re: Doc: Rework contrib appendix -- informative titles, tweaked sentences
Karl O. Pinc <kop@karlpinc.com>
From: "Karl O. Pinc" <kop@karlpinc.com>
To: Alvaro Herrera <alvherre@alvh.no-ip.org>
Cc: PostgreSQL Hackers <pgsql-hackers@lists.postgresql.org>
Date: 2023-01-20T20:22:25Z
Lists: pgsql-hackers
Attachments
- v8-0001-List-trusted-and-obsolete-extensions.patch (text/x-patch) patch v8-0001
- v8-0002-Page-break-before-sect1-in-contrib-appendix-when-pdf.patch (text/x-patch) patch v8-0002
On Fri, 20 Jan 2023 20:12:38 +0100
Alvaro Herrera <alvherre@alvh.no-ip.org> wrote:
> Ah, I wanted to attach the two remaining patches and forgot.
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.
v8-0002-Page-break-before-sect1-in-contrib-appendix-when-pdf.patch
This frobs the PDF style sheet so that when sect1 is used
in the appendix for the contrib directory, there is a page
break before every sect1. This puts each module/extension
onto a separate page, but only for the contrib appendix.
Aside from hardcoding the "contrib" id, which I suppose isn't
too bad since it's publicly exposed as a HTML anchor (or URL
component?) and unlikely to change, this also means that the
contrib documentation can't use <section> instead of <sect1>.
Sometimes I think I only know enough XSLT to get into trouble.
While v8 is "right", I can't say if it is a good idea/good practice.
Regards,
Karl <kop@karlpinc.com>
Free Software: "You don't pay back, you pay forward."
-- Robert A. Heinlein
Commits
-
Remove new <para id="contrib-obsolete">.
- 244ab8c00c42 16.0 landed
-
doc/PDF: Add page breaks for <sect1> in contrib appendix
- 30e9f2608adf 16.0 landed
-
doc: Add lists of modules trusted/obsolete
- a0137388cb64 16.0 landed
-
HTML docs: Add padding to table.simplelist for more readable output
- a7e584a7d68a 16.0 landed
-
Describe each contrib module in its SGML section title
- e86c8b728f3c 16.0 landed