diff --git a/README.md b/README.md index 4442524c..a9247214 100644 --- a/README.md +++ b/README.md @@ -14,29 +14,42 @@ ## 使用 > 注意： +> > - 本模板已经兼容 TeX Live 2019，并且这个版本复制伪粗体文字不会产生乱码，建议单独使用 Tex Live 的同学尽快升级 2019 版本 -> - 本模板默认情况下使用计算机科学与技术专用格式，如需使用其他专业格式，请修改 `zjuthesis.tex` 中 `\documentclass` 部分的 `MajorFormat` -> - 计算机专业的部分页面与学校通用格式不同，如果你不是计算机专业的同学，请使用非计算机专业的模板 +> - 本模板默认情况下使用 `general` 格式，如需使用其他专业格式，请修改 `zjuthesis.tex` 中 `\documentclass` 部分的 `MajorFormat` +> - 计算机专业的部分页面与学校通用格式不同，如果你是计算机专业的同学，请使用计算机专业的模板 1. [下载模板代码](https://github.com/TheNetAdmin/zjuthesis/releases) -2. 安装 TeXLive 工具包，编译需要 XeTeX 引擎。安装所需的镜像文件可以选用浙江大学开源镜像站提供的[镜像](https://mirrors.zju.edu.cn/CTAN/systems/texlive/Images/)以便在校内网下更快下载。 -3. 在 `zjuthesis.tex` 中 `\documentclass[]{zjuthesis}` 部分填写个人信息，注意以下信息用于控制文档的生成： +1. 安装 TeXLive 工具包，编译需要 XeTeX 引擎。安装所需的镜像文件可以选用浙江大学开源镜像站提供的[镜像](https://mirrors.zju.edu.cn/CTAN/systems/texlive/Images/)以便在校内网下更快下载。 +1. 在 `zjuthesis.tex` 中 `\documentclass[]{zjuthesis}` 部分填写个人信息，注意以下信息用于控制文档的生成： | Type | Period | BlindReview | MajorFormat | | :------------- | :------------------- | :---------------------------------- | :----------------------------------- | | thesis: 论文类 | proposal: 开题报告 | true: 生成盲审用pdf（隐藏个人信息） | 默认: cs | | design: 设计类 | final: 最终论文/设计 | false: 生成提交用pdf | 与 `config/format/major/` 下目录名相同 | -4. 在 `content` 目录下编写内容 -5. 在 `pages` 目录下填写必要的内容，如审核评语等 -6. 在 `figure` 目录下保存图片，在 `reference/ref.bib` 内插入文献条目 -7. 在根目录下运行命令 `latexmk -xelatex -outdir=out zjuthesis` 即可编译 TeX 文件到 `out` 目录（该目录不会被记录版本） +1. 在 `content` 目录下编写内容 +1. 在 `pages` 目录下填写必要的内容，如审核评语等 +1. 在 `figure` 目录下保存图片，在 `reference/ref.bib` 内插入文献条目 +1. 在根目录下运行命令 `latexmk -xelatex -outdir=out zjuthesis` 即可编译 TeX 文件到 `out` 目录（该目录不会被记录版本） ## 扩展 1. 针对每个专业的扩展格式编写请新建目录 `config/format/major/专业简称` ，在该目录下固定新建文件 `format.tex`，引入该目录下所有格式设置文件 -2. 扩展格式的 `\usepackage{packagename}` 尽量放在其所在子目录下的 `packages.tex` 内，不要放在 `config/packages.tex` 内，避免其他专业同学使用时产生 package 冲突或额外引入 -3. 最后修改 `zjuthesis.tex` 中 `\documentclass` 部分的 `MajorFormat` ，使用新格式的目录名即可 +1. 扩展格式的 `\usepackage{packagename}` 尽量放在其所在子目录下的 `packages.tex` 内，不要放在 `config/packages.tex` 内，避免其他专业同学使用时产生 package 冲突或额外引入 +1. 最后修改 `zjuthesis.tex` 中 `\documentclass` 部分的 `MajorFormat` ，使用新格式的目录名即可 +1. 现在支持的专业模板如下 + + | 模板名称 | 专业 | + | :------ | :------------ | + | cs | 计算机科学与技术 | + | isee | 信息电子 | + | math | 数学 | + | physics | 物理 | + +1. 经过两年的使用，现在尚未发现某个专业模板的格式于校级模板有很大出入。 + 所以这里列出的各个专业模板主要是提供了方便的宏。 + 但**计算机学院**的模板使用的封面和评分页于校级模板有所不同，使用时请注意切换。 ## Slide 模板 @@ -51,7 +64,7 @@ - 在 Github 上提出 issue，附上模板格式要求 - 发送邮件到我邮箱 (zxwang42 [at] gmail.com)，附上模板格式要求与样例文件 - **在 Github 上提出 Pull Request，贡献你编写的代码** - + 1. Q: latexmk 编译不通过？ A: 可以先尝试执行 `tlmgr update --self --all` 更新整个 TexLive，然后重新编译。因为直接安装的 TexLive 并不包含所有最新版本的宏包，一些旧版宏包的 BUG 可能会影响编译。 @@ -61,9 +74,9 @@ A: 貌似目前查重工具对 LaTeX 生成的 pdf 支持比较差，主要有两点 1) 伪粗体会造成乱码； 2) LaTeX 生成的 pdf 默认采用了 UTF-8 的编码，而查重工具对这种编码支持不好，可能会认为是 GBK 之类的编码，从而造成大量乱码； - + 第一点可以通过升级到 TeX Live 2019 解决。 - + 第二点暂时没有特别好的解决方法，如果有同学有相关经验的话，可以 issue 留言或者邮件告知我，我会更新 README。 1. Q: pdf 文字复制得到乱码？ @@ -78,27 +91,26 @@ > > 要想彻底解决这个问题，只能换用有真正粗体版本的字体，目前为止我并没有找到仿宋对应的粗体版本。 > 当然 Office 对字体伪粗体问题有更好的解决方式，毕竟人家是收钱的嘛…… - - 相关讨论见：https://github.com/CTeX-org/ctex-kit/issues/353 + > 相关讨论见：https://github.com/CTeX-org/ctex-kit/issues/353 1. Q: 某些 pdf 阅读器(如 Chrome )打开看不到中文，或者中文乱码 A: 可能是 LaTeX 没有正确嵌入字体，最简单的解决方案是用没有乱码的 pdf 阅读器打开->打印->打印成 pdf ，然后尝试用有问题的阅读器打开，看是否仍有问题。 - + 如果需要了解具体发生了什么，请查阅 zjuthesis.log ，在文件内搜索 warning 和 error ，看一下是否有字体相关的报错。 1. Q: 怎么在 Overleaf 上使用？ A: 下载本模板并在 Overleaf 上上传 .zip 文件，选择使用 XeLatex 编译器。 - + 由于字体存在版权问题，还请大家自行设置字体。 - + 如果编译超时（不显示 pdf 也不报错），请尝试注释中文字体设置（位于 `config/format/general/font.tex` 以及 `config/foramt/major/.../font.tex`），然后重新编译，应该就可以了。编译超时可能是缺失字体导致的，请大家自行上传字体并设置字体路径。 1. Q: 怎么配合 vscode 使用？ A: 参见[这里](https://github.com/TheNetAdmin/zjuthesis/issues/11) - + 1. 其他问题请在 [Github issue](https://github.com/TheNetAdmin/zjuthesis/issues/) 提出，或使用邮件与我联系（邮箱见上方Q1）。 ## 开源许可 diff --git a/config/format/major/general/format.tex b/config/format/major/general/format.tex new file mode 100644 index 00000000..4122a74a --- /dev/null +++ b/config/format/major/general/format.tex @@ -0,0 +1 @@ +% No specific format \ No newline at end of file diff --git a/config/version.tex b/config/version.tex index db25e55f..ad9240ae 100644 --- a/config/version.tex +++ b/config/version.tex @@ -1 +1 @@ -\newcommand{\zjuthesisversion}{2.2.2} +\newcommand{\zjuthesisversion}{3.0.0} diff --git a/pages/final/cover.tex b/pages/final/cover.tex index 8df28bd8..f38c47a7 100644 --- a/pages/final/cover.tex +++ b/pages/final/cover.tex @@ -39,8 +39,14 @@ \fangsong 题目 & \uline{\hfill \Title \hfill} \\ ~ & ~\\ - 学生姓名 & \uline{\hfill} \\ - 学生学号 & \uline{\hfill} \\ + \ifthenelse{\equal{\MajorFormat}{cs}} + { + 学生姓名 & \uline{\hfill} \\ + 学生学号 & \uline{\hfill} \\ + } + { + 姓名与学号 & \uline{\hfill} \\ + } 指导教师 & \uline{\hfill} \\ 年级与专业 & \uline{\hfill} \\ 所在学院 & \uline{\hfill} \\ @@ -57,8 +63,14 @@ \begin{tabularx}{.7\textwidth}{>{\fangsong}l >{\fangsong}X<{\centering}} 题目 & \uline{\hfill \Title \hfill} \\ ~ & ~\\ - 学生姓名 & \uline{\hfill \StudentName \hfill} \\ - 学生学号 & \uline{\hfill \StudentID \hfill} \\ + \ifthenelse{\equal{\MajorFormat}{cs}} + { + 学生姓名 & \uline{\hfill \StudentName \hfill} \\ + 学生学号 & \uline{\hfill \StudentID \hfill} \\ + } + { + 姓名与学号 & \uline{\hfill \StudentName~\StudentID \hfill} \\ + } 指导教师 & \uline{\hfill \AdvisorName \hfill} \\ 年级与专业 & \uline{\hfill \mbox{\Grade}级\Major \hfill} \\ 所在学院 & \uline{\hfill \Department \hfill} \\ diff --git a/pages/proposal/cover.tex b/pages/proposal/cover.tex index a9094940..824fc78d 100644 --- a/pages/proposal/cover.tex +++ b/pages/proposal/cover.tex @@ -36,14 +36,14 @@ \begin{center} \bfseries \zihao{3} \begin{tabularx}{.7\textwidth}{>{\fangsong}l >{\fangsong}X<{\centering}} - \ifthenelse{\equal{\MajorFormat}{cs}} - { - 学生姓名 & \uline{\hfill} \\ - 学生学号 & \uline{\hfill} \\ - } - { - 姓名与学号 & \uline{\hfill} \\ - } + \ifthenelse{\equal{\MajorFormat}{cs}} + { + 学生姓名 & \uline{\hfill} \\ + 学生学号 & \uline{\hfill} \\ + } + { + 姓名与学号 & \uline{\hfill} \\ + } 指导教师 & \uline{\hfill} \\ 年级与专业 & \uline{\hfill} \\ 所在学院 & \uline{\hfill} \\ @@ -55,14 +55,14 @@ \begin{center} \bfseries \zihao{3} \begin{tabularx}{.7\textwidth}{>{\fangsong}l >{\fangsong}X<{\centering}} - \ifthenelse{\equal{\MajorFormat}{cs}} - { - 学生姓名 & \uline{\hfill \StudentName \hfill} \\ - 学生学号 & \uline{\hfill \StudentID \hfill} \\ - } - { - 姓名与学号 & \uline{\hfill \StudentName~\StudentID \hfill} \\ - } + \ifthenelse{\equal{\MajorFormat}{cs}} + { + 学生姓名 & \uline{\hfill \StudentName \hfill} \\ + 学生学号 & \uline{\hfill \StudentID \hfill} \\ + } + { + 姓名与学号 & \uline{\hfill \StudentName~\StudentID \hfill} \\ + } 指导教师 & \uline{\hfill \AdvisorName \hfill} \\ 年级与专业 & \uline{\hfill \mbox{\Grade}级\Major \hfill} \\ 所在学院 & \uline{\hfill \Department \hfill} \\ diff --git a/zjuthesis.tex b/zjuthesis.tex index 722d8f79..8dee844a 100644 --- a/zjuthesis.tex +++ b/zjuthesis.tex @@ -12,7 +12,7 @@ Department = 学院, Title = 毕业论文/设计题目, SubmitDate = 递交日期, - MajorFormat = cs, + MajorFormat = general, Type = design, % `thesis` or `design` Period = final, % `final` or `proposal` BlindReview = false % `true` or `false`