README.md

# skill_tree_oceanbase

## 初始化

```
pip install -r requirement.txt
```


## 目录结构说明

* 技能树`骨架文件`：
    * 位置：`data/tree.json` 
    * 说明：该文件是执行 `python main.py` 生成的，请勿人工编辑
* 技能树`根节点`配置文件：
    * 位置：`data/config.json`
    * 说明：可编辑配置关键词等字段，其中 `node_id` 字段是生成的，请勿编辑
* 技能树`难度节点`：
    * 位置：`data/xxx`，例如: `data/1.Oceanbase初阶`
    * 说明：
        * 每个技能树有 3 个等级，目录前的序号是必要的，用来保持文件夹目录的顺序
        * 每个目录下有一个 `config.json` 可配置关键词信息，其中 `node_id` 字段是生成的，请勿编辑
* 技能树`章节点`：
    * 位置：`data/xxx/xxx`，例如：`data/1.OceanBase初阶/1.快速入门`
    * 说明：
        * 每个技能树的每个难度等级有 n 个章节，目录前的序号是必要的，用来保持文件夹目录的顺序
        * 每个目录下有一个 `config.json` 可配置关键词信息，其中 `node_id` 字段是生成的，请勿编辑
* 技能树`知识节点`：
    * 位置：`data/xxx/xxx/xxx`，例如：`data/1.OceanBase初阶/1.快速入门/1.安装OBD`
    * 说明：
        * 每个技能树的每章有 `n` 个知识节点，目录前的序号是必要的，用来保持文件夹目录的顺序
        * 每个目录下有一个 `config.json`
            * 其中 `node_id` 字段是生成的，请勿编辑
            * 其中 `keywords` 可配置关键字字段
            * 其中 `children` 可配置该`知识节点`下的子树结构信息，参考后面描述
            * 其中 `export` 可配置该`知识节点`下的导出习题信息，参考后面描述


## `知识节点` 子树信息结构

例如 `data/1.OceanBase初阶/7.查询数据/config.json` 里配置对该知识节点子树信息结构：
```json
    // ...

    "children": [
        // TODO ...
    ],
}
```



## `知识节点` 的导出习题编辑

例如 `data/1.OceanBase初阶/7.查询数据/config.json` 里配置对该知识节点导出的习题

```json
{
    // ...
    "export": [
        "hello.json"
    ]
}
```

每个文件名，指向对应的习题定义 json 。

## `知识节点` 的导出习题选项配置编辑

目前我们支持使用 markdown 语法直接编辑习题和各选项，或者编写习题代码和替换规则，让程序动态生成选项。

我们先介绍使用替换规则的习题如何编辑，在最后介绍 markdown 方式编写习题的方法。对于 Java 技能树，我们更*推荐*
使用 markdown 方式编写习题。

### 使用替换规则编写习题

首先，在知识节点下增加一个习题定义文件，例如 hello.json ：

```json
{
    "type": "code_options",
    "author": "刘鑫",
    "source": "hello.sql",
}
```

其中

 * 类型现在仅支持 `code_options` 一种，保持不变即可
 * author 是题目作者
 * source 指题目定义，题目可以是源代码 + 替换规则的形式，也可以用 markdown 编写

我们先讨论使用替换规则定义题目的方式。

例如在 `data/1.OceanBase初阶/7.查询数据` 下增加一个`hello.sql`代码文件：

```sql
select 'hello';
```

其次，增加一个同名的选项配置文件`HelloWorld.json`，目前有三种配置规则

#### 单行替换规则

* 配置由`one_line`字段指定的单行替换字典
* 格式是：`"<源字符串>"`: [`"<替换字符串A>"`, `<替换字符串B>`,...],
    * 其中每个 `"<源字符串>"` `/` `"<替换字符串A>"` 被生成为是一个替换选项
    * 指定的配置应该能至少生成 `3+` 个替换选项

```json
{
    "one_line": {
        "select": ["print", "log", "echo"]
    }
}
```

上面的替换规则会将代码替换成 3 个变种的代码：

```sql
print 'hello';
```

```java
log 'hello';

```

```java
echo 'hello';
```

这些变种代码将会作为技能树该知识点该代码选择题的选项。

#### 多行替换规则

* 配置由`multiline`字段指定的多行替换数组
* 数组的每个元素是一组替换规则，会整组被替换

例如：

假设我们有习题代码：

```sql
begin
    update parent set children = children + $child
    insert child(c select $child;
    commit;
end
```
和变形规则

```json
{
    "mulitiline": [{
        "begin": "{",
        "end": "}"
    },
    { 
        "commit": "save",
        "begin": "try{",
        "commit;": "",
        "end": "}finally{\n\tsave;\n}"
    },
    {
        "begin": "begin:",
        "commit;": "",
        "end": "finally: \tcommit;"
    }]
```

上面的替换规则会将代码替换成 3 个变种的代码：

```sql
{
    update parent set children = children + $child
    insert child(c select $child;
    commit;
}
```

```sql
try{
    update parent set children = children + $child
    insert child(c select $child;

}finally{
    save;
}
```

```sql
begin:
    update parent set children = children + $child
    insert child(c select $child;

finally:
    commit;
```

这些变种代码将会作为技能树该知识点该代码选择题的选项。


#### 预制的替换规则

 * 配置由 `prepared` 字段制定的预制文件数组
 * 数组每一个元素是一个预制的代码文件的路径文件名

例如：

```json
{
    "prepared": [
        "hello.1.sql",
        "hello.2.sql",
        "hello.3.sql"]
}
```

同样，该配置将支持将源代码生成3个变种代码

```sql
try{
    update parent set children = children + $child
    insert child(c select $child;

}finally{
    save;
}
```

```sql
begin:
    update parent set children = children + $child
    insert child(c select $child;

finally:
    commit;
```

### 使用 markdown 编写习题

如前内容，我们在知识节点下增加一个习题配置，例如在 `data/1.Java初阶/1.Java概述/1.什么是Java` 下增加一个`HelloWorld.json`代码：

```json
{
    "type": "code_options",
    "author": "刘鑫",
    "source": "HelloWorld.md",
    "exercise_id":"1190bb7834904da0b1f20915960714d5",
    "notebook_enable": true
}
```
其中 type 字段目前都固定是 `code_options`。exercise_id 可以不写，处理程序会自动填补这个数据。根据具体情况写好其它字段，注意这里 source 的文件名，我们指定了一个 markdwon 文件。现在我们新建一个 HelloWorld.md 并编辑为：

````markdown
# Hello World


以下 `Hello World` 程序中，能够正确输出内容的是：

## 答案

```sql

select 'hello';
```

## 选项

### A

```sql
print 'hello';
```

### B

```sql
echo 'hello';
```

### C

```sql
log 'hello';
```

````

这是一个最基本的习题结构，它包含标题、答案、选项，注意这几个一级和二级标题必须填写正确，解释器会读取这几个标题。而选项的标题会被直接忽略掉，在最终生成的习题中不包含选项的三级标题，所以这个标题可以用来标注一些编辑信息，例如“此选项没有关闭文件连接”，“类型错误”等等。

### 增强信息

    为了编写习题和生成 notebook 的需要，markdown 解释器支持两种模板能力，具体到 oceanbase ，现在还没有对应的 notebook 支持，所以这部分内容仅供参考，未来如果支持了 oceanbase notebook，就按照下文规范。

````markdown

## aop

### before

```sql
create table test(id integer primary key, content varchar(256));
```

### after

```java
drop table test;
```
````

那么在创建notebook的时候，before 会插入到源代码前一个单元，after 则会插入到源代码后。aop 章节可以只包含 before 或 after 中的某一个，也可以两个都有。

另一些情况下，我们可能需要把各个选项中重复的代码提取出来，建立一个模板，此时可以在答案之前建立一个名为 template 的二级标题，例如：

````markdwon

## template

```sql
begin
$code
end;

```

````

注意这里的代码中，有一个 `$code` 占位符，它在管道程序处理过程中，会替换成答案和个选项内容中的代码。

在后续的数据处理流程中，markdown 会被编译为 prepared 类型的习题。

## 技能树合成

在`src`目录下执行 `python main.py -a tree` 会合成技能树文件，合成的技能树文件: `data/tree.json`
* 合成过程中，会自动检查每个目录下 `config.json` 里的 `node_id` 是否存在，不存在则生成
* 合成过程中，会自动检查每个知识点目录下 `config.json` 里的 `export` 里导出的习题配置，检查是否存在`exercise_id` 字段，如果不存在则生成