cross-references and title link text

[sbodoff]

When I create a cross-reference to a topic, the topic title is automatically displayed as the link text. However, if I create a cross-reference to a section or example with a title, that section or example title is not displayed as the link text. Is this a known defect or can I configure oXygen to show me the title whenever I create a cross-reference to an element that has a <title> subelement?

[Radu]

Hi,

This is a small bug in Oxygen. I registered an issue for it and it will probably be fixed in Oxygen 15.1 in a couple of months. I will update this forum thread when the fix becomes available.

Regards,
Radu

[Radu]

Hi,

Just to update the thread, Oxygen 15.1 was officially released and should contain a fix for this issue.

Regards,
Radu

[hauber]

I just added an xref to a DITA section in oXygen 15.2, and the section's title is not displayed in Author mode. It is however shown in the generated document when transformed to PDF.

[Radu]

Hi,

Could you give me a small example?

Here's what I tested on my side:

I created in a DITA topic a section like:

Code: Select all

<section id="sect">

            <title>THE SECTION TITLE</title>

            <p>Para text</p>

        </section>

and from another topic made a reference like:

Code: Select all

<xref href="path/to/target.dita#topic-1/sect" format="dita"/>

and the section title was shown on the link when editing in the Author visual editing mode.

Do you use the standard DITA framework support which comes with Oxygen 15.2 or a customized DITA framework?

Regards,
Radu

[Miriam]

Hi,

I have a similar issue to what's described in this thread, except with <fig> and <step> instead of <section>. My xrefs resolve fine in my output, but in Author mode, they don't pull in the text. (i.e. <xref href="#concept_kyq_q4y_g4/cr_dialogue" type="fig"/> correctly resolves in the output, but shows as >.< in Author mode).

It would be very helpful to the writers if xrefs to figures, steps, and tables work like xrefs to topics. Is there something I can do to get the auto-generated text? I have oXygen Editor 16.

[Radu]

Hi Miriam,

Please also post some sample DITA XML content in order for me to try and reproduce the issue on my side.

I tried to create a figure like:

Code: Select all

<fig id="fig">

        <title>FIGURE TITLE</title>

        <image href="../images/Gardeniaflower.jpg" />

</fig>

and then to refer to it from a step:

Code: Select all

            <step>

                <cmd>Link: <xref href="../topics/care.dita#care/fig" type="fig"/></cmd>

            </step>

and the title of the figure showed up as link text in Oxygen 16.0.

Regards,
Radu

[Miriam]

Checking the topics today, it appears to be a refresh issue. When I initially build the cross-reference, the link text generally does not auto-generate. If I close and re-open the file, it appears.

Sometimes the link does auto-generate right away, though. The unpredictability is confusing, but something we can live with now that we have a general idea what to expect.

[Radu]

Hi Miriam,

It seems that if in the same topic you have a reference to an element which has a title (in your case a figure) the static text on the reference is not updated when the title of the figure is changed. We'll try to improve this behavior in a future version.
In the meantime, as a tip you can use the F5 keyboard shortcut to refresh the XML document instead of re-opening it.

Regards,
Radu

[Satu]

Hi,

I don't seem to be able to get the link text for references to <step> elements. The text only shows a full stop (.), not the number of the step or the text "Step". Refreshing the topic, or closing and opening the topic again does not help.

However, references to figures and links to other topics get the link text immediately.

I did not see a reference to the links to steps in the above discussion. Has this issue been addressed?

Regards,
Satu

[Radu]

Hi Satu,

I would need to know the:

1) Oxygen version you are using.
2) Output format (HTML, PDF, etc) you are publishing to.
3) If you are using the DITA OT bundled with Oxygen or an external one (and what DITA OT version if this is the case).
4) If you have any customizations for the output.

Regards,
Radu

[Satu]

Hi Radu,

I'm using Oxygen 16.1. The problem is not in the output, there I can see the target text as designed.

My problem is that when I create the link in Oxygen, I cannot see the step numbers in the link text. I only see this:

Code: Select all

<step id="GUID-668A0718-C90A-4E77-8902-4BBBCB973506">

				<cmd>Repeat steps <xref

						href="GUID-EB548F81-39FB-44EE-B599-CBCD5AC25C16#GUID-EB548F81-39FB-44EE-B599-CBCD5AC25C16/GUID-3D36D572-B55D-4B42-A7A9-1C62DDC8BBC8" format="dita">.</xref> to <xref

						href="GUID-EB548F81-39FB-44EE-B599-CBCD5AC25C16#GUID-EB548F81-39FB-44EE-B599-CBCD5AC25C16/GUID-C60D346E-7E75-4655-B767-7F81DA4DB6BD" format="dita">.</xref>.</cmd>

				</step>

"Repeat steps . to .."

What I was expecting to see in the editor was:

Code: Select all

<step id="GUID-668A0718-C90A-4E77-8902-4BBBCB973506">

				<cmd>Repeat steps <xref

						href="GUID-EB548F81-39FB-44EE-B599-CBCD5AC25C16#GUID-EB548F81-39FB-44EE-B599-CBCD5AC25C16/GUID-3D36D572-B55D-4B42-A7A9-1C62DDC8BBC8" format="dita">1</xref> to <xref

						href="GUID-EB548F81-39FB-44EE-B599-CBCD5AC25C16#GUID-EB548F81-39FB-44EE-B599-CBCD5AC25C16/GUID-C60D346E-7E75-4655-B767-7F81DA4DB6BD" format="dita">3</xref>.</cmd>

				</step>

"Repeat steps 1 to 3."

This would make it a lot easier to keep track on the links.

Is it so that Oxygen does not support this?

Best regards,
Satu

[Radu]

Hi Satu,

Yes, Oxygen does not yet support presenting the step number on links in the Author editing mode.
We have a registered issue for this and I will add your vote for it.

Regards,
Radu

[Satu]

Thank you Radu!

Best wishes,
Satu