diff --git a/aspnet-core/modules/localization-management/LINGYUN.Abp.LocalizationManagement.Application.Contracts/README.EN.md b/aspnet-core/modules/localization-management/LINGYUN.Abp.LocalizationManagement.Application.Contracts/README.EN.md new file mode 100644 index 000000000..cdb780aec --- /dev/null +++ b/aspnet-core/modules/localization-management/LINGYUN.Abp.LocalizationManagement.Application.Contracts/README.EN.md @@ -0,0 +1,46 @@ +# LINGYUN.Abp.LocalizationManagement.Application.Contracts + +The application service layer contract module for localization management, defining application service interfaces, DTO objects, and permission definitions. + +## Features + +* Defines language management application service interfaces +* Defines resource management application service interfaces +* Defines text management application service interfaces +* Defines permissions and authorization +* Provides DTO object definitions + +## Module Dependencies + +```csharp +[DependsOn(typeof(AbpLocalizationManagementApplicationContractsModule))] +public class YouProjectModule : AbpModule +{ + // other +} +``` + +## Permission Definitions + +* LocalizationManagement.Resource - Authorizes access to resources +* LocalizationManagement.Resource.Create - Authorizes resource creation +* LocalizationManagement.Resource.Update - Authorizes resource modification +* LocalizationManagement.Resource.Delete - Authorizes resource deletion +* LocalizationManagement.Language - Authorizes access to languages +* LocalizationManagement.Language.Create - Authorizes language creation +* LocalizationManagement.Language.Update - Authorizes language modification +* LocalizationManagement.Language.Delete - Authorizes language deletion +* LocalizationManagement.Text - Authorizes access to texts +* LocalizationManagement.Text.Create - Authorizes text creation +* LocalizationManagement.Text.Update - Authorizes text modification +* LocalizationManagement.Text.Delete - Authorizes text deletion + +## Application Service Interfaces + +* `ILanguageAppService`: Language management application service interface +* `IResourceAppService`: Resource management application service interface +* `ITextAppService`: Text management application service interface + +## More Information + +* [中文文档](./README.md) diff --git a/aspnet-core/modules/localization-management/LINGYUN.Abp.LocalizationManagement.Application.Contracts/README.md b/aspnet-core/modules/localization-management/LINGYUN.Abp.LocalizationManagement.Application.Contracts/README.md new file mode 100644 index 000000000..58caaa5b8 --- /dev/null +++ b/aspnet-core/modules/localization-management/LINGYUN.Abp.LocalizationManagement.Application.Contracts/README.md @@ -0,0 +1,46 @@ +# LINGYUN.Abp.LocalizationManagement.Application.Contracts + +本地化管理应用服务层契约模块，定义了本地化管理的应用服务接口、DTO对象和权限定义。 + +## 功能特性 + +* 定义语言管理应用服务接口 +* 定义资源管理应用服务接口 +* 定义文本管理应用服务接口 +* 定义权限和授权 +* 提供DTO对象定义 + +## 模块引用 + +```csharp +[DependsOn(typeof(AbpLocalizationManagementApplicationContractsModule))] +public class YouProjectModule : AbpModule +{ + // other +} +``` + +## 权限定义 + +* LocalizationManagement.Resource - 授权对象是否允许访问资源 +* LocalizationManagement.Resource.Create - 授权对象是否允许创建资源 +* LocalizationManagement.Resource.Update - 授权对象是否允许修改资源 +* LocalizationManagement.Resource.Delete - 授权对象是否允许删除资源 +* LocalizationManagement.Language - 授权对象是否允许访问语言 +* LocalizationManagement.Language.Create - 授权对象是否允许创建语言 +* LocalizationManagement.Language.Update - 授权对象是否允许修改语言 +* LocalizationManagement.Language.Delete - 授权对象是否允许删除语言 +* LocalizationManagement.Text - 授权对象是否允许访问文档 +* LocalizationManagement.Text.Create - 授权对象是否允许创建文档 +* LocalizationManagement.Text.Update - 授权对象是否允许修改文档 +* LocalizationManagement.Text.Delete - 授权对象是否允许删除文档 + +## 应用服务接口 + +* `ILanguageAppService`: 语言管理应用服务接口 +* `IResourceAppService`: 资源管理应用服务接口 +* `ITextAppService`: 文本管理应用服务接口 + +## 更多信息 + +* [English documentation](./README.EN.md) diff --git a/aspnet-core/modules/localization-management/LINGYUN.Abp.LocalizationManagement.Application/README.EN.md b/aspnet-core/modules/localization-management/LINGYUN.Abp.LocalizationManagement.Application/README.EN.md new file mode 100644 index 000000000..cf75b8d1a --- /dev/null +++ b/aspnet-core/modules/localization-management/LINGYUN.Abp.LocalizationManagement.Application/README.EN.md @@ -0,0 +1,52 @@ +# LINGYUN.Abp.LocalizationManagement.Application + +The application service layer implementation module for localization management, providing application service implementations for localization resource management. + +## Features + +* Implements language management application services +* Implements resource management application services +* Implements text management application services +* Supports AutoMapper object mapping +* Provides standardized CRUD operations + +## Module Dependencies + +```csharp +[DependsOn(typeof(AbpLocalizationManagementApplicationModule))] +public class YouProjectModule : AbpModule +{ + // other +} +``` + +## Application Services + +* `LanguageAppService`: Language management application service + - Create language + - Update language + - Delete language + - Get language list + - Get language details + +* `ResourceAppService`: Resource management application service + - Create resource + - Update resource + - Delete resource + - Get resource list + - Get resource details + +* `TextAppService`: Text management application service + - Create text + - Update text + - Delete text + - Get text list + - Get text details + +## Permissions + +All application services follow the permission requirements defined by the module. See the permission definitions in the Domain.Shared module for details. + +## More Information + +* [中文文档](./README.md) diff --git a/aspnet-core/modules/localization-management/LINGYUN.Abp.LocalizationManagement.Application/README.md b/aspnet-core/modules/localization-management/LINGYUN.Abp.LocalizationManagement.Application/README.md new file mode 100644 index 000000000..1dc220be0 --- /dev/null +++ b/aspnet-core/modules/localization-management/LINGYUN.Abp.LocalizationManagement.Application/README.md @@ -0,0 +1,52 @@ +# LINGYUN.Abp.LocalizationManagement.Application + +本地化管理应用服务层实现模块，提供本地化资源管理的应用服务实现。 + +## 功能特性 + +* 实现语言管理应用服务 +* 实现资源管理应用服务 +* 实现文本管理应用服务 +* 支持AutoMapper对象映射 +* 提供标准化的CRUD操作 + +## 模块引用 + +```csharp +[DependsOn(typeof(AbpLocalizationManagementApplicationModule))] +public class YouProjectModule : AbpModule +{ + // other +} +``` + +## 应用服务 + +* `LanguageAppService`: 语言管理应用服务 + - 创建语言 + - 更新语言 + - 删除语言 + - 获取语言列表 + - 获取语言详情 + +* `ResourceAppService`: 资源管理应用服务 + - 创建资源 + - 更新资源 + - 删除资源 + - 获取资源列表 + - 获取资源详情 + +* `TextAppService`: 文本管理应用服务 + - 创建文本 + - 更新文本 + - 删除文本 + - 获取文本列表 + - 获取文本详情 + +## 权限 + +所有应用服务都遵循模块定义的权限要求，详见Domain.Shared模块的权限定义。 + +## 更多信息 + +* [English documentation](./README.EN.md) diff --git a/aspnet-core/modules/localization-management/LINGYUN.Abp.LocalizationManagement.Domain.Shared/README.EN.md b/aspnet-core/modules/localization-management/LINGYUN.Abp.LocalizationManagement.Domain.Shared/README.EN.md new file mode 100644 index 000000000..20b2d659e --- /dev/null +++ b/aspnet-core/modules/localization-management/LINGYUN.Abp.LocalizationManagement.Domain.Shared/README.EN.md @@ -0,0 +1,45 @@ +# LINGYUN.Abp.LocalizationManagement.Domain.Shared + +The shared domain layer module for localization management, defining error codes, localization resources, constants, and other shared content. + +## Features + +* Defines constants related to localization management +* Defines localization error codes +* Provides localization resource files +* Supports multilingual error messages + +## Module Dependencies + +```csharp +[DependsOn(typeof(AbpLocalizationManagementDomainSharedModule))] +public class YouProjectModule : AbpModule +{ + // other +} +``` + +## Error Codes + +* Localization:001100 - Language {CultureName} already exists +* Localization:001400 - Language name {CultureName} not found or built-in language operation not allowed +* Localization:002100 - Resource {Name} already exists +* Localization:002400 - Resource name {Name} not found or built-in resource operation not allowed + +## Localization Resources + +The module defines the following localization resources: + +* DisplayName:Enable - Enable +* DisplayName:CreationTime - Creation Time +* DisplayName:LastModificationTime - Modification Time +* DisplayName:SaveAndNext - Save & Next +* Permissions:LocalizationManagement - Localization Management +* Permissions:Language - Language Management +* Permissions:Resource - Resource Management +* Permissions:Text - Text Management +* etc... + +## More Information + +* [中文文档](./README.md) diff --git a/aspnet-core/modules/localization-management/LINGYUN.Abp.LocalizationManagement.Domain.Shared/README.md b/aspnet-core/modules/localization-management/LINGYUN.Abp.LocalizationManagement.Domain.Shared/README.md new file mode 100644 index 000000000..6b24202cb --- /dev/null +++ b/aspnet-core/modules/localization-management/LINGYUN.Abp.LocalizationManagement.Domain.Shared/README.md @@ -0,0 +1,45 @@ +# LINGYUN.Abp.LocalizationManagement.Domain.Shared + +本地化管理领域层共享模块，定义了错误代码、本地化资源、常量等共享内容。 + +## 功能特性 + +* 定义本地化管理相关的常量 +* 定义本地化错误代码 +* 提供本地化资源文件 +* 支持多语言错误消息 + +## 模块引用 + +```csharp +[DependsOn(typeof(AbpLocalizationManagementDomainSharedModule))] +public class YouProjectModule : AbpModule +{ + // other +} +``` + +## 错误代码 + +* Localization:001100 - 语言 {CultureName} 已经存在 +* Localization:001400 - 语言名称 {CultureName} 不存在或内置语言不允许操作 +* Localization:002100 - 资源 {Name} 已经存在 +* Localization:002400 - 资源名称 {Name} 不存在或内置资源不允许操作 + +## 本地化资源 + +模块定义了以下本地化资源： + +* DisplayName:Enable - 启用 +* DisplayName:CreationTime - 创建时间 +* DisplayName:LastModificationTime - 修改时间 +* DisplayName:SaveAndNext - 保存并下一步 +* Permissions:LocalizationManagement - 本地化管理 +* Permissions:Language - 语言管理 +* Permissions:Resource - 资源管理 +* Permissions:Text - 文档管理 +* 等... + +## 更多信息 + +* [English documentation](./README.EN.md) diff --git a/aspnet-core/modules/localization-management/LINGYUN.Abp.LocalizationManagement.Domain/README.EN.md b/aspnet-core/modules/localization-management/LINGYUN.Abp.LocalizationManagement.Domain/README.EN.md new file mode 100644 index 000000000..faa86406b --- /dev/null +++ b/aspnet-core/modules/localization-management/LINGYUN.Abp.LocalizationManagement.Domain/README.EN.md @@ -0,0 +1,45 @@ +# LINGYUN.Abp.LocalizationManagement.Domain + +The domain layer module for localization management, implementing dynamic localization resource storage and management functionality. + +## Features + +* Implements `ILocalizationStore` interface for localization resource storage and retrieval +* Supports language management (CRUD operations) +* Supports resource management (CRUD operations) +* Supports text management (CRUD operations) +* Supports in-memory caching of localization resources +* Supports distributed cache synchronization + +## Module Dependencies + +```csharp +[DependsOn(typeof(AbpLocalizationManagementDomainModule))] +public class YouProjectModule : AbpModule +{ + // other +} +``` + +## Configuration + +```json +{ + "LocalizationManagement": { + "LocalizationCacheStampTimeOut": "00:02:00", // Localization cache timestamp timeout, default 2 minutes + "LocalizationCacheStampExpiration": "00:30:00" // Localization cache expiration time, default 30 minutes + } +} +``` + +## Domain Services + +* `LanguageManager`: Language management service, providing language creation, update, deletion, etc. +* `ResourceManager`: Resource management service, providing resource creation, update, deletion, etc. +* `TextManager`: Text management service, providing text creation, update, deletion, etc. +* `LocalizationStore`: Localization storage service, implementing the `ILocalizationStore` interface +* `LocalizationStoreInMemoryCache`: In-memory cache service for localization resources + +## More Information + +* [中文文档](./README.md) diff --git a/aspnet-core/modules/localization-management/LINGYUN.Abp.LocalizationManagement.Domain/README.md b/aspnet-core/modules/localization-management/LINGYUN.Abp.LocalizationManagement.Domain/README.md new file mode 100644 index 000000000..7c9b0cd0a --- /dev/null +++ b/aspnet-core/modules/localization-management/LINGYUN.Abp.LocalizationManagement.Domain/README.md @@ -0,0 +1,45 @@ +# LINGYUN.Abp.LocalizationManagement.Domain + +本地化管理领域层模块，实现了动态本地化资源存储和管理功能。 + +## 功能特性 + +* 实现 `ILocalizationStore` 接口，提供本地化资源的存储和检索功能 +* 支持语言管理（增删改查） +* 支持资源管理（增删改查） +* 支持文本管理（增删改查） +* 支持本地化资源的内存缓存 +* 支持分布式缓存同步 + +## 模块引用 + +```csharp +[DependsOn(typeof(AbpLocalizationManagementDomainModule))] +public class YouProjectModule : AbpModule +{ + // other +} +``` + +## 配置项 + +```json +{ + "LocalizationManagement": { + "LocalizationCacheStampTimeOut": "00:02:00", // 本地化缓存时间戳超时时间，默认2分钟 + "LocalizationCacheStampExpiration": "00:30:00" // 本地化缓存过期时间，默认30分钟 + } +} +``` + +## 领域服务 + +* `LanguageManager`: 语言管理服务，提供语言的创建、更新、删除等功能 +* `ResourceManager`: 资源管理服务，提供资源的创建、更新、删除等功能 +* `TextManager`: 文本管理服务，提供文本的创建、更新、删除等功能 +* `LocalizationStore`: 本地化存储服务，实现了 `ILocalizationStore` 接口 +* `LocalizationStoreInMemoryCache`: 本地化资源内存缓存服务 + +## 更多信息 + +* [English documentation](./README.EN.md) diff --git a/aspnet-core/modules/localization-management/LINGYUN.Abp.LocalizationManagement.EntityFrameworkCore/README.EN.md b/aspnet-core/modules/localization-management/LINGYUN.Abp.LocalizationManagement.EntityFrameworkCore/README.EN.md new file mode 100644 index 000000000..65a06c3e8 --- /dev/null +++ b/aspnet-core/modules/localization-management/LINGYUN.Abp.LocalizationManagement.EntityFrameworkCore/README.EN.md @@ -0,0 +1,62 @@ +# LINGYUN.Abp.LocalizationManagement.EntityFrameworkCore + +Entity Framework Core integration implementation for the localization management module, providing data access and persistence functionality. + +## Features + +* Implements database mapping for localization management +* Supports custom table prefix and schema +* Provides EF Core implementation of repository interfaces +* Supports database operations for languages, resources, and texts + +## Module Dependencies + +```csharp +[DependsOn(typeof(AbpLocalizationManagementEntityFrameworkCoreModule))] +public class YouProjectModule : AbpModule +{ + // other +} +``` + +## Configuration + +```csharp +public override void ConfigureServices(ServiceConfigurationContext context) +{ + context.Services.AddAbpDbContext(options => + { + options.AddRepository(); + options.AddRepository(); + options.AddRepository(); + }); + + Configure(options => + { + options.UseMySQL(); // or other databases + }); +} +``` + +Database table configuration options: +```csharp +public class LocalizationModelBuilderConfigurationOptions : AbpModelBuilderConfigurationOptions +{ + public LocalizationModelBuilderConfigurationOptions( + string tablePrefix = "", + string schema = null) + : base(tablePrefix, schema) + { + } +} +``` + +## Database Tables + +* Languages - Language table +* Resources - Resource table +* Texts - Text table + +## More Information + +* [中文文档](./README.md) diff --git a/aspnet-core/modules/localization-management/LINGYUN.Abp.LocalizationManagement.EntityFrameworkCore/README.md b/aspnet-core/modules/localization-management/LINGYUN.Abp.LocalizationManagement.EntityFrameworkCore/README.md new file mode 100644 index 000000000..adbedcac9 --- /dev/null +++ b/aspnet-core/modules/localization-management/LINGYUN.Abp.LocalizationManagement.EntityFrameworkCore/README.md @@ -0,0 +1,62 @@ +# LINGYUN.Abp.LocalizationManagement.EntityFrameworkCore + +本地化管理模块的Entity Framework Core集成实现，提供数据访问和持久化功能。 + +## 功能特性 + +* 实现本地化管理的数据库映射 +* 支持自定义表前缀和Schema +* 提供仓储接口的EF Core实现 +* 支持语言、资源、文本的数据库操作 + +## 模块引用 + +```csharp +[DependsOn(typeof(AbpLocalizationManagementEntityFrameworkCoreModule))] +public class YouProjectModule : AbpModule +{ + // other +} +``` + +## 配置项 + +```csharp +public override void ConfigureServices(ServiceConfigurationContext context) +{ + context.Services.AddAbpDbContext(options => + { + options.AddRepository(); + options.AddRepository(); + options.AddRepository(); + }); + + Configure(options => + { + options.UseMySQL(); // 或其他数据库 + }); +} +``` + +数据库表配置选项： +```csharp +public class LocalizationModelBuilderConfigurationOptions : AbpModelBuilderConfigurationOptions +{ + public LocalizationModelBuilderConfigurationOptions( + string tablePrefix = "", + string schema = null) + : base(tablePrefix, schema) + { + } +} +``` + +## 数据库表 + +* Languages - 语言表 +* Resources - 资源表 +* Texts - 文本表 + +## 更多信息 + +* [English documentation](./README.EN.md) diff --git a/aspnet-core/modules/localization-management/LINGYUN.Abp.LocalizationManagement.HttpApi/README.EN.md b/aspnet-core/modules/localization-management/LINGYUN.Abp.LocalizationManagement.HttpApi/README.EN.md new file mode 100644 index 000000000..90e54b7ed --- /dev/null +++ b/aspnet-core/modules/localization-management/LINGYUN.Abp.LocalizationManagement.HttpApi/README.EN.md @@ -0,0 +1,56 @@ +# LINGYUN.Abp.LocalizationManagement.HttpApi + +The HTTP API module for localization management, providing RESTful API interfaces. + +## Features + +* Provides HTTP API interfaces for localization management +* Supports REST operations for languages, resources, and texts +* Integrates ABP dynamic API functionality +* Supports API version control +* Supports Swagger documentation generation + +## Module Dependencies + +```csharp +[DependsOn(typeof(AbpLocalizationManagementHttpApiModule))] +public class YouProjectModule : AbpModule +{ + // other +} +``` + +## API Controllers + +* `LanguageController`: Language management API controller +* `ResourceController`: Resource management API controller +* `TextController`: Text management API controller + +## Configuration + +```csharp +public override void PreConfigureServices(ServiceConfigurationContext context) +{ + PreConfigure(options => + { + options.AddAssemblyResource( + typeof(LocalizationManagementResource), + typeof(AbpLocalizationManagementApplicationContractsModule).Assembly); + }); + + PreConfigure(mvcBuilder => + { + mvcBuilder.AddApplicationPartIfNotExists(typeof(AbpLocalizationManagementApplicationContractsModule).Assembly); + }); +} +``` + +## API Routes + +* `/api/localization-management/languages` - Language management related APIs +* `/api/localization-management/resources` - Resource management related APIs +* `/api/localization-management/texts` - Text management related APIs + +## More Information + +* [中文文档](./README.md) diff --git a/aspnet-core/modules/localization-management/LINGYUN.Abp.LocalizationManagement.HttpApi/README.md b/aspnet-core/modules/localization-management/LINGYUN.Abp.LocalizationManagement.HttpApi/README.md new file mode 100644 index 000000000..a03eab365 --- /dev/null +++ b/aspnet-core/modules/localization-management/LINGYUN.Abp.LocalizationManagement.HttpApi/README.md @@ -0,0 +1,56 @@ +# LINGYUN.Abp.LocalizationManagement.HttpApi + +本地化管理HTTP API模块，提供RESTful风格的API接口。 + +## 功能特性 + +* 提供本地化管理的HTTP API接口 +* 支持语言、资源、文本的REST操作 +* 集成ABP动态API功能 +* 支持API版本控制 +* 支持Swagger文档生成 + +## 模块引用 + +```csharp +[DependsOn(typeof(AbpLocalizationManagementHttpApiModule))] +public class YouProjectModule : AbpModule +{ + // other +} +``` + +## API控制器 + +* `LanguageController`: 语言管理API控制器 +* `ResourceController`: 资源管理API控制器 +* `TextController`: 文本管理API控制器 + +## 配置项 + +```csharp +public override void PreConfigureServices(ServiceConfigurationContext context) +{ + PreConfigure(options => + { + options.AddAssemblyResource( + typeof(LocalizationManagementResource), + typeof(AbpLocalizationManagementApplicationContractsModule).Assembly); + }); + + PreConfigure(mvcBuilder => + { + mvcBuilder.AddApplicationPartIfNotExists(typeof(AbpLocalizationManagementApplicationContractsModule).Assembly); + }); +} +``` + +## API路由 + +* `/api/localization-management/languages` - 语言管理相关API +* `/api/localization-management/resources` - 资源管理相关API +* `/api/localization-management/texts` - 文本管理相关API + +## 更多信息 + +* [English documentation](./README.EN.md) diff --git a/aspnet-core/modules/localization-management/README.EN.md b/aspnet-core/modules/localization-management/README.EN.md new file mode 100644 index 000000000..1fa97b518 --- /dev/null +++ b/aspnet-core/modules/localization-management/README.EN.md @@ -0,0 +1,103 @@ +# Localization Management + +Localization document management module. Due to long project paths not being supported in Windows systems, the project directory uses the abbreviation 'lt'. + +## Features + +* Support dynamic management of localization resources +* Support language management (CRUD operations) +* Support resource management (CRUD operations) +* Support text management (CRUD operations) +* Support in-memory caching of localization resources +* Support distributed cache synchronization +* Provide standard RESTful API interfaces +* Seamless integration with ABP framework + +## Module Description + +### Basic Modules + +* [LINGYUN.Abp.Localization.Persistence](../localization/LINGYUN.Abp.Localization.Persistence) - Localization persistence module, implements IStaticLocalizationSaver interface to persist local static resources to storage facilities +* [LINGYUN.Abp.LocalizationManagement.Domain.Shared](./LINGYUN.Abp.LocalizationManagement.Domain.Shared) - Domain layer shared module, defines error codes, localization, and module settings +* [LINGYUN.Abp.LocalizationManagement.Domain](./LINGYUN.Abp.LocalizationManagement.Domain) - Domain layer module, implements ILocalizationStore interface +* [LINGYUN.Abp.LocalizationManagement.EntityFrameworkCore](./LINGYUN.Abp.LocalizationManagement.EntityFrameworkCore) - Data access layer module, integrates EFCore +* [LINGYUN.Abp.LocalizationManagement.Application.Contracts](./LINGYUN.Abp.LocalizationManagement.Application.Contracts) - Application service layer shared module, defines external interfaces, permissions, and functionality restriction policies for managing localization objects +* [LINGYUN.Abp.LocalizationManagement.Application](./LINGYUN.Abp.LocalizationManagement.Application) - Application service layer implementation, implements localization object management interfaces +* [LINGYUN.Abp.LocalizationManagement.HttpApi](./LINGYUN.Abp.LocalizationManagement.HttpApi) - RestApi implementation, implements independent external RestApi interfaces + +### Advanced Modules + +No advanced modules at present. + +### Permission Definitions + +* LocalizationManagement.Resource - Authorizes access to resources +* LocalizationManagement.Resource.Create - Authorizes resource creation +* LocalizationManagement.Resource.Update - Authorizes resource modification +* LocalizationManagement.Resource.Delete - Authorizes resource deletion +* LocalizationManagement.Language - Authorizes access to languages +* LocalizationManagement.Language.Create - Authorizes language creation +* LocalizationManagement.Language.Update - Authorizes language modification +* LocalizationManagement.Language.Delete - Authorizes language deletion +* LocalizationManagement.Text - Authorizes access to texts +* LocalizationManagement.Text.Create - Authorizes text creation +* LocalizationManagement.Text.Update - Authorizes text modification +* LocalizationManagement.Text.Delete - Authorizes text deletion + +### Configuration + +```json +{ + "LocalizationManagement": { + "LocalizationCacheStampTimeOut": "00:02:00", // Localization cache timestamp timeout, default 2 minutes + "LocalizationCacheStampExpiration": "00:30:00" // Localization cache expiration time, default 30 minutes + } +} +``` + +### Database Tables + +The module uses the following database tables to store localization data: + +* Languages - Language table +* Resources - Resource table +* Texts - Text table + +Table prefix and schema can be configured through `LocalizationModelBuilderConfigurationOptions`: + +```csharp +public class LocalizationModelBuilderConfigurationOptions : AbpModelBuilderConfigurationOptions +{ + public LocalizationModelBuilderConfigurationOptions( + string tablePrefix = "", + string schema = null) + : base(tablePrefix, schema) + { + } +} +``` + +### API Endpoints + +The module provides the following REST API endpoints: + +* `/api/localization-management/languages` - Language management related APIs +* `/api/localization-management/resources` - Resource management related APIs +* `/api/localization-management/texts` - Text management related APIs + +## Error Codes + +* Localization:001100 - Language {CultureName} already exists +* Localization:001400 - Language name {CultureName} not found or built-in language operation not allowed +* Localization:002100 - Resource {Name} already exists +* Localization:002400 - Resource name {Name} not found or built-in resource operation not allowed + +## More Information + +* [中文文档](./README.md) + +## Change Log + +### 2024.12 +* Improved module documentation +* Added English documentation support diff --git a/aspnet-core/modules/localization-management/README.md b/aspnet-core/modules/localization-management/README.md index e51a19138..7b0a44809 100644 --- a/aspnet-core/modules/localization-management/README.md +++ b/aspnet-core/modules/localization-management/README.md @@ -2,6 +2,17 @@ 本地化文档管理模块,因项目路径太长Windows系统不支持,项目目录取简称 lt +## 功能特性 + +* 支持动态管理本地化资源 +* 支持多语言管理（增删改查） +* 支持资源管理（增删改查） +* 支持文本管理（增删改查） +* 支持本地化资源的内存缓存 +* 支持分布式缓存同步 +* 提供标准的RESTful API接口 +* 支持与ABP框架无缝集成 + ## 模块说明 ### 基础模块 @@ -16,6 +27,8 @@ ### 高阶模块 +暂无高阶模块。 + ### 权限定义 * LocalizationManagement.Resource 授权对象是否允许访问资源 @@ -28,12 +41,63 @@ * LocalizationManagement.Language.Delete 授权对象是否允许删除语言 * LocalizationManagement.Text 授权对象是否允许访问文档 * LocalizationManagement.Text.Create 授权对象是否允许创建文档 -* LocalizationManagement.Text.Update 授权对象是否允许删除Oss对象 -* LocalizationManagement.Text.Delete 授权对象是否允许下载Oss对象 - -### 功能定义 +* LocalizationManagement.Text.Update 授权对象是否允许修改文档 +* LocalizationManagement.Text.Delete 授权对象是否允许删除文档 ### 配置定义 +```json +{ + "LocalizationManagement": { + "LocalizationCacheStampTimeOut": "00:02:00", // 本地化缓存时间戳超时时间，默认2分钟 + "LocalizationCacheStampExpiration": "00:30:00" // 本地化缓存过期时间，默认30分钟 + } +} +``` + +### 数据库表 + +本模块使用以下数据库表存储本地化数据： + +* Languages - 语言表 +* Resources - 资源表 +* Texts - 文本表 + +可通过 `LocalizationModelBuilderConfigurationOptions` 配置表前缀和Schema： + +```csharp +public class LocalizationModelBuilderConfigurationOptions : AbpModelBuilderConfigurationOptions +{ + public LocalizationModelBuilderConfigurationOptions( + string tablePrefix = "", + string schema = null) + : base(tablePrefix, schema) + { + } +} +``` + +### API接口 + +本模块提供以下REST API接口： + +* `/api/localization-management/languages` - 语言管理相关API +* `/api/localization-management/resources` - 资源管理相关API +* `/api/localization-management/texts` - 文本管理相关API + +## 错误代码 + +* Localization:001100 - 语言 {CultureName} 已经存在 +* Localization:001400 - 语言名称 {CultureName} 不存在或内置语言不允许操作 +* Localization:002100 - 资源 {Name} 已经存在 +* Localization:002400 - 资源名称 {Name} 不存在或内置资源不允许操作 + +## 更多信息 + +* [English documentation](./README.EN.md) + ## 更新日志 +### 2024.12 +* 完善模块文档 +* 添加英文文档支持