Sections tab
This tab displays the Text content, which is structured in sections. The Text lines correspond to a word-wrap typing mode. From this tab, you can create reference links between the Text and instances of other entities.
- If you click OK, the Text is transformed and saved in the new version of the model. The text is displayed in a read/write mode. An output change is present in the Pending Changes view.
- If you click Cancel or the closing icon, the Text is transformed but is not saved in the new version of the model. The Text is then displayed in a read-only mode.
- The tree that shows the Text section codes. If you click a section code, the Sections area, which displays the section content, automatically opens. If you right-click a section code, a contextual menu contains items to add or remove a section, or to copy and paste a section with its content.
- Buttons that you can use to add or remove a section, or to move a section in the tree.
- The Sections area that opens when you click a section code in the tree or request the addition of a section. This area contains the constituting lines of the section.
- The first column contains the line types, on one character.
Using certain line types, you can specify entity calls to create reference links (super reference and subreference) between the Text and instances of other entities. You add these calls from a section or section part. An I or a B type line indicates the first line that refers to the entity instance. A J or E type line indicates the last line that refers to the entity instance. If it is not specified, all the following lines refer to the entity instance. You enter the referenced instance in the description column.
The other line types (L, K, -, or 1 to 9 for example) are migrated from Pacbase but are not effective in Rational® Programming Patterns. They are not used by the publishing or when the Text is used in a Volume.
- The second column contains the section description.
It contains the section code and content.
The section code must be on 2 characters. It is recommended to use letters or digits only.
You enter the description content in a word-wrap typing mode. You can add or remove characters inside the existing content. You can also copy and paste lines or characters.
You can create subreference links from the Text to other instances. This creation can be manual but a content assist makes it easier. To use it, press Ctrl + space bar. A wizard displays the list of the entity types. Double-click an entity type or enter the corresponding 3 characters. The wizard then displays the list of the instances that are available for this entity type. Double-click one of them to insert it in the Text. The insertion is formatted as @ENTINSTANCE, where ENT is the entity type and INSTANCE is the entity instance. The following entity types are available:- DBD for Database Blocks
- DEL for Data Elements
- DST for Data Structures
- IAD for Input Aids
- LIB for Libraries
- MET for Meta Entities
- MSP for Macros
- OST for Dialogs
- OSV for Server Dialogs
- PGM for Programs
- RPT for Reports
- SCR for Screens
- SEG for Segments
- SRV for Servers
- TXT for Texts
- VOL for Volumes
- USE for User Entities
Example: A link to a Macro AASQUEL corresponds to the insertion of @MSPAASQUEL.The instance is displayed as a link that you can double-click to open the instance editor. However, if you enter the link manually, the instance might not exist. In this case, a message box indicates that the link is not resolved.
- The third column can contain links to Data Elements because a
Text that describes an application often refers to individual Data
Elements.
A subreference link is then automatically created from the Text to the Data Element.
A Data Element cannot be referenced on the lines whose type is I, J, B, E, or Y.
The creation of a subreference link to a Data Element corresponds to the insertion of @DELINSTANCE, where DEL is the Data Element entity and INSTANCE is the Data Element instance. You can enter this link manually or use the content assist.
The instance is displayed as a link that you can double-click to open the instance editor. However, if you enter the link manually, the instance might not exist. In this case, a message box indicates that the link is not resolved.