args.eclipsehelp.toc/TOCROOT not used by map2eclipse.xsl

[jelovirt]

Converted from SourceForge issue 1568130, submitted by dave_resch

The args.eclipsehelp.toc property is not used to set the name of the toc.xml file generated by map2eclipse.xsl. However, it is passed as a param (TOCROOT) to the map2plugin.xsl, so the resulting plugin.xml file refers to the toc.xml file as ${args.eclipsehelp.toc}.xml.

Thus, if you set args.eclipsehelp.toc to a non-default value, you get a plug-in that points to a non-extant toc.xml file.

[jelovirt]

Submitted by dave_resch

This defect was discovered in DITA-OT 1.3 release.

[jelovirt]

Submitted by imagiczhang

the file name for toc file doesn't follow the ditamap name instead of being defined by the parameter. This decision is made to meet the needs for multiple toc files in one eclipse plug-in. Users can ignore this deprecated parameter and prevent using it.

[jelovirt]

Submitted by dave_resch

Sorry. I do not understand you.

Do you mean that the args.eclipsehelp.toc property is deprecated?

Is there no feature that allows you to specify the name of the toc.xml file generated by DITA-OT?

[jelovirt]

Submitted by robander

This may just serve to confuse things, but my understanding of the history is that originally the TOC xml file was always named toc.xml, and the property was available to change this. We fixed the code (at least I would consider it a fix) to make the name of the XML file match the name of the input map.

Am I correct that you wish to continue to override the map name using the same old parameter, and that the parameter no longer works? You do not wish to have the name of the toc.xml file match the DITA map?

As a side note - I am not sure why the parameter was removed. We should not be removing parameters without warning, even if the function has been superseded.

[jelovirt]

Submitted by dave_resch

Yes, you are correct; I want to override the default name of the Eclipse TOC file (map_file_name.xml) generated by DITA-OT with a standard name (such as toc.xml). Indeed, the args.eclipsehelp.toc parameter does not work in DITA-OT 1.3.x. It used to work in DITA-OT 1.2.1 and earlier.

The current problem is that it "sort of" works, so the OT-generated plugin.xml file points to a TOC file name based on the value of the args.eclipsehelp.toc parameter (e.g., toc.xml), but the OT-generated TOC file is named for the ditamap, so the resulting plugin.xml is broken.

While I don't mind the default (map) file name for the Eclipse TOC file, there are occasions when I do not want to expose the actual map file name in a plug-in.

Thanks for looking at this.

[jelovirt]

Submitted by robander

I'm moving this to the feature request tracker. I agree that the ability should not have been removed in the first place, but at this point getting it to work will essentially mean implementing it from scratch as a new feature.

[raducoravu]

One of our users had the same problem.
The parameter args.eclipse.toc is used only in the "plugin.xml" to reference the TOC file but it is not used when the TOC file gets created in the target "dita.out.map.eclipse.toc" from "DITA-OT/plugins/org.dita.eclipsehelp/build_dita2eclipsehelp.xml"

[robander]

Assigning to myself to either fix or close in 2.3 - I'm not sure what still applies from this issue.

[robander]

Checking with 2.2.4 and confirmed this is still an issue. The TOC file now defaults to the name of the map, rather than to toc.xml. If you specify args.eclipsehelp.toc, the generated TOC file is unchanged, but the map references the specified value plus the .xml extension.

[robander]

Given that this has been broken since 1.3, and the updated behavior (without the parameter) is better than the old behavior, my preference is to remove the broken parameter entirely in 2.3. I don't think it is necessary to deprecate the parameter, given that it has not worked for 7 or 8 years. Instead, we should remove it, and stop passing it to map2plugin.xml; @infotexture note that this also means removing it from the docs: http://www.dita-ot.org/dev/parameters/parameters-eclipsehelp.html

[robander]

Submitted #2354 to remove the parameter - @infotexture I forgot that removing the parameter from plugin.xml would remove from the docs, so nevermind about that...