Description box in web client

If extended rich text is enabled for your application server, various icons are available to format text in the Description field.

Procedure

  1. To enable extended rich text, complete one of the following steps:
    • In the Advanced Properties page, set the Enable extended rich text presentation property to True. For more information, see Configuring advanced properties.
      1. Edit the server-installation-directory\server\conf\ccm\teamserver.properties file.
      2. Stop the server, and then add the following line in the teamserver.properties file: com.ibm.team.workitem.enableExtendedRichTextPresentation=true.
      3. Save the updated teamserver.properties file, then restart the server.

    The following icons are available.

    Toolbar icon Description Keyboard shortcut Windows Keyboard shortcut iOS
    Bold icon Undo Ctrl + Z Cmd + Z
    Bold icon Redo Ctrl + Y Cmd + Y
    Bold icon Bolds text. Ctrl + B Cmd + B
    Italics icon Italicizes text. Ctrl + I Cmd + I
    Strikethrough icon Places a line through text. Ctrl + K Cmd + K
    Underline icon Places a line under the text. Ctrl + U Cmd + U
    Remove Format icon Removes all formatting from the selected text. Shift + Space Shift + Space
    Numbered list icon Inserts a numbered list. Ctrl + Alt + N Cmd + Alt + N
    Bulleted list icon Inserts an unordered list. Ctrl + Alt + O Cmd + Alt + O
    Insert horizontal line icon Inserts a horizontal line across the entire length of the Description field. Ctrl + Shift + Alt + H Cmd + Shift + Alt + H
    Font icon Applies a specific font to text. Select the wanted font from the list.    
    Size icon Sets text to a specific size. Select the wanted size from the list.    
    Text Color icon Sets the color of the text. Select the wanted color from the grid.    
    Background Text Color icon Sets the background color of the text. Select the wanted background color from the grid.    
    Decrease Indent icon Decreases the indentation of the selected text. Ctrl + Shift + Alt + E Cmd + Shift + Alt + E
    Increase Indent icon Increases the indentation of the selected text. Ctrl + Shift + Alt + N Cmd + Shift + Alt + N
    Insert table Insert the table inline to the description. Ctrl + Shift + 1 Cmd + Shift + 1
    Add image icon Inserts image inline to the description. The following types of images are supported:
    • JPEG
    • GIF
    • PNG
    • BMP
    		 Ctrl + Shift + 2 Cmd + Shift + 2
    Inter or edit external link icon Insert or edit an external link in the description Ctrl + Shift + 6 Cmd + Shift + 6
    Insert user link icon Insert a user link in the description Ctrl + Shift + 7 Cmd + Shift + 7
    Insert work item link icon Insert a work item link into the description Ctrl + Shift + 8 Cmd + Shift + 8
    Open accessibility icon Open accessibility help Alt + 0 Option + 0
  2. To add images, inline to the description:
    1. Place your cursor where you want to add an image, and consider the following scenarios:
      Copy-paste a screenshot from the clipboard
      You can capture a screen shot and use the browser context menu or press Ctrl+V on Windows or Cmd+V on Mac to paste it in the description of a work item.
      Copy-paste an image from the file explorer
      You can copy an image file from file explorer by using the browser context menu or press Ctrl+C on Windows and Cmd+C on Mac and paste it in the description of a work item by using the browser context menu or keyboard shortcuts Ctrl+V on Windows and Cmd+V on Mac.
      Browse an existing attachment of the same work item
      1. Click the Add image icon icon or press Cmd+Shift+2 on Mac and Ctrl+Shift+2 on Windows to open the Insert image box.
      2. In the Attachment on this work item field, select from the filtered list of attachments, the attachment that you want to add as an image or in the Attachment ID field, specify the ID of the attachment. You can preview the image in the Preview box.
      3. In the Alternative text field, specify the alternative text for the image and click OK.
      Browse an existing attachment of another work item
      To add an image added as an attachment in another work item, specify the attachment ID of that image in the Insert image box.
    2. To view or edit the properties of an inline image, double-click the image or select the image and press Cmd+Shift+2 on Mac and Ctrl+Shift+2 on Windows to open the Insert image box.
    3. You can resize inline images that are added to the work item description and large HTML fields. You use the drag handles that are available on the corners of the image and move them to resize the image to the required size.
  3. To add a table in the description field, click the Insert table icon or press Ctrl+Shift+1 on Windows and Cmd+Shift+1 on Mac. Click within the table to get the balloon toolbar that you can use to perform the following actions:
    • Column operations:
      • Set header column
      • Insert column
      • Delete column
      • Select column
    • Row operations
      • Set header row
      • Insert row
      • Delete row
      • Select row
    • Set table properties
      • Set table border properties
      • Set background color of the table
      • Set the dimensions of the table
    • Set cell properties
      • Set cell border properties
      • Set background color of the cell
      • Set the dimensions of the cell
      • Set the text alignment in the cell
    • Toggle table caption
    • Merge cells
      • Merge cells horizontally or vertically
      • Split cells horizontally or vertically
    You can hover over the table to perform the following additional actions:
    • Select and delete the table using the delete key.
    • Drag and drop table within the different part of the editor.
    • Insert a paragraph before or after the table.

    Consider the following information to know more about the actions that you can perform on the inline images and tables from various editors.

    Editors Add an inline image/table View an inline image/table Edit an inline image/table Copy from another work item Delete an inline image/table
    Work item editor Y Y Y Y Y
    Plans inline editor Y Y Y Y Y
    Query results inline editor Y Y Y Y Y
    Quick planner N Y N Y Y
    Eclipse client N Y N N N
    Visual studio client Y Y Y Y Y
    OSLC creation dialog Y Y Y Y Y
    OSLC, REST, or Java™ client Y N Y Y Y
    Note:
    • Viewing and editing of inline images and tables is in accordance with the existing extended rich text (ERT) behavior.
    • You cannot copy and paste an image from a work item in one Engineering Workflow Management repository to a work item in another Engineering Workflow Management repository.
    • The history of a work item displays the latest version of the table. It shows changes to the table contents but does not highlight structural changes, such as adding, deleting rows and columns.
    • Tables are not visible if the email format is plain text.
    • You can only see the alt-text of the image in an email.
    • You can view the inline images added in the work item description and large HTML fields of Jazz Reporting Service reports, but not tables.
    • You cannot view the inline images and tables added in the work item description and large HTML fields from IBM® Engineering Lifecycle Optimization - Publishing - generated documents and IBM Engineering Lifecycle Optimization Engineering Insights views.
    • You cannot view existing inline images in the work item history view if the context root is changed as part of the server rename. Any new images added to the work item after the server rename are displayed in the history view.