Knowit.ResourceEditor 3.0.0

Knowit Resource Editor

Installation

Knowit.ResourceEditor provides a UI for Optimizely editors to translate (or override existing translations) for resource strings. In order to install Resource Editor use the following command:

> dotnet add package Knowit.ResourceEditor --source https://www.myget.org/F/creuna-nuget/api/v3/index.json

After installation:

• Open Startup.cs
• Register Resource Editor services with extension method AddResourceEditor
• Add name for registered localization providers passing it as parameter to methods AddEmbeddedLocalization/AddLocalizationProvider

example:

    public void ConfigureServices(IServiceCollection services)
    {
        if (_webHostingEnvironment.IsDevelopment())
        {
            AppDomain.CurrentDomain.SetData("DataDirectory", Path.Combine(_webHostingEnvironment.ContentRootPath, "App_Data"));

            services.Configure<SchedulerOptions>(options => options.Enabled = false);
        }

        services
            .AddCmsAspNetIdentity<ApplicationUser>()
            .AddCms()
            .AddAdminUserRegistration()
            ;

        services.AddResourceEditor();

        services
            .AddEmbeddedLocalization<Startup>("Site translations")
            ;
    }

• Initialize ResourceEditor components with extension method UseResourceEditor,

example:

    public void Configure(IApplicationBuilder app, IWebHostEnvironment env)
    {
        if (env.IsDevelopment())
        {
            app.UseDeveloperExceptionPage();
        }

        app.UseStaticFiles();
        app.UseRouting();
        app.UseAuthentication();
        app.UseAuthorization();

        app.UseResourceEditor();

        app.UseEndpoints(endpoints =>
        {
            endpoints.MapContent();
        });
    }

• Configure Resource Editor via code implementing configuratoin action (by default "WebAdmins" required role is used)

example:

    services.AddResourceEditor(configurePolicy => configurePolicy.RequireRole("Administrators"), options =>
        {
            options.DefaultResourceProviders = new List<string>
            {
                "Site translations" //NOTE: Registered localization providers' names should be used here.
            };
            
            options.DefaultFromLanguage = "en";
            options.DefaultToLanguage = "no";
        });
    }

or/and configure via 'appsettings.json' (configuration in appSettings.json has highest proirty over configuration in code)

example:

"ResourceEditor": {
    "DefaultResourceProviders": 
    [
        "EmbeddedXmlLocalization"
    ],
    "DefaultPageSize": "200",
    "DefaultModeIsSimple": "true",
    "DefaultSortField": "From",
    "DefaultIsAscending": "false",
    "DefaultFromLanguage": "en",
    "DefaultToLanguage": "no"
    "AutoSaveInterval": "15000",
    "TranslationsFileNameFormat": "translations_{0}.xml",
    "TranslationsArchiveFileName": "translations.zip",
  }

How to use

ResourceEditor can be found under edit mode Main Menu → Resource Editor

Common scenarios

Translate resources

1. Select From and To languages
2. Optionally add a search phrase and press Load button. Leave search phrase empty to load all resources
3. When resources are loaded

• Use To column to add translation and press Enter, Tab or mouse click to next resource in order to save changes. Check Status column to ensure changes are saved
• Use local filtering (heading of each column)
• Sorting

NOTE: There is a toggle Hide translated/Show overridden that can be useful when already translated needs to be hidden or otherwise show translated only. By default, none of them is checked. When this filter is changed resources must be reloaded by pressing Load button

Edit resources

In order to edit existing or previously added translations set From and To languages to a needed language. Use To column for editing.

Advanced scenarios

Configuration

Commonly used providers must be configured in Startup.cs. Usually there are built-in providers like EPiServerShellModulesResources, EPiServerShellProductModulesResources etc. that doesn’t need to be translated and therefore must be hidden by default. Settings->Resource providers in the advanced panel allow to temporary enable them and translate/change.

Export/Import

This function might be useful when changes are done in one environment and then needs to be moved to another for instance from Staging to Production or otherwise when Staging needs to be refreshed from Production.

• Export All - Exports all resources regardless applied filter
• Export Filtered - Exports all filtered. Only server filter is taken into account, local filters (heading of each column) are ignored
• When resources are imported all existing are overwritten so be careful with import in production environment and do a backup using Export All