Skip to content

Localization

Jump to bottom
Vlada Shubina edited this page Nov 4, 2022 · 3 revisions

Template localization

.NET Templates are localizable. If a template is localized for the language matching the current locale, its elements will appear in that language in hosts that use the Template Engine libraries, including dotnet new and the Visual Studio New Project Dialog. Localizable elements are:

  • name
  • author
  • description
  • symbols
    • description
    • display name
    • description and display name for choices for choice parameters
  • post actions
    • description
    • manual instructions

Localization files should be located inside the .template-config\localize folder. The format of the localization file is JSON, and there should be one file per language. The naming convention for localization files is: templatestrings.<lang code>.json, where the lang code should match one of the CultureInfo names from the list provided by GetCultures. The structure of the localization JSON files consist of key-value pairs, where:

  • The key is the reference to an element of template.json to be localized. If the element is a child, the full path using / delimiter should be given. Example: symbols/Framework/choices/netstandard2.1/description.
  • The value is the localization of the element given by the key.

Examples of localization files can be found here.

These files are to be parsed by the template engine when loading information about the template. The Template Engine API returns information for localizable properties in language matching the current UI culture (if localization is available) transparently, without explicit user action.

Post action localization

Ensure that all post actions in template.json have an id property prior setting up the localization. The id should be unique within the template. Without the id property the localization files cannot be created. In case the post action uses more than one manualInstructions, id should be also added for each manual instruction.

Automatic generation of localization files

The localization files can be generated automatically as part of a build using the LocalizeTemplates MSBuild task from the Microsoft.TemplateEngine.Tasks package. The task is meant to be used in template package project and will create the JSON files after the project is built. The task supports the configuration using following properties:

  • LocalizableTemplatesPath - the folder containing templates to be localized. Default value: ..
  • TemplateLanguages - the languages to create files for. Default value: cs;de;en;es;fr;it;ja;ko;pl;pt-BR;ru;tr;zh-Hans;zh-Hant.

Example of usage:

<PropertyGroup>
   <LocalizeTemplates>true</LocalizeTemplates>
   <TemplateLanguages>en;de</TemplateLanguages>
</PropertyGroup>

<ItemGroup>
   <PackageReference Include="Microsoft.TemplateEngine.Tasks" Version="1.0.0.0" PrivateAssets="all" IsImplicitlyDefined="true" />
</ItemGroup>

This example will generate localization files for English and German languages for all templates in the package.

1st party templates localization

Prerequisite: the repo should be onboarded for OneLocBuild to localize the template content. See the link for more details.

Repo is using arcade

Microsoft.TemplateEngine.Tasks is included to Microsoft.DotNet.Arcade.Sdk. To start localizing the templates, enable the following property in template package project: <UsingToolTemplateLocalizer>true</UsingToolTemplateLocalizer>. This enables generating localization JSON files on the build. Arcade has all the configuration applied that allows to automatically detect template package project and handover JSON files for localization and receive the back. After the translation is done, the repo receives the PR replacing original English values in generated files with localized one.

Repo is not using arcade

Microsoft.TemplateEngine.Tasks may be still manually added to engineering or directly to template package project as explained above. In addition to that, localization handover process should be changed as following:

  • LocalizeTemplates task generates ready files to be used including <lang code> in filename. OneLocBuild should receive the file without language code: templatestrings.json. The localization pipeline should rename the templatestrings.en.json to templatestrings.json and include it to localization project JSON to be translated.
  • please work with your localization developer advocate to ensure that
    • localization files are handed back in JSON format and to original location After the translation is done, the repo should receive the PR replacing original English values in generated JSON files with localized ones. It is important to ensure that files are handed over to original location (.template.config\localize folder).

It is recommended to setup a way to update Microsoft.TemplateEngine.Tasks package version, however it is not recommended to update it on each daily build. The package is released with each build of dotnet/templating repo, even if there are no changes. Therefore, updating the version on each build might be superfluous. It is recommended to update the version when the next preview or stable version is released.

3rd party templates localization

  • Include LocalizeTemplates task from Microsoft.TemplateEngine.Tasks as explained above. Microsoft.TemplateEngine.Tasks is available on NuGet.org.
  • Control the languages to be used with TemplateLanguages property.
  • Translate the content in generated JSON files using any suitable means prior to distributing template package.

It is recommended to update Microsoft.TemplateEngine.Tasks package version when the next preview or stable version is released.

Clone this wiki locally