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-20T19:33:46Z
Lists: pgsql-hackers
On Fri, 20 Jan 2023 20:12:03 +0100
Alvaro Herrera <alvherre@alvh.no-ip.org> wrote:
> On 2023-Jan-20, Karl O. Pinc wrote:
>
> > On Fri, 20 Jan 2023 12:42:31 +0100
> > Alvaro Herrera <alvherre@alvh.no-ip.org> wrote:
>
> > > 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.
>
> Ah well. I just put it back the way you had it.
>
> > > 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?
>
> I don't know, I was thinking that perhaps at the start of the appendix
> we could have some kind of marker that says "in this chapter, the
> <sect1>s all get a page break", then a marker to stop that at the end
> of the appendix. Or a tweak to the stylesheet, "when inside an
> appendix, all <sect1>s get a pagebreak", in a way that doesn't affect
> the other chapters.
>
> The <?hard-pagebreak?> solution looks really ugly to me (in the source
> code I mean), but I suppose if we discover no other way to do it, we
> could do it like that.
I can do a forced page break for sect1-s in the pdf stylesheet just
for the contrib appendix (appendix F) by looking for a parent
with an id of "contrib". That would work, but seems like a kludge.
(Otherwise, you look for a parent of "appendix" and force the page
break in all appendixes.)
I'll send a patch.
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