DITA Publishing - Glossary & References
Posted: Mon Jun 03, 2019 10:35 am
Hi,
I'm quite new to DITA publishing, as we used to publish using DocBook5 for our technical documents. I want further investigate DITA publishing mainly due to the powerfull Responsive WebHelp and PDF (via CSS publishing). And I have two basic - but very important for us - things that I would like to do with DITA:
1- build an "automated" glossary based on terms that I would call inside my DITA content, anywhere it appears. For example each time I have the accronym "ROV" inside my DITA content, I would like to insert something like, and in the final output (WebHelp or PDF) this would point to a Glossary section, where the user will find "ROV: Remotely Operated Vehicle". Ideally in the Webhelp content, a popover <div> would appear when the user mouseover the term, displaying the definition... Also I would love that the glossary build itself based on the terms that are present on the DITA content (and only these terms), among a complete/general glossary that contains all the terms that we may have to use on our documents... My feeling is that I need to use the <glossary> document type, and benefits from the various values defined in each <glossentry>, but I would really like to have something as simple and automated as possible. I do not want to have to manually select each term which is used in my DITA content to build the gloassary (like in the Flowers example of your distribution). Is it possible?
2- build a "Reference documents" section where we would have entries like this:
and refer to these lines inside the DITA content with xref that would display either the , or the title or both. Is there a way to achieve this with DITA (I'm sure there is! )
Thanks for your help!
Regards
David
I'm quite new to DITA publishing, as we used to publish using DocBook5 for our technical documents. I want further investigate DITA publishing mainly due to the powerfull Responsive WebHelp and PDF (via CSS publishing). And I have two basic - but very important for us - things that I would like to do with DITA:
1- build an "automated" glossary based on terms that I would call inside my DITA content, anywhere it appears. For example each time I have the accronym "ROV" inside my DITA content, I would like to insert something like
Code: Select all
<term>ROV</term>
2- build a "Reference documents" section where we would have entries like this:
Code: Select all
[1] AO-111-123456............ Document Title #1
[2] AO-111-34566778............ Document Title #2
...
Code: Select all
[1]
Thanks for your help!
Regards
David