Questions about validation of reused topics in different keyscopes
Post here questions and problems related to editing and publishing DITA content.
-
- Posts: 818
- Joined: Thu May 02, 2019 2:32 pm
Questions about validation of reused topics in different keyscopes
Post by chrispitude »
We have a large WebHelp map that contains multiple books. Each book has its own keyscope. Some content is reused within multiple books, which also means the content is reused in multiple keyscope contexts.
In the following example, "Book4 good" and "Book4 bad" both include a shared topic file:
The shared topic file has a cross-book link to a "bookX" topic. "Book4 good" declares "bookX" as a peer map, and so the cross-book link is good. "Book 4bad" does not declare "bookX", and so the cross-book link is bad.
When I run Validate and Check for Completeness, I get:
Some questions I have are:
Here's the testcase:
In the following example, "Book4 good" and "Book4 bad" both include a shared topic file:
- image.png (18.83 KiB) Viewed 322 times
The shared topic file has a cross-book link to a "bookX" topic. "Book4 good" declares "bookX" as a peer map, and so the cross-book link is good. "Book 4bad" does not declare "bookX", and so the cross-book link is bad.
When I run Validate and Check for Completeness, I get:
- image.png (9.44 KiB) Viewed 322 times
Some questions I have are:
- Why do I get two validation failures for the same "Book 4bad" topic instance?
- When I double-click the validation error, it opens the topic but the reference is not highlighted in the editing window as unresolved. Is this expected?
- If I manually open the "Book 4bad" instance of the shared topic, still the reference is not shown as unresolved. For a multiple-instance topic, does Oxygen always display the topic with its first map-instance context applied?
Here's the testcase:
- oxygen_validation_keyscopes.zip
- (6.7 KiB) Downloaded 17 times
Re: Questions about validation of reused topics in different keyscopes
Hi Chris,
I do not think I can provide an immediate answer for this, I added an internal issue to look into this case:
EXM-52134 Investigate validate and check for completeness behaviors
Some hunches related to your questions:
Regards,
Radu
I do not think I can provide an immediate answer for this, I added an internal issue to look into this case:
EXM-52134 Investigate validate and check for completeness behaviors
Some hunches related to your questions:
I think that when validating Oxygen reaches this topic through two different paths and considers the topic to somehow be reachable through different key scopes and thus parses it twice. If you right click an error in the "Errors" list and choose "Show message", Oxygen will show a "Reference stack" showing through which path it reached the topic. Sometimes this helps when debugging a problem. I suspect it's related to the fact that you define the "book4bad" keyscope both on the map reference and on the <map> element itself, so it looks like a bug on our side.Why do I get two validation failures for the same "Book 4bad" topic instance?
The validation of a topic may not be done as accurately when it's validated on its own, so I think that when validating a single topic in certain cases we are more lenient and may resolve a keyref although we shouldn't, again, I will look into this.When I double-click the validation error, it opens the topic but the reference is not highlighted in the editing window as unresolved. Is this expected?
If I manually open the "Book 4bad" instance of the shared topic, still the reference is not shown as unresolved. For a multiple-instance topic, does Oxygen always display the topic with its first map-instance context applied?
Regards,
Radu
Radu Coravu
<oXygen/> XML Editor
http://www.oxygenxml.com
<oXygen/> XML Editor
http://www.oxygenxml.com
-
- Posts: 818
- Joined: Thu May 02, 2019 2:32 pm
Re: Questions about validation of reused topics in different keyscopes
Post by chrispitude »
Fantastic, thanks Radu!
Return to “DITA (Editing and Publishing DITA Content)”
Jump to
- Oxygen XML Editor/Author/Developer
- ↳ Feature Request
- ↳ Common Problems
- ↳ DITA (Editing and Publishing DITA Content)
- ↳ SDK-API, Frameworks - Document Types
- ↳ DocBook
- ↳ TEI
- ↳ XHTML
- ↳ Other Issues
- Oxygen XML Web Author
- ↳ Feature Request
- ↳ Common Problems
- Oxygen Content Fusion
- ↳ Feature Request
- ↳ Common Problems
- Oxygen PDF Chemistry
- ↳ Feature Request
- ↳ Common Problems
- Oxygen Feedback
- ↳ Feature Request
- ↳ Common Problems
- Oxygen XML WebHelp
- ↳ Feature Request
- ↳ Common Problems
- XML
- ↳ General XML Questions
- ↳ XSLT and FOP
- ↳ XML Schemas
- ↳ XQuery
- NVDL
- ↳ General NVDL Issues
- ↳ oNVDL Related Issues
- XML Services Market
- ↳ Offer a Service