Hi Lou,

Good news. After some time prodding and experimenting, I think the best way to do this without
breaking the world is in our xsl templates.

The filename is currently keying on the id attribute in the parent property of the class. Changing js2doc to emit a different id didn't work out very well, the for js2doc to work as currently designed, the id needs to be predictable based on the original type name. Changing that would need some more js2doc hacking and perhaps lots of lfc changes.

Anyway, there is a docbook processing instruction that leaves the ids intact and allows us to control the output file name separately, and we can generate that processing instruction in the xsl. That only breaks a few things, and I'm in the middle of fixing them.

I don't expect I'll be finished before I'm out for a long weekend, so it should be sometime Tues or Wed next week before I have something for review. I can't publish a partial fix since it will break the build (one of the things broken is the toc.xml/ classes.xml/tags.xml
generation and checking).

- Don

On Sep 7, 2008, at 9:57 AM, Lou Iorio wrote:


On Sep 3, 2008, at 10:13 AM, Donald Anderson wrote:

Does that do the trick?

It only solves a small part of the problem, since a class name may be inside a <code> or <literal> tag, and it might have no markup at all (or markup I don't know about). Also, the reference
may be to a class method, like LzClass.method().

It would be much easier if the file names matched the class and tag names, for example, lz.BrowserService would be in lz.BrowserService.html instead of LzBrowserService.html.

I'm not clever enough to figure out how the file names are constructed, but I suspect it's part of the JS2Doc process (JS2Doc.java perhaps?). Also, whatever is generating, for example, this:

<div class="refentry" lang="en"><a name="LzBrowserService"></a><div class="titlepage"></div>

in the HTML would need to change.

This change would make a global search and replace possible, and wouldn't break any links. Without this change, I need to go through all the .lzs and .lzx files and deal with each occurrence of Lz[a-zA-Z0-9] one at a time. I suspect this process would take weeks, and be highly error prone, but I also have no idea how much work it is to change the file names
and ids.

Lou


--

Don Anderson
Java/C/C++, Berkeley DB, systems consultant

voice: 617-547-7881
email: [EMAIL PROTECTED]
www: http://www.ddanderson.com



Reply via email to