This is a feature request: it would be very helpful if we could have cross-references within the model files. One usage case is for assemblies that have a large number of similar interfaces (i.e., multiple published streams with similar types of information). When written as Word Documents, I have tended to put extensive documentation (i.e., in the description field) of the first instance, and then simply refer the reader to it in the subsequent instances.
If this were done in the markdown style, I would like to be able to do something like this in the model files:
For further details, see [description of equivalent telemetry item](tcs.cm.iris.imgCurAtmDispersion)
where tcs.cms.iris.imgCurAtmDispersion is a fully-qualified name for a telemetry item with the description in all its gory detail.
Within NFIRAOS, I am also aware of several locations where multiple complex commands and telemetry items are related to one another, and their descriptions could be made much clearer through the use of cross-references.
This is a feature request: it would be very helpful if we could have cross-references within the model files. One usage case is for assemblies that have a large number of similar interfaces (i.e., multiple published streams with similar types of information). When written as Word Documents, I have tended to put extensive documentation (i.e., in the description field) of the first instance, and then simply refer the reader to it in the subsequent instances.
If this were done in the markdown style, I would like to be able to do something like this in the model files:
where
tcs.cms.iris.imgCurAtmDispersionis a fully-qualified name for a telemetry item with the description in all its gory detail.Within NFIRAOS, I am also aware of several locations where multiple complex commands and telemetry items are related to one another, and their descriptions could be made much clearer through the use of cross-references.