Allow Abbreviations with multiple meanings
Hello all,
there is already an open ticket for my request: MANUALS-6178.
With this post I would like to know how some of you use the abbreviation module and how you deal with the missing option to use an abbreviation with multiple meanings. This in order to find the best possible solution.
I can say that both the abbreviation and definition modules have been used sporadically and only by a few editors in our organisation.
In addition to the library created with the module, we used to have a manual in which we manually compiled the abbreviations given in the EU regulations.
My intention is to abolish this manual work and instead use the WebManuals module to collect all the abbreviations used in the manuals and defined in the EU regulations.
However, in order to make full use of the abbreviation module, it must be possible to save an abbreviation with different meanings.
I would like to show our editors a way to see directly when entering an abbreviation which definitions are already available and to define a new meaning for it if needed.
E.g.:
An editor typing in "AD" should see a suggested meaning for "Airworthiness Directive" and "Aerodrome" in a drop-down list. If he/she means one of them, he/she can select it, or if he/she means something else, he/she should be allowed to define a new meaning.
I am not entirely happy with the current solution of adding special characters to the end of an abbreviation to allow multiple meanings.
Firstly, it doesn't look professional in my eyes, and secondly, I don't think it's very practical to ask our editors to try out all the possible special characters at the end of their abbreviation to see if they might already exist.
However, I am sure there are things I may have missed or where I have made wrong assumptions.
So I would very much appreciate a comment on what you think of my idea, and I would like to hear how you handle abbreviations in your manuals and WebManuals.
With kind regards
Michel
Comments
Hi Michel, I like and support your idea of the dropdown list.
Our practice is to separate the different meanings with "/". In your example AD: Airworthiness Directive / Aerodrome.
We're not using the definitions module as it does not support bullet or numbered lists, and some definitions would required it. I've also seen definitions containing small tables, which is also not currently supported by the module.
Hi Michel,
I also agree with your idea for a dropdown list.
We currently only distribute via PDF, so we use a "." after the duplicate abbreviation and hide this as white text after an abbreviations list in the first chapter of the manual (otherwise it would look like a full stop mid sentence). I agree it doesn't look very professional and some regulators have questioned why there is a "." against some abbreviations in the list!
Thank you Bruno and Teresa for sharing your solutions and support.
I see both ideas might work, but I'm also afraid that both might confuse our CAA or anyone not being fully aware of the procedure and the need for this work around.
Please correct me if I was wrong, but I'd also consider both solutions as not very handy for our editors.
Bruno Quadros Rodrigues: How do you allow your Editors to add a new meaning to the list if needed?
Again, thank you very much for participating on this discussion and cooperation to find a best possible solution.
A nice weekend to all of you :-)
Please sign in to leave a comment.