User Info

EN | Purpose, features, utilization of the UPPS! Extension WorkItem Hider (WH)

---

Page overview

WhatWho is mythis appropriatedocumentation rolefor?

as

You are a reader?Polarion

Anyuser rolereponsible whose tasks include utilizing Polarion, especiallyfor creating Work Item content, such as documentation embedded to LiveDocs.

What should I already know?Prerequisites

Before reading this documentation you should be familiar with creating and editing Work Item content in Polarion.

What you will I learn?learn

After reading this documentation, you will be able to:

• Understand the purpose and concept of the WorkItem Hider.
• Use the Work Item Hider to make selected Work Items in a LiveDoc hideable.

Overview of WorkItem Hider

Documentation is most effective when it is available directly at the point of use. In Polarion, document templates often include help or comment Work Items that guide users when creating or editing Work Items in derived documents.

However, when a document is created from such a template, these help/comment Work Items appear alongside the actual Work Items. In documents with extensive guidance, this can clutter the structure and reduce readability. Deleting the help/comment Work Items improves the overview, but doing so too early may remove valuable guidance that is still needed later.

The WorkItem Hider solves this problem by allowing help and comment Work Items to be shown or hidden as needed, without deleting them.

Instructions for use

Define hideable Work Items

In a Polarion project, administrators can define which Work Items are automatically treated as hideable in project LiveDocs. 

The criteria can be based, for example, on:

• the Work Item type, or
• a specific Work Item field value that identifies a Work Item as help or comment content  

Contact your system or project administrator to configure these criteria for your project.  

Once the criteria are configured, you can create hideable Work Items in your LiveDocs by:

• using the defined Work Item types, or
• setting the defined field values in your Work Items.

Identify a toggle hideable Work Items

Any Work Item that meets the configured criteria for hideable content displays a Hide/Unhide icon on the right side of the LiveDoc Editor.

Click the Hide/Unhide icon to hide or show the Work Item.

Depending on your user settings, hidden Work Items are displayed in one of the following ways:

• Hidden with hover preview: The Work Item is not visible in the LiveDoc Editor unless you hover over its position or unhide it.
  
  
  
• Always shown in compact view: A compact (minimized) view of the Work Item remains visible until the Work Item is unhidden.
  
  
  

Clicking a hidden Work Item restores it also to the normal view.

Further actions

If a LiveDoc contains at least one hideable Work Item, an action button is displayed next to each heading Work Item in the LiveDoc.  

Left-click the button to hide or show all hideable Work Items below the heading.

Left-click the button to open a menu with the following options:

Hide Children:

• Hides all hideable Work Items below the current heading.

Show Children:

• Shows all hideable Work Items below the current heading.

Hide All:

• Hides all hideable Work Items in the current LiveDoc.

Show All:

• Shows all hideable Work Items in the current LiveDoc.

LiveDoc w/o hideable WIs:

• Opens the current LiveDoc in a new tab with all hideable Work Items filtered out.

Table w/o hideable WIs:

• Opens the Table View of the current LiveDoc in a new tab with all hideable Work Items filtered out.

User settings

You can configure the WorkItem Hider to match your personal preferences. To access the user settings:

1. Open the UPPS! Extensions Menu in the Polarion Navigation Header.
2. Select WorkItem Hider Config.

The User Configuration dialog opens, which provides the following user settings:

Always Display Compact View:

• When enabled, hidden Work Items are shown in their compact view.
• When disabled, the compact view appears only by hovering over the position of a hidden Work Item.

Settings saved in the User Configuration dialog apply only to the current user and are effective across all projects on the server where the extension is active.