Re: Abbreviation list

From: Thomas Pundt <mlists(at)rp-online(dot)de>
To: Alban Hertroys <a(dot)hertroys(at)magproductions(dot)nl>
Cc: Steve Crawford <scrawford(at)pinpointresearch(dot)com>, Alvaro Herrera <alvherre(at)commandprompt(dot)com>, pgsql-general(at)postgresql(dot)org
Subject: Re: Abbreviation list
Date: 2007-10-19 11:19:45
Message-ID: 471892D1.4000507@rp-online.de
Views: Raw Message | Whole Thread | Download mbox | Resend email
Thread:
Lists: pgsql-docs pgsql-general

Alban Hertroys schrieb:
> Steve Crawford wrote:
>> My vote is to add "Appendix I. Abbreviations". Don't know if it's
>> practical for 8.3 documentation but it would be nice to add even if it
>> only has a few entries as additional ones could be collected via the
>> user notes.
>>
>> I suggest as a discussion starting-point the following inclusion criteria:
>>
>> 1. Any abbreviation/acronym that appears in the PostgreSQL documentation
>> (even if those terms may not be PG specific - we shouldn't assume that
>> everyone knows them). Good documentation practice recommends defining
>> abbreviations the first time they are used. Better still, ensure that
>> they are in the abbreviation list.
>
> Isn't this just what the ABBR tag in html is for?

Well, yes; according w3.org its purpose is to describe the
abbreviation/acronym inline in a document using a title attribute:

<acronym title="Grand Unified Configuration">GUC</acronym>

Firefox by default underlines the abbreviation with a dotted line and
displays the title when leaving the cursor on it. In a way this means
probably defining the abbreviation.

Reference: http://www.w3.org/TR/html401/struct/text.html#edef-ABBR

--
Thomas Pundt <thomas(dot)pundt(at)rp-online(dot)de> ---- http://rp-online.de/ ----

In response to

Responses

Browse pgsql-docs by date

  From Date Subject
Next Message Alvaro Herrera 2007-10-19 13:59:20 Re: Abbreviation list
Previous Message Alban Hertroys 2007-10-19 10:41:24 Re: Abbreviation list

Browse pgsql-general by date

  From Date Subject
Next Message Ciprian Dorin Craciun 2007-10-19 11:45:00 Re: Stalled post to pgsql-bugs
Previous Message Pavel Stehule 2007-10-19 10:52:07 Re: Stalled post to pgsql-bugs