Re: Doc: Rework contrib appendix -- informative titles, tweaked sentences

From: "Karl O(dot) Pinc" <kop(at)karlpinc(dot)com>
To: Alvaro Herrera <alvherre(at)alvh(dot)no-ip(dot)org>
Cc: PostgreSQL Hackers <pgsql-hackers(at)lists(dot)postgresql(dot)org>
Subject: Re: Doc: Rework contrib appendix -- informative titles, tweaked sentences
Date: 2023-01-20 12:26:00
Message-ID: 20230120062600.690e80ea@slate.karlpinc.com
Views: Raw Message | Whole Thread | Download mbox | Resend email
Thread:
Lists: pgsql-hackers pgsql-www

On Fri, 20 Jan 2023 12:42:31 +0100
Alvaro Herrera <alvherre(at)alvh(dot)no-ip(dot)org> wrote:

> On 2023-Jan-19, Karl O. Pinc wrote:
>
> > On Thu, 19 Jan 2023 11:03:53 -0600
> > "Karl O. Pinc" <kop(at)karlpinc(dot)com> wrote:
> >
> > > Attached are 2 patches, a regular and a delta from your v4 review:
> > >
> > > contrib_v5-delta.patch.txt
> > > contrib_v5.patch.txt
> >
> > I left your appendix title unchanged: "Additional Supplied
> > Extensions and Modules".
> >
> > I had put "Extensions" after
> > "Modules", because, apparently, things that come last in the
> > sentence are most remembered by the reader. My impression is that
> > more people are looking for extensions than modules.
>
> Hmm, I didn't know that. I guess I can put it back. My own instinct
> is to put the most important stuff first, not last, but if research
> says to do otherwise, fine, let's do that.

A quick google on the subject tells me that I can't figure out a good
quick google. I believe it's from the book at bottom. Memorability
goes "end", "beginning", "middle". IIRC.

> I went over all the titles again. There were a couple of mistakes
> and inconsistencies, which I've fixed to the best of my knowledge.
> I'm happy with 0001 now and will push shortly unless there are
> complaints.
>
> I'm still unsure of the [trusted]/[obsolete] marker, so I split that
> out to commit 0002. I would like to see more support for that before
> pushing that one.
>
> I also put the page-split bits to another page, because it seems a bit
> too clumsy.

All the above sounds good to me.

> I hope somebody with more docbook-fu can comment: maybe
> there's a way to fix it more generally somehow?

What would the general solution be? There could be a forced page
break at the beginning of _every_ sect1. For PDFs. That seems
a bit much, but maybe not. The only other thing I can think of
that's "general" would be to force a page break for sect1-s
that are in an appendix. Is any of this wanted? (Or technically
"better"?)

Thanks for the help.

----

Writing for Readers
By George R. Bramer, Dorothy Sedley · 1981

About this edition
ISBN:9780675080453, 0675080452
Page count:532
Published:1981
Format:Hardcover
Publisher:C.E. Merrill Publishing Company
Original from:Pennsylvania State University
Digitized:July 15, 2009
Language:English
Author:George R. Bramer, Dorothy Sedley

It's part of a wave of reaction against Strunk & White,
where they started basing writing on research into reading.
(If it's the right book.)

Regards,

Karl <kop(at)karlpinc(dot)com>
Free Software: "You don't pay back, you pay forward."
-- Robert A. Heinlein

In response to

Responses

Browse pgsql-hackers by date

  From Date Subject
Next Message Marco Slot 2023-01-20 12:35:51 Re: [PATCH] Use indexes on the subscriber when REPLICA IDENTITY is full on the publisher
Previous Message Alvaro Herrera 2023-01-20 11:42:31 Re: Doc: Rework contrib appendix -- informative titles, tweaked sentences

Browse pgsql-www by date

  From Date Subject
Next Message Alvaro Herrera 2023-01-20 19:12:03 Re: Doc: Rework contrib appendix -- informative titles, tweaked sentences
Previous Message Alvaro Herrera 2023-01-20 11:42:31 Re: Doc: Rework contrib appendix -- informative titles, tweaked sentences