{"contents":"# modern-hust-cse-report\n\nAn (unofficial) Typst template for lab reports at the School of Cyber Science and Engineering, Huazhong University of Science and Technology (HUST).\n\n此项目是华中科技大学网络空间安全学院实验/实践报告的通用Typst 模板。\n\nTypst 旨在成为 LaTeX 的现代替代，帮助我们实现了格式分离，只需输入纯文本的报告内容，而不需要操心任何格式上的问题。它上手曲线非常平滑，并且作为纯文本格式对于使用AI撰写实验报告颇有优势。\n\n由于网页端 typst.app 并不包含微软字体，因为更推荐在本地撰写和编译。如果你使用的是VSCode，可以通过 [Tinymist 插件](https://marketplace.visualstudio.com/items?itemName=myriad-dreamin.tinymist)预览。Tinymist也同样支持绝大多数文本编辑器，\n\n当然，考虑到这是一个通用模板，对于具体的课程，你要对着老师给的模板填充一部分文字构成该课程的具体模板。不过一旦制作完成，你可以把模板分享给同学，无需重复劳动。\n\n这个模板基本上严格符合学院官方的实验报告要求。需要注意的是，根据具体的课程不同，有的老师给你的Word模板可能有问题，比如缺少报告要求页，比如甚至采用汉字来进行排序编号，比如标题甚至不是仿宋，但这只是老师给的模板错误，我个人觉得我们仍然应该使用正确的模板。\n\n## 格式声明\n\n- 标题页使用仿宋，校名/学院/报告标题均为26pt。如果你的课程名称较长（如《计算机网络工程与安全实践》），标题可能一行放不下，可以通过 `title-size: 25pt` 缩小标题字号，少1pt肉眼不可感\n- 一级标题黑体18pt居中\n- 二级标题黑体14pt左对齐\n- 标题前后1em间距\n- 首页底部日期固定为 `datetime.today()` 渲染\n- 页眉为黑体10.5pt，内容为“网络空间安全学院” + 报告标题\n- 标题页标题固定带“本科：”前缀\n- 块级数学公式（使用 `$ $` 包裹）会自动添加右侧编号：\n\n目前评分表格的格式千奇百怪，所以无法提供一种统一的模板(但是你可以让 AI 帮你写，我推荐 Claude，只有它比较会写 Typst)。\n\n## 安装\n\n此模板需要你的电脑里有 Fangsong, SimSun, SimHei, Times New Roman 等 Windows 字体。\n\n### 方法一：使用 typst init（推荐）\n\n在当前目录初始化项目：\n\n```bash\ntypst init @preview/modern-hust-cse-report\n```\n\n指定自定义目录名称：\n\n```bash\ntypst init @preview/modern-hust-cse-report my-report\n```\n\n### 方法二：手动导入\n\n在已有 Typst 项目中导入该模板并填写信息：\n\n```typst\n#import \"@preview/modern-hust-cse-report:0.1.2\": report, fig, tbl\n\n#show: report.with(\n  name: \"李华\",\n  class: \"网安2101\",\n  id: \"U2020XXXXX\",\n  contact: \"user@example.com\",\n  scoretable:[\n    // 评分表要用 Typst 格式写在这里\n    // 如果有课程目标评价标准、评分标准等内容，也都写在这里\n    // 如果有多页内容，记得使用 #pagebreak() 分页\n  ],\n  title: \"《密码硬件综合实践》报告\",\n  signature: \"signature.png\", // 签名图片路径，设置为 none 则不显示签名\n)\n\n= 第一章\n== 第一节\n\n正文内容……\n\n// 插入图片\n#fig(\"image.png\", caption: \"这是图片标题\", width: 80%)\n// 这将自动显示为：图1-1-1:这是图片标题\n\n// 插入表格\n#tbl(\n  table(\n    columns: 3,\n    [姓名], [学号], [成绩],\n    [张三], [001], [95],\n    [李四], [002], [88],\n  ),\n  caption: \"学生成绩表\"\n)\n// 这将自动显示为：表1-1-1:学生成绩表\n\n// 插入数学公式（块级公式会自动编号）\n$ E = m c^2 $\n// 这将自动显示为：E = m c^2  (1-1-1)\n\n```\n\n## 使用\n### 图片插入\n\n使用 `fig` 函数插入图片，它会自动添加格式化的图注：\n\n```typst\n#fig(\"path/to/image.png\", caption: \"图片描述\", width: 80%)\n```\n\n- `caption`: 图片标题（必填）\n- `width`: 图片宽度，可以是百分比或绝对值（可选，默认 auto）\n- 图片编号格式为 `图x-y-z`，其中 x 是一级标题编号，y 是二级标题编号，z 是该节内的图片序号\n- 每个二级标题下的图片编号会自动重置\n- 图注使用 Times New Roman 和黑体混合字体，14pt，居中显示在图片下方\n\n### 表格插入\n\n使用 `tbl` 函数插入表格，它会自动添加格式化的表注：\n\n```typst\n#tbl(\n  table(\n    columns: 3,\n    [列1], [列2], [列3],\n    [数据1], [数据2], [数据3],\n  ),\n  caption: \"表格描述\"\n)\n```\n\n- `content`: 表格内容（使用 Typst 的 `table()` 函数创建）\n- `caption`: 表格标题（必填）\n- 表格编号格式为 `表x-y-z`，其中 x 是一级标题编号，y 是二级标题编号，z 是该节内的表格序号\n- 每个二级标题下的表格编号会自动重置\n- 表注使用 Times New Roman 和黑体混合字体，14pt，居中显示在表格上方\n","is_binary":false,"path":"README.md","ref":""}