master-report-sample.typ

#import "master-report-template.typ": *
#import "@preview/codelst:2.0.0": sourcecode
#show: setup-lovelace

#let algorithm = algorithm.with(supplement: "算法")


#show: project.with(
  asymmetric_margin: true,
  padding_page: true,
  title: [基于 ChatGPT 的狗屁通文章生成器],
  subject: [研究生（XX）报告],
  author: [你的名字],
  major: [你的专业],
  id: [M2024xxxxx],
  suporvisor: [你的老板],
  college: [你的学院],
  date: datetime(year: 2024, month: 12, day: 9),
  abstract: [
    *注：该模板中如不填写 `abstract` 字段，则不会出现摘要页，在编写课程报告时可以删除。*

    先帝创业未半而中道崩殂，今天下三分，益州疲弊，此诚危急存亡之秋也。然侍卫之臣不懈于内，忠志之士忘身于外者，盖追先帝之殊遇，欲报之于陛下也。诚宜开张圣听，以光先帝遗德，恢弘志士之气，不宜妄自菲薄，引喻失义，以塞忠谏之路也。

  宫中府中，俱为一体；陟罚臧否，不宜异同。若有作奸犯科及为忠善者，宜付有司论其刑赏，以昭陛下平明之理，不宜偏私，使内外异法也。],
  keywords:("关键字1", "关键字2"),
  abstract_en: [The founding emperor passed away before his endeavor was half completed, and now the empire is divided into three parts. Yizhou is exhausted and in decline, and this is truly a critical moment of survival or destruction. However, the palace guards are tirelessly serving within, and loyal subjects are sacrificing themselves outside, all in order to repay the late emperor's kindness and show loyalty to the current emperor. It is appropriate to listen to wise advice, to honor the late emperor's virtues, to inspire the courage of loyal subjects, and not to belittle oneself or distort the truth, in order to keep the path of loyal counsel open. 

  The palace and government are one entity, and punishments should be consistent. If there are those who commit crimes or show loyalty and virtue, they should be judged by the legal system to demonstrate your fairness as emperor, rather than showing partiality that would create different laws for those inside and outside the palace.],
  keywords_en:("Something", "Something else"),
)


= 绪论

== typst 介绍


typst 是最新最热的标记文本语言，定位与 LaTeX 类似，具有极强的排版能力，通过一定的语法写文档，然后生成 pdf 文件。与 LaTeX 相比有以下的优势：


1. 编译巨快：因为提供增量编译的功能所以在修改后基本能在一秒内编译出 pdf 文件，typst 提供了监听修改自动编译的功能，可以像 Markdown 一样边写边看效果。

2. 环境搭建简单：原生支持中日韩等非拉丁语言，不用再大量折腾字符兼容问题以及下载好几个 G 的环境。只需要下载命令行程序就能开始编译生成 pdf。

3. 语法友好：对于普通的排版需求，上手难度跟 Markdown 相当，同时文本源码阅读性高：不会再充斥一堆反斜杠跟花括号

个人观点：跟 Markdown 一样好用，跟 LaTeX 一样强大


#figure(
  image("assets/avatar.jpeg", height: 20%),
  caption: "我的 image 实例 0",
)

== 基本语法

=== 代码执行

正文可以像前面那样直接写出来，隔行相当于分段。

个人理解：typst 有两种环境，代码和内容，在代码的环境中会按代码去执行，在内容环境中会解析成普通的文本，代码环境用{}表示，内容环境用[]表示，在 content 中以 \# 开头来接上一段代码，比如\#set rule，而在花括号包裹的块中调用代码就不需要 \#。


=== 标题

类似 Markdown 里用 \# 表示标题，typst 里用 = 表示标题，一级标题用一个 =，二级标题用两个 =，以此类推。


间距、字体等会自动排版。

\#pagebreak() 函数相当于分页符，在华科的要求里，第一级标题应当分页，请手动分页。

#pagebreak()

= 本模板相关封装

== 图片

改用模块 #link("https://typst.app/universe/package/i-figured")[i-figure] 实现图片，表格与公式的编号。

#figure(
  image("assets/avatar.jpeg", height: 20%),
  caption: "我的 image 实例 1",
) <img1>

引用的话就在 figure 后加上标签，在原标签前加上前缀 `fig:, tbl:, eqt:`（分别对应图片，表格与公式）。

#figure(
  image("assets/avatar.jpeg", height: 20%),
  caption: "我的 image 实例 2",
) <img2>

引用 2-1: @fig:img1

== 表格

表格跟图片差不多，但是表格的输入要复杂一点，建议在 typst 官网学习，自由度特别高，定制化很强。

同样使用 figure 函数包裹表格

#figure(
  table(
    columns: (100pt, 100pt, 100pt),
    inset: 10pt,
    stroke: 0.7pt,
    align: horizon,
    [], [*Area*], [*Parameters*],
    image("assets/avatar.jpeg", height: 10%),
    [$ pi h (D^2 - d^2) / 4 $ <->],
    [
      $h$: height \
      $D$: outer radius \
      $d$: inner radius
    ],
    image("assets/avatar.jpeg", height: 10%),
    [$ sqrt(2) / 12 a^3 $ <->],
    [$a$: 边长]
  ),
  caption: "芝士样表"
) <tbl1>

#figure(
  three_line_table(
    (
    ("Country List", "Country List", "Country List"),
    ("Country Name or Area Name", "ISO ALPHA Code", "ISO ALPHA"),
    ("Afghanistan", "AF", "AFT"),
    ("Aland Islands", "AX", "ALA"),
    ("Albania", "AL", "ALB"),
    ("Algeria", "DZ", "DZA"),
    ("American Samoa", "AS", "ASM"),
    ("Andorra", "AD", "AND"),
    ("Angola", "AP", "AGO"),
  )),
  kind: table,
  caption: "三线表示例"
)

#figure(
  three_line_table(
    (
    ("Country List", "Country List", "Country List", "Country List"),
    ("Country Name or Area Name", "ISO ALPHA 2 Code", "ISO ALPHA 3", "8"),
    ("Afghanistan", "AF", "AFT", "7"),
    ("Aland Islands", "AX", "ALA", "6"),
    ("Albania", "AL", "ALB", "5"),
    ("Algeria", "DZ", "DZA", "4"),
    ("American Samoa", "AS", "ASM", "3"),
    ("Andorra", "AD", "AND", "2"),
    ("Angola", "AP", "AGO", "1"),
  )),
  kind: table,
  caption: "三线表示例2"
)


== 公式

公式用两个\$包裹，但是语法跟 LaTeX 并不一样，如果有大量公式需求建议看官网教程 https://typst.app/docs/reference/math/equation/。

不需要封装即可为公式编号

$ A = pi r^2 $ <eq1>

根据@eqt:eq1 ，推断出@eqt:eq2

$ x < y => x gt.eq.not y $ <eq2>

然后也有多行的如@eqt:eq3，标签名字可以自定义

$ sum_(k=0)^n k
    &< 1 + ... + n \
    &= (n(n+1)) / 2 $ <eq3>

如果不想编号就在公式后面使用标签 `<->` 

$ x < y => x gt.eq.not y $ <->

== 列表

- 无序列表1: 1

- 无序列表2: 2

#indent()列表后的正文，应当有缩进。这里加入一个 \#indent() 函数来手动生成段落缩进，是因为在目前的 typst 设计里，按英文排版的习惯，连续段落里的第一段不会缩进，也包括各种列表。

1. 有序列表1
2. 有序列表2

列表后的正文，应当有缩进，但是这里没有，请自己在段首加上\#indent()

想自己定义可以自己set numbering，建议用 \#[] 包起来保证只在该作用域内生效：

#[
#set enum(numbering: "1.a)")
+ 自定义列表1
  + 自定义列表1.1
+ 自定义列表2
  + 自定义列表2.1
]

== 代码
=== 代码块

//代码块使用的是库codelst，语法和markdown类似
#sourcecode[```typ
#show "ArtosFlow": name => box[
  #box(image(
    "logo.svg",
    height: 0.7em,
  ))
  #name
]

This report is embedded in the
ArtosFlow project. ArtosFlow is a
project of the Artos Institute.
```]

=== 伪代码


计算机学院建议使用如下的伪代码模版进行伪代码书写。

reference link: https://typst.app/universe/package/lovelace

#algorithm(
  caption: [The Euclidean algorithm],
  pseudocode(
    no-number,
    [*input:* integers $a$ and $b$],
    no-number,
    [*output:* greatest common divisor of $a$ and $b$],
    [*while* $a != b$ *do*], ind,
      [*if* $a > b$ *then*], ind,
        $a <- a - b$, ded,
      [*else*], ind,
        $b <- b - a$, ded,
      [*end*], ded,
    [*end*],
    [*return* $a$]
  )
)


#pagebreak()
= 其他说明

== 文献引用

引用支持 LaTeX Bib 的格式，也支持更简单好看的 yml 来配置（尚未流行，推荐优先使用`.bib`）在引用时使用`#bib_cite(<tag>)`，像这样#bib_cite(<impagliazzo2001problems>,<Burckhardt:2013>)以获得右上的引用标注#bib_cite(<刘星2014恶意代码的函数调用图相似性分析>)#bib_cite(<papadimitriou1998combinatorial>)。

记得在最后加入\#references("path/to/ref.bib")函数的调用来生成参考文献。

由于华科使用自创引用格式，基本上为 GB/T 7714 去掉[J]、[C]、[M] 刊物类型。Typst 已支持 `csl` 自定义参考文献列表，基于#link("https://github.com/redleafnew/Chinese-STD-GB-T-7714-related-csl/blob/main/462huazhong-university-of-science-and-technology-school-of-cyber-science-and-engineering.csl")[#underline()[这个]]修改，如果想再自定义新的格式，请修改 `template.typ` 中 `bibliography` 函数中 style 参数。


== 致谢部分

致谢部分在最后加入\#acknowledgement()函数的调用来生成。


== 模板相关

这个模板应该还不是完全版，可能不能覆盖到华科论文的所有case要求，如果遇到特殊 case 请提交 issue 说明，或者也可以直接提 pull request

同时，由于 typst 太新了，2023年4月初刚发布0.1.0版本，可能会有大的break change发生，模板会做相应修改。

主要排版数据参考来自 https://github.com/zfengg/HUSTtex 同时有一定肉眼排版成分，所以有可能不完全符合华科排版要求，如果遇到不对的间距、字体等请提交 issue 说明。

=== 数据相关

所有拉丁字母均为 Times New Roman，大小与汉字相同

正文为宋体12pt，即小四

图表标题为黑体12pt

表格单元格内容宋体10.5pt，即五号

一级标题黑体18pt加粗，即小二

二级标题14pt加粗，即四号

正文行间距1.24em（肉眼测量，1.5em与与word的1.5倍行距并不一样）

a4纸，上下空2.5cm，左右空3cm

#pagebreak()
= 这是一章占位的

== 占位的二级标题 1

== 占位的二级标题 2

== 占位的二级标题 3

== 占位的二级标题 4

=== 占位的三级标题 1

=== 占位的三级标题 2

==== 占位的四级标题 1

==== 占位的四级标题 2

== 占位的二级标题 5

== 占位的二级标题 6



#pagebreak()
#acknowledgement()[

*特别注意：研究生课程报告中致谢不是必须的！！！把这个函数删除就不会出现这一页了。*

完成本篇论文之际，我要向许多人表达我的感激之情。

首先，我要感谢我的指导教师，他/她对本文提供的宝贵建议和指导。所有这些支持和指导都是无私的，而且让我受益匪浅。

其次，我还要感谢我的家人和朋友们，他们一直以来都是我的支持和鼓励者。他们从未停止鼓舞我，勉励我继续前行，感谢你们一直在我身边，给我幸福和力量。

此外，我还要感谢我的同学们，大家一起度过了很长时间的学习时光，互相支持和鼓励，共同进步。因为有你们的支持，我才能不断地成长、进步。

最后，我想感谢笔者各位，你们的阅读和评价对我非常重要，这也让我意识到了自己写作方面的不足，同时更加明白了自己的研究方向。谢谢大家！

再次向所有支持和鼓励我的人表达我的谢意和感激之情。

本致谢生成自 ChatGPT。
]

#pagebreak()

#bibliography("./ref.bib")