Re: proposal: convert comments in documents to html comments

From: Alvaro Herrera <alvherre(at)alvh(dot)no-ip(dot)org>
To: Noboru Saito <noborusai(at)gmail(dot)com>
Cc: Peter Geoghegan <pg(at)bowt(dot)ie>, Tom Lane <tgl(at)sss(dot)pgh(dot)pa(dot)us>, Michael Paquier <michael(at)paquier(dot)xyz>, Pg Docs <pgsql-docs(at)lists(dot)postgresql(dot)org>
Subject: Re: proposal: convert comments in documents to html comments
Date: 2022-06-27 08:48:39
Message-ID: 20220627084839.5fuankjxgt6m62vv@alvherre.pgsql
Views: Raw Message | Whole Thread | Download mbox | Resend email
Thread:
Lists: pgsql-docs

On 2022-Jun-27, Noboru Saito wrote:

> > I don't have much of a clue about our docbook toolchain, beyond the
> > basics (plus I have no front-end experience). Is anybody else aware of
> > a reasonable approach to making git hashes discoverable from the html
> > release notes?
>
> If you simply want to display it with a tooltip, the attached patch
> can do that.
>
> I also attach html and css.
> Please do not expect the quality of the css,
> as it was created for the purpose of checking the operation.

I like the idea of making the commits unobtrusively visible in the
output page. This proposal looks a good step forward, but I'm sure we
can improve a little bit more. For example, can we make the SHA1 hash
for each commit be a link to the gitweb page? (Does this require
pattern matching in the XLST rule?) Also, when there's more than one
commit in one entry, it'd be better to have them on separate lines
rather than run together in a single line.

Thanks!

--
Álvaro Herrera Breisgau, Deutschland — https://www.EnterpriseDB.com/
"Linux transformó mi computadora, de una `máquina para hacer cosas',
en un aparato realmente entretenido, sobre el cual cada día aprendo
algo nuevo" (Jaime Salinas)

In response to

Responses

Browse pgsql-docs by date

  From Date Subject
Next Message Laurenz Albe 2022-06-27 08:52:19 Re: Remove recommendation for nightly VACUUM
Previous Message Magnus Hagander 2022-06-27 08:31:43 Re: Remove recommendation for nightly VACUUM