Skip to content

Commit

Permalink
docs:feat:2025
Browse files Browse the repository at this point in the history
新增拆分集控文件教程;修改版权年份为2025
  • Loading branch information
fhzit committed Feb 7, 2025
1 parent aa14819 commit 0be0f4c
Show file tree
Hide file tree
Showing 9 changed files with 140 additions and 13 deletions.
12 changes: 11 additions & 1 deletion src/.vuepress/sidebar/zh.ts
Original file line number Diff line number Diff line change
Expand Up @@ -76,7 +76,17 @@ export const zhSidebar = sidebar({
"connect-to-mgmt-server.md",
"configure.md",
"policy.md",
"tutorial-create-management-config.md",
{
text: "教程:手动编写集控配置文件",
collapsible: true,
expanded: true,
prefix: "tutorial-create-management-config/",
children: [
"tutorial-create-management-config.md",
"tutorial-partition-management-config.md",
],
icon: "fa-solid fa-book"
},
],
},
],
Expand Down
2 changes: 1 addition & 1 deletion src/.vuepress/theme.ts
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ export default hopeTheme({
sidebar: zhSidebar,

// autocorrect-disable
footer: "Copyright (c) 2024 ClassIsland | " +
footer: "Copyright (c) 2025 ClassIsland | " +
'本文档以 CC BY-NC-SA 4.0 许可协议授权。' +
'<br/>' +
'<a href="https://beian.miit.gov.cn/" target="_blank"> 沪ICP备2024084943号</a> | ' +
Expand Down
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@

**👉️在创建仓库界面勾选【Add a README file】复选框**

![1715485878305](image/tutorial-create-management-config/1715485878305.png)
![1715485878305](../image/tutorial-create-management-config/1715485878305.png)

::: note
为了方便,我们在这里统一将仓库命名为`classisland-mgmt-cfg`,您也可以给仓库起一个您喜欢的名字。
Expand All @@ -40,13 +40,13 @@

在仓库创建好之后,我们进入了仓库的主界面(如图所示):

![1715486027121](image/tutorial-create-management-config/1715486027121.png)
![1715486027121](../image/tutorial-create-management-config/1715486027121.png)

现在我们需要进入 GitHub Codespaces 来编辑仓库里的文件。

**👉️在仓库界面按下键盘上的<kbd>.</kbd>(英文句号)进入 GitHub Codespaces。**

![1715486161995](image/tutorial-create-management-config/1715486161995.png)
![1715486161995](../image/tutorial-create-management-config/1715486161995.png)

现在万事俱备,我们可以开始编写集控的配置文件了。

Expand All @@ -56,7 +56,7 @@

**👉️新建一个文件,并命名为`manifest.json`**

**👉️将以下文本粘贴到`manifest.json中`**
**👉️将以下文本粘贴到`manifest.json`**

```json title="manifest.json"
{
Expand Down Expand Up @@ -97,15 +97,15 @@

**👉同意许可协议,然后点击【加入集控】按钮。**

![1715487543978](image/tutorial-create-management-config/1715487543978.png)
![1715487543978](../image/tutorial-create-management-config/1715487543978.png)

::: tip
如果您先前已经完成欢迎向导,您可以[根据此处的文档](connect-to-mgmt-server.md)来加入集控。
:::

此时会弹出集控加入界面,并自动加载了我们刚刚放置在应用目录下的`ManagementPreset.json`文件。您可以点击【浏览】按钮选择其它的配置文件。

![1715487558487](image/tutorial-create-management-config/1715487558487.png)
![1715487558487](../image/tutorial-create-management-config/1715487558487.png)

**👉在 ID 一栏填入`TEST`**

Expand All @@ -117,15 +117,15 @@ ID 在此处可以标识 ClassIsland 实例。在后续的实际应用中,您

**👉在弹出的确认提示框上,点击【加入】按钮。**

![1715487625695](image/tutorial-create-management-config/1715487625695.png)
![1715487625695](../image/tutorial-create-management-config/1715487625695.png)

**👉在弹出的加入成功提示框上,点击【确定】按钮。**

![1715487641719](image/tutorial-create-management-config/1715487641719.png)
![1715487641719](../image/tutorial-create-management-config/1715487641719.png)

此时应用会重新启动。在重新启动后,进入【应用设置】,您可以看到右上角出现了【由贵单位管理】徽章。

![1715487682961](image/tutorial-create-management-config/1715487682961.png)
![1715487682961](../image/tutorial-create-management-config/1715487682961.png)

🎉恭喜!您现在已经成功地加入了集控!

Expand All @@ -145,6 +145,8 @@ ID 在此处可以标识 ClassIsland 实例。在后续的实际应用中,您

这些文件分别存储了科目、时间表和课表信息。尽管这些文件仍然以 ClassIsland 档案文件格式存储,但在加载时只会加载相应的部分。您也可以上传并使用自己的档案文件。

如何拆分档案文件,您可以参考[这篇文档](tutorial-partition-management-config.md)

**👉在`manifest.json`中添加以下高亮代码,并将所有 url 中中用户名部分替换成你的 GitHub 用户名。**

```json title="manifest.json" hl_lines="4-15"
Expand Down Expand Up @@ -178,7 +180,7 @@ ID 在此处可以标识 ClassIsland 实例。在后续的实际应用中,您

如果前面的步骤没有差错,ClassIsland 会自动拉取档案。您可以在启动应用后,进入【档案编辑】界面,查看拉取的档案。

![1715490985052](image/tutorial-create-management-config/1715490985052.png)
![1715490985052](../image/tutorial-create-management-config/1715490985052.png)

## 应用 url 模板

Expand Down Expand Up @@ -284,7 +286,7 @@ https://example.com/client/TEST/policy.json

在重启应用后打开设置界面,您可以看到设置编辑功能已被禁用。

![1716004833729](image/tutorial-create-management-config/1716004833729.png)
![1716004833729](../image/tutorial-create-management-config/1716004833729.png)

您可以进一步阅读[策略文件](policy.md)文档,了解其它的策略配置,并根据需要自定义策略。

Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,115 @@
# 教程:拆分集控配置文件

本教程将指引您手动拆分集控配置文件。

每当你看见👉️符号,就说明你应该做一些事情。而其余的只供您参考和更深入的理解。

## 在开始之前

我们需要在本地安装一个 ClassIsland 实例并编写好您的档案。您可以参考[这篇文档](/app/profile/)编写档案。

**👉️按照指示[下载并安装 ClassIsland 本体](https://github.com/HelloWRC/ClassIsland?tab=readme-ov-file#%E5%BC%80%E5%A7%8B%E4%BD%BF%E7%94%A8)**

**👉️按照指示[编写档案](/app/profile/)**

**👉️获取编写好的 ClassIsland 档案。**

**👉️确保您已经安装了文本编辑器,如 Visual Studio Code,用于编辑 JSON 文件,本教程以 `Visual Studio Code` 为例。**

ClassIsland 档案存放在 ClassIsland 目录下的 `Profiles` 文件夹中。
ClassIsland 默认档案名称为 `Default.json`,您也可以使用您自定义的档案名称。

## 拆分档案

👉️打开一款任意的 `Chrome` ,本教程以 `Microsoft Edge` 浏览器为例。

👉️将 `Default.json` 拖入 `Microsoft Edge` 浏览器

![drag-default-json-to-edge](../image/tutorial-create-management-config/drag-default-json-to-edge.png)

👉️点击左上角的 `优质打印` 按钮

![click-print-quality-button](../image/tutorial-create-management-config/click-print-quality-button.png)

### 拆分出 TimeLayouts.json
👉️在 `Microsoft Edge` 中,复制 `Default.json` 文件中的 `TimeLayouts` 部分。

👉️在 `Visual Studio Code` 创建一个新的文件,命名为 `TimeLayouts.json`

👉️将以下模板粘贴到 `TimeLayouts.json` 文件中:

```json:TimeLayouts.json
{
"Name": "",
"TimeLayouts": {},
"ClassPlans": {
// 粘贴从 Default.json 中复制的 ClassPlans 内容
},
"Subjects": {}
}
```

### 拆分出 ClassPlans.json

👉️在 `Microsoft Edge` 中,复制 Default.json 文件中的 ClassPlans 部分。

👉️在 `Visual Studio Code` 创建一个新的文件,命名为 ClassPlans.json。

👉️将以下模板粘贴到 ClassPlans.json 文件中:

```json:ClassPlans.json
{
"Name": "",
"TimeLayouts": {},
"ClassPlans": {
// 粘贴从 Default.json 中复制的 ClassPlans 内容
},
"Subjects": {}
}
```

👉️将复制的 ClassPlans 内容粘贴到 ClassPlans.json 文件中的 ClassPlans 字段内。

👉️保存 ClassPlans.json 文件。

### 拆分出 Subjects.json

👉️在 `Microsoft Edge` 中,复制 Default.json 文件中的 Subjects 部分。

👉️在 `Visual Studio Code` 创建一个新的文件,命名为 Subjects.json。

👉️将以下模板粘贴到 Subjects.json 文件中:

```json:Subjects.json
{
"Name": "",
"TimeLayouts": {},
"ClassPlans": {},
"Subjects": {
// 粘贴从 Default.json 中复制的 Subjects 内容
}
}
```

👉️将复制的 Subjects 内容粘贴到 Subjects.json 文件中的 Subjects 字段内。

👉️保存 Subjects.json 文件。

正确拆分截图:
`classPlan.json`文件

![classPlan](../image/tutorial-create-management-config/classPlan.png)

`Subjects.json`文件

![Subjects](../image/tutorial-create-management-config/Subjects.png)

`TimeLayouts.json`文件

![TimeLayouts](../image/tutorial-create-management-config/TimeLayouts.png)


## 结语

🎉恭喜!您现在已经对拆分集控文件有了初步的认识。您可以进一步研究[集控文档](tutorial-create-management-config.md#拉取档案),来更深入地了解编写集控配置的方法。

0 comments on commit 0be0f4c

Please sign in to comment.