-
Notifications
You must be signed in to change notification settings - Fork 3.3k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #10147 from abpframework/maliming/docs-1
How to override localization strings of depending modules
- Loading branch information
Showing
3 changed files
with
88 additions
and
0 deletions.
There are no files selected for viewing
Binary file added
BIN
+32 KB
...cles/2021-09-25-How-to-Override-Localization-Strings-Of-Depending-Modules/1.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added
BIN
+26.1 KB
...cles/2021-09-25-How-to-Override-Localization-Strings-Of-Depending-Modules/2.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
88 changes: 88 additions & 0 deletions
88
...es/2021-09-25-How-to-Override-Localization-Strings-Of-Depending-Modules/POST.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,88 @@ | ||
# How to override localization strings of depending modules | ||
|
||
## Source Code | ||
|
||
You can find the source of the example solution used in this article [here](https://github.com/abpframework/abp-samples/tree/master/DocumentationSamples/ExtendLocalizationResource). | ||
|
||
## Getting Started | ||
|
||
This example is based on the following document | ||
https://docs.abp.io/en/abp/latest/Localization#extending-existing-resource | ||
|
||
We will change the default `DisplayName:Abp.Timing.Timezone` and `Description:Abp.Timing.Timezone` of [`AbpTimingResource`](https://github.com/abpframework/abp/blob/dev/framework/src/Volo.Abp.Timing/Volo/Abp/Timing/Localization/AbpTimingResource.cs) and add localized text in [Russian language(`ru`)](https://github.com/abpframework/abp/blob/dev/framework/src/Volo.Abp.Timing/Volo/Abp/Timing/Localization/en.json). | ||
|
||
I created the `AbpTiming` folder in the `Localization` directory of the `ExtendLocalizationResource.Domain.Shared` project. | ||
|
||
Create `en.json` and `ru.json` in its directory. | ||
|
||
`en.json` | ||
```json | ||
{ | ||
"culture": "en", | ||
"texts": { | ||
"DisplayName:Abp.Timing.Timezone": "My Time zone", | ||
"Description:Abp.Timing.Timezone": "My Application time zone" | ||
} | ||
} | ||
``` | ||
|
||
`ru.json` | ||
```json | ||
{ | ||
"culture": "ru", | ||
"texts": { | ||
"DisplayName:Abp.Timing.Timezone": "Часовой пояс", | ||
"Description:Abp.Timing.Timezone": "Часовой пояс приложения" | ||
} | ||
} | ||
``` | ||
|
||
![](1.png) | ||
|
||
We have below content in `ExtendLocalizationResource.Domain.Shared.csproj` file, See [Virtual-File-System](https://docs.abp.io/en/abp/latest/Virtual-File-System#working-with-the-embedded-files) understand how it works. | ||
|
||
```xml | ||
<ItemGroup> | ||
<EmbeddedResource Include="Localization\ExtendLocalizationResource\*.json" /> | ||
<Content Remove="Localization\ExtendLocalizationResource\*.json" /> | ||
</ItemGroup> | ||
|
||
<ItemGroup> | ||
<PackageReference Include="Microsoft.Extensions.FileProviders.Embedded" Version="5.0.*" /> | ||
</ItemGroup> | ||
``` | ||
|
||
Change the code of the `ConfigureServices` method in `ExtendLocalizationResourceDomainSharedModule`. | ||
|
||
```cs | ||
Configure<AbpLocalizationOptions>(options => | ||
{ | ||
options.Resources | ||
.Add<ExtendLocalizationResourceResource>("en") | ||
.AddBaseTypes(typeof(AbpValidationResource)) | ||
.AddVirtualJson("/Localization/ExtendLocalizationResource"); | ||
|
||
//add following code | ||
options.Resources | ||
.Get<AbpTimingResource>() | ||
.AddVirtualJson("/Localization/AbpTiming"); | ||
|
||
options.DefaultResourceType = typeof(ExtendLocalizationResourceResource); | ||
}); | ||
``` | ||
|
||
Execute `ExtendLocalizationResource.DbMigrator` to migrate the database and run `ExtendLocalizationResource.Web`. | ||
|
||
We have changed the English localization text and added Russian localization. | ||
|
||
### Index page | ||
|
||
```cs | ||
<p>@AbpTimingResource["DisplayName:Abp.Timing.Timezone"]</p> | ||
@using(CultureHelper.Use("ru")) | ||
{ | ||
<p>@AbpTimingResource["DisplayName:Abp.Timing.Timezone"]</p> | ||
} | ||
``` | ||
|
||
![](2.png) |