W3C home > Mailing lists > Public > www-i18n-comments@w3.org > February 2004

[i18n-html-tech] Some editorial comments

From: Bjoern Hoehrmann <derhoermi@gmx.net>
Date: Wed, 25 Feb 2004 06:03:06 +0100
To: www-i18n-comments@w3.org
Message-ID: <406227f4.202132811@smtp.bjoern.hoehrmann.de>


  Some quick editorial notes on <http://www.w3.org/TR/i18n-html-tech/>:

Sound authoritative!

  Phrases like "According to the HTML specification ..." leave some
  doubt whether the statement holds true in practise, the document
  should rather just tell the facts and if considered useful add a
  reference to the relevant section in the specification, like (see
  <a>Section Foo in the Bar specification</a>).

No ampersands!

  Headings like "Document structure & metadata" look odd, use "and"
  unless you really refer to the & character (like in XML character

Use meaningful anchors!

  To simplify linking the document anchors should be short, easy to
  memorize and access. Rather than


  It should be e.g.


  It would be helpful if there was some link close to the guideline
  to figure out the anchor of the current section or copy and paste
  a link to it. For example each guideline could be a link to itself,

    <a id='use-unicode' href='#use-unicode'>Choose UTF-8 or another
    Unicode encoding for all content.</a>

  The style sheet does not need to expose that it is a link, it is
  just a means for more experienced readers that likely want to point
  to the document in Usenet/Mail/Irc/etc. discussions.

Received on Wednesday, 25 February 2004 00:03:03 UTC

This archive was generated by hypermail 2.3.1 : Tuesday, 6 January 2015 20:20:14 UTC