<abbreviated-form keyref="xxx"/>

Post here questions and problems related to editing and publishing DITA content.
Bob.Conlin
Posts: 22
Joined: Sun Aug 14, 2011 5:21 am

<abbreviated-form keyref="xxx"/>

Post by Bob.Conlin »

I figured out abbrevlist rendering a glosslist, that works ok. Next I'm trying to get <abbreviated-form keyref="xxx"/> to work. I have the glossary information in place that works to populate the abbrevlist but when I try <abbreviated-form keyref="xxx"/> nothing is rendered in the topic.
In Acronyms.dita My gloss entry looks like this:
<glossentry id="xxx">
<glossterm>Test Acronym (xxx)</glossterm>
<glossBody>
<glossSurfaceForm>Test Acronym</glossSurfaceForm>
<glossAlt>
<glossAcronym>xxx</glossAcronym>
</glossAlt>
</glossBody>
</glossentry>

In the map I have:
<glossref keys="xxx" href="Acronyms.dita"/>
<topicref href="Test_Topic.dita"/>

In the topic I have:
<abbreviated-form keyref="xxx"/> a couple of times.

My understanding is that the SurfaceForm should render on first usage and the Acronym should render on every occurrence thereafter. I get nothing in any occurrence. What am I missing? Thanks for the help.
Radu
Posts: 9041
Joined: Fri Jul 09, 2004 5:18 pm

Re: <abbreviated-form keyref="xxx"/>

Post by Radu »

Hi Bob,

Sorry for the delay, we are getting close to releasing Oxygen 13.
I also took a look at the samples you sent on our support email address.
As you may know Oxygen uses the DITA Open Toolkit to publish DITA content to various output sources.

In my opinion if you had a glossgroup like this:

Code: Select all

<glossgroup id="ggr">
<title>Acronyms</title>
<glossentry id="glossEntryID">....
and it was referenced in the DITA Map like this:

Code: Select all

 <glossref keys="keyName" href="AcronymTestGloss.dita"/>...
then the correct way to reference it would be like:

Code: Select all

<abbreviated-form keyref="keyName/glossEntryID"/>
So the key ref also needs to specify the ID of the glossentry inside the glossgroup (as there may be more than one glossentries in the file).
Unfortunately this approach does not seem to work neither in the XHTML or PDF outputs.

If you had a standalone glossentry DITA file like this:

Code: Select all

<glossentry id="glossEntryID">....
which was referenced in the DITA Map like:

Code: Select all

 <glossref keys="keyName" href="glossentry.dita"/>...
then the correct way to reference it would be like:

Code: Select all

<abbreviated-form keyref="keyName"/>
The second approach works for XHTML but not for PDF. Actually I added a bug for this on the DITA Bugs List a while ago.

http://sourceforge.net/tracker/index.ph ... tid=725074

Unfortunately the bug was not resolved.

I think this is a case in which the DITA 1.2 specification was not yet properly implemented in the DITA Open Toolkit publishing processor.
Maybe you can also ask around on the DITA Users List, see what workarounds others are using.

Regards,
Radu
Radu Coravu
<oXygen/> XML Editor
http://www.oxygenxml.com
Bob.Conlin
Posts: 22
Joined: Sun Aug 14, 2011 5:21 am

Re: <abbreviated-form keyref="xxx"/>

Post by Bob.Conlin »

Thanks for checking it out for me. I thought the problem was something I was doing. The OT is up to 1.5.4. Is there a way to test with that OT?
Radu
Posts: 9041
Joined: Fri Jul 09, 2004 5:18 pm

Re: <abbreviated-form keyref="xxx"/>

Post by Radu »

Hi Bob,

Oxygen comes with a bundled DITA OT installation but it does not force you to use the bundled version for your transformations.
You can edit your transformation scenario to point to another DITA OT installation like:

http://www.oxygenxml.com/doc/ug-oxygen/ ... ta-ot.html

Regards,
Radu
Radu Coravu
<oXygen/> XML Editor
http://www.oxygenxml.com
LASSE_MLE
Posts: 30
Joined: Mon Dec 05, 2022 3:24 pm

Re: <abbreviated-form keyref="xxx"/>

Post by LASSE_MLE »

TestAcronymsGlossGroup.7z
(881 Bytes) Downloaded 109 times
Hello,

First of all, happy new year to all!

I know this topic is very old but I am in the same situation with issues using GlossGroup for acronyms management...
I have used different white papers to try to implement the acronyms capability: A very basic ditamap is joined to this topic to illustrate my situation:
  • Acronyms.dita contains a glossgroup with several glossentry
  • My topic (maintcar.dita) contains reference to the acronyms using abbreviated-form.
  • Finally my ditamap lists the topic (maintcar.dita) and the glossref in the Acronyms.dita file
This works perfectly for the DITA Map HTML5 scenario but unfortunately it does not work with the others (typically DITA Map PDF - based on HTML5 & CSS which is the one I want).

Is there news since 2011? Sorry but I did not find other topics on the forum...

BR,

ML
--------------
<oXygen/> XML Editor 24.1, build 2022030807
julien_lacour
Posts: 495
Joined: Wed Oct 16, 2019 3:47 pm

Re: <abbreviated-form keyref="xxx"/>

Post by julien_lacour »

Hello,

In order to make your sample work with PDF outputs, you need to add the print="yes" attribute on each <glossref>.
The abbreviated-forms will be resolved after that.

Regards,
Julien
chrispitude
Posts: 907
Joined: Thu May 02, 2019 2:32 pm

Re: <abbreviated-form keyref="xxx"/>

Post by chrispitude »

Hi Julien,

I was also surprised by this behavior. I filed a DITA-OT bug for it:

#4026: In preprocess2, <glossref> elements are ignored

but as I found, the DITA spec clearly describes that @print defaults to no for <glossref> references.

I have seen other users mention that they use <topicref> instead of <glossref> to avoid this confusion.

Some related discussion here: https://dita-users.groups.io/g/main/top ... 8024#45067
LASSE_MLE
Posts: 30
Joined: Mon Dec 05, 2022 3:24 pm

Re: <abbreviated-form keyref="xxx"/>

Post by LASSE_MLE »

julien_lacour wrote: Tue Jan 03, 2023 4:08 pm Hello,

In order to make your sample work with PDF outputs, you need to add the print="yes" attribute on each <glossref>.
The abbreviated-forms will be resolved after that.

Regards,
Julien
Hello,

Thank you Julien, it works like a charm!
you saved my day!

BR,

ML
Post Reply