Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

glossentry reports missing if used in shortdesc and another topic uses <xref> to origin topic #3153

Closed
jomjohn opened this issue Nov 20, 2018 · 3 comments
Labels
bug preprocess priority/medium Medium (or unknown) priority issue stale No recent activity. May be closed soon.

Comments

@jomjohn
Copy link
Contributor

jomjohn commented Nov 20, 2018

Expected Behavior

When <term keyref="gloss_term"/> is used in a <shortdesc> the value needs to resolve when shortdesc is read.

Actual Behavior

The glossterm is left blank: broken_term_in_shordesc_preview

Possible Solution

I am not sure if this is a keyref issue or a topicpull issue. I would think that the keyref would already be resolved by the time topicpull happens. The keyref is trying to resolve relative to the dita-ot/xsl location rather than the doc source location.

Steps to Reproduce

My sample source and output is included in this zip: samples.zip

  1. Updated files:

hierarchy.ditamap, added glossary.ditamap:
<mapref href="glossary.ditamap"/>

glossary.ditamap (new)
<topichead> <topicmeta> <navtitle>Glossary</navtitle> </topicmeta> <glossref href="glossary/gloss_google.dita" keys="gloss_google"/> </topichead>

glossary/gloss_google.dita (new):
<glossentry id="gloss_google"> <glossterm>Google</glossterm> <glossdef>The place where you find stuff.</glossdef> </glossentry>

concepts/lawnmower.xml, added term glossentry reference in <shortdesc>
<shortdesc>The lawnmower is a machine used to cut grass in the yard. You can look it up on <term keyref="gloss_google"/></shortdesc>

concepts/oil.xml added <link> to lawnmower.xml:
<link href="lawnmower.xml" format="dita" type="concept"></link>

  1. Run dita -v --input=samples/hierarchy.ditamap --format=xhtml
  2. In one case (where child links are created) the term resolves correctly:
    glossary_term_resolved
    In Oil.xml the term is blank:
    broken_term_in_shordesc_preview

Copy of the error message, log file or stack trace

[topicpull] java.io.FileNotFoundException: C:*****\dita-ot.git\src\main\xsl\glossary\gloss_google.dita (The system cannot find the path specified)
[topicpull] file:/C:/*****/dita-ot-docs/samples/concepts/lawnmower.xml:11:121: [DOTX031E][ERROR]: The file ../glossary/gloss_google.dita is not available to resolve link information.

Environment

  • DITA-OT version: 3.2 and older
  • Operating system and version: Windows
  • How did you run DITA-OT? dita -v --input=samples/hierarchy.ditamap --format=xhtml
  • Transformation type: xhtml

Thank you for any help you can provide to fix this issue!

@robander
Copy link
Member

robander commented Dec 7, 2018

I've seen other issues over time with short descriptions that include links being pulled into cross reference hover-help ... ran into another just a week or two ago and couldn't see a good way to resolve it. Usually the problem is worse when files are not in the same directory, but that's not always the issue.

@robander robander added bug priority/medium Medium (or unknown) priority issue preprocess labels Dec 7, 2018
@robander
Copy link
Member

I think this is probably a duplicate of #3078. Whether @keyref or <xref>, the defect is caused by cross references that end up in the short description ==> pulled into hover help.

@stale
Copy link

stale bot commented Jun 4, 2021

This issue has been automatically marked as stale because it has not been updated recently. It will be closed soon if no further activity occurs. Thank you for your contributions.

@stale stale bot added the stale No recent activity. May be closed soon. label Jun 4, 2021
@stale stale bot closed this as completed Jun 26, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug preprocess priority/medium Medium (or unknown) priority issue stale No recent activity. May be closed soon.
Projects
None yet
Development

No branches or pull requests

2 participants