Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Section
titleParameters


Section
titlekeys

The comma-separated list of I18N keys.

If no key is provided the service returns with a BAD REQUEST (HTTP code 400).

projectdoc-box-tip

The article Localization provides the most relevant keys.

The resource bundle with valid keys is part of the OBR or JAR file that are deployed to your Confluence server.



projectdoc-section
titlelocale

The optional locale to use. If not provided, the context of the call defines the locale.

Typically the value is not provided so that the locale provided of the user's context is used. In case a user needs to fetch localized information by a locale that is different from its default, supply a locale of the format accepted by toLocale(String).

If a locale is specified, but invalid, the service returns with a BAD REQUEST (HTTP code 400).

Default value: The locale specified by the calling user as default.


Section
titlestrict

The boolean flag allows to control whether or not the keys must be translated literally.

If this flag is set to false, the keys may be short versions where the prefix projectdoc.doctype.common. is missing for readability.

Note Box

Users may only want to set this flag to true in case they need to actually access a label by a key that contains no dot.

Default value: false


...