modern-cqut-thesis:0.1.0 (#1437)

packages/preview/modern-cqut-thesis/0.1.0/.gitignore

@@ -0,0 +1 @@
+

packages/preview/modern-cqut-thesis/0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 aFei-CQUT
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

packages/preview/modern-cqut-thesis/0.1.0/README.md

@@ -0,0 +1,86 @@
+# 重庆理工大学学位论文 
+
+重庆理工大学毕业论文（设计）的 Typst 模板，能够简洁、快速、持续生成 PDF 格式的毕业论文。
+
+需要注意的是我们没有提供线上的模板（复习时间有点紧张…），但是你不要紧张！本地编辑不需要线上模板，如果你需要@preview的话，请运行`bat`或者`py`脚本。
+
+## 使用
+
+**只需修改 `thesis.typ` 文件即可，基本可以满足你的所有需求。**
+
+## 平台
+
+1. 在 VS Code 中安装 [Tinymist Typst](https://marketplace.visualstudio.com/items?itemName=myriad-dreamin.tinymist) 和 [Typst Preview](https://marketplace.visualstudio.com/items?itemName=mgt19937.typst-preview) 插件。前者负责语法高亮和错误检查等功能，后者负责预览。
+    - 推荐下载 [Typst Companion](https://marketplace.visualstudio.com/items?itemName=CalebFiggers.typst-companion) 插件，其提供了例如 `Ctrl + B` 进行加粗等便捷的快捷键。
+    - 你还可以下载 [Typst Sync](https://marketplace.visualstudio.com/items?itemName=OrangeX4.vscode-typst-sync) 和 [Typst Sympy Calculator](https://marketplace.visualstudio.com/items?itemName=OrangeX4.vscode-typst-sympy-calculator) 插件，前者提供了本地包的云同步功能，后者提供了基于 Typst 语法的科学计算器功能。
+3. 用 VS Code 打开生成的目录，打开 `thesis.typ` 文件，并按下 `Ctrl + K V` 进行实时编辑和预览。
+
+
+## 开发者指南
+
+### template 目录
+
+- `thesis.typ` 文件: 你的论文源文件，可以随意更改这个文件的名字，甚至你可以将这个文件在同级目录下复制多份，维持多个版本。
+- `thesis.bib` 文件: 用于放置参考文献。
+- `logos` 目录: 用于放置logo的文件夹。
+
+
+### 内部目录
+
+1. `utils` 目录: 包含了模板使用到的各种自定义辅助函数，存放没有外部依赖，且 **不会渲染出页面的函数**。
+2. `pages` 目录: 包含了模板用到的各个 **独立页面**，例如封面页、声明页、摘要等，即 **会渲染出不影响其他页面的独立页面的函数**。
+3. `layouts` 目录: 布局目录，存放着用于排篇布局的、应用于 `show` 指令的、**横跨多个页面的函数**，例如为了给页脚进行罗马数字编码的前言 `preface` 函数。
+  - 主要分成了 `doc` 文稿、`preface` 前言、`mainmatter` 正文与 `appendix` 附录/后记。
+4. `lib.typ`:
+  - **职责一**: 作为一个统一的对外接口，暴露出内部的 utils 函数。
+  - **职责二**: 使用 **函数闭包** 特性，通过 `documentclass` 函数类进行全局信息配置，然后暴露出拥有了全局配置的、具体的 `layouts` 和 `pages` 内部函数。
+
+### TodoList
+
+- **说明文档**
+  - [ ] 编写更详细的说明文档，后续考虑使用 [tidy](https://github.com/typst/packages/tree/main/packages/preview/tidy/0.1.0) 编写，你现在可以先参考 [NJUThesis](https://mirror-hk.koddos.net/CTAN/macros/unicodetex/latex/njuthesis/njuthesis.pdf) 的文档，参数大体保持一致，或者直接查阅对应源码函数的参数
+- **类型检查**
+  - [ ] 应该对所有函数入参进行类型检查，及时报错
+- **全局配置**
+  - [x] 类似 LaTeX 中的 `documentclass` 的全局信息配置
+  - [x] **盲审模式**，将个人信息替换成小黑条，并且隐藏致谢页面，论文提交阶段使用 
+  - [x] **双面模式**，会加入空白页，便于打印
+  - [x] **自定义字体配置**，可以配置「宋体」、「黑体」与「楷体」等字体对应的具体字体
+  - [x] **数学字体配置**：模板不提供配置，用户可以自己使用 `#show math.equation: set text(font: "Fira Math")` 更改
+- **模板**
+  - [x] 本科生模板
+    - [x] 字体测试页
+    - [x] 毕业论文封面
+    - [x] 课程设计封面
+    - [x] 声明页
+    - [x] 中文摘要
+    - [x] 英文摘要
+    - [x] 目录页
+    - [x] 插图目录
+    - [x] 表格目录
+    - [x] 符号表
+    - [x] 致谢
+  - [x] 研究生模板
+    - [x] 封面 
+    - [x] 声明页 
+    - [x] 摘要
+    - [x] 页眉 
+    - [ ] 国家图书馆封面
+    - [ ] 出版授权书
+  - [ ] 博士后模板
+- **编号**
+  - [x] 前言使用罗马数字编号
+  - [x] 附录使用罗马数字编号
+  - [x] 表格使用 `1.1` 格式进行编号
+  - [x] 数学公式使用 `(1.1)` 格式进行编号
+- **环境**
+  - [x] 定理环境（这个也可以自己使用第三方包配置）
+  - [x] 化学环境
+- **其他文件**
+  - [x] 本科生开题报告
+  - [x] 研究生开题报告
+
+
+## 致谢
+
+- 感谢 [HUST-typst-template](https://github.com/werifu/HUST-typst-template) ，[sysu-thesis-typst](https://github.com/howardlau1999/sysu-thesis-typst)  ，[modern-nju-thesis](https://github.com/nju-lug/modern-nju-thesis) 与 [PKU-typst-template](https://github.com/pku-typst) 等Typst中文模板。

packages/preview/modern-cqut-thesis/0.1.0/layouts/appendix.typ

@@ -0,0 +1,24 @@
+#import "@preview/i-figured:0.2.4"
+#import "../utils/custom-numbering.typ": custom-numbering
+
+// 后记，重置 heading 计数器
+#let appendix(
+  numbering: custom-numbering.with(first-level: "", depth: 4, "1.1 "),
+  // figure 计数
+  show-figure: i-figured.show-figure.with(numbering: "1.1"),
+  // equation 计数
+  show-equation: i-figured.show-equation.with(numbering: "(1.1)"),
+  // 重置计数
+  reset-counter: false,
+  it,
+) = {
+  set heading(numbering: numbering)
+  if reset-counter {
+    counter(heading).update(0)
+  }
+  // 设置 figure 的编号
+  show figure: show-figure
+  // 设置 equation 的编号
+  show math.equation.where(block: true): show-equation
+  it
+}

packages/preview/modern-cqut-thesis/0.1.0/layouts/doc.typ

@@ -0,0 +1,34 @@
+// 文稿设置，可以进行一些像页面边距这类的全局设置
+#let doc(
+  // documentclass 传入参数
+  info: (:),
+  // 其他参数
+  fallback: false,  // 字体缺失时使用 fallback，不显示豆腐块
+  lang: "zh",
+  margin: (x: 89pt),
+  it,
+) = {
+  // 1.  默认参数
+  info = (
+    title: ("基于 Typst 的", "重庆理工大学学位论文"),
+    author: "张三",
+  ) + info
+
+  // 2.  对参数进行处理
+  // 2.1 如果是字符串，则使用换行符将标题分隔为列表
+  if type(info.title) == str {
+    info.title = info.title.split("\n")
+  }
+
+  // 3.  基本的样式设置
+  set text(fallback: fallback, lang: lang)
+  set page(margin: margin)
+
+  // 4.  PDF 元信息
+  set document(
+    title: (("",)+ info.title).sum(),
+    author: info.author,
+  )
+
+  it
+}

packages/preview/modern-cqut-thesis/0.1.0/layouts/mainmatter.typ

@@ -0,0 +1,176 @@
+#import "@preview/i-figured:0.2.4"
+#import "../utils/anti-matter.typ": anti-front-end
+#import "../utils/style.typ": 字号, 字体
+#import "../utils/custom-numbering.typ": custom-numbering
+#import "../utils/custom-heading.typ": heading-display, active-heading, current-heading
+#import "../utils/indent.typ": fake-par
+#import "../utils/unpairs.typ": unpairs
+
+#let mainmatter(
+  // documentclass 传入参数
+  twoside: false,
+  fonts: (:),
+  // 其他参数
+  leading: 1.5 * 15.6pt - 0.7em,
+  spacing: 1.5 * 15.6pt - 0.7em,
+  justify: true,
+  first-line-indent: 2em,
+  numbering: custom-numbering.with(first-level: "第一章 ", depth: 4, "1.1 "),
+  // 正文字体与字号参数
+  text-args: auto,
+  // 标题字体与字号
+  heading-font: auto,
+  heading-size: (字号.四号,),
+  heading-weight: ("regular",),
+  heading-above: (2 * 15.6pt - 0.7em, 2 * 15.6pt - 0.7em),
+  heading-below: (2 * 15.6pt - 0.7em, 1.5 * 15.6pt - 0.7em),
+  heading-pagebreak: (true, false),
+  heading-align: (center, auto),
+  // 页眉
+  header-render: auto,
+  header-vspace: 0em,
+  display-header: false,
+  skip-on-first-level: true,
+  stroke-width: 0.5pt,
+  reset-footnote: true,
+  // caption 的 separator
+  separator: "  ",
+  // caption 样式
+  caption-style: strong,
+  caption-size: 字号.五号,
+  // figure 计数
+  show-figure: i-figured.show-figure,
+  // equation 计数
+  show-equation: i-figured.show-equation,
+  ..args,
+  it,
+) = {
+  // 0.  标志前言结束
+  anti-front-end()
+
+  // 1.  默认参数
+  fonts = 字体 + fonts
+  if (text-args == auto) {
+    text-args = (font: fonts.宋体, size: 字号.小四)
+  }
+  // 1.1 字体与字号
+  if (heading-font == auto) {
+    heading-font = (fonts.黑体,)
+  }
+  // 1.2 处理 heading- 开头的其他参数
+  let heading-text-args-lists = args.named().pairs()
+    .filter((pair) => pair.at(0).starts-with("heading-"))
+    .map((pair) => (pair.at(0).slice("heading-".len()), pair.at(1)))
+
+  // 2.  辅助函数
+  let array-at(arr, pos) = {
+    arr.at(calc.min(pos, arr.len()) - 1)
+  }
+
+  // 3.  设置基本样式
+  // 3.1 文本和段落样式
+  set text(..text-args)
+  set par(
+    leading: leading,
+    justify: justify,
+    first-line-indent: first-line-indent,
+    spacing: spacing
+  )
+  show raw: set text(font: fonts.等宽)
+  // 3.2 脚注样式
+  show footnote.entry: set text(font: fonts.宋体, size: 字号.五号)
+  // 3.3 设置 figure 的编号
+  show heading: i-figured.reset-counters
+  show figure: show-figure
+  // 3.4 设置 equation 的编号和假段落首行缩进
+  show math.equation.where(block: true): show-equation
+  // 3.5 表格表头置顶 + 不用冒号用空格分割 + 样式
+  show figure.where(
+    kind: table
+  ): set figure.caption(position: top)
+  set figure.caption(separator: separator)
+  show figure.caption: caption-style
+  show figure.caption: set text(font: fonts.宋体, size: 字号.五号)
+  // 3.6 优化列表显示
+  //     术语列表 terms 不应该缩进
+  show terms: set par(first-line-indent: 0pt)
+
+  // 4.  处理标题
+  // 4.1 设置标题的 Numbering
+  set heading(numbering: numbering)
+  // 4.2 设置字体字号并加入假段落模拟首行缩进
+  show heading: it => {
+    set text(
+      font: array-at(heading-font, it.level),
+      size: array-at(heading-size, it.level),
+      weight: array-at(heading-weight, it.level),
+      ..unpairs(heading-text-args-lists
+        .map((pair) => (pair.at(0), array-at(pair.at(1), it.level))))
+    )
+    set block(
+      above: array-at(heading-above, it.level),
+      below: array-at(heading-below, it.level),
+    )
+    it
+    fake-par
+  }
+  // 4.3 标题居中与自动换页
+  show heading: it => {
+    if (array-at(heading-pagebreak, it.level)) {
+      // 如果打上了 no-auto-pagebreak 标签，则不自动换页
+      if ("label" not in it.fields() or str(it.label) != "no-auto-pagebreak") {
+        pagebreak(weak: true)
+      }
+    }
+    if (array-at(heading-align, it.level) != auto) {
+      set align(array-at(heading-align, it.level))
+      it
+    } else {
+      it
+    }
+  }
+
+  // 5.  处理页眉
+  set page(..(if display-header {
+    (
+      header: {
+        // 重置 footnote 计数器
+        if reset-footnote {
+          counter(footnote).update(0)
+        }
+        locate(loc => {
+          // 5.1 获取当前页面的一级标题
+          let cur-heading = current-heading(level: 1, loc)
+          // 5.2 如果当前页面没有一级标题，则渲染页眉
+          if not skip-on-first-level or cur-heading == none {
+            if header-render == auto {
+              // 一级标题和二级标题
+              let first-level-heading = if not twoside or calc.rem(loc.page(), 2) == 0 { heading-display(active-heading(level: 1, loc)) } else { "" }
+              let second-level-heading = if not twoside or calc.rem(loc.page(), 2) == 2 { heading-display(active-heading(level: 2, prev: false, loc)) } else { "" }
+              set text(font: fonts.楷体, size: 字号.五号)
+              stack(
+                first-level-heading + h(1fr) + second-level-heading,
+                v(0.25em),
+                if first-level-heading != "" or second-level-heading != "" { line(length: 100%, stroke: stroke-width + black) },
+              )
+            } else {
+              header-render(loc)
+            }
+            v(header-vspace)
+          }
+        })
+      }
+    )
+  } else {
+    (
+      header: {
+        // 重置 footnote 计数器
+        if reset-footnote {
+          counter(footnote).update(0)
+        }
+      }
+    )
+  }))
+
+  it
+}

packages/preview/modern-cqut-thesis/0.1.0/layouts/preface.typ

@@ -0,0 +1,18 @@
+#import "../utils/anti-matter.typ": anti-matter
+
+// 前言，重置页面计数器
+#let preface(
+  // documentclass 传入的参数
+  twoside: false,
+  // 其他参数
+  spec: (front: "I", inner: "1", back: "I"),
+  ..args,
+  it,
+) = {
+  // 分页
+  if (twoside) {
+    pagebreak() + " "
+  }
+  counter(page).update(0)
+  anti-matter(spec: spec, ..args, it)
+}