diff --git a/.gitignore b/.gitignore index bd77a0c4..7ac94c49 100644 --- a/.gitignore +++ b/.gitignore @@ -11,6 +11,10 @@ *.cb *.cb2 .*.lb +*.cls +*.pdf +*.hd +*.sty ## Intermediate documents: *.dvi diff --git a/Makefile b/Makefile index bad74ee5..7949e828 100644 --- a/Makefile +++ b/Makefile @@ -7,6 +7,8 @@ CLSFILE = dtx-style.sty bitart.cls bitbook.cls LATEXMK = latexmk +SCAFFOLDDIR = ../BIThesis-scaffold + # make deletion work on Windows ifdef SystemRoot RM = del /Q @@ -14,7 +16,7 @@ else RM = rm -f endif -.PHONY: all cls doc clean FORCE_MAKE +.PHONY: all cls doc clean FORCE_MAKE copy $(PACKAGE).pdf: cls FORCE_MAKE $(LATEXMK) $(PACKAGE).dtx @@ -37,3 +39,9 @@ clean-dist: -@$(RM) -r $(PACKAGE).pdf clean-all: clean clean-dist FORCE_MAKE + + +copy: + cp bitbook.cls $(SCAFFOLDDIR)/graduation-thesis + cp bitart.cls $(SCAFFOLDDIR)/lab-report + cp bitart.cls $(SCAFFOLDDIR)/proposal-report diff --git a/README.md b/README.md index f36b127a..db33b781 100644 --- a/README.md +++ b/README.md @@ -4,7 +4,6 @@ 📖 _非官方本科生毕业设计毕业论文 LaTeX 模板（以及更多）_ ![BIThesis](./assets/bithesis_badge_solid.svg) -[![English version](assets/english.svg)](./README-en.md) [![Latexmk](https://badgen.net/badge/compiler/Latexmk?color=blue&labelColor=2b2b2b)](https://mg.readthedocs.io/latexmk.html) [![License](https://badgen.net/github/license/BITNP/BIThesis?color=008080&labelColor=2b2b2b)](./LICENSE) [![Join on Slack](https://img.shields.io/badge/Slack%20Community-BIThesis-black?logo=slack&style=social&logoColor=2eb67d)](https://join.slack.com/t/bithesis/shared_invite/zt-epmzkyk0-fJRsUS36AlwMNB2AI_Q~Vw) @@ -27,50 +26,25 @@ BIThesis 是针对北京理工大学本科同学毕业设计、毕业论文制

内容

-- [项目内容](#%e9%a1%b9%e7%9b%ae%e5%86%85%e5%ae%b9) -- [如何使用 BIThesis](#%e5%a6%82%e4%bd%95%e4%bd%bf%e7%94%a8-bithesis) - - [详细的在线参考文档](#%e8%af%a6%e7%bb%86%e7%9a%84%e5%9c%a8%e7%ba%bf%e5%8f%82%e8%80%83%e6%96%87%e6%a1%a3) - - [PDF 使用手册](#pdf-%e4%bd%bf%e7%94%a8%e6%89%8b%e5%86%8c) - - [在线视频教程](#%e5%9c%a8%e7%ba%bf%e8%a7%86%e9%a2%91%e6%95%99%e7%a8%8b) +- [开发者指南](#开发者指南) - [贡献者指南](#%e8%b4%a1%e7%8c%ae%e8%80%85%e6%8c%87%e5%8d%97) - [贡献者](#%e8%b4%a1%e7%8c%ae%e8%80%85) - [相关项目](#%e7%9b%b8%e5%85%b3%e9%a1%b9%e7%9b%ae) - [发布状态](#%e5%8f%91%e5%b8%83%e7%8a%b6%e6%80%81) -## 项目内容 -BIThesis 为各位在北京理工大学就读的本科同学提供了基于北京理工大学计算机学院给出的「北京理工大学计算机学院本科生毕业论文：开题报告」与北京理工大学教务部提供的「北京理工大学本科生毕业设计：论文模板」的 LaTeX 模板等。**借助于 BIThesis 的 LaTeX 模板，你可以在保证论文格式整齐、完美、符合要求的前提下，专注于学术研究、项目实现，从而顺利完成你的学术项目。** -| 模板 | 预览 | 特性 | 维护人 | -| :------------------------------------------ | :---------------------------------------------------------------------------------------------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :--------------------------------------------- | -| **[开题报告](./proposal-report)**
| proposal | | [@北京理工大学网络开拓者协会 BIThesis 工作组](https://github.com/BITNP) | -| **[毕业设计论文](./graduation-thesis)**
| grad_thesis | | [@北京理工大学网络开拓者协会 BIThesis 工作组](https://github.com/BITNP) | -| **[实验报告](./lab-report)**
| lab_report | | [@北京理工大学网络开拓者协会 BIThesis 工作组](https://github.com/BITNP) | +## 开发者指南 -## 如何使用 BIThesis +### 与 scaffold 联调开发 -### 详细的在线参考文档 +将 `BITNP/BIThesis` 与 `BITNP/BIThesis-scaffold` 放在同一级目录下， +然后进入 `BIThesis` 目录。 -**有关如何安装 Latex、编译 BIThesis 和使用 BIThesis 模板中的单个模板的全面指南，请参阅 BIThesis 的 Wiki。👇** - -[![BIThesis Wiki](https://img.shields.io/badge/BIThesis-Wiki-009944?logo=wikipedia&labelColor=2b2b2b&style=for-the-badge)](https://bithesis.bitnp.net/) - -具体的，有关如何使用和编译单个模板的详细指南，请访问： - -- [BIThesis Wiki: 开题报告](https://bithesis.bitnp.net/Guide/3-Templates/Proposal-Report.html) -- [BIThesis Wiki: 毕业设计论文](https://bithesis.bitnp.net/Guide/3-Templates/Final-Graduation-Thesis.html) -- [BIThesis Wiki: 实验报告](https://bithesis.bitnp.net/Guide/3-Templates/Lab-Report.html) - -### PDF 使用手册 - -另外，我们也提供一个撰写详细的 PDF 使用手册。你可以在这里下载 BIThesis 手册的 PDF 版本：[`bithesis-documentation.pdf`](https://github.com/BITNP/BIThesis/releases/latest) - -### 在线视频教程 - -你也可以在这里观看在线的视频教程： - -- 哔哩哔哩弹幕网：[BIThesis —— 教你优雅地撰写论文 | LaTeX 毕设模板系列教程](https://www.bilibili.com/video/BV1GT4y1V78d/) -- BIThesis 文档视频部分（包含有一些视频中提到的代码）：[BIThesis - Videos](https://bithesis.bitnp.net/Video/) +```Bash +# 请首先确保 entr 正确安装 +ls bithesis.dtx | entr -s 'yes -y y | make doc && make copy' +``` ## 贡献者指南 diff --git a/bithesis.dtx b/bithesis.dtx index 26008b6d..5a3a32cb 100644 --- a/bithesis.dtx +++ b/bithesis.dtx @@ -151,13 +151,14 @@ %<*book> % \end{macrocode} % \begin{macrocode} + \newif\if@bit@bachelor \newif\if@bit@master \newif\if@bit@docter \DeclareOption{bachelor}{\@bit@bachelortrue} -\DeclareOption*{\PassOptionsToClass{\CurrentOption}{ctexart}} -\ExecuteOptions{lab-report} +\DeclareOption*{\PassOptionsToClass{\CurrentOption}{ctexbook}} +\ExecuteOptions{bachelor} \ProcessOptions\relax @@ -167,7 +168,7 @@ % 目前 29mm 最接近 Word 排版 \RequirePackage{xeCJK} \RequirePackage{titletoc} -\RequirePackage{fontspec} + % \RequirePackage{fontspec} \RequirePackage{setspace} \RequirePackage{graphicx} \RequirePackage{fancyhdr} @@ -200,12 +201,17 @@ isbn=false, ]{biblatex} +% 参考文献引用文件位于 misc/ref.bib +\addbibresource{./misc/ref.bib} + % 西文字体默认为 Times New Roman \setromanfont{Times New Roman} % 论文题目字体为华文细黑 -\setCJKfamilyfont{xihei}{[STXIHEI.TTF]} % 若希望使用本机字体，也可以用 {STXihei} 来调用 +\setCJKfamilyfont{xihei}[AutoFakeBold,AutoFakeSlant]{[STXIHEI.TTF]} % 若希望使用本机字体，也可以用 {STXihei} 来调用 \newcommand{\xihei}{\CJKfamily{xihei}} + + % 主题页面格式：BIThesis \fancypagestyle{BIThesis}{ % 页眉高度 @@ -349,22 +355,23 @@ \RequirePackage{setspace}% \RequirePackage{graphicx}% \RequirePackage{fancyhdr}% -\RequirePackage{titlesec}% \RequirePackage{pdfpages}% \RequirePackage{setspace}% \RequirePackage{booktabs}% \RequirePackage{multirow}% -\RequirePackage{float}% \RequirePackage{caption}% -\RequirePackage{etoolbox} + +\if@bit@labreport + \RequirePackage{titlesec}% + \RequirePackage{float}% + \RequirePackage{etoolbox} +\fi \if@bit@proposalreport % 设置参考文献编译后端为 biber，引用格式为 GB/T7714-2015 格式 % 参考文献使用宏包见 https://github.com/hushidong/biblatex-gb7714-2015 \usepackage[style=gb7714-2015,backend=biber]{biblatex} - % 参考文献引用文件 refs.bib - \addbibresource{misc/refs.bib} \fi