Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/sjtug/sjtutex
Macro Packages and Scripts for SJTU TeX users
https://github.com/sjtug/sjtutex
latex sjtuthesis
Last synced: 5 days ago
JSON representation
Macro Packages and Scripts for SJTU TeX users
- Host: GitHub
- URL: https://github.com/sjtug/sjtutex
- Owner: sjtug
- License: lppl-1.3c
- Created: 2019-11-07T03:47:46.000Z (about 5 years ago)
- Default Branch: v2
- Last Pushed: 2024-12-18T02:03:37.000Z (6 days ago)
- Last Synced: 2024-12-18T02:28:55.176Z (6 days ago)
- Topics: latex, sjtuthesis
- Language: TeX
- Size: 9.62 MB
- Stars: 62
- Watchers: 12
- Forks: 7
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Support: support/sjtu-vi-gen.tex
Awesome Lists containing this project
README
# SJTUTeX
[](https://www.ctan.org/pkg/sjtutex)
## 简介
SJTUTeX 是 [SJTUThesis](https://github.com/sjtug/SJTUThesis) 项目使用的文档类集，
包含上海交通大学学位论文文档类 `sjtuthesis`，以及普通文档类 `sjtuarticle` 和 `sjtureport`。
对于 LaTeX 模版的更改，都应该在这个 repo 中进行，而后把解包后的结果同步到 SJTUThesis。
本文档类集基于 LaTeX3 编写，使用说明详见 [发布区](https://github.com/sjtug/SJTUTeX/releases) 文档。
SJTUTeX 和 SJTUThesis 项目共享讨论区与社区写作模式。如遇问题，请在 [SJTUThesis](https://github.com/sjtug/SJTUThesis) 中反馈。
## 安装至发行版
如果你正在使用 TeX Live 或 MacTeX，可以在终端输入下面的命令安装至本地发行版中。
```bash
cd sjtutex
l3build install
```
也可以将 [发布区](https://github.com/sjtug/SJTUTeX/releases/latest) 的 `sjtutex.tds.zip` 手动解压到发行版的 TDS 目录下。
## 开发指南
开发主要在 `sjtutex` 文件夹中进行，生成发布包会进行解包、测试、文档等全部流程。
```bash
cd sjtutex
l3build unpack # 解包
l3build doc # 文档
l3build check # 测试
l3build ctan # 生成发布包
```
### 解包
文档类主要代码在 `source/sjtutex.dtx` 中，需要解包之后才能够使用。
```
l3build unpack
```
解包结果将置于 `build/unpacked`（含有 dtx 文件）和 `build/local`（不含 dtx 文件） 文件夹下。
### 文档
从 `source/sjtutex.dtx` 编译出文档类文档 `sjtutex.pdf` 可以使用
```
l3build doc
```
> 请注意文档类文档 `sjtutex.pdf` 的正确编译需要使用 Noto CJK 字体（即 `ctex` 字体配置中的 `fontset=ubuntu`）。
### 测试
文档类还含有多个测试用例（比如 `sample-thesis-zh`），主要存放于 `testfiles` 文件夹中（支持文件存放于 `testfiles/support` 文件夹）。
测试全部示例使用
```
l3build check
```
上面的过程默认隐藏编译细节。为了查看单个测试用例 `` 的编译细节，可以使用
```
l3build check
```
测试的 PDF 结果生成于 `build/result` 文件夹。
> 请使用尽可能新版本的 [l3build](https://github.com/latex3/l3build)，更多细节请参见 [l3build 文档](https://mirrors.sjtug.sjtu.edu.cn/CTAN/macros/latex/contrib/l3build/l3build.pdf)（`texdoc l3build`）。
## 软件许可证
上海交通大学校徽图片（`sjtu-vi-logo-red.pdf` 等）的版权归上海交通大学所有。
其他部分使用 [LPPL](LICENSE) 授权。