Skip to content

Commit

Permalink
Modify Chinese annotations
Browse files Browse the repository at this point in the history
  • Loading branch information
@JusterZhu
JusterZhu committed Apr 10, 2024
1 parent 198eb1e commit b605fba
Show file tree
Hide file tree
Showing 9 changed files with 119 additions and 135 deletions.
14 changes: 10 additions & 4 deletions website/docs/doc/Component Introduction.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,13 @@ sidebar_position: 1



### 2.统一语言（Unifying Language）
### 2.使用引导

![](imgs/bootstrap.jpg)



### 3.统一语言（Unifying Language）

在开始使用GeneralUpdate之前我们需要先知道体系中的一些基础概念。

Expand All @@ -81,7 +87,7 @@ sidebar_position: 1



### 3.GeneralUpdate提供什么？
### 4.GeneralUpdate提供什么？

##### 组件功能

Expand Down Expand Up @@ -152,7 +158,7 @@ sc delete GeneralUpdate.SystemService



### 4.GeneralUpdate支持什么？
### 5.GeneralUpdate支持什么？

##### .NET框架

Expand Down Expand Up @@ -210,7 +216,7 @@ sc delete GeneralUpdate.SystemService

这是一个绝佳的机会，不仅可以推动技术的进步，也可以提高您的品牌知名度和社区影响力。我们相信，您的赞助将会对这个开源项目产生深远的影响。此外所有的赞助将用于购买GeneralUpdate实物周边产品奖励给项目贡献代码的社区伙伴，如果有实际贡献的小伙伴可以联系下方邮箱与我取得联系。

个人能力有限，目前项目的大小已经超出个人维护的精力范围之外设计维护实属不易，期待您的积极参与，让我们携手共创未来！
目前项目的大小已经超出个人维护的精力范围之外设计维护实属不易，期待您的积极参与，让我们携手共创未来！

谢谢！

Expand Down
14 changes: 7 additions & 7 deletions website/docs/doc/GeneralClient.OSS.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -86,10 +86,10 @@ GeneralUpdateOSS提供以下能力。

#### 方法

| Method | |
| ---------------------- | ------------------------------------------ |
| Start() | Starting an OSS update . |
| AddListenerException() | Listen for internal exception information. |
| Method | |
| ---------------------- | ---------------------- |
| Start() | 启动OSS更新。 |
| AddListenerException() | 监听组件内部异常信息。 |



Expand Down Expand Up @@ -127,7 +127,7 @@ ParamsOSS 更新配置参数，详细内容参考本文档🌴ParamsOSS。

**参数**

**parameter** ParamsOSS安卓平台的跟新配置参数。
**parameter** ParamsOSS 安卓平台的跟新配置参数。

**upgradeAppName** 需要升级的应用名称。

Expand All @@ -137,7 +137,7 @@ ParamsOSS 更新配置参数，详细内容参考本文档🌴ParamsOSS。

**方法**

Monitor download progress.
监听下载进度。

```c#
public static void AddListenerDownloadProcess(Action<object, OSSDownloadArgs> callbackAction);
Expand Down Expand Up @@ -171,7 +171,7 @@ callbackAction Action<object, OSSDownloadArgs>

**方法**

Listen for internal exception information.
监听组件内部异常。

```c#
public static void AddListenerException(Action<object, ExceptionEventArgs> callbackAction);
Expand Down
90 changes: 44 additions & 46 deletions website/docs/doc/GeneralUpdate.ClientCore.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -219,8 +219,8 @@ GeneralClientBootstrap提供以下能力。
| Config() | 更新相关内容配置参数，url 服务器地址及 端口号, appSecretKey客户端唯一标识用于 区分产品分支。 |
| GetOption() | 获取更新配置。 |
| Strategy() | 设置当前更新策略，例如：如果是Windows 平台则使用WindowsStrategy， linux...mac...android以此类推。 |
| SetCustomSkipOption() | Let the user decide whether to update in the state of non-mandatory update. |
| AddCustomOption() | Add an asynchronous custom operation. In theory, any custom operation can be done. It is recommended to register the environment check method to ensure that there are normal dependencies and environments after the update is completed. |
| SetCustomSkipOption() | 让用户在非强制更新的状态下决定是否进行更新。 |
| AddCustomOption() | 添加一个异步的自定义操作。理论上，任何自定义操作都可以完成。建议注册环境检查方法，以确保更新完成后存在正常的依赖和环境。 |
| AddListenerMultiAllDownloadCompleted() | 完成所有的下载任务通知。 |
| AddListenerMultiDownloadProgress() | 单个或多个更新包下载通知事件。 |
| AddListenerMultiDownloadCompleted() | 单个或多个更新包下载完成事件。 |
Expand All @@ -234,58 +234,56 @@ GeneralClientBootstrap提供以下能力。

| 属性 |
| ------------------------------------------------------------ |
| **MainUpdateUrl** string Update check api address. |
| **MainUpdateUrl** string 更新检查api地址。 |
| **AppType** int 1:ClientApp 2:UpdateApp |
| **UpdateUrl** string Update check api address. |
| **AppName** string Need to start the name of the app. |
| **MainAppName** string Need to start the name of the app. |
| **Format** string Update package file format(Defult format is Zip). |
| **IsUpgradeUpdate** bool Whether an update is required to upgrade the application. |
| **IsMainUpdate** bool Whether the main application needs to be updated. |
| **UpdateLogUrl** string Update log web address. |
| **UpdateVersions** List VersionInfo Version information that needs to be updated. |
| **Encoding** Encoding The encoding format for file operations. |
| **DownloadTimeOut** int Time-out event for file download. |
| **AppSecretKey** string application key. |
| **ClientVersion** string Client current version. |
| **LastVersion** string The latest version. |
| **InstallPath** string installation path (for update file logic). |
| **TempPath** string Download file temporary storage path (for update file logic). |
| **ProcessBase64** string Configuration parameters for upgrading the terminal program. |
| **Platform** string The platform to which the current strategy belongs. |
| **BlackFiles** List string Files in the blacklist will skip the update. |
| **BlackFormats** List string File formats in the blacklist will skip the update. |
| **DriveEnabled** bool Whether to enable the driver upgrade function. |
| **WillMessageEnabled** bool Whether open note function, if you want to start needs to be synchronized to deploy 'GeneralUpdate. SystemService' service. |


| **UpdateUrl** string Update 更新检查api地址。 |
| **AppName** string 需要启动应用程序的名称。 |
| **MainAppName** string 需要启动主应用程序的名称。 |
| **Format** string 更新包文件格式（默认格式为Zip）。 |
| **IsUpgradeUpdate** bool 是否需要更新来升级应用程序。 |
| **IsMainUpdate** bool 主应用程序是否需要更新。 |
| **UpdateLogUrl** string 更新日志网页地址。 |
| **UpdateVersions** List 需要更新的版本信息VersionInfo。 |
| **Encoding** Encoding 文件操作的编码格式。 |
| **DownloadTimeOut** int 下载超时时间。 |
| **AppSecretKey** string 应用程序密钥，需要和服务器约定好。 |
| **ClientVersion** string 客户端当前版本号。 |
| **LastVersion** string 最新版本号。 |
| **InstallPath** string 安装路径（用于更新文件逻辑）。 |
| **TempPath** string 下载文件临时存储路径（用于更新文件逻辑）。 |
| **ProcessBase64** string 升级终端程序的配置参数。 |
| **Platform** string 当前策略所属的平台。（Windows\linux\Mac） |
| **BlackFiles** List 黑名单中的文件将跳过更新。 |
| **BlackFormats** 黑名单中的文件格式将跳过更新。 |
| **DriveEnabled** bool 是否启用驱动升级功能。 |
| **WillMessageEnabled** bool 是否开启遗言功能，如果想要启动需要同步部署'GeneralUpdate. SystemService'服务。 |

### 🌴Configinfo

| **属性** |
| ------------------------------------------------------------ |
| **AppType** int 1:ClientApp 2:UpdateApp |
| **AppName** string Need to start the name of the app. |
| **AppSecretKey** string application key. |
| **ClientVersion** string Client current version. |
| **UpdateUrl** string Update check api address. |
| **UpdateLogUrl** string Update log web address. |
| **InstallPath** string installation path (for update file logic). |
| **MainUpdateUrl** string Update check api address. |
| **MainAppName** string Client app name. |
| **属性** |
| ----------------------------------------------------- |
| **AppType** int 1:ClientApp 2:UpdateApp |
| **AppName** string 需要启动应用程序的名称。 |
| **AppSecretKey** string 应用程序密钥。 |
| **ClientVersion** string 客户端当前版本。 |
| **UpdateUrl** string 更新检查api地址。 |
| **UpdateLogUrl** string 更新日志网页地址。 |
| **InstallPath** string 安装路径（用于更新文件逻辑）。 |
| **MainUpdateUrl** string 更新检查api地址。 |
| **MainAppName** string 主客户端应用名称 |



### 🍵UpdateOption

| **枚举** |
| ------------------------------------------------------------ |
| **Format** Update the file format of the package. |
| **Encoding** Compress encoding. |
| **MainApp** Main program name. |
| **DownloadTimeOut** Timeout period (unit: second). If this parameter is not specified, the default timeout period is 30 seconds. |
| **Drive** Whether to enable the driver upgrade function. |
| **WillMessage** Whether open note function, if you want to start needs to be synchronized to deploy 'GeneralUpdate. SystemService' service. |
| **Format** 更新包的文件格式。 |
| **Encoding** 压缩编码。 |
| **MainApp** 主程序名称。 |
| **DownloadTimeOut** 超时时间（单位：秒）。如果未指定此参数，则默认超时时间为30秒。 |
| **Drive** 是否启用驱动升级功能。 |
| **WillMessage** 是否开启遗言功能，如果想要启动需要同步部署'GeneralUpdate. SystemService'服务。 |



Expand Down Expand Up @@ -396,11 +394,11 @@ Configinfo

**info** Configinfo 客户端相关参数类。

**url** string Remote server address.
**url** string 远程服务器地址。

**appSecretKey** string application key(与服务端约定好的密钥，用于区分客户端进行版本管理或指定客户端推送升级).

**appName** string The updater name does not need to contain an extension.
**appName** string 更新程序的名称不需要包含扩展名。



Expand Down Expand Up @@ -481,7 +479,7 @@ func Func<Task<bool>> 注入一个Task异步的自定义回调函数。

**方法**

Add an asynchronous custom operation. In theory, any custom operation can be done. It is recommended to register the environment check method to ensure that there are normal dependencies and environments after the update is completed.
添加一个异步的自定义操作。理论上，任何自定义操作都可以完成。建议注册环境检查方法，以确保更新完成后存在正常的依赖和环境。

```c#
public GeneralClientBootstrap AddCustomOption(List<Func<bool>> funcs);
Expand Down
82 changes: 31 additions & 51 deletions website/docs/doc/GeneralUpdate.Core.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -146,69 +146,49 @@ GeneralUpdateBootstrap提供以下能力。

**属性**

**MainUpdateUrl** string Update check api address.

**AppType** int 1:ClientApp 2:UpdateApp

**UpdateUrl** string Update check api address.

**AppName** string Need to start the name of the app.

**MainAppName** string Need to start the name of the app.

**Format** string Update package file format(Defult format is Zip).

**IsUpgradeUpdate** bool Whether an update is required to upgrade the application.

**IsMainUpdate** bool Whether the main application needs to be updated.

**UpdateLogUrl** string Update log web address.

**UpdateVersions** List VersionInfo Version information that needs to be updated.

**Encoding** Encoding The encoding format for file operations.

**DownloadTimeOut** int Time-out event for file download.

**AppSecretKey** string application key.

**ClientVersion** string Client current version.

**LastVersion** string The latest version.

**InstallPath**string installation path (for update file logic).

**TempPath** string Download file temporary storage path (for update file logic).

**ProcessBase64** string Configuration parameters for upgrading the terminal program.

**Platform** string The platform to which the current strategy belongs.

**BlackFiles** List string Files in the blacklist will skip the update.

**BlackFormats** List string File formats in the blacklist will skip the update.

**DriveEnabled** bool Whether to enable the driver upgrade function.

**WillMessageEnabled** bool Whether open note function, if you want to start needs to be synchronized to deploy 'GeneralUpdate. SystemService' service.
| 属性 |
| ------------------------------------------------------------ |
| **MainUpdateUrl** string 更新检查api地址。 |
| **AppType** int 1:ClientApp 2:UpdateApp |
| **UpdateUrl** string Update 更新检查api地址。 |
| **AppName** string 需要启动应用程序的名称。 |
| **MainAppName** string 需要启动主应用程序的名称。 |
| **Format** string 更新包文件格式（默认格式为Zip）。 |
| **IsUpgradeUpdate** bool 是否需要更新来升级应用程序。 |
| **IsMainUpdate** bool 主应用程序是否需要更新。 |
| **UpdateLogUrl** string 更新日志网页地址。 |
| **UpdateVersions** List 需要更新的版本信息VersionInfo。 |
| **Encoding** Encoding 文件操作的编码格式。 |
| **DownloadTimeOut** int 下载超时时间。 |
| **AppSecretKey** string 应用程序密钥，需要和服务器约定好。 |
| **ClientVersion** string 客户端当前版本号。 |
| **LastVersion** string 最新版本号。 |
| **InstallPath** string 安装路径（用于更新文件逻辑）。 |
| **TempPath** string 下载文件临时存储路径（用于更新文件逻辑）。 |
| **ProcessBase64** string 升级终端程序的配置参数。 |
| **Platform** string 当前策略所属的平台。（Windows\linux\Mac） |
| **BlackFiles** List 黑名单中的文件将跳过更新。 |
| **BlackFormats** 黑名单中的文件格式将跳过更新。 |
| **DriveEnabled** bool 是否启用驱动升级功能。 |
| **WillMessageEnabled** bool 是否开启遗言功能，如果想要启动需要同步部署'GeneralUpdate. SystemService'服务。 |



### 🍵UpdateOption

**枚举**

**Format** Update the file format of the package.
**Format** 更新包的文件格式。

**Encoding** Compress encoding.
**Encoding** 压缩编码。

**MainApp** Main program name.
**MainApp** 主程序名称。

**DownloadTimeOut** Timeout period (unit: second). If this parameter is not specified, the default timeout period is 30 seconds.
**DownloadTimeOut** 超时时间（单位：秒）。如果未指定此参数，则默认超时时间为30秒。

**Drive** Whether to enable the driver upgrade function.
**Drive** 是否启用驱动升级功能。

**WillMessage** Whether open note function, if you want to start needs to be synchronized to deploy 'GeneralUpdate. SystemService' service.
**WillMessage** 是否开启遗言功能，如果想要启动需要同步部署'GeneralUpdate. SystemService'服务。



Expand Down
18 changes: 9 additions & 9 deletions website/docs/doc/GeneralUpdate.Differential.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -82,37 +82,37 @@ DifferentialCore提供增量识别，生成二进制补丁、补丁还原、设

**方法**

Generate patch file [Cannot contain files with the same name but different extensions] .
生成补丁文件[不能包含文件名相同但扩展名不同的文件]。

```c#
public async Task Clean(string sourcePath, string targetPath, string patchPath = null);
```

**参数**

**sourcePath** Previous version folder path .
**sourcePath** 上一个版本的文件夹路径。

**targetPath** Recent version folder path.
**targetPath** 最近版本的文件夹路径。

**patchPath** Store discovered incremental update files in a temporary directory .
**patchPath** 将发现的增量更新文件存储在临时目录中。



### 🌼Dirty()

**方法**

Apply patch [Cannot contain files with the same name but different extensions] .
应用补丁[不能包含文件名相同但扩展名不同的文件]。

```c#
public async Task Dirty(string appPath, string patchPath);
```

**参数**

**appPath** Client application directory .
**appPath** 客户端应用程序目录。

**patchPath** Patch file path.
**patchPath** 补丁文件路径。



Expand All @@ -128,9 +128,9 @@ public void SetBlocklist(List<string> blackFiles, List<string> blackFileFormats)

**参数**

**blackFiles** A collection of blacklist files that are skipped when updated.
**blackFiles** 更新时跳过的黑名单文件的集合。

**blackFileFormats** A collection of blacklist file name extensions that are skipped on update.
**blackFileFormats** 更新时跳过的黑名单文件名扩展名的集合。



Expand Down
Loading

0 comments on commit b605fba

Please sign in to comment.