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

Xin LI delphij at FreeBSD.org
Mon Jan 2 11:05:53 UTC 2006


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.

Cheers,



More information about the freebsd-doc mailing list