在详细了解实验手册的编写语法之前,请先了解一下实验手册的组成。一份完整的实验手册由两部分组成:实验主体和互动元素。
实验主体
实验的主体包括实验名称、实验任务、实验步骤、正文和步骤检查器,任何一个实验都需要具备这五个要素。
实验主体一览表:
主体名称 | 定义方式 |
实验名称 | Markdown 一级标题 |
实验任务 | Markdown 二级标题 |
实验步骤 | Markdown 三级标题 |
正文 | 在二级标题或三级标题下编写 |
检查器 | 在实验步骤下编写 |
互动元素
互动元素可以帮助用户理解实验,以及提高实验的互动性。适当地使用互动元素,可以让实验更直观、有趣、易理解。
互动元素一览表:
元素名称 | 定义方式 | 作用域 |
代码块 | Markdown 代码块 | - |
内联代码 | Markdown 内联代码或 <code> 标签 | - |
环境变量 | ${runtime.vars.<变量名>} | - |
文件定位 | <locate> 标签 | 仅终端 |
解释气泡 | <bubble> 标签 | - |
图片 | Markdown 图片 | - |
视频 | <video> 标签 | - |
网页 | <webpage> 标签 | 仅终端 |
链接 | Markdown 链接 | - |
列表 | Markdown 列表 | - |
表格 | Markdown 表格 | - |
公式 | Markdown 代码块 + <formula> 标签 | - |
注意:
文件定位、网页这两种元素只在终端模式中生效。