Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/totalo/hnuthesis-x

Last synced: 21 days ago
JSON representation

Host: GitHub
URL: https://github.com/totalo/hnuthesis-x
Owner: totalo
License: mit
Created: 2024-02-24T09:43:01.000Z (9 months ago)
Default Branch: main
Last Pushed: 2024-05-17T08:15:40.000Z (6 months ago)
Last Synced: 2024-10-04T09:55:26.543Z (about 1 month ago)
Language: TeX
Size: 13.7 MB
Stars: 1
Watchers: 1
Forks: 1
Open Issues: 0
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

# 湖南大学硕士学位论文 LaTeX 模板

forked from [yusanshi/hnuthesis](https://github.com/yusanshi/hnuthesis)

由于原作者不提供维护，所以 fork 了一个仓库，持续维护，欢迎大家提 issue 和 PR。

优化：
1、直接添加了对应的字体文件
2、添加 macOS 的使用方式

[![Compile and publish the release](https://github.com/yusanshi/hnuthesis/actions/workflows/main.yml/badge.svg)](https://github.com/yusanshi/hnuthesis/actions/workflows/main.yml) [![GitHub Releases](https://img.shields.io/github/v/release/yusanshi/hnuthesis)](https://github.com/yusanshi/hnuthesis/releases/latest)

本项目是湖南大学硕士学位论文 LaTeX 模板 hnuthesis，按照《[湖南大学研究生学位论文撰写规范](http://gra.hnu.edu.cn/info/1276/3444.htm)》的要求编写（**个人能力、精力有限，不保证完全符合规范，_Use at your own risk!_**）。

下载地址：[GitHub Releases](https://github.com/yusanshi/hnuthesis/releases)、[Overleaf](https://www.overleaf.com/latex/templates/hu-nan-da-xue-shuo-shi-xue-wei-lun-wen-latex-mo-ban-hnuthesis/dbjwjghhvmmd)。

本项目基于 [Gwinel/Latex](https://github.com/Gwinel/Latex/)。

关于 LaTeX 的安装、配置、编写的相关问题，请参阅其他类似项目（如 [thuthesis](https://github.com/tuna/thuthesis) 和 [ustcthesis](https://github.com/ustctug/ustcthesis) 等）。

## 关键文件说明

- `main.tex`: 主文件，编译入口；
- `hnuthesis.cls`: 撰写规范，需要调整格式在该文件中对应修改；
- `references.bib`: 参考文献列表；
- `chapters/`: 论文章节文件夹，分章有利于保持 TeX 文件的整洁；
- `figures/`: 插图文件夹，LaTeX 支持多种格式，如 EPS、PDF、PNG 等；
- `main.pdf`: 编译生成的论文 PDF 文件；
- `main-for-word.pdf`: 编译生成的适用于转 Word 的论文 PDF 文件（栅格化公式，防止转 Word 后*不忍直视*）。

## 编译

### 1. 个人设备

#### Windows 以及 Linux

1. 安装 LaTeX 发行版；

2. 对于Linux系统，需要额外安装字体，以 Debian/Ubuntu 为例：

```bash
sudo apt-get update

# 自动同意 Microsoft EULA 并安装 ttf-mscorefonts-installer
echo ttf-mscorefonts-installer msttcorefonts/accepted-mscorefonts-eula select true | sudo debconf-set-selections
sudo apt-get install -y ttf-mscorefonts-installer

# 手动下载安装 SimSun（中易宋体）、SimHei（中易黑体）字体
mkdir simfonts && wget -qO- https://github.com/yusanshi/hnuthesis/files/6371620/SimFonts.tar.gz | tar xz -C simfonts
mkdir -p ~/.local/share/fonts && mv simfonts ~/.local/share/fonts
fc-cache -f
```

3. 编译主版本：

```bash
latexmk -xelatex -shell-escape main.tex
```

或者在 vscode 下安装 [LaTeX Workshop](https://marketplace.visualstudio.com/items?itemName=James-Yu.latex-workshop) 插件后 _complie on save_（[插件的配置示例](https://github.com/yusanshi/hnuthesis/issues/2#issuecomment-972627364)）。

4. 编译主版本和转 Word 版：

```bash
./run.sh
```

> 注意：脚本的运行需要 Unix style 的命令行环境，对于 Windows 用户，可以使用安装完 Git 客户端之后的 Git Bash。

#### macOS

> 参考：https://zhuanlan.zhihu.com/p/560361957

2. 安装对应的字体，参考文件中的 `SimFonts.tar.gz`；

### 2. Overleaf

### 3. GitHub Actions

1. 通过 `Use this template` 或 Fork 创建项目；

2. 通过 push tag 触发 compile & publish 过程，如：

```
git tag v0.x.x
git push --tags
```

待 GitHub Actions 结束后在 releases 中下载新编译的 `main.pdf` 和 `main-for-word.pdf` 文件。

![image](https://user-images.githubusercontent.com/36265606/116044616-b6b30e00-a6a3-11eb-82ff-e8bba576da16.png)

## 转 Word 文件

使用转换 `main-for-word.pdf` 文件。第二次转换文件时需要登录 Adobe 账号才能下载，建议在浏览器的“无痕浏览”“隐私模式”等模式下访问以跳过强制登录。

## TODO

- 重新整理 `hnuthesis.cls` 和 `hnunumerical.bst`，支持博士学位；
- [issue] 转 Word 时，文献引用符号后面的文字变小。