Configure Work Item Presentation dialog box

Invoked from the Document Editor toolbar of an open Live Doc Document (accessed from Navigation: Documents and Pages).

Content elements in Documents can be marked as Work Items - a paragraph can be marked as a Requirement, for example. Marking of elements may be done automatically via Work Item Rules when a Document is created via import from Word, or explicitly by a user working on the Document. The Configure Work Item Presentation dialog box is where you can specify which type or types of Work Items the Document can contain, and customize the presentation of elements marked as Work Items so that they display certain Work Item data field values in addition to the textual content. For example, you might display the Work Item ID and severity in paragraphs marked as Requirements, or the ID and status in paragraphs marked as Test Cases.

You can display the value of both standard Work Item fields and Custom Fields via the Select Fields button. You can specify whether field values appear at the start of the Work Item, or at the end. For example, you might display the value of the outlineNumber field at the start, and the severity field at the end of paragraphs that are marked Work Items. You can display multiple field values at both the beginning and end of marked elements. For example, you might show outlineNumber and id at the start, and severity and timePoint at the end of paragraphs marked as Work Items.

Each row in the table represents a Work Item type. Document content can be marked as a Work Item of any type specified in this dialog box.

Fields:

• Type: Specifies a Work Item type to be supported by the Document. The list contains the types currently configured for the project in the workitem_type_enum.xml enumeration.

  (See: Configuring Enumerations.)

• Label: The name of the Work Item type specified in Type. This value appears in the drop-down menu of the Document editor toolbar. Value defaults to the configured name of the Work Item type selected in Type. User can change it, but there is usually no need to do so.

• Content: Specifies what Work Item content will be included when a new Work Item is inserted, or Document text is manually marked as a Work Item of the type specified in Type. Take note of the following:

  • If you select Description, all selected content is placed in the Work Item's Description and no value is set for its Title. When viewed in the integrated tracker, the Work Item's Title field will be derived from the first 80 characters of the Description. No separate title appears in the Document.

  • If you select Title and Description, all selected content is placed in the Description, and a line for Title is created which the user fills in. Title is maintained as a separate data field from Description.

  • If the setting in Content includes Title and/or Description, the ENTER keyboard shortcut has different behavior in these fields.

• No Page Break: When checked, then Polarion will attempt, so far as possible, not to have page breaks within Work Items when exporting the Document to PDF, or round-trip for Microsoft Word.

• Hidden: If checked, the Work Item type is not displayed in the drop-down menu of the Document Editor toolbar. The presentation will be applied to existing Work Items of the type specified in Type (if any), but users will not be able to apply it manually to new or existing Document content.

• Actions: The icon adds another row to the table in which support for an additional Work Item type can be configured for the Document. The icon removes a row from the table, removing support in the Document for the specified Work Item type. The remove icon is disabled, and the row for the Work Item type cannot be removed if any Document content has been marked as a Work Item of the type defined by the row. The content must either be deleted from the Document, or unmarked as a Work Item in order to remove a row from the table, and support for the Work Item type it represents.

  The Select Fields button leads to the Select Fields dialog in which you can specify which Work Item fields should appear in the Document, and where they should appear. You can opt to show any field (including custom fields) in the Document, the Document Sidebar (Work Item Properties page) or both. Some fields (usually of Enumeration type) allow you to specify whether they appear as text, as an icon, or both. (Note that this dialog can also be opened via Select Fields menu item of Work Item Properties page of the Document Sidebar.)

  Fields configured as showing in the Document will be exported to PDF, and to Microsoft Word for Word round-trip.