Horton

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

Jonathan S. Katz <jkatz@postgresql.org>

View thread View on postgr.es
From: "Jonathan S. Katz" <jkatz@postgresql.org>
To: Alvaro Herrera <alvherre@alvh.no-ip.org>, "Karl O. Pinc" <kop@karlpinc.com>
Cc: w^3 <pgsql-www@lists.postgresql.org>, Greg Stark <stark@mit.edu>, "Gregory Stark (as CFM)" <stark.cfm@gmail.com>, Daniel Gustafsson <daniel@yesql.se>
Date: 2023-03-29T17:17:33Z
Lists: pgsql-hackers 
On 3/23/23 5:45 AM, Alvaro Herrera wrote:
> On 2023-Mar-22, Karl O. Pinc wrote:
> 
>> Hi,
>>
>> I rebuilt the HEAD (master) html with:
>>
>>    make STYLE=website html
>>
>> and what I see locally is still different from
>> what is on postgresql.org.
>>
>> So the build system does indeed seem to be generating
>> "different html" that looks un-good compared to what
>> Alvaro and I are seeing when we build locally.
> 
> Hah, you're right -- the website is missing the closing </p>.  Weird.
> It is definitely possible that the website is using outdated XSLT
> stylesheets.  For example, at the top of the page in my local build I
> see this:
> 
> <?xml version="1.0" encoding="UTF-8" standalone="no"?>
> <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"><html xmlns="http://www.w3.org/1999/xhtml"><head>
> 
> whereas the website only says
> 
> <!doctype html>
> <html lang="en">
>   <head>

The above doctype correct for the web. That's the HTML5 doctype tag.

I haven't gone through the the doc loading process in awhile, but what 
happens is that the docs build with the HTML generated (make html) and 
then are processed and "uploaded" to the website through this code[1]. 
It's possible that somewhere in the "HTML tidy" process something may be 
removed.

Looking at the current state of the contrib page, I'm not sure what the 
rendering is that you expect. I can see us adding more margin to the 
bottom of the table as that looks close together, but I'm not sure I 
understand what other issues there are?

Jonathan

[1] 
https://git.postgresql.org/gitweb/?p=pgweb.git;a=blob;f=tools/docs/docload.py;hb=HEAD

Commits

  1. Remove new <para id="contrib-obsolete">.

  2. doc/PDF: Add page breaks for <sect1> in contrib appendix

  3. doc: Add lists of modules trusted/obsolete

  4. HTML docs: Add padding to table.simplelist for more readable output

  5. Describe each contrib module in its SGML section title