[Ndoc-users]   causes broken output in some cultures

[Atsushi E. <at...@xi...>]

Hi there,

(I once sent this message to ex-contributor, turned out it was quite
a while ago, so I'm resending it here this time.)

I heard from some Japanese guys that there is a fork project for NDoc
(NDoc-ja). http://sourceforge.jp/projects/ndoc-jp/
Looks like the purpose of that project not localization but
globalization. I was curious, so I asked people why they needed
Japanese version since extra fork does not sound good.

Then someone told me that NDoc MSDN2Documenter never works fine
because of   ( ) which does not have a corresponding
character in Shift_JIS encoding (it escaped   into 0x3F'?').

So, current ndoc approach does not look fine.

That ndoc-ja version has such a hack in Msdn2Documenter.cs like:

	private void TransformAndWriteResult(
		string transformName,
		XsltArgumentList arguments,
		string filename)
	{

	<snip>

	using (streamWriter =  new StreamWriter(
		File.Open(Path.Combine(workspace.WorkingDirectory, filename),
FileMode.Create),
		currentFileEncoding))
	{
		//
		// Cannot convert &#160; to Shift_JIS code!!!!
		//
		string html = stringWriter.ToString().Replace("\xA0", "&nbsp;");
			streamWriter.Write(html);
	}

This problem could be solved by

	- avoiding that character (I dunno why it is used; &#32;
	  would be fine), or
	- using UTF-8 (dunno if it is OK for MS help format), or
	- writing custom output-escaping XmlWriter.

I'm not familiar with the .chm requirements, so I don't know which
will work or not. If first two approaches does not sound fine, I'll
hack such XmlWriter for it, so let me know (I'm not a fan of this
approach because it just avoids the real problem and also not
perfect for performance) but such change would be minimum for
current code basis).

Atsushi Eno