| From: | Douglas Domingues da Silveira <douglas(at)f10(dot)com(dot)br> |
|---|---|
| To: | Marcos Pegoraro <marcos(at)f10(dot)com(dot)br> |
| Cc: | Robert Treat <rob(at)xzilla(dot)net>, Tom Lane <tgl(at)sss(dot)pgh(dot)pa(dot)us>, Peter Eisentraut <peter(at)eisentraut(dot)org>, PostgreSQL Hackers <pgsql-hackers(at)lists(dot)postgresql(dot)org> |
| Subject: | Re: Get rid of "Section.N.N.N" on DOCs |
| Date: | 2026-06-05 19:00:41 |
| Message-ID: | CACCOSt1_BgES=LpqdtbO-ryD2MTtqrsHQiRLtB7Gt4mxJ+qCdQ@mail.gmail.com |
| Views: | Whole Thread | Raw Message | Download mbox | Resend email |
| Thread: | |
| Lists: | pgsql-hackers |
I believe this is a good example where we can use AI, since the big thing
about AI is the understanding of human language.
As we need to check for hundreds of redundancy cases when replacing Section
N.N.N with the Section name, AI can make things much easier. With that in
mind, I created a small project for the AI to identify which cases would
have redundancy in the SGML files and rewrite the texts.
After doing this, with the generated HTMLs in hand, I created a file for
review, containing some columns to make the reading of what changed easier,
such as Original HTML, Rewritten HTML, and columns with the
original/rewritten SGMLs.
In addition, I also made some other replacements in the
stylessheet-html-common.xsl file for the replacements of Appendix, Tables
and Chapters.
I´m sending a patch and the review file.
Em sex., 5 de jun. de 2026 às 15:20, Marcos Pegoraro <marcos(at)f10(dot)com(dot)br>
escreveu:
> Em qua., 31 de dez. de 2025 às 21:03, Robert Treat <rob(at)xzilla(dot)net>
> escreveu:
>
>> The surrounding text already gives context as to what we will find in
>> those linked references,
>
>
> My intention here is to read and rewrite all texts that need revision, so
> the surrounding text will probably change as well. When reading documents,
> we need to open the link or hover the mouse over it to read the link to
> see that that is not what we want, before returning to reading, so it's
> quite common to get lost in the text because of this back and forth.
> Instead of
> There are currently four procedural languages available in the standard
> PostgreSQL distribution: PL/pgSQL (Chapter 41
> <https://www.postgresql.org/docs/current/plpgsql.html>), PL/Tcl (
> Chapter 42 <https://www.postgresql.org/docs/current/pltcl.html>), PL/Perl
> (Chapter 43 <https://www.postgresql.org/docs/current/plperl.html>), and
> PL/Python (PL/Python
> <https://www.postgresql.org/docs/current/plpython.html>).
> Wouldn't it be better to have a paragraph like this ?
> There are currently four procedural languages available in the standard
> PostgreSQL distribution: PL/pgSQL
> <https://www.postgresql.org/docs/current/plpgsql.html>, PL/Tcl
> <https://www.postgresql.org/docs/current/pltcl.html>, PL/Perl
> <https://www.postgresql.org/docs/current/plperl.html> and PL/Python
> <https://www.postgresql.org/docs/current/plpython.html>.
>
> So I don't care if that link is a section, a appendix, a chapter, I'm sure
> I'll go there only if I really want.
>
>
>> But the numbers do provide some subtle clues as to the relationship of
>> the
>> linked references to the page we are on AND other references within
>> that page.
>
>
> Well, if a link was written on that page, independently if it's a chapter,
> a GUC, a section, it's important for the user to know. And again, I don't
> care if I'm jumping to a distant section or chapter, it's important to
> understand entirely the page I'm reading.
>
> So, my intention here is to provide the user with continuous reading. If I
> read a paragraph with links but it's displayed as if it were in a book
> without footnotes, it gives me a much faster and easier reading experience.
> If I have to stop my reading to open other links because I don't know if
> they're important or not, or also bad ignore some words, the reading isn't
> as productive.
>
> regards
> Marcos
>
--
| Attachment | Content-Type | Size |
|---|---|---|
| xref_review.html | text/html | 3.0 MB |
| 0001-N.N.N-to-section-name.patch | application/octet-stream | 405.2 KB |
| From | Date | Subject | |
|---|---|---|---|
| Next Message | Jacob Champion | 2026-06-05 19:06:27 | Re: oauth integer overflow |
| Previous Message | Bruce Momjian | 2026-06-05 18:58:41 | Re: First draft of PG 19 release notes |