#2874 Generation Of HTML Docs Broken

[wintertime]

When using
$ ant generate-documentation
a long list of errors gets printed. I redirected it to a file so you can see them.

I tried to investigate, but the error about localize getting called wrongly feels misleading.
The stack trace points to line 193 in src/net/freecol/tools/GenerateDocumentation.java and there this is created from doc/specification.xsl .
I guess either specification.xsl is outdated/incompatible or some of the magic in the TransformerFactory is broken?

[Mike Pope]

I guess either specification.xsl is outdated...

That is almost certainly the case following some of the message key changes. Investigating now.

[Mike Pope]

OK, there are broken names that are easy to fix (git.eb73fd0), but the TransformerFactory stuff is also broken. I experimented with commenting out parts of the xsl, and established that any reference to freecol:localize causes an error. I suspect that failure of the magic that is supposed to load this function out of GenerateDocumentation is the more specific cause.

GenerateDocumentation was clearly last working in March 2013, but reverting to that point does not fix the problem. I think this means that the failure was introduced when we first started using Java7. I have no easy way to revert to Java6 ATM to check this. Googling around there is some complaint that xalan is dead, and may be incompatible, at least the way we are using it. However trying to replace xalan is beyond my immediate knowledge. I think we should just work around this for 0.11.4 if possible.

[wintertime]

I have another log done with your change, just in case it helps you.
I agree that fixing this can wait, as noone was using it since the time it broke.

[Mike Pope]

I have another log done with your change, just in case it helps you.

Alas no. Same stack trace as I am seeing.

[sinomaen]

Works for me if I add fork="true" to the java task call in generate-documentation Ant target. It also works if I run GenerateDocumentation.java directly, not by using Ant.

Generated documentation is localized, but icons are missing.

[Mike Pope]

Win! That fixed the crash for me too. Many thanks for the help, this bug was going nowhere without your intervention. Your change is git.9439bfc.

The icons are missing due to a resource naming convention change. I may know next to nothing about XSL, but I can pattern match, so this might be tractable. Looking at it now.

[Mike Pope]

The icons should be back with git.e998755. Still some other localization failures to do.

[Mike Pope]

Should be all fixed in git.804c710e. I will leave this bug open a bit longer in case someone spots an omission.

[Mike Pope]

OK, time to close.