diff options
Diffstat (limited to 'Master/texmf-dist/doc')
-rw-r--r-- | Master/texmf-dist/doc/latex/bithesis/README.md | 93 | ||||
-rw-r--r-- | Master/texmf-dist/doc/latex/bithesis/bithesis.pdf | bin | 0 -> 194456 bytes | |||
-rw-r--r-- | Master/texmf-dist/doc/latex/bithesis/dtx-style.sty | 275 |
3 files changed, 368 insertions, 0 deletions
diff --git a/Master/texmf-dist/doc/latex/bithesis/README.md b/Master/texmf-dist/doc/latex/bithesis/README.md new file mode 100644 index 00000000000..a7cd83b2987 --- /dev/null +++ b/Master/texmf-dist/doc/latex/bithesis/README.md @@ -0,0 +1,93 @@ +<div align="center"> + <img src="./assets/bithesis_icon.svg" alt="BIThesis Icon"> + +📖 _非官方本科生毕业设计毕业论文 LaTeX 模板(以及更多)_ + +![BIThesis](./assets/bithesis_badge_solid.svg) +[![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)。 + +## 贡献者 + +> 本项目的存在离不开以下所有贡献者的辛勤贡献。更多信息请访问:[BIThesis - 致谢](https://bithesis.bitnp.net/Guide/5-Acknowledgements/Acknowledgements.html)。 + +[![](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) + +## 相关项目 + +- [北京理工大学硕士(博士)学位论文 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/Master/texmf-dist/doc/latex/bithesis/bithesis.pdf b/Master/texmf-dist/doc/latex/bithesis/bithesis.pdf Binary files differnew file mode 100644 index 00000000000..b15b8c45d53 --- /dev/null +++ b/Master/texmf-dist/doc/latex/bithesis/bithesis.pdf diff --git a/Master/texmf-dist/doc/latex/bithesis/dtx-style.sty b/Master/texmf-dist/doc/latex/bithesis/dtx-style.sty new file mode 100644 index 00000000000..89542c0a600 --- /dev/null +++ b/Master/texmf-dist/doc/latex/bithesis/dtx-style.sty @@ -0,0 +1,275 @@ +%% +%% This is file `dtx-style.sty', +%% generated with the docstrip utility. +%% +%% The original source files were: +%% +%% bithesis.dtx (with options: `dtx-style') +%% +%% Copyright (C) 2020 +%% Association of Bit Network Pioneer and any individual authors listed in the documentation. +%% ------------------------------------------------------------------------------ +%% +%% This work may be distributed and/or modified under the +%% conditions of the LaTeX Project Public License, either +%% version 1.3c of this license or (at your option) any later +%% version. This version of this license is in +%% http://www.latex-project.org/lppl/lppl-1-3c.txt +%% and the latest version of this license is in +%% http://www.latex-project.org/lppl.txt +%% and version 1.3 or later is part of all distributions of +%% LaTeX version 2020/11/27 or later. +%% +%% This work has the LPPL maintenance status `maintained'. +%% +%% The Current Maintainer of this work is Feng Kaiyu. +%% ------------------------------------------------------------------------------ +%% + +\ProvidesPackage{dtx-style} +\RequirePackage{hypdoc} +\RequirePackage{ifthen} +\RequirePackage{fontspec}[2017/01/20] +\RequirePackage{amsmath} +\RequirePackage{unicode-math} +\RequirePackage[UTF8,scheme=chinese,heading]{ctex} +\RequirePackage[ + top=2.5cm, bottom=2.5cm, + left=4cm, right=2cm, + headsep=3mm]{geometry} +\RequirePackage{graphicx} +\RequirePackage{multirow} +\RequirePackage[ruled,vlined]{algorithm2e} +\RequirePackage{wrapfig} +\RequirePackage{hologo} +\RequirePackage{array,longtable,booktabs} +\RequirePackage{listings} +\RequirePackage{fancyhdr} +\RequirePackage[dvipsnames]{xcolor} +\RequirePackage{awesomebox} +\RequirePackage{etoolbox} +\RequirePackage{dirtree} +\RequirePackage{metalogo} +\RequirePackage[tightLists=false]{markdown} +\RequirePackage{caption} +\RequirePackage{tikz} +\usetikzlibrary{positioning} +\RequirePackage{framed} +\RequirePackage{menukeys} + + % 设置代码高亮 +\RequirePackage{minted} +\usemintedstyle{tango} + + % 设置列表无间隔 +\usepackage{enumitem} +\setlist{nosep} + +\markdownSetup{ + renderers = { + link = {\href{#2}{#1}}, + } +} + +\hypersetup{ + pdflang = zh-CN, + pdftitle = {BIThesis:北京理工大学学位论文及报告模板}, + pdfauthor = {冯开宇}, + pdfsubject = {北京理工大学学位论文及报告模板使用说明}, + pdfkeywords = {论文模板; 北京理工大学; 使用说明}, + pdfdisplaydoctitle = true +}% + +\newcommand{\BIThesisLaTeX}{{\BIThesis} 北京理工大学学位论文及报告{\LaTeX}模板} +\newcommand{\version}{v2.0 BirthdayCake} + +\ctexset{ + today=big, + abstractname=简介 +} + +\ctexset{section={ + format={\raggedright \bfseries \zihao{-3}}, + name = {第,章} + } +} + +\ctexset{subsection={ + format = {\bfseries \raggedright \zihao{4}} + } +} + +\ifthenelse{\equal{\@nameuse{g__ctex_fontset_tl}}{mac}}{ + \setmainfont{Palatino} + \setsansfont[Scale=MatchLowercase]{Helvetica} + \setmonofont[Scale=MatchLowercase]{Menlo} + \xeCJKsetwidth{‘’“”}{1em} +}{ + \setmainfont[ + Extension = .otf, + UprightFont = *-regular, + BoldFont = *-bold, + ItalicFont = *-italic, + BoldItalicFont = *-bolditalic, + ]{texgyrepagella} + \setsansfont[ + Extension = .otf, + UprightFont = *-regular, + BoldFont = *-bold, + ItalicFont = *-italic, + BoldItalicFont = *-bolditalic, + ]{texgyreheros} + \setmonofont[ + Extension = .otf, + UprightFont = *-regular, + BoldFont = *-bold, + ItalicFont = *-italic, + BoldItalicFont = *-bolditalic, + Scale = MatchLowercase, + Ligatures = CommonOff, + ]{texgyrecursor} +} +\unimathsetup{ + math-style=ISO, + bold-style=ISO, +} +\IfFontExistsTF{XITSMath-Regular.otf}{ + \setmathfont[ + Extension = .otf, + BoldFont = XITSMath-Bold, + StylisticSet = 8, + ]{XITSMath-Regular} + \setmathfont[range={cal,bfcal},StylisticSet=1]{XITSMath-Regular.otf} +}{ + \setmathfont[ + Extension = .otf, + BoldFont = *bold, + StylisticSet = 8, + ]{xits-math} + \setmathfont[range={cal,bfcal},StylisticSet=1]{xits-math.otf} +} + +\colorlet{bit@macro}{blue!60!black} +\colorlet{bit@env}{blue!70!black} +\colorlet{bit@option}{purple} +\patchcmd{\PrintMacroName}{\MacroFont}{\MacroFont\bfseries\color{bit@macro}}{}{} +\patchcmd{\PrintDescribeMacro}{\MacroFont}{\MacroFont\bfseries\color{bit@macro}}{}{} +\patchcmd{\PrintDescribeEnv}{\MacroFont}{\MacroFont\bfseries\color{bit@env}}{}{} +\patchcmd{\PrintEnvName}{\MacroFont}{\MacroFont\bfseries\color{bit@env}}{}{} + +\def\DescribeOption{% + \leavevmode\@bsphack\begingroup\MakePrivateLetters% + \Describe@Option} +\def\Describe@Option#1{\endgroup + \marginpar{\raggedleft\PrintDescribeOption{#1}}% + \bit@special@index{option}{#1}\@esphack\ignorespaces} +\def\PrintDescribeOption#1{\strut \MacroFont\bfseries\sffamily\color{bit@option} #1\ } +\def\bit@special@index#1#2{\@bsphack + \begingroup + \HD@target + \let\HDorg@encapchar\encapchar + \edef\encapchar usage{% + \HDorg@encapchar hdclindex{\the\c@HD@hypercount}{usage}% + }% + \index{#2\actualchar{\string\ttfamily\space#2} + (#1)\encapchar usage}% + \index{#1:\levelchar#2\actualchar + {\string\ttfamily\space#2}\encapchar usage}% + \endgroup + \@esphack} + +\lstdefinestyle{lstStyleBase}{% + basicstyle=\small\ttfamily, + aboveskip=\medskipamount, + belowskip=\medskipamount, + lineskip=0pt, + boxpos=c, + showlines=false, + extendedchars=true, + upquote=true, + tabsize=2, + showtabs=false, + showspaces=false, + showstringspaces=false, + numbers=none, + linewidth=\linewidth, + xleftmargin=4pt, + xrightmargin=0pt, + resetmargins=false, + breaklines=true, + breakatwhitespace=false, + breakindent=0pt, + breakautoindent=true, + columns=flexible, + keepspaces=true, + gobble=4, + framesep=3pt, + rulesep=1pt, + framerule=1pt, + backgroundcolor=\color{gray!5}, + stringstyle=\color{green!40!black!100}, + keywordstyle=\bfseries\color{blue!50!black}, + commentstyle=\slshape\color{black!60}} + +\lstdefinestyle{lstStyleShell}{% + style=lstStyleBase, + frame=l, + rulecolor=\color{purple}, + language=bash} + +\lstdefinestyle{lstStyleLaTeX}{% + style=lstStyleBase, + frame=l, + rulecolor=\color{violet}, + language=[LaTeX]TeX} + +\lstnewenvironment{latex}{\lstset{style=lstStyleLaTeX}}{} +\lstnewenvironment{shell}{\lstset{style=lstStyleShell}}{} + +\setlist{nosep} + +\DeclareDocumentCommand{\option}{m}{\textsf{#1}} +\DeclareDocumentCommand{\env}{m}{\texttt{#1}} +\newcommand{\myentry}[1]{% + \marginpar{\raggedleft\color{purple}\bfseries\strut #1}} +\newcommand{\note}[2][Note]{{% + \color{magenta}{\bfseries #1}\emph{#2}}} + +\DeclareDocumentCommand{\githubuser}{m}{\href{https://github.com/#1}{@#1}} + + % 设置 caption 与 figure 之间的距离 +\setlength{\abovecaptionskip}{11pt} +\setlength{\belowcaptionskip}{9pt} + + % 设置图片的 caption 格式 +\renewcommand{\thefigure}{\thesection-\arabic{figure}} +\captionsetup[figure]{font=small,labelsep=space} + + % 设置表格的 caption 与 table 之间的垂直距离 +\captionsetup[table]{skip=2pt} + + % 设置表格的 caption 格式 +\renewcommand{\thetable}{\thesection-\arabic{table}} +\captionsetup[table]{font=small,labelsep=space} + + % 定义 BIThesis \LaTeX 风格的 Logo +\usepackage{relsize} +\makeatletter +\def\matex@ssize{\larger[-1]\scshape} +\DeclareRobustCommand{\BIThesis}{ + \mbox{ + \kern-0.5em{B}\kern-0.05em + {I}\kern-0.05em + {T}\kern-0.1em + \raisebox{-0.38ex}{\matex@ssize {H}}\kern-0.1em + {\matex@ssize {E}}\kern-0.05em + \raisebox{-0.38ex}{\matex@ssize {S}}\kern-0.05em + {\matex@ssize {I}}\kern-0.05em + \raisebox{-0.35ex}{\matex@ssize {S}}\kern-0.5em + } +} +\makeatother + +\endinput +%% +%% End of file `dtx-style.sty'. |