Skip to main content

Rigi Documentation

Configure documentation settings

Important

The settings and actions described below are only available to Rigi subscribers. For details, see the User roles section.

In the user_menu.png (system menu) > Server settings > Documentation display, you can configure general settings for documentation books and screenshots. By default, those settings will be applied to new books, but can be changed for specific books (for details, see the Create screenshots based on HTML previews guide).

Documentation.png

In this display, you can make the following settings:

  • Set the size of the browser window in which the HTML preview is loaded.

  • Select image format for screenshots: jpeg or png.

  • Add values in different languages for variables used in your application. This will then enable you to localize variables on screenshots, for example, when a captured HTML preview contains names or proper nouns. Using locale-specific variables, you can ensure the screenshots will display the localized variants.

    To do so, perform the following steps:

    1. To add a locale-specific value, click the Edit.png 'Edit variables' icon. The Edit locale-specific variables popup will be displayed.

      locale_variables.png

    2. From the Select locales dropdown, select the languages for which you will add values.

    3. In the Variables field, enter the name of the variable.

    4. In the Settings section, enter the required values for the selected languages.

      Default value

      To use a default value for a variable, enter the required value in the Settings field and leave the language-specific fields empty.

    5. Click the Save button.

  • To export locale-specific variables to a CSV file, click the Download_blue.png 'Export variables' icon. The Export locale-specific variables popup will be displayed.

    Export_variables.png

    1. Specify whether you want to export variables to a single file or create a separate file for each language.

    2. Specify the CSV separator (comma or semicolon).

    3. Click the Export button.

  • To import variables from a CSV file, click the Upload_blue.png 'Import variables' icon and upload the required file.

In this section: