[PATCH FOR REVIEW] doc/en_US.ISO8859-1/books SGML cleanup

[Simon L. Nielsen]

On 2006.01.02 11:05:53 +0000, Xin LI wrote:
> Hi, Simon,
> 
> On Mon, Jan 02, 2006 at 11:56:48AM +0100, Simon L. Nielsen wrote:
> > > 	http://people.freebsd.org/~delphij/for_review/patch-books
> > > 
> > > Look appropriate?  The primary change is to escape >, <, and &, plus
> > > adding some "'s for attributes.
> > 
> > I haven't done a complete review but, you replaced some text with
> > entities which aren't needed, since the document is ISO8859-1 so
> > e.g. a "?" (AKA ø) is perfectly valid.  E.g.
> > 
> > - * Converted to 5.X by S?ren (Xride) Straarup
> > + * Converted to 5.X by Søren (Xride) Straarup
> 
> I agree, but since our documentation is going to be translated into
> various languages, I would suggest that we always escape these
> characters, for the master (English) edition, which will make our
> (especially Chinese, Japanese and Korean translation teams) life a lot
> easier, because these characters would be misinterpreted to unreadable
> stuff by poorly written editors, and we do not need to re-escape
> these in translated versions, thus avoids mistakes.

OK, I hadn't thought about that.  Since there is a valid reason for
using the entities it's fine with me.

-- 
Simon L. Nielsen
-------------- next part --------------
A non-text attachment was scrubbed...
Name: not available
Type: application/pgp-signature
Size: 187 bytes
Desc: not available
URL: <http://lists.freebsd.org/pipermail/freebsd-doc/attachments/20060102/7042cb18/attachment.sig>