Skip to main content

Rigi Documentation

Add contextual comments

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

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

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

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

  • The string is not used anymore and should be removed from the code.

In such cases, we recommend adding a contextual comment:

  1. In the Capture manager, hover over the required string and click the Edit.png icon.

    To add the same comment for several strings, select those strings and click the Edit.png icon above the list.

    Contextual_comments2.png

  2. Enter your comment in the Edit contextual comment popup and click the Save button.

Your comment is now displayed in the string list. The Coverage area also displays information about the number of contextual comments.

Contextual_comments3.png

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

String_translators.png