diff options
Diffstat (limited to 'Master/texmf-dist/doc/latex/bithesis')
| -rw-r--r-- | Master/texmf-dist/doc/latex/bithesis/README-zh.md | 88 | ||||
| -rw-r--r-- | Master/texmf-dist/doc/latex/bithesis/README.md | 84 | ||||
| -rw-r--r-- | Master/texmf-dist/doc/latex/bithesis/bithesis.pdf | bin | 194456 -> 216524 bytes | |||
| -rw-r--r-- | Master/texmf-dist/doc/latex/bithesis/contributing-zh.md | 58 | ||||
| -rw-r--r-- | Master/texmf-dist/doc/latex/bithesis/contributing.md | 60 | ||||
| -rw-r--r-- | Master/texmf-dist/doc/latex/bithesis/dtx-style.sty | 9 |
6 files changed, 253 insertions, 46 deletions
diff --git a/Master/texmf-dist/doc/latex/bithesis/README-zh.md b/Master/texmf-dist/doc/latex/bithesis/README-zh.md new file mode 100644 index 00000000000..62e548767cb --- /dev/null +++ b/Master/texmf-dist/doc/latex/bithesis/README-zh.md @@ -0,0 +1,88 @@ +<div align="center"> + <img src="./assets/bithesis_icon.svg" alt="BIThesis Icon"> + +📖 _非官方本科生毕业设计毕业论文 LaTeX 模板（以及更多）_ + + +[](./README-en.md) +[](https://mg.readthedocs.io/latexmk.html) +[](./LICENSE) +[](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 官方社区！ + +[](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 |  | +| Netlify Deploy | [](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/Master/texmf-dist/doc/latex/bithesis/README.md b/Master/texmf-dist/doc/latex/bithesis/README.md index a7cd83b2987..d8a8e199976 100644 --- a/Master/texmf-dist/doc/latex/bithesis/README.md +++ b/Master/texmf-dist/doc/latex/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)._ - +[](https://bithesis.bitnp.net/) +[](./README-zh.md) [](https://mg.readthedocs.io/latexmk.html) [](./LICENSE) [](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! [](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 文件 +[](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/links/0)[](https://sourcerer.io/fame/spencerwooo/spencerwooo/BIThesis/links/1)[](https://sourcerer.io/fame/spencerwooo/spencerwooo/BIThesis/links/2)[](https://sourcerer.io/fame/spencerwooo/spencerwooo/BIThesis/links/3)[](https://sourcerer.io/fame/spencerwooo/spencerwooo/BIThesis/links/4)[](https://sourcerer.io/fame/spencerwooo/spencerwooo/BIThesis/links/5)[](https://sourcerer.io/fame/spencerwooo/spencerwooo/BIThesis/links/6)[](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 |  | | Netlify Deploy | [](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/Master/texmf-dist/doc/latex/bithesis/bithesis.pdf b/Master/texmf-dist/doc/latex/bithesis/bithesis.pdf Binary files differindex b15b8c45d53..de2c9e0a913 100644 --- a/Master/texmf-dist/doc/latex/bithesis/bithesis.pdf +++ b/Master/texmf-dist/doc/latex/bithesis/bithesis.pdf diff --git a/Master/texmf-dist/doc/latex/bithesis/contributing-zh.md b/Master/texmf-dist/doc/latex/bithesis/contributing-zh.md new file mode 100644 index 00000000000..cfdf95b80d3 --- /dev/null +++ b/Master/texmf-dist/doc/latex/bithesis/contributing-zh.md @@ -0,0 +1,58 @@ +# 贡献者指南 + +[](./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]中有**很多活跃的维护者**和**友好的社区氛围**。在这里你能获得很多与本项目有关的帮助。 + +[](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/Master/texmf-dist/doc/latex/bithesis/contributing.md b/Master/texmf-dist/doc/latex/bithesis/contributing.md new file mode 100644 index 00000000000..7fe28f4955b --- /dev/null +++ b/Master/texmf-dist/doc/latex/bithesis/contributing.md @@ -0,0 +1,60 @@ +# Contributing + +[](./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**. + +[](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 diff --git a/Master/texmf-dist/doc/latex/bithesis/dtx-style.sty b/Master/texmf-dist/doc/latex/bithesis/dtx-style.sty index 89542c0a600..cc1da48240f 100644 --- a/Master/texmf-dist/doc/latex/bithesis/dtx-style.sty +++ b/Master/texmf-dist/doc/latex/bithesis/dtx-style.sty @@ -6,7 +6,7 @@ %% %% bithesis.dtx (with options: `dtx-style') %% -%% Copyright (C) 2020 +%% Copyright (C) 2021 %% Association of Bit Network Pioneer and any individual authors listed in the documentation. %% ------------------------------------------------------------------------------ %% @@ -80,7 +80,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{ @@ -266,6 +270,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 |