Generation of references and acronymns

[Mats Gejnevall]

We have created a package with all our references and acronymns. Maybe a 1000 of them. We are generating a number of documents from our model (200+). In each document we want to include relevant reference and acronymns. To do that we are planning to add one reference diagram och one acronymn diagram for each of the 200+ documents (i.e. a subpackage in each packages structure for each document) so we can reuse the references and acronymns and changes in the text needs only to be made in one place.

But when we generate the documents, we have not found any way to inlcude the reference and acrynomn elements (not the diagram) in the document. The diagrams can be included but that is not how we want the elements to show up in our documents. It should be in the old table style (e.g. a list of acronymns and their descriptions).

Does anyone know how to do this? Must be a pretty common problem people run into.

Thanks
Mats

[PeteC]

One option is the Glossary. There are two ways to use this - one is the Glossary from the menu Alt-2 and select Glossary. You can generate a document fragment from the glossary. I did previously manage to generate a partial glossary. From memory, I think I used the Type field to define where the Term and Meaning was relevant and then either a filter, search or script (I forget which and can't find to hand where it is - I could look another day if you need a bit more info) to control which glossary entries were relevant to a specific document output. It was something like the Type could be Global meaning it applied to all, P1 where it applied to project 1, P1 P2 where it applied to both project 1 and project 2 etc. That might be manageable if you don't have too many different glossaries (of the order of ten or so rather than 200 different glossaries) or if terms were not applicable to many documents; it would become unmanageable if you wanted 200 different glossaries and some terms belonged in a large number of those.

The other thing I found recently was a different way to do glossaries as diagrams - Add a new diagram and it's either Glossary Diagrams or Glossary Item Lists. You might find this a better option. I don't know much more of what you could do but it might be worth looking into.

[Geert Bellekens]

You can either use the
diagram>element> section, or you can create an SQL fragment that lists the references and acronyms shown on your diagram

Geert

[Mats Gejnevall]

What I did in the end was the following:
1. Created one template for acronymns and one for references (simple with package, diagram elements and a table with names and descriptions)
2. Created a glossary package with one subpackage for acronymns and one for references
3. Added all possible acronymns and references to these packages
4. For each local document to generate I added a virtual document consisting of a <master document> and an acronymn and an references <model document>. The model documents mapped to the templates defined in step 1
5. Added a package in each document structure with packages and and diagrams for local document acronymns and references
6. Added the acronymns and references for the given document to those diagrams
7. Generated the document and it worked perfectly (after a few tweeks)

Code: [Select]

ackage >
{Pkg.Name}
diagram >
element >
Abbreviations/ Acronymns Description
{Element.Name} {Element.Notes}
< element
< diagram
child packages >
< child packages
< package