RE: Question: Do we have a rule to use "PostgreSQL" and "<productname>PostgreSQL</productname>" separately?

From: "Hayato Kuroda (Fujitsu)" <kuroda(dot)hayato(at)fujitsu(dot)com>
To: 'Daniel Gustafsson' <daniel(at)yesql(dot)se>, Tom Lane <tgl(at)sss(dot)pgh(dot)pa(dot)us>
Cc: PostgreSQL Hackers <pgsql-hackers(at)postgresql(dot)org>
Subject: RE: Question: Do we have a rule to use "PostgreSQL" and "<productname>PostgreSQL</productname>" separately?
Date: 2023-03-22 03:19:11
Message-ID: TYAPR01MB58667A7C8317E267467CC599F5869@TYAPR01MB5866.jpnprd01.prod.outlook.com
Views: Raw Message | Whole Thread | Download mbox | Resend email
Thread:
Lists: pgsql-hackers

Dear Daniel, Tom,

> > On 20 Mar 2023, at 15:31, Tom Lane <tgl(at)sss(dot)pgh(dot)pa(dot)us> wrote:
> >
> > "Hayato Kuroda (Fujitsu)" <kuroda(dot)hayato(at)fujitsu(dot)com> writes:
> >> While checking documentations, I found that one line notes our product as
> >> "<productname>PostgreSQL</productname>", whereas another line notes
> as just
> >> "PostgreSQL".
> >
> > IMO the convention is to use the <productname> tag everywhere that we
> > spell out "PostgreSQL". I don't think it's actually rendered differently
> > with our current stylesheets, but maybe someday it will be.
>
> IIRC the main use in DocBook is for automatically decorating productnames with
> trademark signs etc, and to generate lists of trademarks, but also that they
> can be rendered differently.

OK, I understood that even if the string is not rendered, that should be tagged as <productname>.

> IIRC the main use in DocBook is for automatically decorating productnames with
> trademark signs etc, and to generate lists of trademarks, but also that they
> can be rendered differently.
>
> This reminded me that I was planning to apply the below to make the markup of
> PostgreSQL consistent:

I have also grepped to detect another wrong markups, and I think at least
"<entry>PostgreSQL</entry>" should be changed. PSA the patch.

```
$ grep -rI \>PostgreSQL\< | grep -v productname
config.sgml: the log. The default is <literal>PostgreSQL</literal>.
func.sgml: <returnvalue>PostgreSQL</returnvalue>
func.sgml: <entry>PostgreSQL</entry>
runtime.sgml: event source named <literal>PostgreSQL</literal>.
problems.sgml: The software package in total is called <quote>PostgreSQL</quote>,
ref/pg_ctl-ref.sgml: default is <literal>PostgreSQL</literal>. Note that this only controls
ref/pg_ctl-ref.sgml: source name <literal>PostgreSQL</literal>.
ref/pg_ctl-ref.sgml: The default is <literal>PostgreSQL</literal>.
```

Best Regards,
Hayato Kuroda
FUJITSU LIMITED

Attachment Content-Type Size
fix_inconsistent_tag.patch application/octet-stream 436 bytes

In response to

Responses

Browse pgsql-hackers by date

  From Date Subject
Next Message Gregory Stark (as CFM) 2023-03-22 03:29:12 Re: [PATCH] Optional OR REPLACE in CREATE OPERATOR statement
Previous Message Gregory Stark (as CFM) 2023-03-22 03:14:07 Re: Raising the SCRAM iteration count