summaryrefslogtreecommitdiff
path: root/macros/latex/contrib/bithesis
diff options
context:
space:
mode:
authorNorbert Preining <norbert@preining.info>2021-01-12 03:01:27 +0000
committerNorbert Preining <norbert@preining.info>2021-01-12 03:01:27 +0000
commit59f820c29fe15f643154da97419acf78749bde8f (patch)
tree5a94f2584a397d60ae601482df04347c9dbc214a /macros/latex/contrib/bithesis
parent5187d8af76756cc8c101de4a50c9ccfb9acd0c9a (diff)
CTAN sync 202101120301
Diffstat (limited to 'macros/latex/contrib/bithesis')
-rw-r--r--macros/latex/contrib/bithesis/README-zh.md88
-rw-r--r--macros/latex/contrib/bithesis/README.md84
-rw-r--r--macros/latex/contrib/bithesis/bithesis.dtx103
-rw-r--r--macros/latex/contrib/bithesis/bithesis.ins4
-rw-r--r--macros/latex/contrib/bithesis/bithesis.pdfbin194456 -> 216524 bytes
-rw-r--r--macros/latex/contrib/bithesis/contributing-zh.md58
-rw-r--r--macros/latex/contrib/bithesis/contributing.md60
7 files changed, 327 insertions, 70 deletions
diff --git a/macros/latex/contrib/bithesis/README-zh.md b/macros/latex/contrib/bithesis/README-zh.md
new file mode 100644
index 0000000000..62e548767c
--- /dev/null
+++ b/macros/latex/contrib/bithesis/README-zh.md
@@ -0,0 +1,88 @@
+<div align="center">
+ <img src="./assets/bithesis_icon.svg" alt="BIThesis Icon">
+
+📖 _非官方本科生毕业设计毕业论文 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)
+
+</div>
+
+<h2>欢迎</h2>
+
+BIThesis 是针对北京理工大学本科同学毕业设计、毕业论文制作的一个非官方的 LaTeX 模板,BIThesis 同时也包括其他本科学习中涉及到的文献综述、实验报告等的 LaTeX 模板。
+
+**我们正在对项目持续更新!目前,你完全可以使用现有的版本开始你的毕业设计开题报告的写作;不过与此同时,我们也在持续推进代码的升级和更新(主要是不影响使用的底层逻辑)。更多开发计划请访问我们的 [Roadmap](https://github.com/BITNP/BIThesis/projects)。想帮助这个项目持续前进?参见我们的[贡献者指南](./contributing-zh.md)。**
+
+> 本项目获得了 [北京理工大学教务部](http://jwc.bit.edu.cn/)、[北京理工大学计算机学院](http://cs.bit.edu.cn/) 的认可、背书与大力支持。详见:[致谢 - 官方赞助](https://bithesis.bitnp.net/Guide/5-Acknowledgements/Acknowledgements.html#%E5%AE%98%E6%96%B9%E8%B5%9E%E5%8A%A9-official-sponsors)。
+
+<h2>Slack 社区</h2>
+
+> 订阅更新,询问问题,提出需求……来参加 Slack 上面的北理 BIThesis 官方社区!
+
+[![Join on Slack](./assets/slack.svg)](https://join.slack.com/t/bithesis/shared_invite/zt-epmzkyk0-fJRsUS36AlwMNB2AI_Q~Vw)
+
+<h2>内容</h2>
+
+- [开发者指南](#开发者指南)
+- [贡献者指南](#%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)
+
+
+
+## 开发者指南
+
+### 生成 .cls 文件
+
+```Bash
+make cls
+```
+
+### 生成宏包手册
+
+```Bash
+make doc
+```
+
+### 与 scaffold 联调开发
+
+将 `BITNP/BIThesis` 与 `BITNP/BIThesis-scaffold` 放在同一级目录下,
+然后进入 `BIThesis` 目录。
+
+```Bash
+# 请首先确保 entr 正确安装
+ls bithesis.dtx | entr -s 'yes -y y | make doc && make copy'
+```
+
+## 贡献者指南
+
+详情请查看[贡献者指南](./contributing-zh.md)。
+
+## 贡献者
+
+参见[Github Contributors](https://github.com/BITNP/BIThesis/graphs/contributors) 与 [BIThesis - 致谢](https://bithesis.bitnp.net/Guide/5-Acknowledgements/Acknowledgements.html)。
+
+## 相关项目
+
+- [北京理工大学硕士(博士)学位论文 LaTeX 模板](https://github.com/BIT-thesis/LaTeX-template)
+- [fduthesis(复旦大学论文模板)](https://github.com/stone-zeng/fduthesis)
+- [上海交通大学 XeLaTeX 学位论文及课程论文模板](https://github.com/sjtug/SJTUThesis)
+- ……
+
+## 发布状态
+
+| CI | Build status |
+| :------------- | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| GitHub Release | ![GitHub Release](https://github.com/BITNP/BIThesis/workflows/Release/badge.svg?branch=master) |
+| Netlify Deploy | [![Netlify Status](https://api.netlify.com/api/v1/badges/81f7b49b-59a1-46bc-ba52-02f8be71d247/deploy-status)](https://app.netlify.com/sites/vigorous-hoover-a697eb/deploys) |
+
+---
+
+📖 **BIThesis** ©BITNP/BIThesis. Released under the [LaTeX Project Public License](LICENSE).
+
+Authored by Spencer Woo. Maintained with help from [contributors](https://github.com/BITNP/BIThesis/graphs/contributors).
diff --git a/macros/latex/contrib/bithesis/README.md b/macros/latex/contrib/bithesis/README.md
index a7cd83b298..d8a8e19997 100644
--- a/macros/latex/contrib/bithesis/README.md
+++ b/macros/latex/contrib/bithesis/README.md
@@ -1,93 +1,89 @@
<div align="center">
- <img src="./assets/bithesis_icon.svg" alt="BIThesis Icon">
+ <img src="assets/bithesis_icon.svg" alt="BIThesis Icon">
-📖 _非官方本科生毕业设计毕业论文 LaTeX 模板(以及更多)_
+📖 _Unofficial LaTeX templates for your bachelor graduation thesis (and maybe more)._
-![BIThesis](./assets/bithesis_badge_solid.svg)
+[![BIThesis](./assets/bithesis_badge_solid.svg)](https://bithesis.bitnp.net/)
+[![Chinese version](./assets/chinese.svg)](./README-zh.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)
</div>
-<h2>欢迎</h2>
+<h2>Welcome</h2>
-BIThesis 是针对北京理工大学本科同学毕业设计、毕业论文制作的一个非官方的 LaTeX 模板,BIThesis 同时也包括其他本科学习中涉及到的文献综述、实验报告等的 LaTeX 模板。
+BIThesis is an unofficial LaTeX template set for your **bachelor graduation thesis** and corresponding reports here at BIT. Hand-crafted following the specifications made by the _[Dept. of Undergraduate Academic Affairs](http://jwc.bit.edu.cn/)_ of _[Beijing Institute of Technology](http://http://www.bit.edu.cn/)_.
-**我们正在对项目持续更新!目前,你完全可以使用现有的版本开始你的毕业设计开题报告的写作;不过与此同时,我们也在持续推进代码的升级和更新(主要是不影响使用的底层逻辑)。更多开发计划请访问我们的 [Roadmap](https://github.com/BITNP/BIThesis/projects)。想帮助这个项目持续前进?参见我们的[贡献者指南](./contributing-zh.md)。**
+> This project is supported by the _[Dept. of Undergraduate Academic Affairs, BIT](http://jwc.bit.edu.cn/)_ and the _[School of Computer Science and Technology, BIT](http://cs.bit.edu.cn/)_. See [Acknowledgements - Official Sponsors](https://bithesis.bitnp.net/Guide/5-Acknowledgements/Acknowledgements.html#%E5%AE%98%E6%96%B9%E8%B5%9E%E5%8A%A9-official-sponsors).
-> 本项目获得了 [北京理工大学教务部](http://jwc.bit.edu.cn/)、[北京理工大学计算机学院](http://cs.bit.edu.cn/) 的认可、背书与大力支持。详见:[致谢 - 官方赞助](https://bithesis.bitnp.net/Guide/5-Acknowledgements/Acknowledgements.html#%E5%AE%98%E6%96%B9%E8%B5%9E%E5%8A%A9-official-sponsors)。
+<h2>Slack Community</h2>
-<h2>Slack 社区</h2>
-
-> 订阅更新,询问问题,提出需求……来参加 Slack 上面的北理 BIThesis 官方社区!
+> Subscribe to new releases, ask questions, request features, etc. Come join our official community on Slack!
[![Join on Slack](./assets/slack.svg)](https://join.slack.com/t/bithesis/shared_invite/zt-epmzkyk0-fJRsUS36AlwMNB2AI_Q~Vw)
-<h2>内容</h2>
+<h2>Table of Contents</h2>
-- [开发者指南](#开发者指南)
-- [贡献者指南](#%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)
+- [How do I use BIThesis?](#how-do-i-use-bithesis)
+ - [Detailed online Wiki](#detailed-online-wiki)
+ - [PDF handbook](#pdf-handbook)
+ - [Online Video Tutorials](#online-video-tutorials)
+- [Contributing](#contributing)
+- [Contributors](#contributors)
+- [Similar Projects](#similar-projects)
+- [Release status](#release-status)
+## How do I use BIThesis?
+### Detailed online Wiki
-## 开发者指南
+**For a comprehensive guide on how to install LaTeX, compile BIThesis, and use a single one of BIThesis' template, please refer to BIThesis' Wiki. 👇**
-### 生成 .cls 文件
+[![BIThesis Wiki](https://img.shields.io/badge/BIThesis-Wiki-009944?logo=wikipedia&labelColor=2b2b2b&style=for-the-badge)](https://bithesis.bitnp.net/)
-```Bash
-make cls
-```
+Specifically, detailed guides on how to use a single one of the templates are available at:
-### 生成宏包手册
+- [BIThesis Wiki: Proposal report](https://bithesis.bitnp.net/Guide/3-Templates/Proposal-Report.html)
+- [BIThesis Wiki: Graduation thesis](https://bithesis.bitnp.net/Guide/3-Templates/Final-Graduation-Thesis.html)
+- [BIThesis Wiki: Lab report](https://bithesis.bitnp.net/Guide/3-Templates/Lab-Report.html)
-```Bash
-make doc
-```
+### PDF handbook
-### 与 scaffold 联调开发
+We also provide a PDF handbook on how to use BIThesis. You can download the PDF version of the BIThesis handbook here: [`bithesis-documentation.pdf`](https://github.com/BITNP/BIThesis/releases/latest).
-将 `BITNP/BIThesis` 与 `BITNP/BIThesis-scaffold` 放在同一级目录下,
-然后进入 `BIThesis` 目录。
+### Online Video Tutorials
-```Bash
-# 请首先确保 entr 正确安装
-ls bithesis.dtx | entr -s 'yes -y y | make doc && make copy'
-```
+You can watch online video tutorials here:
-## 贡献者指南
+- Bilibili: [BIThesis —— 教你优雅地撰写论文 | LaTeX 毕设模板系列教程](https://www.bilibili.com/video/BV1GT4y1V78d/)
+- BIThesis documentation videos (including some code which are referenced in the videos): [BIThesis - Videos](https://bithesis.bitnp.net/Video/)
-详情请查看[贡献者指南](./contributing-zh.md)。
+## Contributing
-## 贡献者
+For details, please see the [contributing doc](./contributing.md).
-> 本项目的存在离不开以下所有贡献者的辛勤贡献。更多信息请访问:[BIThesis - 致谢](https://bithesis.bitnp.net/Guide/5-Acknowledgements/Acknowledgements.html)。
+## Contributors
-[![](https://sourcerer.io/fame/spencerwooo/spencerwooo/BIThesis/images/0)](https://sourcerer.io/fame/spencerwooo/spencerwooo/BIThesis/links/0)[![](https://sourcerer.io/fame/spencerwooo/spencerwooo/BIThesis/images/1)](https://sourcerer.io/fame/spencerwooo/spencerwooo/BIThesis/links/1)[![](https://sourcerer.io/fame/spencerwooo/spencerwooo/BIThesis/images/2)](https://sourcerer.io/fame/spencerwooo/spencerwooo/BIThesis/links/2)[![](https://sourcerer.io/fame/spencerwooo/spencerwooo/BIThesis/images/3)](https://sourcerer.io/fame/spencerwooo/spencerwooo/BIThesis/links/3)[![](https://sourcerer.io/fame/spencerwooo/spencerwooo/BIThesis/images/4)](https://sourcerer.io/fame/spencerwooo/spencerwooo/BIThesis/links/4)[![](https://sourcerer.io/fame/spencerwooo/spencerwooo/BIThesis/images/5)](https://sourcerer.io/fame/spencerwooo/spencerwooo/BIThesis/links/5)[![](https://sourcerer.io/fame/spencerwooo/spencerwooo/BIThesis/images/6)](https://sourcerer.io/fame/spencerwooo/spencerwooo/BIThesis/links/6)[![](https://sourcerer.io/fame/spencerwooo/spencerwooo/BIThesis/images/7)](https://sourcerer.io/fame/spencerwooo/spencerwooo/BIThesis/links/7)
+For more information, please see: [Github Contributors](https://github.com/BITNP/BIThesis/graphs/contributors) and [Acknowledgements](https://bithesis.bitnp.net/Guide/5-Acknowledgements/Acknowledgements.html).
-## 相关项目
+## Similar Projects
- [北京理工大学硕士(博士)学位论文 LaTeX 模板](https://github.com/BIT-thesis/LaTeX-template)
- [fduthesis(复旦大学论文模板)](https://github.com/stone-zeng/fduthesis)
- [上海交通大学 XeLaTeX 学位论文及课程论文模板](https://github.com/sjtug/SJTUThesis)
- ……
-## 发布状态
+## Release status
| CI | Build status |
| :------------- | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| GitHub Release | ![GitHub Release](https://github.com/BITNP/BIThesis/workflows/Release/badge.svg?branch=master) |
+| GitHub Release | ![GitHub Release](https://github.com/BITNP/BIThesis/workflows/Release/badge.svg?branch=master) |
| Netlify Deploy | [![Netlify Status](https://api.netlify.com/api/v1/badges/81f7b49b-59a1-46bc-ba52-02f8be71d247/deploy-status)](https://app.netlify.com/sites/vigorous-hoover-a697eb/deploys) |
-<!-- ## 免责声明
-
-本项目尚未经由 _北京理工大学教务部_ 确认(但即将会被官方授权)。使用此模板的风险由你自己承担。笔芯 (´▽`ʃ♡ƪ) -->
---
-📖 **BIThesis** ©BITNP/BIThesis. Released under the [LaTeX Project Public License](LICENSE).
+📖 **BIThesis** ©Spencer Woo. Released under the [LaTeX Project Public License](LICENSE).
Authored by Spencer Woo. Maintained with help from [contributors](https://github.com/BITNP/BIThesis/graphs/contributors).
diff --git a/macros/latex/contrib/bithesis/bithesis.dtx b/macros/latex/contrib/bithesis/bithesis.dtx
index 5a3a32cb3b..db84b03eed 100644
--- a/macros/latex/contrib/bithesis/bithesis.dtx
+++ b/macros/latex/contrib/bithesis/bithesis.dtx
@@ -1,6 +1,7 @@
% \iffalse meta-comment
%
-% Copyright (C) 2020 by Feng Kaiyu
+% Copyright (C) 2021
+% Association of Bit Network Pioneer and any individual authors listed elsewhere in this file.
% -----------------------------------
%
% This file may be distributed and/or modified under the
@@ -19,10 +20,10 @@
%<cls>\NeedsTeXFormat{LaTeX2e}[1999/12/01]
%<book>\ProvidesClass{bitbook}
%<article>\ProvidesClass{bitart}
-%<cls> [2020/11/27 v1.0.0 BIT Thesis Templates]
+%<cls> [2021/01/06 v1.0.1 BIT Thesis Templates]
%
%<*driver>
-\ProvidesFile{bithesis.dtx}[2020/11/27 1.0.0 BIT Thesis Templates]
+\ProvidesFile{bithesis.dtx}[2021/01/06 1.0.1 BIT Thesis Templates]
\documentclass{ltxdoc}
\usepackage{dtx-style}
@@ -66,7 +67,7 @@
% \\[1cm]
% \bfseries 北京理工大学本科生{\LaTeX}学位论文及报告模板 }
% \author{北京理工大学网络开拓者协会 \\ \texttt{webmaster@bitnp.net}} %
-% \date{\zihao{-4} \today\quad \color{RubineRed}{\kaishu {\BIThesis} 版本 \version}}
+% \date{\zihao{-4} \today\quad \color{RubineRed}{\kaishu {\BIThesis}版本\version}}
% \maketitle\thispagestyle{empty}
%
% \def\abstractname{}
@@ -80,26 +81,30 @@
% \begin{center}
% \noindent\rule[0.25\baselineskip]{0.5\textwidth}{0.7pt}
% \end{center}
+%
% \def\abstractname{免责声明}
% \begin{abstract}
% \noindent
% \begin{enumerate}
-% \item 本模板的发布遵守 \href{https://www.latex-project.org/lppl/lppl-1-3c.txt}{\LaTeX{} Project Public License (1.3.c)},使用前请认真阅读协议内
-% 容。
+% \item 本模板的发布遵守 \LPPL ,使用前请认真阅读协议内容。
% \item 任何个人或组织以本模板为基础进行修改、扩展而生成的新的专用模板,请严格遵
% 守 \LaTeX{} Project Public License 协议。由于违犯协议而引起的任何纠纷争端均与
% 本模板作者无关。
% \end{enumerate}
% \end{abstract}
%
-%
% \vspace{5mm}
%
% \def\abstractname{简介}
% \begin{abstract}
-% \BIThesisLaTeX 是北京理工大学本科生毕业设计开题报告、总论文,以及其他课程报告、实验报告等重要论文、报告的 {\LaTeX} 模板集合。如果你厌烦了 Word 格式的不人性化、参考文献的难以管理、公式输入的差劲体验……那么欢迎来尝试用专业的学术稿件排版利器 —— {\LaTeX},来排版你的论文。专业高端、学界认可、开源免费,{\LaTeX} 是你论文排版的最佳搭档。
+% \BIThesisLaTeX 是北京理工大学本科生毕业设计开题报告、总论文,以及其他课程报告、实验报告等重要论文、报告的 {\LaTeX} 模板集合。
+% 如果你厌烦了 Word 格式的不人性化、参考文献的难以管理、公式输入的差劲体验……那么欢迎来尝试用专业的学术稿件排版利器 —— {\LaTeX},来排版你的论文。
+% 专业高端、学界认可、开源免费,{\LaTeX} 是你论文排版的最佳搭档。
%
-% \BIThesisLaTeX 目前支持使用 {\hologo{XeLaTeX}} 进行编译,使用以 biber 为后端的 BibLaTeX 进行参考文献的生成,符合《信息与文献参考文献著录规则》(\href{http://openstd.samr.gov.cn/bzgk/gb/newGbInfo?hcno=7FA63E9BBA56E60471AEDAEBDE44B14C}{GB/T 7714—2015})的标准。目前主要设计完成了计算机学院本科生毕业论文开题报告、毕业设计毕业论文与通用实验报告的 {\LaTeX} 模板。
+% \BIThesisLaTeX 目前支持使用 {\hologo{XeLaTeX}} 进行编译,使用以 biber 为后端的 BibLaTeX 进行参考文献的生成,
+% 符合《信息与文献参考文献著录规则》
+% (\href{http://openstd.samr.gov.cn/bzgk/gb/newGbInfo?hcno=7FA63E9BBA56E60471AEDAEBDE44B14C}{GB/T 7714—2015})的标准。
+% 目前主要设计完成了计算机学院本科生毕业论文开题报告、毕业设计毕业论文与通用实验报告的 {\LaTeX} 模板。
%
% \end{abstract}
% \newpage
@@ -108,23 +113,69 @@
% \clearpage
% \setlength{\parskip}{0.8ex}
%
-% \section{模板介绍}
-% \section{贡献者}
-% \section{安装}
+% \section{项目简介}
+% \subsection{历史与贡献者们}
+% \begin{itemize}
+% \item 2019 - 2020 年,\BIThesis 最早由 2016 级的武上博、王赞、唐誉铭、牟思睿和詹熠莎等人维护。
+% \begin{itemize}
+% \item 在此期间,\BIThesis 从无到有诞生了,包括使用手册、在线文档和开箱即用的模板。
+% \item 同时,2017 级的赵池等同学完成了一系列 \BIThesisLaTeX 的视频教程。
+% \end{itemize}
+% \item 2020 - 2021 年,2017 级的冯开宇、杨思云、郝正亮和顾骁等人接管了维护开发工作。
+% \begin{itemize}
+% \item 在此期间,冯开宇将原来的 .tex 文件制作成了宏包,并发布到 CTAN 上。
+% \item 项目代码也随之被拆分成了 \BIThesisMacroPackage,\BIThesisWiki 和 \BIThesisScaffold。
+% \end{itemize}
+% \end{itemize}
+% \subsection{\BIThesis 是什么?}
+% \BIThesis 之名是英文单词 Beijing Institution of Technology(北京理工大学)的首字母缩写“BIT” 与“Thesis”结合而成。在纯文本环境下,该名字应写作“BIThesis”。
+%
+% \BIThesisLaTeX 是由北京理工大学众多学子发起并维护的开源项目。该项目旨在建立一套简单易用的北京理工大学 \LaTeX 学位论文模板,包括本科综合论文训练。
+% \subsubsection{\BIThesisLaTeX 的组成}
+% 我们将 \BIThesisLaTeX 划分为了三个主要仓库:
+% \begin{table}[H]
+% \centering
+% \begin{tabular}{@{}l l p{6cm} @{}}
+% \toprule
+% 项目 & 项目地址 & 主要目的 \\ \midrule
+% BIThesis & \href{https://github.com/BITNP/BIThesis}{BITNP/BIThesis} & 主要存储 \BIThesis 宏包 \\
+% BIThesis-wiki & \href{https://github.com/BITNP/BIThesis-wiki}{BITNP/BIThesis-wiki} & 存储 \BIThesisLaTeX 项目在线文档 \\
+% BIThesis-scaffold & \href{https://github.com/BITNP/BIThesis-scaffold}{BITNP/BIThesis-scaffold} & 存储开箱即用的论文模板样式,便于使用者快速开始写作 \\ \bottomrule
+% \end{tabular}
+% \end{table}
+%
+% 如果你仅想解决「我如何使用 \BIThesisLaTeX 来帮助我完成实验论文?」这个问题,那么欢迎你访问我们的\href{https://bithesis.bitnp.net}{在线文档}以获得更多信息。
+%
% \section{使用说明}
-%
-% \DescribeMacro{\YOURMACRO}
-% Put description of |\YOURMACRO| here.
-%
-% \DescribeEnv{YOURENV}
-% Put description of |YOURENV| here.
-%
-% \StopEventually{\PrintIndex}
-%
+% \subsection{\BIThesis 宏包的组成}
+% 为了适应用户的不同需求,并符合 CTeX 宏集的设计习惯,我们将 \BIThesisMacroPackage 的主要功能设计安排在两个中文文档类当中,具体的组成见 \ref{tab:classes}。
+% \begin{table}[H]
+% \centering
+% \caption{测试}
+% \label{tab:classes}
+% \begin{tabular}{@{}lll@{}}
+% \toprule
+% 类别 & 文件 & 说明 \\ \midrule
+% \multirow{2}{*}{文档类} & bitart.cls & 对应 ctxart.cls,提供实验报告模板、开题报告模板。 \\
+% & bitbook.cls & 对应 ctexbook.cls ,提供本科毕业模板。 \\ \cmidrule(l){2-3}
+% \end{tabular}
+% \end{table}
+% \subsection{\BIThesis 宏包的安装和更新}
+% 最常见的 \TeX 发行版(\hologo{TeX} Live 和 \hologo{MiKTeX})已收录\BIThesisMacroPackage 及其依赖的宏包和宏集。
+%
+% 如果安装以上发行版的时间较早,可能你本地的环境中不存在 \BIThesisMacroPackage 或者不是最新版本的。那么你需要通过包管理器来安装/更新 \BIThesisMacroPackage:
+% \mint{bash}|tlmgr update --self --all|
+% \subsection{使用 \BIThesis 文档类}
+% 推荐使用 \BIThesisScaffold 来进行具体的项目编写。\BIThesisScaffold 提供了多种最常用的模板,你可以在 \href{https://github.com/BITNP/BIThesis}{主项目的 Releases}中找到它们。
% \section{致谢}
+% \section{软件许可证}
+% \begin{itemize}
+% \item 北京理工大学校徽校名图片的版权归北京理工大学所有。
+% \item \BIThesisLaTeX 宏包以及相关文档类使用 \LPPL 授权。
+% \item \BIThesisLaTeX 文档及其他附属文件通过 \LPPL 授权。
+% \end{itemize}
% \section{实现细节}
%
-%
% \begin{macrocode}
%<*package>
% \end{macrocode}
@@ -176,7 +227,6 @@
\RequirePackage{setspace}
\RequirePackage{booktabs}
\RequirePackage{multirow}
-\RequirePackage{caption}
\RequirePackage{tikz}
\RequirePackage{etoolbox}
\RequirePackage{hyperref}
@@ -543,7 +593,11 @@
pdfdisplaydoctitle = true
}%
-\newcommand{\BIThesisLaTeX}{{\BIThesis} 北京理工大学学位论文及报告{\LaTeX}模板}
+\newcommand{\BIThesisLaTeX}{{\BIThesis}北京理工大学学位论文及报告{\LaTeX}模板}
+\newcommand{\BIThesisMacroPackage}{{\BIThesis}宏集}
+\newcommand{\BIThesisWiki}{{\BIThesis}在线文档}
+\newcommand{\BIThesisScaffold}{{\BIThesis}模板}
+\newcommand{\LPPL}{{\href{https://www.latex-project.org/lppl/lppl-1-3c.txt}{\LaTeX{} Project Public License (1.3.c)}}}
\newcommand{\version}{v2.0 BirthdayCake}
\ctexset{
@@ -732,6 +786,7 @@
\raisebox{-0.38ex}{\matex@ssize {S}}\kern-0.05em
{\matex@ssize {I}}\kern-0.05em
\raisebox{-0.35ex}{\matex@ssize {S}}\kern-0.5em
+ \kern 1ex
}
}
\makeatother
diff --git a/macros/latex/contrib/bithesis/bithesis.ins b/macros/latex/contrib/bithesis/bithesis.ins
index 923da3dd31..98393c70e9 100644
--- a/macros/latex/contrib/bithesis/bithesis.ins
+++ b/macros/latex/contrib/bithesis/bithesis.ins
@@ -1,4 +1,4 @@
-%% Copyright (C) 2020
+%% Copyright (C) 2021
%% Association of Bit Network Pioneer and any individual authors listed elsewhere in this file.
%% --------------------------------------------------------------------------
%%
@@ -22,7 +22,7 @@
\preamble
- Copyright (C) 2020
+ Copyright (C) 2021
Association of Bit Network Pioneer and any individual authors listed in the documentation.
------------------------------------------------------------------------------
diff --git a/macros/latex/contrib/bithesis/bithesis.pdf b/macros/latex/contrib/bithesis/bithesis.pdf
index b15b8c45d5..de2c9e0a91 100644
--- a/macros/latex/contrib/bithesis/bithesis.pdf
+++ b/macros/latex/contrib/bithesis/bithesis.pdf
Binary files differ
diff --git a/macros/latex/contrib/bithesis/contributing-zh.md b/macros/latex/contrib/bithesis/contributing-zh.md
new file mode 100644
index 0000000000..cfdf95b80d
--- /dev/null
+++ b/macros/latex/contrib/bithesis/contributing-zh.md
@@ -0,0 +1,58 @@
+# 贡献者指南
+
+[![English version](assets/english.svg)](./contributing.md)
+
+:tada: 首先,感谢你为本项目付出的宝贵时间!:tada:
+
+以下是有关如何为本项目贡献力量的一些指导建议。
+
+以下内容大多是指导性质的建议,并非强制要求。总之,在行动之前确保你知道自己要做什么。
+
+本文档目前仍处于完善阶段,欢迎通过提出你自己的意见或者提交 PR 来帮助我们。
+
+## Guidance
+
+**[我不想看下面的内容,我只是想问个小问题!!!](#加入我们的-slack-频道)**
+
+| | 普通使用者 | 开发者 |
+| ---------- | ------------------------------- | ------------------------------------------- |
+| 提出问题 | [Slack](#加入我们的-slack-频道) | [Slack](#加入我们的-slack-频道) |
+| 提交 Bug | [Slack](#加入我们的-slack-频道) | [Github - Issues](#在-github-上提交-bug) |
+| 有好的想法 | [Slack](#加入我们的-slack-频道) | [Slack](#加入我们的-slack-频道) |
+| 提交 PR | | [Github - Pull Request](#提交-pull-request) |
+| 有信心维护代码 | | [加入 Slack 并联系我们](#加入我们的-slack-频道) |
+
+## 加入我们的 Slack 频道
+
+在我们提供的[官方 Slack 频道][slack channel invitation]中有**很多活跃的维护者**和**友好的社区氛围**。在这里你能获得很多与本项目有关的帮助。
+
+[![点击这里加入 Slack](/assets/slack.svg)](https://join.slack.com/t/bithesis/shared_invite/zt-epmzkyk0-fJRsUS36AlwMNB2AI_Q~Vw)
+
+- 使用 `#community` 频道来**讨论问题**、**提出你的建议**或者**寻求帮助**。
+- 使用 `#random` 频道来**水群**:laughing:!
+- 使用 `#announcement` 频道获取和本项目相关的**最新资讯和使用方法**!
+
+> 提示:关于具体如何提出问题并没有明确的要求。总之请提供尽可能详细的信息,并且思考一下这个问题是不是已经被解决了。
+
+## 在 Github 上提交 Bug
+
+如果你能更精确的定位问题所在,或者能够提供更详细的信息;你可以向我们[提交一个 issue][issue reporting link]。
+
+## 提交 Pull Request
+
+欢迎提交 Pull Request!
+
+以下流程将会帮助你完成一次 PR。
+
+1. Fork 这个项目。
+2. 使用 `git clone` 将项目拉取到本地。
+3. 使用最少的修改来解决 bug。
+4. 使用 `git commit` 提交变更。
+5. 创建一个 PR,并添加相应的说明。
+6. 在 PR 被合并之前请保持关注,以便进行修改。
+
+寻找更细致的流程请参考
+_[Github Help](https://help.github.com/en/github/collaborating-with-issues-and-pull-requests)_。
+
+[slack channel invitation]: https://join.slack.com/t/bithesis/shared_invite/zt-epmzkyk0-fJRsUS36AlwMNB2AI_Q~Vw
+[issue reporting link]: https://github.com/BITNP/BIThesis/issues/new
diff --git a/macros/latex/contrib/bithesis/contributing.md b/macros/latex/contrib/bithesis/contributing.md
new file mode 100644
index 0000000000..7fe28f4955
--- /dev/null
+++ b/macros/latex/contrib/bithesis/contributing.md
@@ -0,0 +1,60 @@
+# Contributing
+
+[![Chinese version](./assets/chinese.svg)](./contributing-zh.md)
+
+:tada: First off, thanks for taking the time to contribute! :tada:
+
+The following is a set of guidelines for contributing to BIThesis.
+
+These are mostly guidelines, not rules. Use your best judgment,
+and feel free to propose changes to this document in a pull request.
+
+## Guidance
+
+**[I don't want to read this whole thing, I just have a small question!!!](#join-our-slack-channel)**
+
+| | For Users | For Developers |
+| --------------- | -------------------------------- | ---------------------------------------------- |
+| Have a Question | [Slack](#join-our-slack-channel) | [Slack](#join-our-slack-channel) |
+| Bug Report | [Slack](#join-our-slack-channel) | [Github - Issues](#bug-report-on-github) |
+| Feature Request | [Slack](#join-our-slack-channel) | [Slack](#join-our-slack-channel) |
+| Pull Request | | [Github - Pull Request](#pull-request-process) |
+
+## Join Our Slack Channel
+
+We provide an [official Slack channel][slack channel invitation]
+with **a bunch of active maintainers** and **a friendly community**
+to give helpful advice **if you have any questions**.
+
+[![Join on Slack](/assets/slack.svg)](https://join.slack.com/t/bithesis/shared_invite/zt-epmzkyk0-fJRsUS36AlwMNB2AI_Q~Vw)
+
+- use `#community` channel to **report a bug**, **feature request** and **asking for help**.
+- use `#random` channel to have **unrelated discussion**:laughing:!
+- use `#announcement` channel if you don't want to miss the **updated news and features**!
+
+> note: there is no detailed rules about how to ask question, just provide enough information and
+rethink before write.
+
+## Bug Report on Github
+
+If you can locate the bug or provide more detailed information, you may
+_[report an issue here][issue reporting link]_.
+
+## Pull Request Process
+
+Pull Request are welcomed!
+
+The following steps will help you finish a pull request.
+
+1. Fork this repo.
+2. `git clone` your forked repo.
+3. Make changes until the bug is fixed.
+4. Commit your changes.
+5. Create a pull request with related information.
+6. Keep in touch with further discussion and refine.
+
+For more information, refer to the
+_[Github Help](https://help.github.com/en/github/collaborating-with-issues-and-pull-requests)_.
+
+[slack channel invitation]: https://join.slack.com/t/bithesis/shared_invite/zt-epmzkyk0-fJRsUS36AlwMNB2AI_Q~Vw
+[issue reporting link]: https://github.com/BITNP/BIThesis/issues/new