Bug 146838

> The next thing is missing context wrt variables, and also wrt some
> terms. Consider the following examples:
>
> * IllegalAccessException calling {0} ("{1}"): {2}
> * Could not find ACL handler {0} in statement: "{1}". Available ACL
> handlers: {2}
>
> For the above examples, it would be helpful to give some context as to
> what it means. Some translators might not know what is happening here,
> so it is extremely difficult to translate, especially if mixed with
> quite a few variables. What does the first statement mean? What is an
> ACL handler? Or, in general, what do the variables refer to, as in the
> following example:
>
> * {0} is required.
> * this is a test of the {0}
>
> It is much easier to translate if it is known what the variables refer
> to. In the second case, "the" would even be translated differently in
> some languages, depending on what {0} is.


Basically, it would be good if for trans-units that we include
variable substitution to include a comment explaining an example of a
filled out value.  Something like :

<!-- example usage:  Email Field is required -->

we could definitely accommodate this.