Skip to content

Commit

Permalink
fix zh_CN doc
Browse files Browse the repository at this point in the history
  • Loading branch information
FerdinandSu committed Dec 3, 2023
1 parent 1eed844 commit 7373bbb
Show file tree
Hide file tree
Showing 8 changed files with 47 additions and 47 deletions.
12 changes: 6 additions & 6 deletions docs/articles/ComplexCommands.md
Original file line number Diff line number Diff line change
@@ -1,15 +1,15 @@
# Create Complex Commands

**These features only works on JMobileSuitLite 0.1.1.4 or later version**
**These features only works on JMobileSuit 0.1.1.4 or later version**

Code example is at the end of this part.

## Parsable-type Parameters

**This feature only works on JMobileSuitLite 0.1.6 or later version**
**This feature only works on JMobileSuit 0.1.6 or later version**

MobileSuit's parameter type can be anything you like, in case there is a parser;
JMobileSuitLite support this function, now.
JMobileSuit support this function, now.

### Create or Select a parser

Expand Down Expand Up @@ -66,7 +66,7 @@ The most important thing when you're using this type of command is that The para

### Array parameter for Parsable-types

**This feature only works on JMobileSuitLite 0.1.6 or later version**
**This feature only works on JMobileSuit 0.1.6 or later version**

The array can not only be ***String[]***, but also other types. You just need to add a ***SuitParser*** Annotation
before the array parameter.
Expand Down Expand Up @@ -171,7 +171,7 @@ you command correctly.

### Auto DynamicParameter Class

**This feature only works on JMobileSuitLite 0.1.6 or later version**
**This feature only works on JMobileSuit 0.1.6 or later version**

Now, you no more needs to write a DynamicParameter::Parse yourself.

Expand Down Expand Up @@ -214,7 +214,7 @@ For Example:
After this part, your **Client.java** may looks like:

``` java
package PlasticMetal.JMobileSuit.Demo;
package ReFreSH.JMobileSuit.Demo;

import ReFreSH.JMobileSuit.NeuesProjekt.PowerLineThemedPromptServer;
import ReFreSH.JMobileSuit.ObjectModel.Annotions.SuitAlias;
Expand Down
2 changes: 1 addition & 1 deletion docs/articles/GetStarted.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Get Started

PlasticMetal.MobileSuit is a powerful tool to quickly build a .NET Core ConsoleApp.
ReFreSH.MobileSuit is a powerful tool to quickly build a .NET Core ConsoleApp.
Now, it is migrated to Java platform, which is called JMobileSuit.

## Create your project
Expand Down
4 changes: 2 additions & 2 deletions docs/articles/MobileSuitScripts.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Use MobileSuitScript Files

**This feature only works on JMobileSuitLite 0.1.2 or later version**
**This feature only works on JMobileSuit 0.1.2 or later version**

Pack-up your commands into a script file can make workflow automatically.

Expand All @@ -12,7 +12,7 @@ application.
Create a text file. Filename dosen't matter, but we recommend you to make the extension ".mss" stands for
MobileSuitScript.

Fill the file with commands of your application. **For JMobileSuitLite 0.1.2.2 or later version**, you can add comment
Fill the file with commands of your application. **For JMobileSuit 0.1.2.2 or later version**, you can add comment
lines starting with '#', which will not be parsed by JMobileSuit.

The commands in the file may be invalid or not in the application (Object/Member not found), however, when JMobileSuit
Expand Down
6 changes: 3 additions & 3 deletions docs/articles/zh_Hans/AdvancedUsage.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: PlasticMetal.JMobileSuitLite的常用特性
title: ReFreSH.JMobileSuit的常用特性
date: 2020-04-19 12:45:11
---

Expand All @@ -25,11 +25,11 @@ hello

## 自定义Prompt Server和Powerline主题的 Prompt Server

你可以自定义作为 Prompt Server的类, 他们需要实现接口 ***PlasticMetal.JMobileSuitLite.IO.PromptServer***. 当然, 也可以直接继承类 ***PlasticMetal.JMobileSuitLite.IO.CommonPromptServer***.
你可以自定义作为 Prompt Server的类, 他们需要实现接口 ***ReFreSH.JMobileSuit.IO.PromptServer***. 当然, 也可以直接继承类 ***ReFreSH.JMobileSuit.IO.CommonPromptServer***.

使用你的Prompt Server来初始化 ***SuitConfiguration***, 然后使用这个配置去初始化 ***SuitHost***.

一个自定义Prompt Server主题: Powerline 被内构于包 *PlasticMetal.JMobileSuitLite* .
一个自定义Prompt Server主题: Powerline 被内构于包 *ReFreSH.JMobileSuit* .

你可以像下面这样使用它:

Expand Down
34 changes: 17 additions & 17 deletions docs/articles/zh_Hans/ComplexCommands.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: 创建更复杂的 PlasticMetal.JMobileSuitLite 命令
title: 创建更复杂的 ReFreSH.JMobileSuit 命令
date: 2020-04-11 12:45:11
---

Expand All @@ -9,10 +9,10 @@ date: 2020-04-11 12:45:11

## 可解析类型的参数

**这些特性在 JMobileSuitLite 0.1.6 或更晚版本被移植**
**这些特性在 JMobileSuit 0.1.6 或更晚版本被移植**

MobileSuit 的参数类型是任意的,只要你能提供一个解析器;
JMobileSuitLite 如今也支持这一功能。
JMobileSuit 如今也支持这一功能。

### 创建,或者选取一个解析器

Expand Down Expand Up @@ -62,11 +62,11 @@ JMobileSuitLite 如今也支持这一功能。

**GoodEvening2** 接着 1, 2 ... 个参数, 第一个参数会被映射到 ***String*** 类型的参数, 其它的(可能是0个)会被视为数组,映射到 ***String[]*** 类型的参数.

编写这种命令最重要的是把使用 ***String[]*** 类型的参数 **必须放在** 方法参数列表的最后一位,否则JMobileSuitLite将无法正确解析它
编写这种命令最重要的是把使用 ***String[]*** 类型的参数 **必须放在** 方法参数列表的最后一位,否则JMobileSuit将无法正确解析它

### 可解析类型的数组参数

**这些特性在 JMobileSuitLite 0.1.6 或更晚版本被移植**
**这些特性在 JMobileSuit 0.1.6 或更晚版本被移植**

数组参数不仅可以是 ***String[]***, 还可以是其它类型的数组. 你只需要添加 ***SuitParser*** 注解在参数前.

Expand All @@ -92,7 +92,7 @@ JMobileSuitLite 如今也支持这一功能。

### 创建一个实现DynamicParameter的类

添加一个类到类 ***Client*** 中, 叫做 ***GoodMorningParameter***, 它实现 ***PlasticMetal.JMobileSuitLite.ObjectModel.Interfaces.DynamicParameter*** 接口. 这个类应该是 `public static`的:
添加一个类到类 ***Client*** 中, 叫做 ***GoodMorningParameter***, 它实现 ***ReFreSH.JMobileSuit.ObjectModel.Interfaces.DynamicParameter*** 接口. 这个类应该是 `public static`的:

``` java
public static class GoodMorningParameter implements DynamicParameter{
Expand Down Expand Up @@ -158,11 +158,11 @@ JMobileSuitLite 如今也支持这一功能。

**GoodMorning2** 跟着 1, 2 ... 个参数, 第一个参数会被映射到 ***String*** 类型的参数, 其它的会被视为数组并被解析为 ***GoodMorningParameter*** 类型的参数.

编写这种命令最重要的是 ***? extends DynamicParameter*** 类型的参数 **必须放在** 方法参数列表的最后一位,否则JMobileSuitLite将无法正确解析它
编写这种命令最重要的是 ***? extends DynamicParameter*** 类型的参数 **必须放在** 方法参数列表的最后一位,否则JMobileSuit将无法正确解析它

### 自动解析的动态参数

**这些特性在 JMobileSuitLite 0.1.6 或更晚版本被移植**
**这些特性在 JMobileSuit 0.1.6 或更晚版本被移植**

现在,你不再需要自己编写DynamicParameter::Parse.

Expand Down Expand Up @@ -201,15 +201,15 @@ JMobileSuit支持四种用于动态参数类型的字段的注解:
在本节之后,你 **Client.java** 中的代码大概像:

``` java
package PlasticMetal.JMobileSuit.Demo;

import PlasticMetal.JMobileSuitLite.NeuesProjekt.PowerLineThemedPromptServer;
import PlasticMetal.JMobileSuitLite.ObjectModel.Annotions.SuitAlias;
import PlasticMetal.JMobileSuitLite.ObjectModel.Annotions.SuitInfo;
import PlasticMetal.JMobileSuitLite.ObjectModel.DynamicParameter;
import PlasticMetal.JMobileSuitLite.ObjectModel.Parsing.*;
import PlasticMetal.JMobileSuitLite.ObjectModel.SuitClient;
import PlasticMetal.JMobileSuitLite.SuitHost;
package ReFreSH.JMobileSuit.Demo;

import ReFreSH.JMobileSuit.NeuesProjekt.PowerLineThemedPromptServer;
import ReFreSH.JMobileSuit.ObjectModel.Annotions.SuitAlias;
import ReFreSH.JMobileSuit.ObjectModel.Annotions.SuitInfo;
import ReFreSH.JMobileSuit.ObjectModel.DynamicParameter;
import ReFreSH.JMobileSuit.ObjectModel.Parsing.*;
import ReFreSH.JMobileSuit.ObjectModel.SuitClient;
import ReFreSH.JMobileSuit.SuitHost;

@SuitInfo("Demo")
public class Client extends SuitClient
Expand Down
22 changes: 11 additions & 11 deletions docs/articles/zh_Hans/GetStarted.md
Original file line number Diff line number Diff line change
@@ -1,27 +1,27 @@
---
title: 快速开始 - PlasticMetal.JMobileSuitLite
title: 快速开始 - ReFreSH.JMobileSuit
date: 2020-04-11 12:45:11
---


PlasticMetal.MobileSuit 是一个用来快速构造 .NET Core控制台程序的强大工具。现在,它的轻量化版本被移植到Java平台上来了,这就是JMobileSuitLite.
ReFreSH.MobileSuit 是一个用来快速构造 .NET Core控制台程序的强大工具。现在,它的轻量化版本被移植到Java平台上来了,这就是JMobileSuit.

## 创建项目

第一步,你需要在IDE中新建一个Java项目。


然后,添加 [PlasticMetal.JMobileSuitLite](https://search.maven.org/artifact/io.github.plastic-metal/JMobileSuitLite) 到你的项目。
然后,添加 [ReFreSH.JMobileSuit](https://search.maven.org/artifact/io.github.hit-refresh/JMobileSuit) 到你的项目。

## 编写客户端类

### 创建类

向项目添加一个新类, 名为 ***Client***. 它继承自 ***PlasticMetal.JMobileSuitLite.ObjectModel.SuitClient***.
向项目添加一个新类, 名为 ***Client***. 它继承自 ***ReFreSH.JMobileSuit.ObjectModel.SuitClient***.

### 为类添加自定义标记:

*PlasticMetal.JMobileSuitLite.ObjectModel.Annotions..SuitInfo* 使用参数 "Demo"
*ReFreSH.JMobileSuit.ObjectModel.Annotions..SuitInfo* 使用参数 "Demo"

### 添加第一条指令

Expand All @@ -33,8 +33,8 @@ PlasticMetal.MobileSuit 是一个用来快速构造 .NET Core控制台程序的

向方法添加以下自定义标记:

1. *PlasticMetal.JMobileSuitLite.ObjectModel.Annotions..SuitInfo* 使用参数 "hello command."
2. *PlasticMetal.JMobileSuitLite.ObjectModel.Annotions..SuitAlias* 使用参数 "H"
1. *ReFreSH.JMobileSuit.ObjectModel.Annotions.SuitInfo* 使用参数 "hello command."
2. *ReFreSH.JMobileSuit.ObjectModel.Annotions.SuitAlias* 使用参数 "H"

### A添加另一条命令

Expand Down Expand Up @@ -63,10 +63,10 @@ new SuitHost(Client.class).Run();
它的内容大概是:

``` java
import PlasticMetal.JMobileSuitLite.ObjectModel.Annotions.SuitAlias;
import PlasticMetal.JMobileSuitLite.ObjectModel.Annotions.SuitInfo;
import PlasticMetal.JMobileSuitLite.ObjectModel.SuitClient;
import PlasticMetal.JMobileSuitLite.SuitHost;
import ReFreSH.JMobileSuit.ObjectModel.Annotions.SuitAlias;
import ReFreSH.JMobileSuit.ObjectModel.Annotions.SuitInfo;
import ReFreSH.JMobileSuit.ObjectModel.SuitClient;
import ReFreSH.JMobileSuit.SuitHost;

@SuitInfo("Demo")
public class Client extends SuitClient
Expand Down
8 changes: 4 additions & 4 deletions docs/articles/zh_Hans/MobileSuitScripts.md
Original file line number Diff line number Diff line change
@@ -1,17 +1,17 @@
---
title: 将PlasticMetal.JMobileSuitLite命令打包为脚本文件来实现工作流程自动化
title: 将ReFreSH.JMobileSuit命令打包为脚本文件来实现工作流程自动化
date: 2020-04-11 12:45:11
---

**该特性在 JMobileSuitLite 0.1.2 或更高版本可用**
**该特性在 JMobileSuit 0.1.2 或更高版本可用**

在本节, 你不再需要编写Java代码, 而是需要编写一个包含你应用里各种命令的脚本文件.

## 创建脚本文件

创建一个文本文件. 文件名可以是任意的, 但是我们建议使用 ".mss" 作为扩展名,意为MobileSuit脚本(MobileSuit Script).

使用你应用里的命令填充脚本。**对于 JMobileSuitLite 0.1.2.2 或更高版本**, 你在 **行首** 添加 *'#'* 来创建行注释,它们不会被JMobileSuit解析.
使用你应用里的命令填充脚本。**对于 JMobileSuit 0.1.2.2 或更高版本**, 你在 **行首** 添加 *'#'* 来创建行注释,它们不会被JMobileSuit解析.

这些命令可能包含非法命令,或者是不存在的命令。然而, 当JMobileSuit执行到包含这种命令的行时,它会停下来并返回错误。该行之后的命令 **不会** 被执行.

Expand All @@ -34,7 +34,7 @@ bye foo

脚本文件可以包含 *RunScript**Rs* 命令, 所以请小心堆栈溢出的发生。.

**This feature only works on JMobileSuitLite 0.1.2 or later version**
**This feature only works on JMobileSuit 0.1.2 or later version**

Pack-up your commands into a script file can make workflow automatically.

Expand Down
6 changes: 3 additions & 3 deletions docs/articles/zh_Hans/index.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
---
title: PlasticMetal.JMobileSuitLite使用文档
title: ReFreSH.JMobileSuit使用文档
date: 2020-04-19 12:45:11
---

[View English Documentation](../GetStarted.md)

欢迎来到PlasticMetal.JMobileSuitLite使用文档!
欢迎来到ReFreSH.JMobileSuit使用文档!

在本页,您将了解如何使用JMobileSuitLite来快速构建一个Java控制台应用程序
在本页,您将了解如何使用JMobileSuit来快速构建一个Java控制台应用程序

> [!NOTE]
> 在开始前,请确保您已经了解Java语言的基本内容。
Expand Down

0 comments on commit 7373bbb

Please sign in to comment.