ES-DOC / esdoc-questionnaire

ES-DOC Questionnaire (webform generator for creating CIM Documents). POC: @allynt
Other
2 stars 1 forks source link

Support CIM2 concept of labels. #441

Closed allynt closed 7 years ago

allynt commented 8 years ago

WHO: @allynt

Does the Q need to support multiple properties being used as class labels?

The Q has the concept of a property that is a "label." This means that the value of this property should be used when describing that property's class. For example, the label of a ModelComponent is its ShortName property.

The CIM2 definitions also have this concept. It uses the "pstr" attribute and can refer to more than one property. For example the label for the class "storage_volume" is: ('%s %s', ('volume', 'units')).

Both QXML and the internal Q code would have to change in non-trivial ways to support this way of labelling classes.

Additionally, it is not clear that this information is being passed onto the esdoc-mp Ontology class.

allynt commented 7 years ago

Having gotten this working, I now need to ensure that a specialization inherits labels from its base schema (unless it has explicitly overwritten them).

allynt commented 7 years ago

Now that this is all working, make sure that all appropriate documents defined in the CIM have labels associated w/ them.

allynt commented 7 years ago

I have created a ticket for the CIM itself after realising that not all CIM classes have labels defined: https://github.com/ES-DOC/esdoc-cim-v2-schema/issues/3.