[ENHANCEMENT] CIMTool 2.3.0 - RTF documentation generation request to include namespace

[biverson62]

This request is an enhancement to CIMTool's documentation builder. When using CIMTool with extension models, it would enhance the documentation if the namespace for the classes, attributes and associations were included. This would allow full traceability of CIM standards used in the profile documentation and project extensions.

Could the attribute/association table be enhanced to add a new column for Namespace? This would be an easy visual way to show the namespace source for each attribute and association.

Here is a visual of how the namespace could be added for both the classes and the attributes and associations. The new enhancement text is shown in purple text below.

Describe alternatives you've considered:

Since maybe for other profile documents the namespace is not needed and is all the same (being that the model/xmi is a single model/xmi); including an option (checkbox or flag in CIMTool) of whether or not to include the namespace might be more acceptable by the community that is using CIMTool.

[tviegut]

@biverson62 :
Such a feature already exists in the new AsciiDoc documentation when using EA project files and is described in the Using CIMTool Documentation Features with the generation of the documentation appearing as in the example below. Note that support for this was limited to EA project files and was not yet implemented for XMI-based schema projects when I pushed out for the 2.3.0 release.

I'd prefer to standardize on this pre-established approach rather than to introduce another method. If you prefer it to appear differently, I'd suggest making a custom builder derived from the RTF builder and customize to what you prefer.

The reason for the below approach is it is optimal from a sizing perspective for table columns. It also is easily visualized as part of either an attribute or association (it does also appear on extension associations though not shown in the example).

[biverson62]

Is there a plan to support the namespace extension when using XMIs as input to CIMTool? XMIs are input with the specified full namespace path. How will a NamespaceName be identified for the extension XMI? And since all model references are input using XMIs, will there be always then a NamespaceName prefix to every attribute and association? Such as cim100, projAExt, projBExt, ...?

Are there any plans to enhance the rtf builder in CIMTool, or is that not planned for continued development with AsciiDoc as the replacement? I believe that the RTF is a valid builder and should be included with CIMTool's enhanced features moving forward. Having RTF documentation is still a valid use case for many organizations.