Captions

You can add a caption to several types of content in Polarion.

• Images (in Documents, Work Items, table cells)

• Tables (in Documents, Work Items)

• Diagrams (in Documents, Work Items, table cells)

To add a caption, click on the item, then click Add Caption on the pop-up menu. In the Add Caption dialog box, you can:

• Enter caption text in the Caption field.

• Select whether the caption should appear above or below the item by clicking the appropriate icon in Show At.

• Select a label that describes the item type, or add a new label. The value set in this field is prefixed to the value in the Caption field.

You can optionally add a new label and apply it when captioning images, diagrams or tables. For example, you might create a label mamed Citation and specify it when adding a caption to some items. You could then insert a Table of Citations in your Document. Note that tables of figures, tables of tables, and tables of custom-labeled items appear only in documents generated by export to PDF and Round-trip for Microsoft Word. A placeholder appears in your Polarion Document.

A custom caption label appears in the Label list when the Document contains a caption that uses it. To remove a custom label, remove all captions that use it and refresh your browser.

Captions and On-demand Work Item loading

When on-demand Work Item loading is enabled by administrators in the system configuration it affects captions as follows:

• If the Document's Work Item Presentation configuration is set up for Test Steps or rich-text type Custom Fields to be visible, then all caption numbers appear as a hash mark (#). They are replaced with the correct numbers when exported.

• If the Document's Work Item Presentation configuration does not contain Test Steps or Custom Fields as outlined above, then caption numbers will display, even with on-demand Work Item loading enabled.

  Visible caption numbers will display correctly even if previous captions from the same sequence have not finished loading.

When on-demand Work Item loading is disabled, then all caption numbers will appear in the Document, but they may take a while to load if the Document is a large one with many Work Items and/or captioned content.

Image

Table

Diagram

There are two default caption label values: Table and Figure. These values determine if a caption is included in a Table of Figures or a Table of Tables, if these are inserted into a Document.