User manual BORLAND TOGETHER ARCHITECT

[. . . ] User Guide for Borland ® Together ® Architect Borland Together ® ® Integrated and Agile Design Solutions Borland Software Corporation 100 Enterprise Way Scotts Valley, California 95066-3249 www. borland. com TogetherSoft Corporation, a wholly owned subsidiary of Borland Software Corporation, may have patents and/or pending patent applications covering subject matter in this document. Please refer to the product CD or the About dialog box for the list of applicable patents. The furnishing of this document does not give you any license to these patents. Copyright © 2004 TogetherSoft Corporation, a wholly owned subsidiary of Borland Software Corporation. [. . . ] The right-click menus on the scope pane vary among headers, footers, and static sections. Items on those menus include the following: · Delete: for headers, footers, and static sections with siblings only. · Insert Sibling Section: for headers and static sections only. The new section goes immediately below this header or section. 466 Documentation Template Controls · Move Up, Move Down, Copy: for static sections only. Static sections have only one property, which is an enabling condition. (See "Enabling Conditions" on page 457. ) Setting area properties To set area properties for headers, footers, and static sections, choose Area Properties from the right-click menu of the details pane. Selecting Area Properties displays a dialog box with three tabbed pages: · Settings: contains check boxes for page settings (such as "start a new page with this section") and for suppressing formatting. (See "Hyperlinking controls to element documentation" for more details. ) · Other: for associating formatting styles with an area, setting style name expressions, and using a control delimiter. Creating controls and setting control properties There are six different kinds of controls. To create a new control in a static section, header, or footer, choose Insert Control from its right-click menu in the details pane followed by: · Label: for static text · Image: for graphics (project diagrams or other images) · Panel: for a container for other commands · Formula: for project-specific data (necessary when the data cannot be accessed with simple data controls) · Data Control: for project-specific data · Include Text: for including text from external files When you insert a new control, the Documentation Template Designer displays a dialog box for setting the control's properties. The template shows each control as a shaded rectangle in the details pane. You can change the properties of a control after it is created by right-clicking the control and choosing Properties, or by selecting the control and choosing Object | Properties from the main menu of the Documentation Template Designer. The result is a dialog box organized into tabbed pages for the properties settings. User Guide for Borland Together Architect 467 Labels, images, and panels The simplest kinds of controls are labels, panels, and images. Labels A label control generates static text that is independent of its containing section. The text does not depend on the metatype of the section or where the section belongs in the template. Placing identical labels in a header and a static section results in the same output as long as the header and static section are not skipped. Label properties include the label's text, style (font, color, and border), and if and how to hyperlink the output. The section, "Text format settings" on page 473 has more details on styles. The checkbox for Render embedded HTML tags determines whether to interpret any HTML tags in the label as HTML tags or simply show them as text. On the Other tab, you also have the option to Render embedded Javadoc tags. For example, enter the following text, @link Class1, on the Label tab, and check Render embedded Javadoc tags on the Other tab of the label control. You also need to mark the area that you wish to reference by the hyperlink as a location of the element's main documentation. To do this, you open the Area Properties for the static section under Iteration by Class, select the Hypertext Target tab, and check Start of the current element's specific documentation. Whenever you generate documentation, the label displays as a hyperlink to the documentation for Class1. Figure 133 Label properties 468 Documentation Template Controls Images An image can be external to the project or it can be a project diagram. [. . . ] · $:vcs. option. cvs. executable$ - include the value contained in the property vcs. option. cvs. executable Template Macros The following macros, surrounded by % characters, are used in the template values for both forward (code generation) and reverse (parser) engineering. Table 93 Macro %Class_Name% Template macros Definition Used in Language All languages The Choose Pattern dialog does not include this Source-generating macro. For classes, it is substituted with the name templates of the class to which this template is applied (such as for class constructors). For members, it is substituted with the name of the class where a member is created by this template. %Date_Created% This macro is expanded into the date of creation in Prologue and epilogue the format: Month XX, YYYY %Time_Created% This macro is expanded into the time of creation in Prologue and epilogue the format: hh:mm:ss AM/PM %FILE_NAME% %FILE_EXT% %Name% %Dst% %Type% Name of the class source code file. Prologue and epilogue Prologue and epilogue All languages All languages All languages All languages All languages All languages All languages Name of a generated class / attribute / operation, Source-generating editable in the Choose Pattern dialog. [. . . ]