Page 1 of 1
Topics from one help system are being included in the output for another help system
Posted: Thu Nov 28, 2024 7:47 am
by gchale3rd
I have a single project that includes multiple help systems (for example, help system A, help system B, and so forth). In the project, the files for each help system are stored in separate folders. Each help system also has its own DITA map.
When I run the transformation scenario for help system A, the output also includes some topics from help system B. I don't want the topics from help system B included in the output for help system A; however, I can't figure out how the topics from help system B are being included in the output for help system A.
I have tried using the Show Referenced Resources and Show Dependent Resources functions on the DITA map for help system A, but neither function shows any links between the two help systems.
The only thing common between the topics in help systems A and B are that some topics pull, via conrefs, variables (such as product and company name) from a shared collection file.
Does anyone have any suggestions for determining how the topics in help system B are being included in the output for help system A and how I can prevent the topics in help system B from being included in the output for help system A?
Re: Topics from one help system are being included in the output for another help system
Posted: Thu Nov 28, 2024 1:40 pm
by Radu
Hi,
In such cases in general I would open a top level DITA Map in the Oxygen DITA Maps Manager view, click the "Validate and check for completeness" toolbar action there and there is a checkbox "Report references to resources outside of the DITA Maps folder", check it and then run the validation, see what external project links you find. I suspect there is something related to those reusable content topics, maybe in those topics there are links to various topics from various projects and the DITA OT might go deep through the entire reusable topic file and follow those links as well. So maybe you can split reusable topic resources in multiple reusable topics to avoid this.
Regards,
Radu
Re: Topics from one help system are being included in the output for another help system
Posted: Tue Dec 03, 2024 5:34 am
by gchale3rd
As you suggested, I ran the
Validate and check for completeness action on the parent (top level) map for Help System B. The results show several instances of unreferenced resources of collection files used in Help System A. Here is an example of one such instance in the results:
Code: Select all
System ID: C:\Availity\repositories\clp-content\source\portal_providers\eligibility_benefits\field_level_topics\_common\c_coll_271_fields.dita
Engine name: oXygen
Severity: warning
Problem ID: dmv.not.used.reusable.component
Description: Unreferenced reusable element: p[@id='271_authorization_column'].
Type: Unreferenced resource
Start location: 79:3
End location: 79:36
System ID: C:\Availity\repositories\clp-content\source\portal_providers\eligibility_benefits\field_level_topics\_common\c_coll_271_fields.dita
Engine name: oXygen
Severity: warning
Problem ID: dmv.not.used.reusable.component
Description: Unreferenced reusable element: p[@id='271_benefit_deductible_column'].
Type: Unreferenced resource
Start location: 26:3
End location: 26:41
System ID: C:\Availity\repositories\clp-content\source\portal_providers\eligibility_benefits\field_level_topics\_common\c_coll_271_fields.dita
Engine name: oXygen
Severity: warning
Problem ID: dmv.not.used.reusable.component
Description: Unreferenced reusable element: p[@id='benefit_deductible_note'].
Type: Unreferenced resource
Start location: 66:3
End location: 66:35
System ID: C:\Availity\repositories\clp-content\source\portal_providers\eligibility_benefits\field_level_topics\_common\c_coll_271_fields.dita
Engine name: oXygen
Severity: warning
Problem ID: dmv.not.used.reusable.component
Description: Unreferenced reusable element: resourceid[@id='f660790b-27dc-4adb-ac0a-1b5a636231a6'].
Type: Unreferenced resource
Start location: 22:3
End location: 22:58
System ID: C:\Availity\repositories\clp-content\source\portal_providers\eligibility_benefits\field_level_topics\_common\c_coll_271_fields.dita
Engine name: oXygen
Severity: warning
Problem ID: dmv.not.used.reusable.component
Description: Unreferenced reusable element: p[@id='271_limitations_column'].
Type: Unreferenced resource
Start location: 71:3
End location: 71:34
The collection files contain chunks of reusable content that we pull into topics in Help System A via conrefs. In the example above, the collection file named
c_coll_271_fields.dita contains five chunks of reusable content (four chunks contained in <p> elements and one chunk contained in a <ul> element) that are referenced (via conrefs) in topics in Help System A.
However, I cannot find any topics in Help System B that use conrefs to pull content from the same collection file. Furthermore, none of the topics in Help System A that pull reusable content from the collection file are referenced in Help System B. And yet these five chunks of reusable content show up as unreferenced resources when I run the
Validate and check for completeness action.
Re: Topics from one help system are being included in the output for another help system
Posted: Wed Dec 04, 2024 11:40 am
by Radu
Hi,
Not sure, as I do not have access to some samples to test on my side it's hard to understand your entire project's architecture.
The fact that the "Validate and check for completness" reports certain elements should probably not be the cause of the fact that the publishing includes more resources than it should.
I suspect that certain bugs in the publishing engine may contribute to the problem that you are experiencing:
https://github.com/dita-ot/dita-ot/issues/3692
If you can create a cut down sample project on which the problem can be reproduced maybe you can zip it and send it to us along with steps to reproduce the problem:
https://www.oxygenxml.com/techSupport.html
Regards,
Radu