Highlighted

How to create a list of acronyms and abbreviations?

Explorer ,
Nov 21, 2018

Copy link to clipboard

Copied

Hi

I'm working with DITA and I would like to have a list of acronyms and abbreviations added to my book (save ditamap as book with fm components). I have learned that if I use Indexterm elements I can have a pretty nice list of these in Index page. But I feel that this is not the right way to do it.

I found also glossentry-file (or glossgroup for several entries) where I can have the acronyms and also the long term and with abbreviated-form element it should be possible to get automatically the acronym or the long one to the topics. But here comes the problem.

I don't know how to refer to this glossgroup, when adding to ditamap and then in topics with abbreviated-form. I have searched from web but I don't understand where these href, keyref and keys values are coming from. I have ID for the glossgoup and I guess that ID should be href or kref, but what are the others?

If glossgroup is used is there a possibility to get the list of used acronyms and abbreviations with the explanations added to the book?

All the help is highly appreciated.

Br,

Pekka

TOPICS
Structured

Views

400

Likes

Translate

Translate

Report

Report
Community Guidelines
Be kind and respectful, give credit to the original source of content, and search for duplicates before posting. Learn more

How to create a list of acronyms and abbreviations?

Explorer ,
Nov 21, 2018

Copy link to clipboard

Copied

Hi

I'm working with DITA and I would like to have a list of acronyms and abbreviations added to my book (save ditamap as book with fm components). I have learned that if I use Indexterm elements I can have a pretty nice list of these in Index page. But I feel that this is not the right way to do it.

I found also glossentry-file (or glossgroup for several entries) where I can have the acronyms and also the long term and with abbreviated-form element it should be possible to get automatically the acronym or the long one to the topics. But here comes the problem.

I don't know how to refer to this glossgroup, when adding to ditamap and then in topics with abbreviated-form. I have searched from web but I don't understand where these href, keyref and keys values are coming from. I have ID for the glossgoup and I guess that ID should be href or kref, but what are the others?

If glossgroup is used is there a possibility to get the list of used acronyms and abbreviations with the explanations added to the book?

All the help is highly appreciated.

Br,

Pekka

TOPICS
Structured

Views

401

Likes

Translate

Translate

Report

Report
Community Guidelines
Be kind and respectful, give credit to the original source of content, and search for duplicates before posting. Learn more
Nov 21, 2018 0
PMYM LATEST
Explorer ,
Dec 07, 2018

Copy link to clipboard

Copied

By searching and also by guessing I learned where the values are coming from(it would be nice to tell in examples what names are used for files so that you know where those are coming from). But I couldn't get it working with PDF, there are only empty places where the acronym or the long term should be shown. I got abbreviated-form to work with HTML5 and with HTML help when I was testing if I could learn something about why it is not working. I was surprised  that it was actually working with those types.

Is there a some known problem related to this abbreviated-form+PDF? I found from different forums that there are some problems but the only questions I found related to my question were missing the answer.

I noticed that I have text ERROR in front of my glossref element in WYSIWYG view but I haven't found out why. Console pod doesn't display anything while saving the ditamap. Validation is ok. In structure view it seems to be related to fm-topicreflabel.

Likes

Translate

Translate

Report

Report
Community Guidelines
Be kind and respectful, give credit to the original source of content, and search for duplicates before posting. Learn more
Reply
Loading...
Dec 07, 2018 0