Skip to content

Commit

Permalink
Release 1.5.0 (#27)
Browse files Browse the repository at this point in the history 
* pre-release 1.5.0 (#26)

* GNU General Public License v3.0

* Update README.md

* Update README.md (#25)

Co-authored-by: cfrpg <726525185@qq.com>

* update 1.5.0

* update

Co-authored-by: cfrpg <726525185@qq.com>
  • Loading branch information
@polossk @cfrpg
polossk and cfrpg authored Apr 26, 2020
1 parent 0fcb0e7 commit 4cadb1d
Show file tree
Hide file tree
Showing 7 changed files with 114 additions and 71 deletions.
61 changes: 40 additions & 21 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3,42 +3,57 @@
![TeX-Document](https://img.shields.io/badge/TeX-Document-3D6117.svg)
[![License](https://img.shields.io/badge/license-GNU_General_Public_License_v3.0-blue.svg)](LICENSE)
![Status](https://img.shields.io/badge/status-complete-brightgreen.svg)
![Version](https://img.shields.io/badge/version-v1.4.1.0430-674EA7.svg)
![Version](https://img.shields.io/badge/version-v1.5.0.0426-674EA7.svg)

| TeXLive Environment | Status |
| -------------------------------------------------------------------- | ------------------ |
| ![TeXLive2016](https://img.shields.io/badge/TeXLive-2016-3D6117.svg) | :heavy_check_mark: |
| ![TeXLive2017](https://img.shields.io/badge/TeXLive-2017-3D6117.svg) | :heavy_check_mark: |
| ![TeXLive2018](https://img.shields.io/badge/TeXLive-2018-3D6117.svg) | :heavy_check_mark: |
| ![TeXLive2019](https://img.shields.io/badge/TeXLive-2019-3D6117.svg) | :heavy_check_mark: |
| ![TeXLive2020](https://img.shields.io/badge/TeXLive-2020-3D6117.svg) | :heavy_check_mark: |

## Usage
这是在西北工业大学本科毕业设计论文格式的要求下的一份 LaTeX 文档类型模板。使用者无需修改导言区文档类型，直接在发布版的基础上，修改章节标题，撰写内容，即可完成毕业设计论文任务。

1. 安装 `setting` 中的字体 `nwpuname.ttf`
2. 直接对 `example.tex` 文件进行修改
3. 如有必要，请仿照 `example.tex` 在 *导言区* 引用 `\input{settings/thesis-setting}`
## 使用说明

1. 安装 `setting` 文件夹中的字体 `nwpuname.ttf`
2. 直接对 `example.tex` 文件进行修改，对应的摘要、章节内容、附录文件均以默认生成，在此基础上加以修改即可
3. 如有必要，也可以请仿照 `example.tex` 在 *导言区* 引用 `\input{settings/thesis-setting}` 来直接设置文档格式为本科毕业设计论文格式
4. 如有必要，修改 `makefile` 文件的 `MAIN` 选项为自己 `tex` 文档的文件名
5. make & Enjoy

## Note
## 注意事项以及常见问题

* 本模板使用的是 **Adobe** 字体(宋体，黑体，楷体，仿宋)，需要另行购买或下载
* `cover.tex` 文件为论文的封面页, `translation-cover` 为本科毕业设计的文献翻译封面页
* 所有字体大小的控制命令统一前缀为`s(a.k.a size)`, 所有字体格式的控制命令统一前缀为`f(a.k.a font)`
* `makefile` 中的 `close`, `clean` 以及 `wipe` 选项为 `windows` 专用, 并且假设使用了 `Acrobat` 打开了当前 pdf 文件
* 校徽用`tikz`生成矢量图形 `logo.tex`
* 额外制作了西北工业大学的标题的特殊字体 `nwpuname.ttf`
* 如有任何问题，请发[issue](/~https://github.com/NWPUMetaphysicsOffice/LaTeX-Template-For-NPU-Thesis/issues/new)
* 基于[GPLv3-LICENSE](LICENSE)，如有帮助，请在自己的文章中引用
* 在编译过程中，如果遇到卡在字体缓冲问题，请先关闭当前进程，并用管理员模式打开命令提示符（或终端），键入 `fc-cache -f -v` 强制刷新字体缓存即可
* Windows 下请将字体放入 `C:\Windows\Fonts` 下，并选择“为所有用户安装”以确保字体文件正确安装
* Adobe 字体：</~https://github.com/dolbydu/font/tree/master/unicode>
* **字体问题**
* 本模板出于排版美观考虑，使用的是 **Adobe** 字体（宋体，黑体，楷体，仿宋），需要另行购买或下载
* Adobe 字体：</~https://github.com/dolbydu/font/tree/master/unicode>
* Windows 下请将字体放入 `C:\Windows\Fonts` 下，并选择“为所有用户安装”以确保字体文件正确安装
* `nwpuname.ttf` 是校名“西北工业大学”的字体文件，该文件只包含这 6 个汉字
* **`makefile` 问题**
* 本模板提供了简单的 `makefile` 文件来控制编译流程
* 这份 `makefile` 中的 `close`, `clean` 以及 `wipe` 选项为 `windows` 专用, 并且假设使用了 `Acrobat` 打开了当前 pdf 文件
* 对于 Linux 玩家而言，没有比这份 `makefile` 更简单的版本了，在此基础上稍作修改即可使用
* **预创建文件及部分格式符说明**
* `cover.tex` 为论文的封面页
* `translation-cover.tex` 为本科毕业设计的文献翻译封面页
* `logo.tex` 是通过 `tikz` 生成的校徽矢量图形 ，如果觉得不好看也可以去形象识别系统下载对应版本，并自行替换
* 字体大小（size）的控制命令统一前缀为 `s`
* 字体格式（font）的控制命令统一前缀为 `f`
* **开源许可问题**
* 基于 [GPLv3-LICENSE](LICENSE)
* 如有帮助，请在自己的文章中引用；如果在此基础上新增/删除/更改，请按照开源许可的要求继续保持开源，且同时继续使用相同开源许可
* **其他可能的模板使用问题**
* 在编译过程中，如果遇到卡在字体缓冲问题，请先关闭当前进程，并用管理员模式打开命令提示符（或终端），键入 `fc-cache -f -v` 强制刷新字体缓存即可
* 模板成型于 **2016 年**，制作者们都已经离开了当时的制作环境。如果后期有任何格式上的变化，欢迎 fork-modify-pull-request 或者在 [issue](/~https://github.com/polossk/LaTeX-Template-For-NPU-Thesis/issues/new) 中详细说明新旧格式，我们乐意解决模板使用的问题
* **恕制作者们不解答任何 LaTeX 使用问题**

## BibTeX

```bibtex
@misc{NWPUThesisLaTeXTemplate,
title={{{\LaTeX}}-Template-For-NPU-Thesis},
author={Shangkun Shen and Zhihe Wang and Weijia Zhang},
author={Shangkun Shen and Zhihe Wang and Jiduo Zhang and Weijia Zhang},
year={2016},
month={05}
}
Expand All @@ -47,11 +62,15 @@
## Copyright

Use this code whatever you want, under the circumstances of acknowleged the
mit license this page below. Star this repository if you like, and it will
GPL license this page below. Star this repository if you like, and it will
be very generous of you!

## License

Copyright (c) 2016 NWPU Metaphysics Office </~https://github.com/NWPUMetaphysicsOffice>
Copyright (c) 2016-2020 *NWPU Metaphysics Office* </~https://github.com/NWPUMetaphysicsOffice>

This repo is under the license of **GNU General Public License v3.0**. Go
and check [license](LICENSE) for details.

This repo is under the license of GNU General Public License v3.0. Go and check [license](LICENSE) for details.
The association *NWPU Metaphysics Office* is a club-like student group. The
members are cfrpg, kidozh, njzwj, polossk, in alphabet order.
Binary file modified example.pdf
View file
Binary file not shown.
2 changes: 1 addition & 1 deletion example.tex
View file
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@
\mainmatter

\renewcommand{\baselinestretch}{1.0}
\sRealHalfXiaosi\fSong
\sHalfXiaosi\fSong

% 正文内容
\input{chapters/chapter01.tex}
Expand Down
Binary file modified plug-ins/math-symbols-readme.pdf
View file
Binary file not shown.
92 changes: 59 additions & 33 deletions plug-ins/math-symbols.sty
View file
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
% math-symbols.sty
% by polossk, version 2.0
% last update 2018-5-15
% by polossk, version 2.2.0.1230
% last update 2019-12-30
% github.com/polossk/Math-Symbols-in-LaTeX
\ProvidesPackage{math-symbols}[2018/5/15 v2.0 Math-Symbols-in-LaTeX]
\ProvidesPackage{math-symbols}[2019/12/30 v2.2.0.1230 Math-Symbols-in-LaTeX]
%------------------------------------------------------------------------------%
%-Requare-Packages-------------------------------------------------------------%
%------------------------------------------------------------------------------%
Expand All @@ -28,6 +28,7 @@
\newcommand\mi{{\mathrm i}} % constant i
\newcommand\mj{{\mathrm j}} % constant j
\newcommand\me{{\mathrm e}} % constant e
\newcommand\mdeg{{^\circ}} % symbol degree
\newcommand\mnatr{{\mathbb N}} % natural num set N
\newcommand\mintg{{\mathbb Z}} % integer set Z
\newcommand\mrato{{\mathbb Q}} % rational set Q
Expand Down Expand Up @@ -92,6 +93,12 @@
\newcommand\mvchi{{\bm \chi}} % vector chi
\newcommand\mvpsi{{\bm \psi}} % vector psi
\newcommand\mvomega{{\bm \omega}} % vector omega
\newcommand\mvvarepsilon{{\bm \varepsilon}} % vector varepsilon
\newcommand\mvvarkappa{{\bm \varkappa}} % vector varkappa
\newcommand\mvvarphi{{\bm \varphi}} % vector varphi
\newcommand\mvvarpi{{\bm \varpi}} % vector varpi
\newcommand\mvvarrho{{\bm \varrho}} % vector varrho
\newcommand\mvvartheta{{\bm \vartheta}} % vector vartheta
%------------------------------------------------------------------------------%
%-[M]ath-[M]atrix-Defination---------------------------------------------------%
%------------------------------------------------------------------------------%
Expand Down Expand Up @@ -133,6 +140,46 @@
\newcommand\mmpsi{{\bm \Psi}} % matrix Psi
\newcommand\mmomega{{\bm \Omega}} % matrix Omega
%------------------------------------------------------------------------------%
%-[M]ath-[T]ensor-Defination---------------------------------------------------%
%------------------------------------------------------------------------------%
\newcommand\mta{{\mathbf A}} % tensor A
\newcommand\mtb{{\mathbf B}} % tensor B
\newcommand\mtc{{\mathbf C}} % tensor C
\newcommand\mtd{{\mathbf D}} % tensor D
\newcommand\mte{{\mathbf E}} % tensor E
\newcommand\mtf{{\mathbf F}} % tensor F
\newcommand\mtg{{\mathbf G}} % tensor G
\newcommand\mth{{\mathbf H}} % tensor H
\newcommand\mti{{\mathbf I}} % tensor I
\newcommand\mtj{{\mathbf J}} % tensor J
\newcommand\mtk{{\mathbf K}} % tensor K
\newcommand\mtl{{\mathbf L}} % tensor L
\newcommand\mtm{{\mathbf M}} % tensor M
\newcommand\mtn{{\mathbf N}} % tensor N
\newcommand\mto{{\mathbf O}} % tensor O
\newcommand\mtp{{\mathbf P}} % tensor P
\newcommand\mtq{{\mathbf Q}} % tensor Q
\newcommand\mtr{{\mathbf R}} % tensor R
\newcommand\mts{{\mathbf S}} % tensor S
\newcommand\mtt{{\mathbf T}} % tensor T
\newcommand\mtu{{\mathbf U}} % tensor U
\newcommand\mtv{{\mathbf V}} % tensor V
\newcommand\mtw{{\mathbf W}} % tensor W
\newcommand\mtx{{\mathbf X}} % tensor X
\newcommand\mty{{\mathbf Y}} % tensor Y
\newcommand\mtz{{\mathbf Z}} % tensor Z
\newcommand\mtgamma{{\bm \Gamma}} % tensor Gamma
\newcommand\mtdelta{{\bm \Delta}} % tensor Delta
\newcommand\mttheta{{\bm \Theta}} % tensor Theta
\newcommand\mtlambda{{\bm \Lambda}} % tensor Lambda
\newcommand\mtxi{{\bm \Xi}} % tensor Xi
\newcommand\mtpi{{\bm \Pi}} % tensor Pi
\newcommand\mtsigma{{\bm \Sigma}} % tensor Sigma
\newcommand\mtupsilon{{\bm \Upsilon}} % tensor Upsilon
\newcommand\mtphi{{\bm \Phi}} % tensor Phi
\newcommand\mtpsi{{\bm \Psi}} % tensor Psi
\newcommand\mtomega{{\bm \Omega}} % tensor Omega
%------------------------------------------------------------------------------%
%-[M]ath-[V]ector-Defination-[T]ransposed--------------------------------------%
%------------------------------------------------------------------------------%
\newcommand\mmat{{{\mathbf A}^T}} % matrix A^T
Expand Down Expand Up @@ -173,41 +220,14 @@
\newcommand\mmpsit{{{\bm \Psi}^T}} % matrix Psi^T
\newcommand\mmomegat{{{\bm \Omega}^T}} % matrix Omega^T
%------------------------------------------------------------------------------%
%-[M]ath-[T]ensor-Defination---------------------------------------------------%
%------------------------------------------------------------------------------%
\newcommand\mta{{\mathsf A}} % tensor A
\newcommand\mtb{{\mathsf B}} % tensor B
\newcommand\mtc{{\mathsf C}} % tensor C
\newcommand\mtd{{\mathsf D}} % tensor D
\newcommand\mte{{\mathsf E}} % tensor E
\newcommand\mtf{{\mathsf F}} % tensor F
\newcommand\mtg{{\mathsf G}} % tensor G
\newcommand\mth{{\mathsf H}} % tensor H
\newcommand\mti{{\mathsf I}} % tensor I
\newcommand\mtj{{\mathsf J}} % tensor J
\newcommand\mtk{{\mathsf K}} % tensor K
\newcommand\mtl{{\mathsf L}} % tensor L
\newcommand\mtm{{\mathsf M}} % tensor M
\newcommand\mtn{{\mathsf N}} % tensor N
\newcommand\mto{{\mathsf O}} % tensor O
\newcommand\mtp{{\mathsf P}} % tensor P
\newcommand\mtq{{\mathsf Q}} % tensor Q
\newcommand\mtr{{\mathsf R}} % tensor R
\newcommand\mts{{\mathsf S}} % tensor S
\newcommand\mtt{{\mathsf T}} % tensor T
\newcommand\mtu{{\mathsf U}} % tensor U
\newcommand\mtv{{\mathsf V}} % tensor V
\newcommand\mtw{{\mathsf W}} % tensor W
\newcommand\mtx{{\mathsf X}} % tensor X
\newcommand\mty{{\mathsf Y}} % tensor Y
\newcommand\mtz{{\mathsf Z}} % tensor Z
%------------------------------------------------------------------------------%
\newcommand\mvzero{{\bm 0}} % vector 0
\newcommand\mvone{{\bm 1}} % vector 1
\newcommand\mmzero{{\mathbf 0}} % matrix 0
\newcommand\mmone{{\mathbf 1}} % matrix 1
\newcommand\mtzero{{\mathbf 0}} % tensor 0
\newcommand\mtone{{\mathbf 1}} % tensor 1
%------------------------------------------------------------------------------%
%-Useful-Functions-and-Operators-----------------------------------------------%
%-Useful-Operators-------------------------------------------------------------%
%------------------------------------------------------------------------------%
\DeclareMathOperator\diff{d\!} % operator diff
\DeclareMathOperator\Diff{D} % operator Diff
Expand All @@ -226,6 +246,12 @@
\DeclareMathOperator*{\argmax}{argmax} % operator argmax
\DeclareMathOperator*{\argopt}{argopt} % operator argopt
\DeclareMathOperator*{\dist}{dist} % operator dist
\DeclareMathOperator\rot{rot} % operator rot
\DeclareMathOperator\curl{curl} % operator curl
\DeclareMathOperator\divergence{div} % operator div
%------------------------------------------------------------------------------%
%-Useful-Functions-------------------------------------------------------------%
%------------------------------------------------------------------------------%
\newcommand\abs[1]{{\lvert {#1} \rvert}} % operator abs
\newcommand\norm[1]{{\| {#1} \|}} % operator norm
\newcommand\normlp[2]{{\norm{#1}}_{#2}} % operator Lp-norm
Expand Down
2 changes: 1 addition & 1 deletion references/reference.bib
View file
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
@misc{NWPUThesisLaTeXTemplate,
title={{{\LaTeX}}-Template-For-NPU-Thesis},
author={Shangkun Shen and Zhihe Wang and Weijia Zhang},
author={Shangkun Shen and Zhihe Wang and Jiduo Zhang and Weijia Zhang},
year={2016},
month={05}
}
Expand Down
Loading

0 comments on commit 4cadb1d

Please sign in to comment.