pg.ddx.io  pgsql-docs@postgresql.org mailing list archive  
help / color / mirror / Atom feed
From: Peter Eisentraut <peter.eisentraut@enterprisedb.com>
To: Daniel Gustafsson <daniel@yesql.se>
To: Alvaro Herrera <alvherre@alvh.no-ip.org>
Cc: pgsql-docs <pgsql-docs@postgresql.org>
Subject: Re: some new glossary entries
Date: Thu, 4 May 2023 07:37:36 +0200
Message-ID: <0bf5c71a-ab61-b7a8-39b3-0d0f25eb7a76@enterprisedb.com> (raw)
In-Reply-To: <34953933-FD51-493A-BCBF-FED1CD1980E0@yesql.se>
References: <20230502102415.pjgo4yhwjmdhe4mc@alvherre.pgsql>
	<34953933-FD51-493A-BCBF-FED1CD1980E0@yesql.se>

On 02.05.23 12:55, Daniel Gustafsson wrote:
>> On 2 May 2023, at 12:24, Alvaro Herrera <alvherre@alvh.no-ip.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#2887978...
>> 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.






view thread (5+ messages)

Message-ID: <0bf5c71a-ab61-b7a8-39b3-0d0f25eb7a76@enterprisedb.com>
Permalink:  ../0bf5c71a-ab61-b7a8-39b3-0d0f25eb7a76@enterprisedb.com/
Also on:    postgresql.org/message-id/0bf5c71a-ab61-b7a8-39b3-0d0f25eb7a76@enterprisedb.com

 · 

reply

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Reply to all the recipients using the --to and --cc options:
  reply via email

  To: pgsql-docs@postgresql.org
  Cc: peter.eisentraut@enterprisedb.com, daniel@yesql.se, alvherre@alvh.no-ip.org
  Subject: Re: some new glossary entries
  In-Reply-To: <0bf5c71a-ab61-b7a8-39b3-0d0f25eb7a76@enterprisedb.com>

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

This inbox is served by DDX for PostgreSQL; see mirroring instructions
for how to clone and mirror all data and code used for this inbox