close

Filter

loading table of contents...

CoreMedia Content Cloud v11 Upgrade Guide / Version 2110

Table Of Contents

6.3.3.2 Tool Support

Of course it is possible to migrate content type localizations manually to the new API. But especially for larger parts it is more convenient to use a converter tool which takes care of everything, except the icons. SVG icons need to be provided manually and added to content type localization registrations where needed.

The primary parameter for the tool is the default-locale file of a content type localization resource bundle. The conversion result depends on whether this file belongs to an extension or not.

If the file belongs to an extension, the tool takes care of:

  • Creating a new shared localization module under apps/studio-client/shared/js/extensions.

  • Generating the new localization resource bundle.

  • Generating the registration code.

  • Adding the new shared module as a dependency to the (extension) module where the input file is located.

  • Creating an extension module for the other apps (currently just one, that is the Workflow App).

Note

Note

Afterwards, the extension tool needs to be used to (re-enable) the extension.

For example, to run the converter tool for a resource bundle LivecontextDocTypes_properties, you switch to the directory apps/studio-client/tools/localization-converter and make the following pnmp call:

pnpm run convert $WORKSPACE_ROOT/apps/studio-client/apps/main/extensions/lc/src/LivecontextDocTypes_properties.ts

If the file does not belong to an extension, you need to provide a name for the new shared localization module in addition to the input file. The tool then takes care of:

  • Creating a new shared localization module with the given name under apps/studio-client/shared/js.

  • Generating the new localization resource bundle.

  • Generating the registration code.

  • Adding the new shared module as a dependency to the module where the input file is located.

Afterwards, you need to add the new shared module as a dependency to the other apps manually. For example, to run the converter tool for a resource bundle BlueprintDocumentTypes_properties, switch to the directory apps/studio-client/tools/localization-converter and run the following code:

pnpm run convert $WORKSPACE_ROOT/apps/studio-client/apps/main/blueprint/blueprintforms/src/BlueprintDocumentTypes_properties.ts -- --sharedPackageBaseName=blueprint-doctypes

There are further advanced options for the tool which might be needed in some special cases.

  • additionalLocales (defaults to ["de","ja"])

    Which locales, besides the default locale, the generated resource bundle should include.

  • coreVersion

    Use this option to explicitly define the version of the used CoreMedia studio-client core. If none is provided the version is derived from the dependencies of the packages containing the given properties files.

  • jangarooNpmVersion

    Use this option to explicitly define the version of the used Jangaroo npm packages. If none is provided the version is derived from the dependencies of the packages containing the given properties files.

Search Results

Table Of Contents
warning

Your Internet Explorer is no longer supported.

Please use Mozilla Firefox, Google Chrome, or Microsoft Edge.