Using Shading for Profiled Elements
You can configure shading that will differentiate between profiles, profile groups, or individual values. Specifying color for one or more types of profile information provides a visual representation of the profiling available for a document type, and which elements have been profiled in a document.
Shading is configured in the profile configuration file (PCF) that supports a document type. Refer to the shadingBackground attribute of the Profile element.
Once configured in the PCF, shading can be activated for a document using the set showprofileshading view command. Shading will be displayed in the following locations:
• In the
Apply Profiles dialog box — the profile groups, sub-categories, and values will be displayed in the color associated with them in the PCF.
Visible when you invoke the dialog box from the Edit View that has profile shading enabled, and the profile is set with shading attributes.
• In a document associated with the PCF — elements with profile values that have an associated shading color configured in the PCF will be displayed in that color in Edit View. Documents will also display an icon
for profiled elements in Document Map view and Column View.
In addition to colors for profile, profile groups, and individual values, you can also specify a color to be used for profile collisions for the document type. An element will be displayed in this color if it has been assigned multiple profile values of different colors. Configure the collision color via the conflictShadingBackground attribute of the ProfileClasses element in the PCF.
Please be aware of the following implementation notes for profile shading:
• A color configured for the main Profile alias is considered the default color. Any profile value that does not have its own profile shading specified will use the default color.
• If a color has been configured for a Profile sub-category (folder), any value in the folder that does not have its own profile shading configured will use the folder color.
• When two profile values have the same color specified, that is not considered a collision.
• In a table, there may be a conflict if a background color set by profiling for ancestor tags coincides with that set for an individual cell. In this instance the cell will inherit the background color if its force flag is on. If not, the cell’s own shading will be displayed.
The force flag will be set on when a shading color is set via Profile shading. The cell’s color will be overridden. This also means that profiling shading will override any content that also sets shading.
In Document Map view, the table icon will not be overridden by the profile icon. Those tags that specifically have a profile set will also have their tag name set to the profile shading color, including the table tag.
• When working with DITA topics and maps, the profile shading will not show the effects of DITA attribute cascading. For example, if a parent has the profiling attribute audience=”novice” set and a child element has audience=”expert”, the child effectively has audience=”novice expert” set, which cannot have a shading color.
The following functions support profile shading:
• profile_shadingbackground()
• profile_conflictshadingbackground()
• profile_values_shadingbackground()
• profilenode_shadingbackground()
• dlgitem_set_background_at()
• dlgitem_get_background_at()
• dlgitem_set_foreground_at()
• dlgitem_get_foreground_at()