Lists: | pgsql-docs |
---|
From: | Peter Eisentraut <peter(dot)eisentraut(at)enterprisedb(dot)com> |
---|---|
To: | pgsql-docs <pgsql-docs(at)postgresql(dot)org> |
Subject: | some new glossary entries |
Date: | 2023-05-02 07:05:37 |
Message-ID: | [email protected] |
Views: | Whole Thread | Raw Message | Download mbox | Resend email |
Lists: | pgsql-docs |
I wrote glossary entries for some terms I wanted to look up there but
didn't find: "restartpoint" and "LSN". I put this together based on
existing text. "LSN" was already in the acronyms list but I think it's
more appropriate in the glossary, so I moved things around a bit.
Attachment | Content-Type | Size |
---|---|---|
0001-doc-New-glossary-entry-Restartpoint.patch | text/plain | 1.1 KB |
0002-doc-New-glossary-entry-Log-sequence-number.patch | text/plain | 2.7 KB |
From: | Daniel Gustafsson <daniel(at)yesql(dot)se> |
---|---|
To: | Peter Eisentraut <peter(dot)eisentraut(at)enterprisedb(dot)com> |
Cc: | pgsql-docs <pgsql-docs(at)postgresql(dot)org> |
Subject: | Re: some new glossary entries |
Date: | 2023-05-02 10:06:08 |
Message-ID: | [email protected] |
Views: | Whole Thread | Raw Message | Download mbox | Resend email |
Lists: | pgsql-docs |
> On 2 May 2023, at 09:05, Peter Eisentraut <peter(dot)eisentraut(at)enterprisedb(dot)com> wrote:
>
> I wrote glossary entries for some terms I wanted to look up there but didn't find: "restartpoint" and "LSN". I put this together based on existing text. "LSN" was already in the acronyms list but I think it's more appropriate in the glossary, so I moved things around a bit.
+1 LGTM.
+ <glossentry id="glossary-lsn">
+ <glossterm>LSN</glossterm>
+ <glosssee otherterm="glossary-log-sequence-number"/>
+ </glossentry>
The other <glosssee otherterm="foo" /> entries doesn't have a glossentry id
attribute set, is the use here related to the glossentry.show.acronym param?
--
Daniel Gustafsson
From: | Alvaro Herrera <alvherre(at)alvh(dot)no-ip(dot)org> |
---|---|
To: | Daniel Gustafsson <daniel(at)yesql(dot)se> |
Cc: | Peter Eisentraut <peter(dot)eisentraut(at)enterprisedb(dot)com>, pgsql-docs <pgsql-docs(at)postgresql(dot)org> |
Subject: | Re: some new glossary entries |
Date: | 2023-05-02 10:24:15 |
Message-ID: | [email protected] |
Views: | Whole Thread | Raw Message | Download mbox | Resend email |
Lists: | pgsql-docs |
On 2023-May-02, Daniel Gustafsson wrote:
> + <glossentry id="glossary-lsn">
> + <glossterm>LSN</glossterm>
> + <glosssee otherterm="glossary-log-sequence-number"/>
> + </glossentry>
>
> The other <glosssee otherterm="foo" /> entries doesn't have a glossentry id
> attribute set, is the use here related to the glossentry.show.acronym param?
I debated with myself for 347d2b07fcc2 on whether to add id attribs to
<glosssee> entries. The only saving grace for doing that is that you
can link to such entries; but if you do that, you're only causing the
user one more click in order to see the definition they want to see. So
in the end I decided not make the glosssee's directly referenceable.
And I think this new entry shouldn't have an id either.
I think that what glossentry.show.acronym allows is to show the
<acronym> text that's part of the main entry:
https://stackoverflow.com/questions/28869578/docbook-5-rendering-without-abbrev-tag/28879785#28879785
so the fact that there's an id in the other entry doesn't change
anything.
If we do turn glossentry.show.acronym on (and I don't see any reason not
to), we can follow up later to add <acronym> and <abbrev> tags to other
entries, too.
--
Álvaro Herrera Breisgau, Deutschland — https://www.EnterpriseDB.com/
"I'm always right, but sometimes I'm more right than other times."
(Linus Torvalds)
https://lore.kernel.org/git/Pine(dot)LNX(dot)4(dot)58(dot)0504150753440(dot)7211(at)ppc970(dot)osdl(dot)org/
From: | Daniel Gustafsson <daniel(at)yesql(dot)se> |
---|---|
To: | Alvaro Herrera <alvherre(at)alvh(dot)no-ip(dot)org> |
Cc: | Peter Eisentraut <peter(dot)eisentraut(at)enterprisedb(dot)com>, pgsql-docs <pgsql-docs(at)postgresql(dot)org> |
Subject: | Re: some new glossary entries |
Date: | 2023-05-02 10:55:16 |
Message-ID: | [email protected] |
Views: | Whole Thread | Raw Message | Download mbox | Resend email |
Lists: | pgsql-docs |
> On 2 May 2023, at 12:24, Alvaro Herrera <alvherre(at)alvh(dot)no-ip(dot)org> wrote:
>
> On 2023-May-02, Daniel Gustafsson wrote:
>
>> + <glossentry id="glossary-lsn">
>> + <glossterm>LSN</glossterm>
>> + <glosssee otherterm="glossary-log-sequence-number"/>
>> + </glossentry>
>>
>> The other <glosssee otherterm="foo" /> entries doesn't have a glossentry id
>> attribute set, is the use here related to the glossentry.show.acronym param?
>
> I debated with myself for 347d2b07fcc2 on whether to add id attribs to
> <glosssee> entries. The only saving grace for doing that is that you
> can link to such entries; but if you do that, you're only causing the
> user one more click in order to see the definition they want to see. So
> in the end I decided not make the glosssee's directly referenceable.
> And I think this new entry shouldn't have an id either.
Agreed, that makes sense.
> I think that what glossentry.show.acronym allows is to show the
> <acronym> text that's part of the main entry:
> https://stackoverflow.com/questions/28869578/docbook-5-rendering-without-abbrev-tag/28879785#28879785
> so the fact that there's an id in the other entry doesn't change
> anything.
>
> If we do turn glossentry.show.acronym on (and I don't see any reason not
> to), we can follow up later to add <acronym> and <abbrev> tags to other
> entries, too.
+1
--
Daniel Gustafsson
From: | Peter Eisentraut <peter(dot)eisentraut(at)enterprisedb(dot)com> |
---|---|
To: | Daniel Gustafsson <daniel(at)yesql(dot)se>, Alvaro Herrera <alvherre(at)alvh(dot)no-ip(dot)org> |
Cc: | pgsql-docs <pgsql-docs(at)postgresql(dot)org> |
Subject: | Re: some new glossary entries |
Date: | 2023-05-04 05:37:36 |
Message-ID: | [email protected] |
Views: | Whole Thread | Raw Message | Download mbox | Resend email |
Lists: | pgsql-docs |
On 02.05.23 12:55, Daniel Gustafsson wrote:
>> On 2 May 2023, at 12:24, Alvaro Herrera <alvherre(at)alvh(dot)no-ip(dot)org> wrote:
>>
>> On 2023-May-02, Daniel Gustafsson wrote:
>>
>>> + <glossentry id="glossary-lsn">
>>> + <glossterm>LSN</glossterm>
>>> + <glosssee otherterm="glossary-log-sequence-number"/>
>>> + </glossentry>
>>>
>>> The other <glosssee otherterm="foo" /> entries doesn't have a glossentry id
>>> attribute set, is the use here related to the glossentry.show.acronym param?
>>
>> I debated with myself for 347d2b07fcc2 on whether to add id attribs to
>> <glosssee> entries. The only saving grace for doing that is that you
>> can link to such entries; but if you do that, you're only causing the
>> user one more click in order to see the definition they want to see. So
>> in the end I decided not make the glosssee's directly referenceable.
>> And I think this new entry shouldn't have an id either.
>
> Agreed, that makes sense.
>
>> I think that what glossentry.show.acronym allows is to show the
>> <acronym> text that's part of the main entry:
>> https://stackoverflow.com/questions/28869578/docbook-5-rendering-without-abbrev-tag/28879785#28879785
>> so the fact that there's an id in the other entry doesn't change
>> anything.
>>
>> If we do turn glossentry.show.acronym on (and I don't see any reason not
>> to), we can follow up later to add <acronym> and <abbrev> tags to other
>> entries, too.
>
> +1
Committed with the recommended changes.