Conceptual: Glossary Improvements


The output format of the glossary MAML document type in the VS 2005 style could be better.
See the following topic for a really nice example:
Microsoft Robotics Studio, Glossary

file attachments


davedev wrote Mar 27, 2008 at 11:26 AM

Some more things to consider:
  1. I noticed that when two <term> elements are used within a single <terms> element, the output is not distinguishable from a single <term> with two words since they are simply separated by a space. Two distinct terms that have the same definition should probably be separated by a comma or appear on different lines altogether. Actually, I think I'd prefer to see the individual terms added at the root level with the definition duplicated as many times as necessary so that they are easier to find. I'm not sure how the relationship between the two terms could be established then, but I'm not sure that it's even necessary.
  2. The text in the <title> element is not being used.
  3. Alphabetical ordering should be automatic. Currently, the exact ordering of the <glossaryEntry> elements in the MAML file is used.

EWoodruff wrote Jun 1, 2008 at 7:35 AM

Not implemented by the May 2008 release. See the May2008Fix.txt attachment for the patch to implement this.

wrote Jun 1, 2008 at 7:35 AM

wrote Feb 22, 2013 at 1:40 AM

BOORDA wrote Mar 16, 2015 at 5:05 PM

I know this is super old, but I felt inclined to comment.
I always hesitate to make anything automatic. You should never assume that everybody uses the program exactly the same. For example, in my Terms for my glossary I want to show the official or correct term first, then any unofficial or slang terms afterwards. Because of the automatic sorting of the terms I cannot do what I intended inside of my glossary. With that being said, I think by default terms and definitions should be ordered alphabetically but ultimately the user should have an option to opt out of auto sorting.