Skip to main content

Rigi Documentation

Add contextual comments and images

Capturing previews for some strings can be hard due to various reasons, such as:

  • It can be complicated to simulate a specific application state so that the error is shown.

  • The person who captures the previews has no permission to enter a specific area.

  • The developers have not yet finalized the UI for this string.

  • The string is no longer used and should be removed from the code.

In such cases, we recommend adding a contextual comment or a contextual image in one of the following areas:

  • In the Capture manager (for details, see Capture manager).

  • In the Texts > String list section of the project menu.

  • In the Context > Texts section of the project menu.

To add or edit a contextual comment or an image for a single string, perform the following steps:

  1. Hover over the required string and click the Edit.png icon. The Edit contextual comment popup will be displayed.

    Context_comment1.png

  2. Enter your comment in the Contextual comment field or upload a contextual image in the field below. You can add both a comment and an image, if necessary.

  3. Click the Save button.

To add or edit a contextual comment for multiple strings, select these strings and click the Edit_comment.png icon above the list.

To add or edit a contextual image for multiple strings, select these strings and click the contextual_image.png icon above the list.

Your comments and images are now displayed in the string list. The Coverage area also displays the number of contextual comments.

Context_comment2.png

Translators will also see contextual comments and images in Rigi Viewer when they select a string not covered by an HTML preview in the online editor.

String_translators.png

Contextual comments can be exported along with the strings in an XLIFF file (for details, see Export XLIFF).