i18nStronglyTypedCore 1.0.0.1

i18nStronglyTypedCore

This is the source code for the i18nStronglyTypedCore nuget package.

Github source code

About

It is a .net core port of afana's excellent i18n (internationalization) provider for MVC 5, using xml for the resource strings.

Of course, dotnet core has its' own i18n provider but like many people, I'd rather keep things strongly typed as much as possible. It's simple to get up and running.

Prerequisites

• Dotnet core 2.1+

To get up and running (quick tutorial)

1. Create an asp.net core application.

• In Visual Studio this is:

• File > New > Project > Web Tab > Asp.NET Core Web Application

• Give it a name (and location, not the one used in the pic) and hit ok

3. Choose the mvc option (which this tutorial uses) and hit ok.

2. Via the CLR or Package Manager (View > Other Windows > Package Manager Console) enter the following, then hit enter:

Install-Package i18nStronglyTypedCore

3. In wwwroot, add a folder called Resources and in that add an xml file called Resources.xml

4. In resources.xml, insert the following placeholder content:

WARNING: The following example has the default culture to be British English (en-GB). You may need en-US or another culture.

<?xml version="1.0" encoding="utf-8" ?>
<resources>
    
    <resource culture="en-GB" type="string" name="Site_Name" value="Site name (english)"></resource>
    
    
    <resource culture="fr-FR" type="string" name="Site_Name" value="Site name (Francais)"></resource>

</resources>

5. Add a top level folder called 'Resources' (not in wwwroot) and create a class called i18n.

6. Have that class inherit from i18nStronglyTypedCore.i18n and include the following property in the class.

public static string Site_Name { get { return GetStringValue(); } }

7. In startup.cs 'Configure' method, add the following 2 lines to initialise the resources.

var pathToResources = System.IO.Path.Combine(env.WebRootPath, @"Resources\Resources.xml");
Resources.i18n.InitResources(pathToResources);

`

8. In views/home/index, remove the standard content and add the following (remember to replace 'Testweb' with you own website's namespace).

@{
    ViewData["Title"] = "Home Page";
}
<h4>English Site Name</h4>
<p>@Testweb.Resources.i18n.Site_Name</p>

<h4>French Site Name</h4>
<p>@Testweb.Resources.i18n.GetLocalisedStringValue(() => Testweb.Resources.i18n.Site_Name, "fr-FR")</p>

9. Run the website. The end result should look like this.

NOTE: The provider will take from the current culture by default.

10. There are many ways to change the default culture. As a quick example, you could place the following in Startup.cs Configure method (before the resources code!)

var cultureInfo = new System.Globalization.CultureInfo("fr-FR");
System.Globalization.CultureInfo.DefaultThreadCurrentCulture = cultureInfo;
System.Globalization.CultureInfo.DefaultThreadCurrentUICulture = cultureInfo;

`

11. Now run the site. The default culture will also be in french. Remove the work done in step 10 to get back to normal.

`