You can use this page to maintain the type-sensitive tagged-value hints that MDriven Designer downloads at startup and shows to people editing tagged values.
Purpose
This page is the central hint definition for tagged values (TVs). A tagged value is a UML extension mechanism that adds metadata to a model element; see Documentation:TaggedValues for the general concept and examples of how tagged values are used.
MDriven Designer downloads this information at startup. The Tagged Value editor uses it to identify the type of model element being edited, filter the available tagged values, and display a short usage hint.
This page is intended for maintainers of MDriven's tagged-value guidance. It is not a general list of every tagged value currently stored in an individual model.
How designers use these hints
To obtain the current hint information in MDriven Designer:
- Open the editor where you access tagged values.
- Select Refresh from Wiki.
- Use the filtered options and the usage hint shown for the current model-element type.
The editor can also offer defined values when a tagged value accepts multiple values. For instructions on working with tagged values in the Designer, see Documentation:Tagged values in the Designer.
Hint key format
Each hint is identified with this key pattern:
#TargetType.<Modernity.>Function
| Part | Meaning |
|---|---|
#
|
Prefix used by the hint key. |
TargetType
|
The type of model element to which the tagged-value hint applies. |
<Modernity.>
|
An optional segment in the key pattern. |
Function
|
The tagged-value function described by the hint. |
For example, a key must follow the pattern above, beginning with # and identifying the target type and function. Do not add an entry until its exact target type, function name, supported value format, and behavior have been confirmed.
Authoring rules
- Add a hint here for each valid tagged value that MDriven Designer should present with type-sensitive guidance.
- Keep the hint specific to the target type so that the Designer can filter options correctly.
- Include a brief usage description that tells the reader what the tagged value controls.
- Where a tagged value accepts a defined set of values, record the allowed values so that the editor can help the user make a valid definition.
- Do not add entries for settings that already have a dedicated Designer property. Those settings are deliberately excluded from this hint data.
- Do not use this page to document application-specific tags. Use Documentation:TaggedValues as the starting point for understanding tagged values in a model.
Maintaining this page
Before publishing a new or changed hint:
- Confirm that the tagged value is valid for the intended model-element type.
- Confirm that the tagged value does not already have a corresponding MDriven Designer property.
- Verify the exact tagged-value name and any allowed values.
- Add the type-specific key and concise usage guidance.
- Refresh from the wiki in the Tagged Value editor and verify that the option appears for the intended type and that its hint is understandable.
Scope
This page supplies tagged-value help. Property Inspector help is maintained separately on Documentation:MDrivenDesignerPropertyInspectorHints.