W3C home > Mailing lists > Public > public-wai-ert@w3.org > May 2009

use of <acronym> in our documents

From: Shadi Abou-Zahra <shadi@w3.org>
Date: Thu, 28 May 2009 13:42:08 +0200
Message-ID: <4A1E7890.8060509@w3.org>
To: ERT WG <public-wai-ert@w3.org>
Dear group,

During the previous teleconference call we agreed on an approach for 
using <acronym> elements in our documents. Here is the rule of thumb:

#1. Try to expand an acronym where it first occurs in a document or a 
major section. For example: "Evaluation and Report Language (EARL)..."

#2. Markup the first occurrence of an acronym in each sub-section, if it 
has not been already expanded. For example: "<acronym title="Evaluation 
and Report Language">EARL</acronym>..."

#3. Do not markup acronyms where it is already expanded. For example: 
"Evaluation and Report Language (<acronym title="Evaluation and Report 
Language">EARL</acronym>)..." is redundant and unnecessary.

#4. Do not markup secondary occurrences of acronyms, only the first 
occurrence in a section (or sub-section) should be either expanded or 
marked up. Especially, do not mark up each occurrence of an acronym in 
the same sentence or paragraph.

#5. Avoid using acronyms (expanded or marked up) in section titles if 
possible. Acronyms are typically jargon and may be uninviting to read.

#6. If the document or sections are very small (such as requirements 
document), it may not be necessary to markup or expand per section but 
rather just once for the entire document.


Hope that helps.

Regards,
   Shadi

-- 
Shadi Abou-Zahra - http://www.w3.org/People/shadi/ |
   WAI International Program Office Activity Lead   |
  W3C Evaluation & Repair Tools Working Group Chair |
Received on Thursday, 28 May 2009 11:42:39 GMT

This archive was generated by hypermail 2.2.0+W3C-0.50 : Thursday, 28 May 2009 11:42:40 GMT