LocalizationProvider.Abstractions 9.0.0

Supporting LocalizationProvider

If you find this library useful, cup of coffee would be awesome! You can support further development of the library via Paypal.

Localization Provider v9.0 - What's Up?

Version 9.0 modernizes the platform to .NET 10 and focuses on Admin UI productivity - most notably automatic machine translations (including translating many resources in one batch), per-resource notes for translators, and a round of performance work across resource synchronization and caching.

Tracking issue: https://github.com/valdisiljuconoks/LocalizationProvider/issues/345

What's new?

Platform

• .NET 10 target framework (Optimizely/Episerver integration updated to CMS 13)
• Nullable reference types enabled across the abstractions and core libraries
• Admin UI host integration rebuilt on Razor Pages with minimal-API service endpoints

Translations & Admin UI

• Automatic translations through a pluggable translator-provider model - ships with Azure AI / Cognitive Services. Translate a single resource straight from the edit dialog with one click.
• Batch translations (#373) - select multiple resources, pick the source and target language, optionally limit to only the empty translations, and review every proposed translation in a read-only preview before anything is saved to the database.
• Per-resource notes (#148) - attach a translator-facing comment/hint to a resource key for extra context. Declare them in code with the [Notes] attribute or edit them inline in the Admin UI (shown in the resource list and in the translation edit dialog), and they round-trip through CSV import/export.
• Bulk delete (#317) - select and remove multiple resources at once.
• Polished Admin UI dialogs - styled, in-app confirmation dialogs replacing native browser prompts.

Performance

• Resource synchronization reworked for large resource sets (SQL Server now syncs via a temp-table + bulk-copy path)
• Caching refactored - CachedTranslations, targeted cache invalidation (no full flush when filling the cache), and removal of hot-path allocations and ToLower() calls
• Memoized expression-based resource keys and cached query/command handler chains
• BenchmarkDotNet hot-path baseline added to guard against regressions

Fixes

• Case-insensitive language-code lookup (#368)
• Various bug fixes and dependency upgrades

Localization Provider v8.0!

I'm pleased to announce that Localization Provider v8.0 is finally out. Again - took a bit longer than expected 😃

What's new?

• .NET8 set as default target
• Added provider model for translations - starting with Azure AI for automatic translations
• ConfigurationContext now supports config configuration as well (you can change some settings after you have added and configured default settings for localization provider). This is very useful in unit test scenarios when you need to adjust some settings for specific test.
• Various bug fixes
• Some performance improvements (resource key comparison, pagination in Admin UI)
• Security improvements (by default upgrading insecure connections)
• Dependencies upgrade

More info in this blog post.

What is the LocalizationProvider project?

LocalizationProvider project is ASP.NET Mvc web application localization provider on steroids.

Giving you the main following features:

• Database-driven localization provider for Asp.Net Mvc applications projects
• Easy resource registrations via code
• Supports hierarchical resource organization (with help of child classes)
• Administration UI for editors to change or add new translations for required languages

Getting Started (.NET)

Bare Minimum to Start With

Below are code fragments that are essential to get started with a localization provider.

Install required packages:

> dotnet add package LocalizationProvider.AspNetCore
> dotnet add package LocalizationProvider.AdminUI.AspNetCore
> dotnet add package LocalizationProvider.Storage.SqlServer

Following service configuration (usually in Startup.cs) is required to get the localization provider working:

public class Startup
{
    public void ConfigureServices(IServiceCollection services)
    {
        // add your authorization provider (asp.net identity, identity server, whichever..)

        services
            .AddControllersWithViews()
            .AddMvcLocalization();

        services.AddRazorPages();
        services.AddRouting();

        services.AddDbLocalizationProvider(_ =>
        {
            _.UseSqlServer(Configuration.GetConnectionString("DefaultConnection"));
            ...
        });

        services.AddDbLocalizationProviderAdminUI(_ =>
        {
            ...
        });
    }

    ...
}

And following setup of the application is required as a minimum (also usually located in Startup.cs):

public class Startup
{
    ...

    public void Configure(IApplicationBuilder app, IHostingEnvironment env)
    {
        app.UseRouting();
        app.UseAuthentication();
        app.UseAuthorization();

        app.UseDbLocalizationProvider();
        app.UseDbLocalizationProviderAdminUI();
        app.UseDbLocalizationClientsideProvider(); //assuming that you like also Javascript

        app.UseEndpoints(endpoints =>
        {
            endpoints.MapControllers();
            endpoints.MapRazorPages();
            endpoints.MapDbLocalizationAdminUI();
            endpoints.MapDbLocalizationClientsideProvider();
        });
    }
}

Also, you can refer to sample app in GitHub for some more hints if needed.

More Detailed Help

• Getting Started
• Getting Started with AdminUI
• Localizing App Content
• Localizing View Model (with DataAnnotations attributes)
• Localizing Client-side

Getting Started - Optimizely CMS/Commerce

• Working with Resources (Optimizely)
• Optimizely Frontend Localization
• Optimizely Xml File Migration

Supported DbLocalizationProvider Storage Providers

• SQL Server
• PostgreSql
• MongoDb
• Azure Tables

Working with DbLocalizationProvider Stuff

• Localized Resource Types
• Synchronization Process
• MSSQL Storage Configuration
• Working with Resources
• Working with Languages
• Translating System.Enum Types
• Mark Required Fields
• Foreign Resources
• Hidden Resources
• Reference Other Resource
• Cache Event Notifications
• XLIFF Support
• CSV Support
• Migrations & Refactorings

Integrating with Optimizely

• For more information about Optimizely integration - read here

Other Versions

Localization Provider v7.x Released

Please read more in this blog post!

More Info

• Part 1: Resources and Models
• Part 2: Configuration and Extensions
• Part 3: Import and Export
• Part 4: Resource Refactoring and Migrations