From: Thomas Pundt <mlists@rp-online.de>
To: Alban Hertroys <a.hertroys@magproductions.nl>
Cc: Steve Crawford <scrawford@pinpointresearch.com>
Cc: Alvaro Herrera <alvherre@commandprompt.com>
Cc: pgsql-general@postgresql.org
Subject: Re: Abbreviation list
Date: Fri, 19 Oct 2007 13:19:45 +0200
Message-ID: <471892D1.4000507@rp-online.de> (raw)
In-Reply-To: <471889D4.5010500@magproductions.nl>
References: <4717AC13.5010609@pinpointresearch.com>
<20071018191047.GN29379@alvh.no-ip.org>
<4717F038.1060709@pinpointresearch.com>
<471889D4.5010500@magproductions.nl>
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.pundt@rp-online.de> ---- http://rp-online.de/ ----
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: mlists@rp-online.de, a.hertroys@magproductions.nl, scrawford@pinpointresearch.com, alvherre@commandprompt.com, pgsql-general@postgresql.org
Subject: Re: Abbreviation list
In-Reply-To: <471892D1.4000507@rp-online.de>
* 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