Skip to content

Commit 0f29fec

Browse files
committed
modify json format defination file
1 parent d63f129 commit 0f29fec

File tree

1 file changed

+19
-10
lines changed

1 file changed

+19
-10
lines changed

doc/csti-json.md

Lines changed: 19 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -34,10 +34,9 @@ lessons: [lessons 数组](#lessons-数组)
3434

3535
描述课程表的全局配置, 包括生成日历的事件描述格式和时区以及课程时间相关的配置.
3636

37-
3837
|属性|描述|
3938
|---|---|
40-
| `event-summary-format` | 字符串, 描述生成的事件的名称, 支持[变量代换](#变量代换).
39+
| `event-summary-format` | 字符串, 描述生成的事件的名称, 支持[变量代换](#变量代换).|
4140
| `event-description-format` | 字符串, 描述生成的事件的详细描述, 支持[变量代换](#变量代换).
4241
| `timezone` | 字符串, 描述时区, 要求是能够被 Java 识别的字符串.|
4342
| `first-day-of-week` | 整数, 范围 `[0-7]`, `0``7` 都表示星期日.|
@@ -49,6 +48,16 @@ lessons: [lessons 数组](#lessons-数组)
4948
>
5049
> `1=08:00:00-08:45:00`, 表示每天的第 `1` 节课自 `08:00:00` 开始, 直到 `08:45:00` 时下课.
5150
51+
|属性|默认值|
52+
|---|---|
53+
|`event-summary-format`|`"${lessonName}-${location}"`|
54+
|`event-description-format`|`"name:${lessonName}\nlocation:${location}\nteacher:${teacher}\ntype:${lessonType}\nremark:${remark}\nschedule:${scheduleFull}"`|
55+
|`timezone`|`Asia/Shanghai`|
56+
|`first-day-of-week`|`1`|
57+
|`semester-start-date`|无(必填)|
58+
|`reminder-time`|`-15m`|
59+
|`lesson-ranges`|无(必填)|
60+
5261
### lessons 数组
5362

5463
数组中每一个元素均为一个描述课程信息的对象, 该对象格式如下:
@@ -65,14 +74,14 @@ lessons: [lessons 数组](#lessons-数组)
6574
]
6675
}
6776
```
68-
|属性|描述
69-
|---|---|
70-
| `name` | 字符串, 描述课程名称.|
71-
| `type` | 字符串, 描述课程的类型, 如专业选修课/专业必修课.|
72-
| `teacher` | 字符串, 该课程的任课教师.|
73-
| `location` | 字符串, 描述上课位置.|
74-
| `remark` | 字符串, 备注, 用来记录一些其他的信息.|
75-
| `schedule` | JSON 数组, 每个元素为一个字符串, 描述上课的周次/星期几/课程的起止节数. 具体格式为 `周次|星期几|课程起止节数` , 三个区域分别可以使用逗号分隔符表示单独添加, 或使用连字符表示范围. 字符串可以有多个, 描述多个不同的规则.|
77+
|属性|描述|默认值|
78+
|---|---|---|
79+
| `name` | 字符串, 描述课程名称.|无(必填)|
80+
| `type` | 字符串, 描述课程的类型, 如专业选修课/专业必修课.|`""`|
81+
| `teacher` | 字符串, 该课程的任课教师.|`""`|
82+
| `location` | 字符串, 描述上课位置.|`""`|
83+
| `remark` | 字符串, 备注, 用来记录一些其他的信息.|`""`|
84+
| `schedule` | JSON 数组, 每个元素为一个字符串, 描述上课的周次/星期几/课程的起止节数. 具体格式为 `周次|星期几|课程起止节数` , 三个区域分别可以使用逗号分隔符表示单独添加, 或使用连字符表示范围. 字符串可以有多个, 描述多个不同的规则.|无(必填)
7685

7786
> 字符串中使用逗号或连字符的例子:
7887
>

0 commit comments

Comments
 (0)