Browse Source

Merge pull request #3420 from abpframework/maliming/docs-patch

Fix options prefix in document.
pull/3463/head
maliming 7 years ago
committed by GitHub
parent
commit
06a4fd7330
No known key found for this signature in database GPG Key ID: 4AEE18F83AFDEB23
  1. 4
      docs/en/API/Dynamic-CSharp-API-Clients.md
  2. 4
      docs/en/Authorization.md
  3. 4
      docs/en/Best-Practices/Entity-Framework-Core-Integration.md
  4. 4
      docs/en/Best-Practices/MongoDB-Integration.md
  5. 2
      docs/en/Modules/Docs.md
  6. 4
      docs/en/UI/AspNetCore/Bundling-Minification.md
  7. 4
      docs/zh-Hans/API/Dynamic-CSharp-API-Clients.md
  8. 4
      docs/zh-Hans/Authorization.md
  9. 4
      docs/zh-Hans/Best-Practices/Entity-Framework-Core-Integration.md
  10. 6
      docs/zh-Hans/Best-Practices/MongoDB-Integration.md
  11. 12
      docs/zh-Hans/UI/AspNetCore/Bundling-Minification.md

4
docs/en/API/Dynamic-CSharp-API-Clients.md

@ -69,7 +69,7 @@ public class MyClientAppModule : AbpModule
} }
```` ````
See the "RemoteServiceOptions" section below for more detailed configuration. See the "AbpRemoteServiceOptions" section below for more detailed configuration.
## Usage ## Usage
@ -104,7 +104,7 @@ While you can inject `IBookAppService` like above to use the client proxy, you c
## Configuration ## Configuration
### RemoteServiceOptions ### AbpRemoteServiceOptions
`AbpRemoteServiceOptions` is automatically set from the `appsettings.json` by default. Alternatively, you can use `Configure` method to set or override it. Example: `AbpRemoteServiceOptions` is automatically set from the `appsettings.json` by default. Alternatively, you can use `Configure` method to set or override it. Example:

4
docs/en/Authorization.md

@ -339,10 +339,10 @@ A permission value provider should return one of the following values from the `
- `PermissionGrantResult.Prohibited` is returned to prohibit the user for the permission. If any of the providers return `Prohibited`, the result will always be `Prohibited`. Doesn't matter what other providers return. - `PermissionGrantResult.Prohibited` is returned to prohibit the user for the permission. If any of the providers return `Prohibited`, the result will always be `Prohibited`. Doesn't matter what other providers return.
- `PermissionGrantResult.Undefined` is returned if this value provider could not decide about the permission value. Return this to let other providers check the permission. - `PermissionGrantResult.Undefined` is returned if this value provider could not decide about the permission value. Return this to let other providers check the permission.
Once a provider is defined, it should be added to the `PermissionOptions` as shown below: Once a provider is defined, it should be added to the `AbpPermissionOptions` as shown below:
```csharp ```csharp
Configure<PermissionOptions>(options => Configure<AbpPermissionOptions>(options =>
{ {
options.ValueProviders.Add<SystemAdminPermissionValueProvider>(); options.ValueProviders.Add<SystemAdminPermissionValueProvider>();
}); });

4
docs/en/Best-Practices/Entity-Framework-Core-Integration.md

@ -107,10 +107,10 @@ public static class IdentityDbContextModelBuilderExtensions
```` ````
* **Do** call `b.ConfigureByConvention();` for each entity mapping (as shown above). * **Do** call `b.ConfigureByConvention();` for each entity mapping (as shown above).
* **Do** create a **configuration options** class by inheriting from the `ModelBuilderConfigurationOptions`. Example: * **Do** create a **configuration options** class by inheriting from the `AbpModelBuilderConfigurationOptions`. Example:
````C# ````C#
public class IdentityModelBuilderConfigurationOptions : ModelBuilderConfigurationOptions public class IdentityModelBuilderConfigurationOptions : AbpModelBuilderConfigurationOptions
{ {
public IdentityModelBuilderConfigurationOptions() public IdentityModelBuilderConfigurationOptions()
: base(AbpIdentityConsts.DefaultDbTablePrefix, AbpIdentityConsts.DefaultDbSchema) : base(AbpIdentityConsts.DefaultDbTablePrefix, AbpIdentityConsts.DefaultDbSchema)

4
docs/en/Best-Practices/MongoDB-Integration.md

@ -90,11 +90,11 @@ public static class AbpIdentityMongoDbContextExtensions
} }
``` ```
- **Do** create a **configuration options** class by inheriting from the `MongoModelBuilderConfigurationOptions`. Example: - **Do** create a **configuration options** class by inheriting from the `AbpMongoModelBuilderConfigurationOptions`. Example:
```c# ```c#
public class IdentityMongoModelBuilderConfigurationOptions public class IdentityMongoModelBuilderConfigurationOptions
: MongoModelBuilderConfigurationOptions : AbpMongoModelBuilderConfigurationOptions
{ {
public IdentityMongoModelBuilderConfigurationOptions() public IdentityMongoModelBuilderConfigurationOptions()
: base(AbpIdentityConsts.DefaultDbTablePrefix) : base(AbpIdentityConsts.DefaultDbTablePrefix)

2
docs/en/Modules/Docs.md

@ -134,7 +134,7 @@ An ABP module must declare `[DependsOn]` attribute if it has a dependency upon a
{ {
public override void ConfigureServices(ServiceConfigurationContext context) public override void ConfigureServices(ServiceConfigurationContext context)
{ {
Configure<PermissionOptions>(options => Configure<AbpPermissionOptions>(options =>
{ {
options.DefinitionProviders.Add<MyProjectPermissionDefinitionProvider>(); options.DefinitionProviders.Add<MyProjectPermissionDefinitionProvider>();
}); });

4
docs/en/UI/AspNetCore/Bundling-Minification.md

@ -246,10 +246,10 @@ public class MyPrismjsStyleExtension : BundleContributor
} }
```` ````
Then you can configure `BundleContributorOptions` to extend existing `PrismjsStyleBundleContributor`. Then you can configure `AbpBundleContributorOptions` to extend existing `PrismjsStyleBundleContributor`.
````csharp ````csharp
Configure<BundleContributorOptions>(options => Configure<AbpBundleContributorOptions>(options =>
{ {
options options
.Extensions<PrismjsStyleBundleContributor>() .Extensions<PrismjsStyleBundleContributor>()

4
docs/zh-Hans/API/Dynamic-CSharp-API-Clients.md

@ -69,7 +69,7 @@ public class MyClientAppModule : AbpModule
} }
```` ````
查看下面的"RemoteServiceOptions"章节获取更多详细配置. 查看下面的"AbpRemoteServiceOptions"章节获取更多详细配置.
## 使用 ## 使用
@ -104,7 +104,7 @@ public class MyService : ITransientDependency
## 配置 ## 配置
### RemoteServiceOptions ### AbpRemoteServiceOptions
默认情况下`AbpRemoteServiceOptions`从`appsettings.json`获取.或者,你可以使用`Configure`方法来设置或重写它.如: 默认情况下`AbpRemoteServiceOptions`从`appsettings.json`获取.或者,你可以使用`Configure`方法来设置或重写它.如:

4
docs/zh-Hans/Authorization.md

@ -340,10 +340,10 @@ public class SystemAdminPermissionValueProvider : PermissionValueProvider
* `PermissionGrantResult.Prohibited` 禁止授权用户,任何一个授权值提供程序返回了 `Prohibited`, 那么其他的提供程序返回的值都不再重要. * `PermissionGrantResult.Prohibited` 禁止授权用户,任何一个授权值提供程序返回了 `Prohibited`, 那么其他的提供程序返回的值都不再重要.
* `PermissionGrantResult.Undefined` 代表当前无法确定是否授予或禁止权限, 返回`UnDefined`由其他权限值提供程序检查权限. * `PermissionGrantResult.Undefined` 代表当前无法确定是否授予或禁止权限, 返回`UnDefined`由其他权限值提供程序检查权限.
定义`Provider`后将其添加到 `PermissionOptions`,如下所示: 定义`Provider`后将其添加到 `AbpPermissionOptions`,如下所示:
````csharp ````csharp
Configure<PermissionOptions>(options => Configure<AbpPermissionOptions>(options =>
{ {
options.ValueProviders.Add<SystemAdminPermissionValueProvider>(); options.ValueProviders.Add<SystemAdminPermissionValueProvider>();
}); });

4
docs/zh-Hans/Best-Practices/Entity-Framework-Core-Integration.md

@ -106,10 +106,10 @@ public static class IdentityDbContextModelBuilderExtensions
```` ````
* **推荐** 为每个Enttiy映射调用 `b.ConfigureByConvention();`(如上所示). * **推荐** 为每个Enttiy映射调用 `b.ConfigureByConvention();`(如上所示).
* **推荐** 通过继承 `ModelBuilderConfigurationOptions` 来创建 **configuration Options** 类. 例如: * **推荐** 通过继承 `AbpModelBuilderConfigurationOptions` 来创建 **configuration Options** 类. 例如:
````C# ````C#
public class IdentityModelBuilderConfigurationOptions : ModelBuilderConfigurationOptions public class IdentityModelBuilderConfigurationOptions : AbpModelBuilderConfigurationOptions
{ {
public IdentityModelBuilderConfigurationOptions() public IdentityModelBuilderConfigurationOptions()
: base(AbpIdentityConsts.DefaultDbTablePrefix, AbpIdentityConsts.DefaultDbSchema) : base(AbpIdentityConsts.DefaultDbTablePrefix, AbpIdentityConsts.DefaultDbSchema)

6
docs/zh-Hans/Best-Practices/MongoDB-Integration.md

@ -1,4 +1,4 @@
## MongoDB 集成 ## MongoDB 集成
* **推荐** 为每个模块定义一个独立的 `MongoDbContext` 接口与实现类. * **推荐** 为每个模块定义一个独立的 `MongoDbContext` 接口与实现类.
@ -90,11 +90,11 @@ public static class AbpIdentityMongoDbContextExtensions
} }
``` ```
- **推荐** 通过继承 `MongoModelBuilderConfigurationOptions` 来创建 **configuration Options** 类. 示例: - **推荐** 通过继承 `AbpMongoModelBuilderConfigurationOptions` 来创建 **configuration Options** 类. 示例:
```c# ```c#
public class IdentityMongoModelBuilderConfigurationOptions public class IdentityMongoModelBuilderConfigurationOptions
: MongoModelBuilderConfigurationOptions : AbpMongoModelBuilderConfigurationOptions
{ {
public IdentityMongoModelBuilderConfigurationOptions() public IdentityMongoModelBuilderConfigurationOptions()
: base(AbpIdentityConsts.DefaultDbTablePrefix) : base(AbpIdentityConsts.DefaultDbTablePrefix)

12
docs/zh-Hans/UI/AspNetCore/Bundling-Minification.md

@ -115,7 +115,7 @@ public class MyWebModule : AbpModule
{ {
public override void ConfigureServices(ServiceConfigurationContext context) public override void ConfigureServices(ServiceConfigurationContext context)
{ {
Configure<BundlingOptions>(options => Configure<AbpBundlingOptions>(options =>
{ {
options options
.ScriptBundles .ScriptBundles
@ -153,7 +153,7 @@ public class MyWebExtensionModule : AbpModule
{ {
public override void ConfigureServices(ServiceConfigurationContext context) public override void ConfigureServices(ServiceConfigurationContext context)
{ {
Configure<BundlingOptions>(options => Configure<AbpBundlingOptions>(options =>
{ {
options options
.ScriptBundles .ScriptBundles
@ -191,7 +191,7 @@ public class MyExtensionGlobalStyleContributor : BundleContributor
然后你可以按照下面的代码使用这个贡献者: 然后你可以按照下面的代码使用这个贡献者:
````C# ````C#
services.Configure<BundlingOptions>(options => services.Configure<AbpBundlingOptions>(options =>
{ {
options options
.ScriptBundles .ScriptBundles
@ -248,10 +248,10 @@ public class MyPrismjsStyleExtension : BundleContributor
} }
```` ````
然后你可以配置 `BundleContributorOptions` 去扩展已存在的 `PrismjsStyleBundleContributor`. 然后你可以配置 `AbpBundleContributorOptions` 去扩展已存在的 `PrismjsStyleBundleContributor`.
````csharp ````csharp
Configure<BundleContributorOptions>(options => Configure<AbpBundleContributorOptions>(options =>
{ {
options options
.Extensions<PrismjsStyleBundleContributor>() .Extensions<PrismjsStyleBundleContributor>()
@ -319,7 +319,7 @@ namespace MyCompany.MyProject
例如: 例如:
````c# ````c#
services.Configure<BundlingOptions>(options => services.Configure<AbpBundlingOptions>(options =>
{ {
options options
.StyleBundles .StyleBundles

Loading…
Cancel
Save